fix(specs): API key description will be obfuscated (#3840) (generated) [skip ci]

Co-authored-by: Kai Welke <[email protected]>

Author: algolia-bot

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

@@ -694,7 +694,7 @@ public partial interface ISearchClient
   DeletedAtResponse DeleteSynonym(string indexName, string objectID, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key. 
+  /// Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`. 
   /// </summary>
   /// <param name="key">API key.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -706,7 +706,7 @@ public partial interface ISearchClient
   Task<GetApiKeyResponse> GetApiKeyAsync(string key, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.  (Synchronous version)
+  /// Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.  (Synchronous version)
   /// </summary>
   /// <param name="key">API key.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>

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

@@ -895,7 +895,7 @@ final class SearchClient implements ApiClient {
     );
   }
 
-  /// Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.
+  /// Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
   ///
   /// Parameters:
   /// * [key] API key.

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

@@ -2014,7 +2014,8 @@ public CompletableFuture<DeletedAtResponse> deleteSynonymAsync(@Nonnull String i
   /**
    * Gets the permissions and restrictions of an API key. When authenticating with the admin API
    * key, you can request information for any of your application's keys. When authenticating with
-   * other API keys, you can only retrieve information for that key.
+   * other API keys, you can only retrieve information for that key, with the description replaced
+   * by `<redacted>`.
    *
    * @param key API key. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
@@ -2028,7 +2029,8 @@ public GetApiKeyResponse getApiKey(@Nonnull String key, RequestOptions requestOp
   /**
    * Gets the permissions and restrictions of an API key. When authenticating with the admin API
    * key, you can request information for any of your application's keys. When authenticating with
-   * other API keys, you can only retrieve information for that key.
+   * other API keys, you can only retrieve information for that key, with the description replaced
+   * by `<redacted>`.
    *
    * @param key API key. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -2040,7 +2042,8 @@ public GetApiKeyResponse getApiKey(@Nonnull String key) throws AlgoliaRuntimeExc
   /**
    * (asynchronously) Gets the permissions and restrictions of an API key. When authenticating with
    * the admin API key, you can request information for any of your application's keys. When
-   * authenticating with other API keys, you can only retrieve information for that key.
+   * authenticating with other API keys, you can only retrieve information for that key, with the
+   * description replaced by `<redacted>`.
    *
    * @param key API key. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
@@ -2059,7 +2062,8 @@ public CompletableFuture<GetApiKeyResponse> getApiKeyAsync(@Nonnull String key,
   /**
    * (asynchronously) Gets the permissions and restrictions of an API key. When authenticating with
    * the admin API key, you can request information for any of your application's keys. When
-   * authenticating with other API keys, you can only retrieve information for that key.
+   * authenticating with other API keys, you can only retrieve information for that key, with the
+   * description replaced by `<redacted>`.
    *
    * @param key API key. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call

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

@@ -1501,7 +1501,7 @@ export function createSearchClient({
     },
 
     /**
-     * Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key.
+     * Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
      *
      * @param getApiKey - The getApiKey object.
      * @param getApiKey.key - API key.

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

@@ -521,7 +521,7 @@ public class SearchClient(
   }
 
   /**
-   * Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.
+   * Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
    * @param key API key.
    * @param requestOptions additional request configuration.
    */

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

@@ -1110,7 +1110,7 @@ public function deleteSynonym($indexName, $objectID, $forwardToReplicas = null,
     }
 
     /**
-     * Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.
+     * Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
      *
      * @param string $key            API key. (required)
      * @param array  $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions

clients/algoliasearch-client-php/lib/Api/SearchClient.php

@@ -2265,7 +2265,7 @@ async def get_api_key_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
-        Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.
+        Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
 
 
         :param key: API key. (required)
@@ -2292,7 +2292,7 @@ async def get_api_key(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> GetApiKeyResponse:
         """
-        Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.
+        Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
 
 
         :param key: API key. (required)
@@ -7179,7 +7179,7 @@ def get_api_key_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
-        Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.
+        Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
 
 
         :param key: API key. (required)
@@ -7206,7 +7206,7 @@ def get_api_key(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> GetApiKeyResponse:
         """
-        Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.
+        Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
 
 
         :param key: API key. (required)

clients/algoliasearch-client-python/algoliasearch/search/client.py

@@ -1127,7 +1127,7 @@ def delete_synonym(index_name, object_id, forward_to_replicas = nil, request_opt
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse")
     end
 
-    # Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.
+    # Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
 
     # @param key [String] API key. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -1157,7 +1157,7 @@ def get_api_key_with_http_info(key, request_options = {})
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.
+    # Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
 
     # @param key [String] API key. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

clients/algoliasearch-client-ruby/lib/algolia/api/search_client.rb

@@ -695,7 +695,7 @@ class SearchClient(
 
   /** Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request
     * information for any of your application's keys. When authenticating with other API keys, you can only retrieve
-    * information for that key.
+    * information for that key, with the description replaced by `<redacted>`.
     *
     * @param key
     *   API key.

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/SearchClient.scala

@@ -1483,7 +1483,7 @@ open class SearchClient {
 
     // Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request
     // information for any of your application's keys. When authenticating with other API keys, you can only retrieve
-    // information for that key.
+    // information for that key, with the description replaced by `<redacted>`.
     //
     //
     // - parameter key: (path) API key.

clients/algoliasearch-client-swift/Sources/Search/SearchClient.swift

@@ -9498,7 +9498,9 @@ paths:
         for any of your application's keys.
 
         When authenticating with other API keys, you can only retrieve
-        information for that key.
+        information for that key,
+
+        with the description replaced by `<redacted>`.
       parameters:
         - $ref: '#/components/parameters/KeyString'
       responses:

specs/bundled/search.doc.yml

@@ -1579,7 +1579,9 @@ paths:
         for any of your application's keys.
 
         When authenticating with other API keys, you can only retrieve
-        information for that key.
+        information for that key,
+
+        with the description replaced by `<redacted>`.
       parameters:
         - $ref: '#/components/parameters/KeyString'
       responses: