fix(Global Search): remove deprecated method getSupportedTypes (#192)

Signed-off-by: Fabrizio Leoni <fabrizio_leoni@it.ibm.com> Co-authored-by: Phil Adams <phil_adams@us.ibm.com>
IBM · Apr 28, 2023 · d9802ed · d9802ed
1 parent 65093dc
commit d9802ed
Show file tree

Hide file tree

Showing 6 changed files with 1 addition and 168 deletions.
diff --git a/.../src/main/java/com/ibm/cloud/platform_services/global_search/v2/GlobalSearchExamples.java b/.../src/main/java/com/ibm/cloud/platform_services/global_search/v2/GlobalSearchExamples.java
@@ -16,10 +16,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.ibm.cloud.platform_services.global_search.v2.model.GetSupportedTypesOptions;
 import com.ibm.cloud.platform_services.global_search.v2.model.ScanResult;
 import com.ibm.cloud.platform_services.global_search.v2.model.SearchOptions;
-import com.ibm.cloud.platform_services.global_search.v2.model.SupportedTypesList;
 import com.ibm.cloud.sdk.core.http.Response;
 import com.ibm.cloud.sdk.core.service.exception.ServiceResponseException;
 
@@ -70,25 +68,5 @@ public static void main(String[] args) throws Exception {
         logger.error(String.format("Service returned status code %s: %s\nError details: %s",
           e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
     }
-
-    try {
-      System.out.println("getSupportedTypes() result:");
-
-      // begin-get_supported_types
-
-      GetSupportedTypesOptions getSupportedTypesOptions = new GetSupportedTypesOptions();
-
-      Response<SupportedTypesList> response = service.getSupportedTypes(getSupportedTypesOptions).execute();
-      SupportedTypesList supportedTypesList = response.getResult();
-
-      System.out.println(supportedTypesList);
-
-      // end-get_supported_types
-
-    } catch (ServiceResponseException e) {
-        logger.error(String.format("Service returned status code %s: %s\nError details: %s",
-          e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()), e);
-    }
-
   }
 }
diff --git a/...l-search/src/main/java/com/ibm/cloud/platform_services/global_search/v2/GlobalSearch.java b/...l-search/src/main/java/com/ibm/cloud/platform_services/global_search/v2/GlobalSearch.java
@@ -12,17 +12,15 @@
  */
 
 /*
- * IBM OpenAPI SDK Code Generator Version: 3.67.0-df2073a1-20230222-221157
+ * IBM OpenAPI SDK Code Generator Version: 3.70.0-7df966bf-20230419-195904
  */
 
 package com.ibm.cloud.platform_services.global_search.v2;
 
 import com.google.gson.JsonObject;
 import com.ibm.cloud.platform_services.common.SdkCommon;
-import com.ibm.cloud.platform_services.global_search.v2.model.GetSupportedTypesOptions;
 import com.ibm.cloud.platform_services.global_search.v2.model.ScanResult;
 import com.ibm.cloud.platform_services.global_search.v2.model.SearchOptions;
-import com.ibm.cloud.platform_services.global_search.v2.model.SupportedTypesList;
 import com.ibm.cloud.sdk.core.http.RequestBuilder;
 import com.ibm.cloud.sdk.core.http.ResponseConverter;
 import com.ibm.cloud.sdk.core.http.ServiceCall;
@@ -33,7 +31,6 @@
 import com.ibm.cloud.sdk.core.util.ResponseConverterUtils;
 import java.util.Map;
 import java.util.Map.Entry;
-import java.util.logging.Logger;
 
 /**
  * Search for resources with the global and shared resource properties repository that is integrated in the IBM Cloud
@@ -47,7 +44,6 @@
  * API Version: 2.0.1
  */
 public class GlobalSearch extends BaseService {
-  private static final Logger LOGGER = Logger.getLogger(GlobalSearch.class.getName());
 
   /**
    * Default service name used when configuring the `GlobalSearch` client.
@@ -130,9 +126,6 @@ public ServiceCall<ScanResult> search(SearchOptions searchOptions) {
     if (searchOptions.accountId() != null) {
       builder.query("account_id", String.valueOf(searchOptions.accountId()));
     }
-    if (searchOptions.boundary() != null) {
-      builder.query("boundary", String.valueOf(searchOptions.boundary()));
-    }
     if (searchOptions.limit() != null) {
       builder.query("limit", String.valueOf(searchOptions.limit()));
     }
@@ -196,40 +189,4 @@ public ServiceCall<ScanResult> search() {
     return search(null);
   }
 
-  /**
-   * DEPRECATED. Get all GhoST indexes.
-   *
-   * Retrieves a list of all GhoST indexes.
-   *
-   * @param getSupportedTypesOptions the {@link GetSupportedTypesOptions} containing the options for the call
-   * @return a {@link ServiceCall} with a result of type {@link SupportedTypesList}
-   * @deprecated this method is deprecated and may be removed in a future release
-   */
-   @Deprecated
-  public ServiceCall<SupportedTypesList> getSupportedTypes(GetSupportedTypesOptions getSupportedTypesOptions) {
-    LOGGER.warning("A deprecated operation has been invoked: getSupportedTypes");
-    RequestBuilder builder = RequestBuilder.get(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v2/resources/supported_types"));
-    Map<String, String> sdkHeaders = SdkCommon.getSdkHeaders("global_search", "v2", "getSupportedTypes");
-    for (Entry<String, String> header : sdkHeaders.entrySet()) {
-      builder.header(header.getKey(), header.getValue());
-    }
-    builder.header("Accept", "application/json");
-    ResponseConverter<SupportedTypesList> responseConverter =
-      ResponseConverterUtils.getValue(new com.google.gson.reflect.TypeToken<SupportedTypesList>() { }.getType());
-    return createServiceCall(builder.build(), responseConverter);
-  }
-
-  /**
-   * DEPRECATED. Get all GhoST indexes.
-   *
-   * Retrieves a list of all GhoST indexes.
-   *
-   * @return a {@link ServiceCall} with a result of type {@link SupportedTypesList}
-   * @deprecated this method is deprecated and may be removed in a future release
-   */
-  @Deprecated
-  public ServiceCall<SupportedTypesList> getSupportedTypes() {
-    return getSupportedTypes(null);
-  }
-
 }
diff --git a/...h/src/main/java/com/ibm/cloud/platform_services/global_search/v2/model/SearchOptions.java b/...h/src/main/java/com/ibm/cloud/platform_services/global_search/v2/model/SearchOptions.java
@@ -22,16 +22,6 @@
  */
 public class SearchOptions extends GenericModel {
 
-  /**
-   * The boundary where the search performs. This parameter must be set only for the cross-account searches.
-   */
-  public interface Boundary {
-    /** global. */
-    String GLOBAL = "global";
-    /** us-regulated. */
-    String US_REGULATED = "us-regulated";
-  }
-
   /**
    * Determines if deleted documents should be included in result set or not. Possible values are false (default), true
    * or any. If false, only existing documents are returned; if true, only deleted documents are returned; If any, both
@@ -91,7 +81,6 @@ public interface CanTag {
   protected String searchCursor;
   protected String transactionId;
   protected String accountId;
-  protected String boundary;
   protected Long limit;
   protected Long timeout;
   protected List<String> sort;
@@ -110,7 +99,6 @@ public static class Builder {
     private String searchCursor;
     private String transactionId;
     private String accountId;
-    private String boundary;
     private Long limit;
     private Long timeout;
     private List<String> sort;
@@ -131,7 +119,6 @@ private Builder(SearchOptions searchOptions) {
       this.searchCursor = searchOptions.searchCursor;
       this.transactionId = searchOptions.transactionId;
       this.accountId = searchOptions.accountId;
-      this.boundary = searchOptions.boundary;
       this.limit = searchOptions.limit;
       this.timeout = searchOptions.timeout;
       this.sort = searchOptions.sort;
@@ -245,17 +232,6 @@ public Builder accountId(String accountId) {
       return this;
     }
 
-    /**
-     * Set the boundary.
-     *
-     * @param boundary the boundary
-     * @return the SearchOptions builder
-     */
-    public Builder boundary(String boundary) {
-      this.boundary = boundary;
-      return this;
-    }
-
     /**
      * Set the limit.
      *
@@ -354,7 +330,6 @@ protected SearchOptions(Builder builder) {
     searchCursor = builder.searchCursor;
     transactionId = builder.transactionId;
     accountId = builder.accountId;
-    boundary = builder.boundary;
     limit = builder.limit;
     timeout = builder.timeout;
     sort = builder.sort;
@@ -432,17 +407,6 @@ public String accountId() {
     return accountId;
   }
 
-  /**
-   * Gets the boundary.
-   *
-   * The boundary where the search performs. This parameter must be set only for the cross-account searches.
-   *
-   * @return the boundary
-   */
-  public String boundary() {
-    return boundary;
-  }
-
   /**
    * Gets the limit.
    *

diff --git a/...search/src/test/java/com/ibm/cloud/platform_services/global_search/v2/GlobalSearchIT.java b/...search/src/test/java/com/ibm/cloud/platform_services/global_search/v2/GlobalSearchIT.java
@@ -122,24 +122,6 @@ public void testSearch() throws Exception {
         }
     }
 
-    @Test
-    public void testGetSupportedTypes() throws Exception {
-        try {
-            GetSupportedTypesOptions getSupportedTypesOptions = new GetSupportedTypesOptions();
-
-            Response<SupportedTypesList> response = service.getSupportedTypes(getSupportedTypesOptions).execute();
-            assertNotNull(response);
-            assertEquals(response.getStatusCode(), 200);
-
-            SupportedTypesList supportedTypesListResult = response.getResult();
-            assertNotNull(supportedTypesListResult);
-            log(String.format("getSupportedTypes() result:\n%s\n", supportedTypesListResult.toString()));
-        } catch (ServiceResponseException e) {
-            fail(String.format("Service returned status code %d: %s\nError details: %s", e.getStatusCode(),
-                    e.getMessage(), e.getDebuggingInfo()));
-        }
-    }
-
     @AfterClass
     public void tearDown() {
         // Add any clean up logic here

diff --git a/...arch/src/test/java/com/ibm/cloud/platform_services/global_search/v2/GlobalSearchTest.java b/...arch/src/test/java/com/ibm/cloud/platform_services/global_search/v2/GlobalSearchTest.java
@@ -13,11 +13,9 @@
 package com.ibm.cloud.platform_services.global_search.v2;
 
 import com.ibm.cloud.platform_services.global_search.v2.GlobalSearch;
-import com.ibm.cloud.platform_services.global_search.v2.model.GetSupportedTypesOptions;
 import com.ibm.cloud.platform_services.global_search.v2.model.ResultItem;
 import com.ibm.cloud.platform_services.global_search.v2.model.ScanResult;
 import com.ibm.cloud.platform_services.global_search.v2.model.SearchOptions;
-import com.ibm.cloud.platform_services.global_search.v2.model.SupportedTypesList;
 import com.ibm.cloud.platform_services.global_search.v2.utils.TestUtilities;
 import com.ibm.cloud.sdk.core.http.Response;
 import com.ibm.cloud.sdk.core.security.Authenticator;
@@ -73,7 +71,6 @@ public void testSearchWOptions() throws Throwable {
       .searchCursor("testString")
       .transactionId("testString")
       .accountId("testString")
-      .boundary("global")
       .limit(Long.valueOf("1"))
       .timeout(Long.valueOf("0"))
       .sort(java.util.Arrays.asList("testString"))
@@ -101,7 +98,6 @@ public void testSearchWOptions() throws Throwable {
     Map<String, String> query = TestUtilities.parseQueryString(request);
     assertNotNull(query);
     assertEquals(query.get("account_id"), "testString");
-    assertEquals(query.get("boundary"), "global");
     assertEquals(Long.valueOf(query.get("limit")), Long.valueOf("1"));
     assertEquals(Long.valueOf(query.get("timeout")), Long.valueOf("0"));
     assertEquals(query.get("sort"), RequestUtils.join(java.util.Arrays.asList("testString"), ","));
@@ -122,48 +118,6 @@ public void testSearchWRetries() throws Throwable {
     testSearchWOptions();
   }
 
-  // Test the getSupportedTypes operation with a valid options model parameter
-  @Test
-  public void testGetSupportedTypesWOptions() throws Throwable {
-    // Register a mock response
-    String mockResponseBody = "{\"supported_types\": [\"supportedTypes\"]}";
-    String getSupportedTypesPath = "/v2/resources/supported_types";
-    server.enqueue(new MockResponse()
-      .setHeader("Content-type", "application/json")
-      .setResponseCode(200)
-      .setBody(mockResponseBody));
-
-    // Construct an instance of the GetSupportedTypesOptions model
-    GetSupportedTypesOptions getSupportedTypesOptionsModel = new GetSupportedTypesOptions();
-
-    // Invoke getSupportedTypes() with a valid options model and verify the result
-    Response<SupportedTypesList> response = globalSearchService.getSupportedTypes(getSupportedTypesOptionsModel).execute();
-    assertNotNull(response);
-    SupportedTypesList responseObj = response.getResult();
-    assertNotNull(responseObj);
-
-    // Verify the contents of the request sent to the mock server
-    RecordedRequest request = server.takeRequest();
-    assertNotNull(request);
-    assertEquals(request.getMethod(), "GET");
-    // Verify request path
-    String parsedPath = TestUtilities.parseReqPath(request);
-    assertEquals(parsedPath, getSupportedTypesPath);
-    // Verify that there is no query string
-    Map<String, String> query = TestUtilities.parseQueryString(request);
-    assertNull(query);
-  }
-
-  // Test the getSupportedTypes operation with and without retries enabled
-  @Test
-  public void testGetSupportedTypesWRetries() throws Throwable {
-    globalSearchService.enableRetries(4, 30);
-    testGetSupportedTypesWOptions();
-
-    globalSearchService.disableRetries();
-    testGetSupportedTypesWOptions();
-  }
-
   // Perform setup needed before each test method
   @BeforeMethod
   public void beforeEachTest() {

diff --git a/...c/test/java/com/ibm/cloud/platform_services/global_search/v2/model/SearchOptionsTest.java b/...c/test/java/com/ibm/cloud/platform_services/global_search/v2/model/SearchOptionsTest.java
@@ -37,7 +37,6 @@ public void testSearchOptions() throws Throwable {
       .searchCursor("testString")
       .transactionId("testString")
       .accountId("testString")
-      .boundary("global")
       .limit(Long.valueOf("1"))
       .timeout(Long.valueOf("0"))
       .sort(java.util.Arrays.asList("testString"))
@@ -52,7 +51,6 @@ public void testSearchOptions() throws Throwable {
     assertEquals(searchOptionsModel.searchCursor(), "testString");
     assertEquals(searchOptionsModel.transactionId(), "testString");
     assertEquals(searchOptionsModel.accountId(), "testString");
-    assertEquals(searchOptionsModel.boundary(), "global");
     assertEquals(searchOptionsModel.limit(), Long.valueOf("1"));
     assertEquals(searchOptionsModel.timeout(), Long.valueOf("0"));
     assertEquals(searchOptionsModel.sort(), java.util.Arrays.asList("testString"));