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

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

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-java/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

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

@@ -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-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/SearchClient.kt

@@ -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-php/lib/Api/AbtestingClient.php

@@ -6,7 +6,11 @@
 
 use Algolia\AlgoliaSearch\Algolia;
 use Algolia\AlgoliaSearch\Configuration\AbtestingConfig;
+use Algolia\AlgoliaSearch\Model\Abtesting\ABTest;
+use Algolia\AlgoliaSearch\Model\Abtesting\ABTestResponse;
 use Algolia\AlgoliaSearch\Model\Abtesting\AddABTestsRequest;
+use Algolia\AlgoliaSearch\Model\Abtesting\ListABTestsResponse;
+use Algolia\AlgoliaSearch\Model\Abtesting\ScheduleABTestResponse;
 use Algolia\AlgoliaSearch\Model\Abtesting\ScheduleABTestsRequest;
 use Algolia\AlgoliaSearch\ObjectSerializer;
 use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapper;
@@ -124,7 +128,7 @@ public function setClientApiKey($apiKey)
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
-     * @return \Algolia\AlgoliaSearch\Model\Abtesting\ABTestResponse|array<string, mixed>
+     * @return ABTestResponse|array<string, mixed>
      */
     public function addABTests($addABTestsRequest, $requestOptions = [])
     {
@@ -310,7 +314,7 @@ public function customPut($path, $parameters = null, $body = null, $requestOptio
      * @param int   $id             Unique A/B test identifier. (required)
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
-     * @return \Algolia\AlgoliaSearch\Model\Abtesting\ABTestResponse|array<string, mixed>
+     * @return ABTestResponse|array<string, mixed>
      */
     public function deleteABTest($id, $requestOptions = [])
     {
@@ -347,7 +351,7 @@ public function deleteABTest($id, $requestOptions = [])
      * @param int   $id             Unique A/B test identifier. (required)
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
-     * @return \Algolia\AlgoliaSearch\Model\Abtesting\ABTest|array<string, mixed>
+     * @return ABTest|array<string, mixed>
      */
     public function getABTest($id, $requestOptions = [])
     {
@@ -387,7 +391,7 @@ public function getABTest($id, $requestOptions = [])
      * @param string $indexSuffix    Index name suffix. Only A/B tests for indices ending with this string are included in the response. (optional)
      * @param array  $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
-     * @return \Algolia\AlgoliaSearch\Model\Abtesting\ListABTestsResponse|array<string, mixed>
+     * @return array<string, mixed>|ListABTestsResponse
      */
     public function listABTests($offset = null, $limit = null, $indexPrefix = null, $indexSuffix = null, $requestOptions = [])
     {
@@ -435,7 +439,7 @@ public function listABTests($offset = null, $limit = null, $indexPrefix = null,
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
-     * @return \Algolia\AlgoliaSearch\Model\Abtesting\ScheduleABTestResponse|array<string, mixed>
+     * @return array<string, mixed>|ScheduleABTestResponse
      */
     public function scheduleABTest($scheduleABTestsRequest, $requestOptions = [])
     {
@@ -463,7 +467,7 @@ public function scheduleABTest($scheduleABTestsRequest, $requestOptions = [])
      * @param int   $id             Unique A/B test identifier. (required)
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
-     * @return \Algolia\AlgoliaSearch\Model\Abtesting\ABTestResponse|array<string, mixed>
+     * @return ABTestResponse|array<string, mixed>
      */
     public function stopABTest($id, $requestOptions = [])
     {