Skip to content

Commit c6b75ca

Browse files
Move Query API keys examples to ES reference documentation (#4637) (#4656)
* Move query api keys examples * Add ext_doc_id (cherry picked from commit 29ca9b8) Co-authored-by: Charlotte Hoblik <[email protected]>
1 parent 76cff8b commit c6b75ca

File tree

7 files changed

+4
-550
lines changed

7 files changed

+4
-550
lines changed

specification/_doc_ids/table.csv

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -809,6 +809,7 @@ security-application-privileges,https://www.elastic.co/docs/reference/elasticsea
809809
security-encrypt-http,https://www.elastic.co/docs/deploy-manage/security/set-up-basic-security-plus-https#encrypt-http-communication,
810810
security-encrypt-internode,https://www.elastic.co/docs/deploy-manage/security/set-up-basic-security#encrypt-internode-communication,
811811
security-privileges,https://www.elastic.co/docs/reference/elasticsearch/security-privileges,
812+
security-query-api-keys,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/query-api-keys,
812813
security-saml-guide,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml,
813814
security-settings-api-keys,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#api-key-service-settings,
814815
security-settings-hashing,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#hashing-settings,
@@ -919,4 +920,4 @@ watcher-api-update-settings,https://www.elastic.co/docs/api/doc/elasticsearch/v9
919920
watsonx-api-keys,https://cloud.ibm.com/iam/apikeys,
920921
watsonx-api-models,https://www.ibm.com/products/watsonx-ai/foundation-models,
921922
watsonx-api-version,https://cloud.ibm.com/apidocs/watsonx-ai#active-version-dates,
922-
xpack-rollup,https://www.elastic.co/docs/manage-data/lifecycle/rollup,
923+
xpack-rollup,https://www.elastic.co/docs/manage-data/lifecycle/rollup,

specification/security/query_api_keys/QueryApiKeysRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,12 @@ import { ApiKeyAggregationContainer, ApiKeyQueryContainer } from './types'
3232
* To use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges.
3333
* If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.
3434
* If you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.
35+
* Refer to the linked documentation for examples of how to find API keys:
3536
* @rest_spec_name security.query_api_keys
3637
* @availability stack since=7.15.0 stability=stable
3738
* @availability serverless stability=stable visibility=public
3839
* @cluster_privileges manage_own_api_key, read_security
40+
* @ext_doc_id security-query-api-keys
3941
* @doc_id security-api-query-api-key
4042
*/
4143
export interface Request extends RequestBase {

specification/security/query_api_keys/examples/request/QueryApiKeysRequestExample2.yaml

Lines changed: 0 additions & 308 deletions
This file was deleted.

0 commit comments

Comments
 (0)