Merge branch 'main' into benk/compositions/rest-api-endpoints

Author: millotp

clients/algoliasearch-client-csharp/algoliasearch/Clients/SearchClient.cs

@@ -1235,6 +1235,7 @@ Rule GetRule(
   /// Required API Key ACLs:
   ///   - settings
   /// <param name="indexName">Name of the index on which to perform the operation.</param>
+  /// <param name="getVersion">When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility. (optional, default to 1)</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -1243,6 +1244,7 @@ Rule GetRule(
   /// <returns>Task of SettingsResponse</returns>
   Task<SettingsResponse> GetSettingsAsync(
     string indexName,
+    int? getVersion = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   );
@@ -1254,6 +1256,7 @@ Task<SettingsResponse> GetSettingsAsync(
   /// Required API Key ACLs:
   ///   - settings
   /// <param name="indexName">Name of the index on which to perform the operation.</param>
+  /// <param name="getVersion">When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility. (optional, default to 1)</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -1262,6 +1265,7 @@ Task<SettingsResponse> GetSettingsAsync(
   /// <returns>SettingsResponse</returns>
   SettingsResponse GetSettings(
     string indexName,
+    int? getVersion = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   );
@@ -3731,6 +3735,7 @@ public Rule GetRule(
   /// <inheritdoc />
   public async Task<SettingsResponse> GetSettingsAsync(
     string indexName,
+    int? getVersion = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   )
@@ -3742,6 +3747,7 @@ public async Task<SettingsResponse> GetSettingsAsync(
 
     requestOptions.PathParameters.Add("indexName", QueryStringHelper.ParameterToString(indexName));
 
+    requestOptions.AddQueryParameter("getVersion", getVersion);
     return await _transport
       .ExecuteRequestAsync<SettingsResponse>(
         new HttpMethod("GET"),
@@ -3755,9 +3761,11 @@ public async Task<SettingsResponse> GetSettingsAsync(
   /// <inheritdoc />
   public SettingsResponse GetSettings(
     string indexName,
+    int? getVersion = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
-  ) => AsyncHelper.RunSync(() => GetSettingsAsync(indexName, options, cancellationToken));
+  ) =>
+    AsyncHelper.RunSync(() => GetSettingsAsync(indexName, getVersion, options, cancellationToken));
 
   /// <inheritdoc />
   public async Task<List<Source>> GetSourcesAsync(

clients/algoliasearch-client-csharp/algoliasearch/Utils/SearchClientExtensions.cs

@@ -1157,7 +1157,7 @@ public async Task<bool> IndexExistsAsync(
   {
     try
     {
-      await GetSettingsAsync(indexName, null, cancellationToken);
+      await GetSettingsAsync(indexName, null, null, cancellationToken);
     }
     catch (AlgoliaApiException ex) when (ex.HttpErrorCode == 404)
     {

clients/algoliasearch-client-dart/packages/client_search/lib/src/api/search_client.dart

@@ -1168,9 +1168,11 @@ final class SearchClient implements ApiClient {
   ///
   /// Parameters:
   /// * [indexName] Name of the index on which to perform the operation.
+  /// * [getVersion] When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility.
   /// * [requestOptions] additional request configuration.
   Future<SettingsResponse> getSettings({
     required String indexName,
+    int? getVersion,
     RequestOptions? requestOptions,
   }) async {
     assert(
@@ -1181,6 +1183,9 @@ final class SearchClient implements ApiClient {
       method: RequestMethod.get,
       path: r'/1/indexes/{indexName}/settings'.replaceAll(
           '{' r'indexName' '}', Uri.encodeComponent(indexName.toString())),
+      queryParams: {
+        if (getVersion != null) 'getVersion': getVersion,
+      },
     );
     final response = await _retryStrategy.execute(
       request: request,

clients/algoliasearch-client-go/algolia/search/api_search.go

@@ -2745,6 +2745,33 @@ public CompletableFuture<Rule> getRuleAsync(@Nonnull String indexName, @Nonnull
     return this.getRuleAsync(indexName, objectID, null);
   }
 
+  /**
+   * Retrieves an object with non-null index settings.
+   *
+   * @param indexName Name of the index on which to perform the operation. (required)
+   * @param getVersion When set to 2, the endpoint will not include `synonyms` in the response. This
+   *     parameter is here for backward compatibility. (optional, default to 1)
+   * @param requestOptions The requestOptions to send along with the query, they will be merged with
+   *     the transporter requestOptions.
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public SettingsResponse getSettings(@Nonnull String indexName, Integer getVersion, @Nullable RequestOptions requestOptions)
+    throws AlgoliaRuntimeException {
+    return LaunderThrowable.await(getSettingsAsync(indexName, getVersion, requestOptions));
+  }
+
+  /**
+   * Retrieves an object with non-null index settings.
+   *
+   * @param indexName Name of the index on which to perform the operation. (required)
+   * @param getVersion When set to 2, the endpoint will not include `synonyms` in the response. This
+   *     parameter is here for backward compatibility. (optional, default to 1)
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public SettingsResponse getSettings(@Nonnull String indexName, Integer getVersion) throws AlgoliaRuntimeException {
+    return this.getSettings(indexName, getVersion, null);
+  }
+
   /**
    * Retrieves an object with non-null index settings.
    *
@@ -2754,7 +2781,7 @@ public CompletableFuture<Rule> getRuleAsync(@Nonnull String indexName, @Nonnull
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public SettingsResponse getSettings(@Nonnull String indexName, @Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
-    return LaunderThrowable.await(getSettingsAsync(indexName, requestOptions));
+    return this.getSettings(indexName, null, requestOptions);
   }
 
   /**
@@ -2764,33 +2791,68 @@ public SettingsResponse getSettings(@Nonnull String indexName, @Nullable Request
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public SettingsResponse getSettings(@Nonnull String indexName) throws AlgoliaRuntimeException {
-    return this.getSettings(indexName, null);
+    return this.getSettings(indexName, null, null);
   }
 
   /**
    * (asynchronously) Retrieves an object with non-null index settings.
    *
    * @param indexName Name of the index on which to perform the operation. (required)
+   * @param getVersion When set to 2, the endpoint will not include `synonyms` in the response. This
+   *     parameter is here for backward compatibility. (optional, default to 1)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public CompletableFuture<SettingsResponse> getSettingsAsync(@Nonnull String indexName, @Nullable RequestOptions requestOptions)
-    throws AlgoliaRuntimeException {
+  public CompletableFuture<SettingsResponse> getSettingsAsync(
+    @Nonnull String indexName,
+    Integer getVersion,
+    @Nullable RequestOptions requestOptions
+  ) throws AlgoliaRuntimeException {
     Parameters.requireNonNull(indexName, "Parameter `indexName` is required when calling `getSettings`.");
 
-    HttpRequest request = HttpRequest.builder().setPath("/1/indexes/{indexName}/settings", indexName).setMethod("GET").build();
+    HttpRequest request = HttpRequest.builder()
+      .setPath("/1/indexes/{indexName}/settings", indexName)
+      .setMethod("GET")
+      .addQueryParameter("getVersion", getVersion)
+      .build();
     return executeAsync(request, requestOptions, new TypeReference<SettingsResponse>() {});
   }
 
+  /**
+   * (asynchronously) Retrieves an object with non-null index settings.
+   *
+   * @param indexName Name of the index on which to perform the operation. (required)
+   * @param getVersion When set to 2, the endpoint will not include `synonyms` in the response. This
+   *     parameter is here for backward compatibility. (optional, default to 1)
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public CompletableFuture<SettingsResponse> getSettingsAsync(@Nonnull String indexName, Integer getVersion)
+    throws AlgoliaRuntimeException {
+    return this.getSettingsAsync(indexName, getVersion, null);
+  }
+
+  /**
+   * (asynchronously) Retrieves an object with non-null index settings.
+   *
+   * @param indexName Name of the index on which to perform the operation. (required)
+   * @param requestOptions The requestOptions to send along with the query, they will be merged with
+   *     the transporter requestOptions.
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public CompletableFuture<SettingsResponse> getSettingsAsync(@Nonnull String indexName, @Nullable RequestOptions requestOptions)
+    throws AlgoliaRuntimeException {
+    return this.getSettingsAsync(indexName, null, requestOptions);
+  }
+
   /**
    * (asynchronously) Retrieves an object with non-null index settings.
    *
    * @param indexName Name of the index on which to perform the operation. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<SettingsResponse> getSettingsAsync(@Nonnull String indexName) throws AlgoliaRuntimeException {
-    return this.getSettingsAsync(indexName, null);
+    return this.getSettingsAsync(indexName, null, null);
   }
 
   /**

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/SearchClient.java

@@ -393,6 +393,10 @@ export type GetSettingsProps = {
    * Name of the index on which to perform the operation.
    */
   indexName: string;
+  /**
+   * When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility.
+   */
+  getVersion?: number | undefined;
 };
 
 /**

clients/algoliasearch-client-javascript/packages/client-search/model/clientMethodProps.ts

@@ -1792,9 +1792,13 @@ export function createSearchClient({
      *  - settings
      * @param getSettings - The getSettings object.
      * @param getSettings.indexName - Name of the index on which to perform the operation.
+     * @param getSettings.getVersion - When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getSettings({ indexName }: GetSettingsProps, requestOptions?: RequestOptions): Promise<SettingsResponse> {
+    getSettings(
+      { indexName, getVersion }: GetSettingsProps,
+      requestOptions?: RequestOptions,
+    ): Promise<SettingsResponse> {
       if (!indexName) {
         throw new Error('Parameter `indexName` is required when calling `getSettings`.');
       }
@@ -1803,6 +1807,10 @@ export function createSearchClient({
       const headers: Headers = {};
       const queryParameters: QueryParameters = {};
 
+      if (getVersion !== undefined) {
+        queryParameters['getVersion'] = getVersion.toString();
+      }
+
       const request: Request = {
         method: 'GET',
         path: requestPath,

clients/algoliasearch-client-javascript/packages/client-search/src/searchClient.ts

@@ -699,13 +699,17 @@ public class SearchClient(
    * Required API Key ACLs:
    *   - settings
    * @param indexName Name of the index on which to perform the operation.
+   * @param getVersion When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility. (default to 1)
    * @param requestOptions additional request configuration.
    */
-  public suspend fun getSettings(indexName: String, requestOptions: RequestOptions? = null): SettingsResponse {
+  public suspend fun getSettings(indexName: String, getVersion: Int? = null, requestOptions: RequestOptions? = null): SettingsResponse {
     require(indexName.isNotBlank()) { "Parameter `indexName` is required when calling `getSettings`." }
     val requestConfig = RequestConfig(
       method = RequestMethod.GET,
       path = listOf("1", "indexes", "$indexName", "settings"),
+      query = buildMap {
+        getVersion?.let { put("getVersion", it) }
+      },
     )
     return requester.execute(
       requestConfig = requestConfig,

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/SearchClient.kt

@@ -1463,11 +1463,12 @@ public function getRule($indexName, $objectID, $requestOptions = [])
      *  - settings
      *
      * @param string $indexName      Name of the index on which to perform the operation. (required)
+     * @param int    $getVersion     When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility. (optional, default to 1)
      * @param array  $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
      * @return array<string, mixed>|SettingsResponse
      */
-    public function getSettings($indexName, $requestOptions = [])
+    public function getSettings($indexName, $getVersion = null, $requestOptions = [])
     {
         // verify the required parameter 'indexName' is set
         if (!isset($indexName)) {
@@ -1481,6 +1482,10 @@ public function getSettings($indexName, $requestOptions = [])
         $headers = [];
         $httpBody = null;
 
+        if (null !== $getVersion) {
+            $queryParameters['getVersion'] = $getVersion;
+        }
+
         // path params
         if (null !== $indexName) {
             $resourcePath = str_replace(