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

algolia-bot · kai687 · algolia-bot · commit 4a4e44c25833 · 2024-09-27T08:21:52.000Z
algolia/api-clients-automation#3840 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Kai Welke <kai.welke@algolia.com>
diff --git a/packages/client-search/src/searchClient.ts b/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.

Original file line number	Diff line number	Diff line change
`@@ -1501,7 +1501,7 @@ export function createSearchClient({`
`1501`	`1501`	`},`
`1502`	`1502`
`1503`	`1503`	`/**`
`1504`		`- * 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.`
	`1504`	+ * 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>`.
`1505`	`1505`	`*`
`1506`	`1506`	`* @param getApiKey - The getApiKey object.`
`1507`	`1507`	`* @param getApiKey.key - API key.`