fix(specs): API key description will be obfuscated (generated)

algolia/api-clients-automation#3840 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Kai Welke <[email protected]>
algolia · Sep 27, 2024 · c6d110a · c6d110a
1 parent 26bfa52
commit c6d110a
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/algoliasearch/src/main/java/com/algolia/api/SearchClient.java b/algoliasearch/src/main/java/com/algolia/api/SearchClient.java
@@ -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