From 1c7790c024844def73ea555d65d0f873fdac8426 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 21 Oct 2024 11:54:42 -0700 Subject: [PATCH 1/5] Edit security API summaries --- specification/_doc_ids/table.csv | 3 +++ specification/security/activate_user_profile/Request.ts | 3 ++- .../bulk_delete_role/SecurityBulkDeleteRoleRequest.ts | 1 + .../security/bulk_put_role/SecurityBulkPutRoleRequest.ts | 1 + .../change_password/SecurityChangePasswordRequest.ts | 2 ++ .../clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts | 3 ++- .../SecurityClearCachedPrivilegesRequest.ts | 3 +++ .../clear_cached_realms/SecurityClearCachedRealmsRequest.ts | 2 ++ .../security/clear_cached_roles/ClearCachedRolesRequest.ts | 2 ++ .../ClearCachedServiceTokensRequest.ts | 3 +++ .../security/create_api_key/SecurityCreateApiKeyRequest.ts | 2 +- .../create_service_token/CreateServiceTokenRequest.ts | 4 +++- .../delete_privileges/SecurityDeletePrivilegesRequest.ts | 2 ++ .../security/delete_role/SecurityDeleteRoleRequest.ts | 5 ++--- .../delete_role_mapping/SecurityDeleteRoleMappingRequest.ts | 1 + .../delete_service_token/DeleteServiceTokenRequest.ts | 3 +++ .../security/delete_user/SecurityDeleteUserRequest.ts | 2 ++ .../security/disable_user/SecurityDisableUserRequest.ts | 2 ++ specification/security/disable_user_profile/Request.ts | 3 ++- .../security/enable_user/SecurityEnableUserRequest.ts | 2 ++ specification/security/enable_user_profile/Request.ts | 3 ++- specification/security/enroll_kibana/Request.ts | 3 ++- specification/security/enroll_node/Request.ts | 3 ++- .../SecurityGetBuiltinPrivilegesRequest.ts | 6 +++--- .../security/get_privileges/SecurityGetPrivilegesRequest.ts | 2 ++ specification/security/get_role/SecurityGetRoleRequest.ts | 5 ++--- .../get_role_mapping/SecurityGetRoleMappingRequest.ts | 5 +++++ .../get_service_accounts/GetServiceAccountsRequest.ts | 4 +++- .../get_service_credentials/GetServiceCredentialsRequest.ts | 2 ++ .../security/get_token/GetUserAccessTokenRequest.ts | 2 ++ specification/security/get_user/SecurityGetUserRequest.ts | 2 ++ 31 files changed, 68 insertions(+), 18 deletions(-) diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 68351266d1..82216c3c25 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -258,6 +258,7 @@ lowercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{bra mapping-date-format,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-date-format.html mapping-meta-field,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html mapping-metadata,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-fields.html +mapping-roles,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html mapping-settings-limit,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-settings-limit.html mapping-source-field,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-source-field.html mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping.html @@ -573,6 +574,8 @@ security-api-saml-logout,https://www.elastic.co/guide/en/elasticsearch/reference security-api-saml-prepare-authentication,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-prepare-authentication.html security-api-saml-sp-metadata,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-sp-metadata.html security-api-ssl,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-ssl.html +security-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html +service-accounts,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html set-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/set-processor.html shape,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/shape.html simulate-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-pipeline-api.html diff --git a/specification/security/activate_user_profile/Request.ts b/specification/security/activate_user_profile/Request.ts index b8d0243c32..41ba0d4f22 100644 --- a/specification/security/activate_user_profile/Request.ts +++ b/specification/security/activate_user_profile/Request.ts @@ -21,7 +21,8 @@ import { GrantType } from '@security/_types/GrantType' import { RequestBase } from '@_types/Base' /** - * Creates or updates a user profile on behalf of another user. + * Create or update a user profile. + * Create or update a user profile on behalf of another user. * @rest_spec_name security.activate_user_profile * @availability stack since=8.2.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts b/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts index 05377914b2..efaa0b90f7 100644 --- a/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts +++ b/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Refresh } from '@_types/common' /** + * Bulk delete roles. * The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. * The bulk delete roles API cannot delete roles that are defined in roles files. * @rest_spec_name security.bulk_delete_role diff --git a/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts b/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts index ebeab2dc36..230c8b271f 100644 --- a/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts +++ b/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts @@ -23,6 +23,7 @@ import { RequestBase } from '@_types/Base' import { Refresh } from '@_types/common' /** + * Bulk create or update roles. * The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. * The bulk create or update roles API cannot update roles that are defined in roles files. * @rest_spec_name security.bulk_put_role diff --git a/specification/security/change_password/SecurityChangePasswordRequest.ts b/specification/security/change_password/SecurityChangePasswordRequest.ts index 52429e61fe..607e26162e 100644 --- a/specification/security/change_password/SecurityChangePasswordRequest.ts +++ b/specification/security/change_password/SecurityChangePasswordRequest.ts @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base' import { Password, Refresh, Username } from '@_types/common' /** + * Change passwords. + * Change the passwords of users in the native realm and built-in users. * @rest_spec_name security.change_password * @availability stack stability=stable */ diff --git a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts index 67c308fdc3..946c95526f 100644 --- a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts +++ b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts @@ -21,7 +21,8 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Evicts a subset of all entries from the API key cache. + * Clear the API key cache. + * Evict a subset of all entries from the API key cache. * The cache is also automatically cleared on state changes of the security index. * @rest_spec_name security.clear_api_key_cache * @availability stack since=7.10.0 stability=stable diff --git a/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts b/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts index 5b183a7ab0..f214e73208 100644 --- a/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts +++ b/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts @@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Clear the privileges cache. + * Evict privileges from the native application privilege cache. + * The cache is also automatically cleared for applications that have their privileges updated. * @rest_spec_name security.clear_cached_privileges * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts b/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts index b87498885a..20b3fc74b5 100644 --- a/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts +++ b/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base' import { Names } from '@_types/common' /** + * Clear the user cache. + * Evict users from the user cache. You can completely clear the cache or evict specific users. * @rest_spec_name security.clear_cached_realms * @availability stack stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts b/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts index b84006af56..aa2f854d67 100644 --- a/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts +++ b/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base' import { Names } from '@_types/common' /** + * Clear the roles cache. + * Evict roles from the native role cache. * @rest_spec_name security.clear_cached_roles * @availability stack stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts b/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts index af81d05f3f..30f16ea6c0 100644 --- a/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts +++ b/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts @@ -21,9 +21,12 @@ import { RequestBase } from '@_types/Base' import { Names, Namespace, Service } from '@_types/common' /** + * Clear service account token caches. + * Evict a subset of all entries from the service account token caches. * @rest_spec_name security.clear_cached_service_tokens * @availability stack stability=stable * @availability serverless stability=stable visibility=private + * @ext_doc_id service-accounts */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts index e5f6f2bb89..a9cd7521cc 100644 --- a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts +++ b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts @@ -25,7 +25,7 @@ import { Duration } from '@_types/Time' /** * Create an API key. - * Creates an API key for access without requiring basic authentication. + * Create an API key for access without requiring basic authentication. * A successful request returns a JSON structure that contains the API key, its unique id, and its name. * If applicable, it also returns expiration information for the API key in milliseconds. * NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. diff --git a/specification/security/create_service_token/CreateServiceTokenRequest.ts b/specification/security/create_service_token/CreateServiceTokenRequest.ts index ce6ed1fda2..cfdddef301 100644 --- a/specification/security/create_service_token/CreateServiceTokenRequest.ts +++ b/specification/security/create_service_token/CreateServiceTokenRequest.ts @@ -21,10 +21,12 @@ import { RequestBase } from '@_types/Base' import { Name, Namespace, Refresh, Service } from '@_types/common' /** - * Creates a service accounts token for access without requiring basic authentication. + * Create a service account token. + * Create a service accounts token for access without requiring basic authentication. * @rest_spec_name security.create_service_token * @availability stack stability=stable * @availability serverless stability=stable visibility=private + * @ext_doc_id service-account */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts b/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts index 782dafc6ab..472469b7ba 100644 --- a/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts +++ b/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts @@ -21,9 +21,11 @@ import { RequestBase } from '@_types/Base' import { Name, Names, Refresh } from '@_types/common' /** + * Delete application privileges. * @rest_spec_name security.delete_privileges * @availability stack since=6.4.0 stability=stable * @availability serverless stability=stable visibility=private + * @ext_doc_id security-privileges */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/delete_role/SecurityDeleteRoleRequest.ts b/specification/security/delete_role/SecurityDeleteRoleRequest.ts index b93b84a622..7717263791 100644 --- a/specification/security/delete_role/SecurityDeleteRoleRequest.ts +++ b/specification/security/delete_role/SecurityDeleteRoleRequest.ts @@ -21,9 +21,8 @@ import { RequestBase } from '@_types/Base' import { Name, Refresh } from '@_types/common' /** - * Delete roles API. - * - * Removes roles in the native realm. + * Delete roles. + * Remove roles in the native realm. * @rest_spec_name security.delete_role * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts b/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts index c4551b64eb..36cb2c3a5c 100644 --- a/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts +++ b/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Name, Refresh } from '@_types/common' /** + * Delete role mappings. * @rest_spec_name security.delete_role_mapping * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/delete_service_token/DeleteServiceTokenRequest.ts b/specification/security/delete_service_token/DeleteServiceTokenRequest.ts index 9f424b628e..0f52e4148f 100644 --- a/specification/security/delete_service_token/DeleteServiceTokenRequest.ts +++ b/specification/security/delete_service_token/DeleteServiceTokenRequest.ts @@ -21,9 +21,12 @@ import { RequestBase } from '@_types/Base' import { Name, Namespace, Refresh, Service } from '@_types/common' /** + * Delete service account tokens. + * Delete service account tokens for a service in a specified namespace. * @rest_spec_name security.delete_service_token * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=private + * @ext_doc_id service-accounts */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/delete_user/SecurityDeleteUserRequest.ts b/specification/security/delete_user/SecurityDeleteUserRequest.ts index 07217b16d0..505f352422 100644 --- a/specification/security/delete_user/SecurityDeleteUserRequest.ts +++ b/specification/security/delete_user/SecurityDeleteUserRequest.ts @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base' import { Refresh, Username } from '@_types/common' /** + * Delete users. + * Delete users from the native realm. * @rest_spec_name security.delete_user * @availability stack stability=stable */ diff --git a/specification/security/disable_user/SecurityDisableUserRequest.ts b/specification/security/disable_user/SecurityDisableUserRequest.ts index 30c1447a4e..3333287fbd 100644 --- a/specification/security/disable_user/SecurityDisableUserRequest.ts +++ b/specification/security/disable_user/SecurityDisableUserRequest.ts @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base' import { Refresh, Username } from '@_types/common' /** + * Deactivate users. + * Deactivate users in the native realm. * @rest_spec_name security.disable_user * @availability stack stability=stable */ diff --git a/specification/security/disable_user_profile/Request.ts b/specification/security/disable_user_profile/Request.ts index eb31d02362..afde74e4c5 100644 --- a/specification/security/disable_user_profile/Request.ts +++ b/specification/security/disable_user_profile/Request.ts @@ -22,7 +22,8 @@ import { RequestBase } from '@_types/Base' import { Refresh } from '@_types/common' /** - * Disables a user profile so it's not visible in user profile searches. + * Deactivate a user profile. + * Deactivated user profiles are not visible in user profile searches. * @rest_spec_name security.disable_user_profile * @availability stack since=8.2.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/enable_user/SecurityEnableUserRequest.ts b/specification/security/enable_user/SecurityEnableUserRequest.ts index 538d919407..671a1f6953 100644 --- a/specification/security/enable_user/SecurityEnableUserRequest.ts +++ b/specification/security/enable_user/SecurityEnableUserRequest.ts @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base' import { Refresh, Username } from '@_types/common' /** + * Activate users. + * Activate users in the native realm. * @rest_spec_name security.enable_user * @availability stack stability=stable */ diff --git a/specification/security/enable_user_profile/Request.ts b/specification/security/enable_user_profile/Request.ts index fd06852d3c..1170825797 100644 --- a/specification/security/enable_user_profile/Request.ts +++ b/specification/security/enable_user_profile/Request.ts @@ -22,7 +22,8 @@ import { RequestBase } from '@_types/Base' import { Refresh } from '@_types/common' /** - * Enables a user profile so it's visible in user profile searches. + * Activate a user profile. + * Activated user profiles are visible in user profile searches. * @rest_spec_name security.enable_user_profile * @availability stack since=8.2.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/enroll_kibana/Request.ts b/specification/security/enroll_kibana/Request.ts index 88db88ab7e..ee792e6863 100644 --- a/specification/security/enroll_kibana/Request.ts +++ b/specification/security/enroll_kibana/Request.ts @@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base' /** - * Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. + * Enroll Kibana. + * Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. * @rest_spec_name security.enroll_kibana * @availability stack since=8.0.0 stability=stable */ diff --git a/specification/security/enroll_node/Request.ts b/specification/security/enroll_node/Request.ts index 1539d1820a..213836e893 100644 --- a/specification/security/enroll_node/Request.ts +++ b/specification/security/enroll_node/Request.ts @@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base' /** - * Allows a new node to join an existing cluster with security features enabled. + * Enroll a node. + * Enroll a new node to allow it to join an existing cluster with security features enabled. * @rest_spec_name security.enroll_node * @availability stack since=8.0.0 stability=stable */ diff --git a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts index 15e290be52..68e16f4f11 100644 --- a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts +++ b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts @@ -20,12 +20,12 @@ import { RequestBase } from '@_types/Base' /** - * Get builtin privileges API. - * - * Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + * Get builtin privileges. + * Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. * @rest_spec_name security.get_builtin_privileges * @availability stack since=7.3.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_security + * @ext_doc_id security-privileges */ export interface Request extends RequestBase {} diff --git a/specification/security/get_privileges/SecurityGetPrivilegesRequest.ts b/specification/security/get_privileges/SecurityGetPrivilegesRequest.ts index 22dfc434a7..9c1dc0671e 100644 --- a/specification/security/get_privileges/SecurityGetPrivilegesRequest.ts +++ b/specification/security/get_privileges/SecurityGetPrivilegesRequest.ts @@ -21,9 +21,11 @@ import { RequestBase } from '@_types/Base' import { Name, Names } from '@_types/common' /** + * Get application privileges. * @rest_spec_name security.get_privileges * @availability stack since=6.4.0 stability=stable * @availability serverless stability=stable visibility=private + * @ext_doc_id security-privileges */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/get_role/SecurityGetRoleRequest.ts b/specification/security/get_role/SecurityGetRoleRequest.ts index 170b4f8a99..08a988a278 100644 --- a/specification/security/get_role/SecurityGetRoleRequest.ts +++ b/specification/security/get_role/SecurityGetRoleRequest.ts @@ -21,9 +21,8 @@ import { RequestBase } from '@_types/Base' import { Names } from '@_types/common' /** - * Get roles API. - * - * Retrieves roles in the native realm. + * Get roles. + * Get roles in the native realm. * @rest_spec_name security.get_role * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts b/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts index a6fba4d641..4b7ae5e510 100644 --- a/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts +++ b/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts @@ -21,10 +21,15 @@ import { RequestBase } from '@_types/Base' import { Names } from '@_types/common' /** + * Get role mappings. + * Role mappings define which roles are assigned to each user. + * The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + * The get role mappings API cannot retrieve role mappings that are defined in role mapping files. * @rest_spec_name security.get_role_mapping * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges manage_security + * @ext_doc_id mapping-roles */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/get_service_accounts/GetServiceAccountsRequest.ts b/specification/security/get_service_accounts/GetServiceAccountsRequest.ts index 298332b094..283ac138e0 100644 --- a/specification/security/get_service_accounts/GetServiceAccountsRequest.ts +++ b/specification/security/get_service_accounts/GetServiceAccountsRequest.ts @@ -21,11 +21,13 @@ import { RequestBase } from '@_types/Base' import { Namespace, Service } from '@_types/common' /** - * This API returns a list of service accounts that match the provided path parameter(s). + * Get service accounts. + * Get a list of service accounts that match the provided path parameters. * @rest_spec_name security.get_service_accounts * @availability stack since=7.13.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges manage_service_account + * @ext_doc_id service-accounts */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/get_service_credentials/GetServiceCredentialsRequest.ts b/specification/security/get_service_credentials/GetServiceCredentialsRequest.ts index 3211fb4cb9..fcb64f51eb 100644 --- a/specification/security/get_service_credentials/GetServiceCredentialsRequest.ts +++ b/specification/security/get_service_credentials/GetServiceCredentialsRequest.ts @@ -21,9 +21,11 @@ import { RequestBase } from '@_types/Base' import { Name, Namespace } from '@_types/common' /** + * Get service account credentials. * @rest_spec_name security.get_service_credentials * @availability stack since=7.13.0 stability=stable * @availability serverless stability=stable visibility=private + * @ext_doc_id service-accounts */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/get_token/GetUserAccessTokenRequest.ts b/specification/security/get_token/GetUserAccessTokenRequest.ts index 6fda3119f0..9a7a127987 100644 --- a/specification/security/get_token/GetUserAccessTokenRequest.ts +++ b/specification/security/get_token/GetUserAccessTokenRequest.ts @@ -23,6 +23,8 @@ import { Password, Username } from '@_types/common' import { AccessTokenGrantType } from './types' /** + * Get a token. + * Create a bearer token for access without requiring basic authentication. * @rest_spec_name security.get_token * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/get_user/SecurityGetUserRequest.ts b/specification/security/get_user/SecurityGetUserRequest.ts index 0da3646956..3c1b978e09 100644 --- a/specification/security/get_user/SecurityGetUserRequest.ts +++ b/specification/security/get_user/SecurityGetUserRequest.ts @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base' import { Username } from '@_types/common' /** + * Get users. + * Get information about users in the native realm and built-in users. * @rest_spec_name security.get_user * @availability stack stability=stable */ From 7975a6ec9ad0edadbd26c77117cc47b0842f1efd Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 21 Oct 2024 13:47:07 -0700 Subject: [PATCH 2/5] Generate output --- output/openapi/elasticsearch-openapi.json | 189 ++++++++++++----- .../elasticsearch-serverless-openapi.json | 23 ++- output/schema/schema.json | 194 ++++++++++-------- .../CreateServiceTokenRequest.ts | 2 +- 4 files changed, 254 insertions(+), 154 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index e508f39991..260b54a0ff 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -26799,7 +26799,8 @@ "tags": [ "security" ], - "summary": "Creates or updates a user profile on behalf of another user", + "summary": "Create or update a user profile", + "description": "Create or update a user profile on behalf of another user.", "operationId": "security-activate-user-profile", "requestBody": { "content": { @@ -26934,8 +26935,8 @@ "tags": [ "security" ], - "summary": "Get roles API", - "description": "Retrieves roles in the native realm.", + "summary": "Get roles", + "description": "Get roles in the native realm.", "operationId": "security-get-role-1", "responses": { "200": { @@ -26947,8 +26948,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The bulk create or update roles API cannot update roles that are defined in roles files.", + "summary": "Bulk create or update roles", + "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", "operationId": "security-bulk-put-role", "parameters": [ { @@ -27028,8 +27029,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The bulk delete roles API cannot delete roles that are defined in roles files.", + "summary": "Bulk delete roles", + "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", "operationId": "security-bulk-delete-role", "parameters": [ { @@ -27104,7 +27105,8 @@ "tags": [ "security" ], - "summary": "Changes the passwords of users in the native realm and built-in users", + "summary": "Change passwords", + "description": "Change the passwords of users in the native realm and built-in users.", "operationId": "security-change-password", "parameters": [ { @@ -27127,7 +27129,8 @@ "tags": [ "security" ], - "summary": "Changes the passwords of users in the native realm and built-in users", + "summary": "Change passwords", + "description": "Change the passwords of users in the native realm and built-in users.", "operationId": "security-change-password-1", "parameters": [ { @@ -27152,7 +27155,8 @@ "tags": [ "security" ], - "summary": "Changes the passwords of users in the native realm and built-in users", + "summary": "Change passwords", + "description": "Change the passwords of users in the native realm and built-in users.", "operationId": "security-change-password-2", "parameters": [ { @@ -27172,7 +27176,8 @@ "tags": [ "security" ], - "summary": "Changes the passwords of users in the native realm and built-in users", + "summary": "Change passwords", + "description": "Change the passwords of users in the native realm and built-in users.", "operationId": "security-change-password-3", "parameters": [ { @@ -27194,8 +27199,8 @@ "tags": [ "security" ], - "summary": "Evicts a subset of all entries from the API key cache", - "description": "The cache is also automatically cleared on state changes of the security index.", + "summary": "Clear the API key cache", + "description": "Evict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "operationId": "security-clear-api-key-cache", "parameters": [ { @@ -27249,7 +27254,8 @@ "tags": [ "security" ], - "summary": "Evicts application privileges from the native application privileges cache", + "summary": "Clear the privileges cache", + "description": "Evict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "operationId": "security-clear-cached-privileges", "parameters": [ { @@ -27303,8 +27309,8 @@ "tags": [ "security" ], - "summary": "Evicts users from the user cache", - "description": "Can completely clear the cache or evict specific users.", + "summary": "Clear the user cache", + "description": "Evict users from the user cache. You can completely clear the cache or evict specific users.", "operationId": "security-clear-cached-realms", "parameters": [ { @@ -27370,7 +27376,8 @@ "tags": [ "security" ], - "summary": "Evicts roles from the native role cache", + "summary": "Clear the roles cache", + "description": "Evict roles from the native role cache.", "operationId": "security-clear-cached-roles", "parameters": [ { @@ -27423,7 +27430,11 @@ "tags": [ "security" ], - "summary": "Evicts tokens from the service account token caches", + "summary": "Clear service account token caches", + "description": "Evict a subset of all entries from the service account token caches.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-clear-cached-service-tokens", "parameters": [ { @@ -27613,7 +27624,7 @@ "security" ], "summary": "Create an API key", - "description": "Creates an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "operationId": "security-create-api-key", "parameters": [ { @@ -27635,7 +27646,7 @@ "security" ], "summary": "Create an API key", - "description": "Creates an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "operationId": "security-create-api-key-1", "parameters": [ { @@ -27743,7 +27754,11 @@ "tags": [ "security" ], - "summary": "Creates a service accounts token for access without requiring basic authentication", + "summary": "Create a service account token", + "description": "Create a service accounts token for access without requiring basic authentication.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-create-service-token", "parameters": [ { @@ -27769,7 +27784,11 @@ "tags": [ "security" ], - "summary": "Creates a service accounts token for access without requiring basic authentication", + "summary": "Create a service account token", + "description": "Create a service accounts token for access without requiring basic authentication.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-create-service-token-1", "parameters": [ { @@ -27795,7 +27814,11 @@ "tags": [ "security" ], - "summary": "Deletes a service account token", + "summary": "Delete service account tokens", + "description": "Delete service account tokens for a service in a specified namespace.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-delete-service-token", "parameters": [ { @@ -27870,7 +27893,11 @@ "tags": [ "security" ], - "summary": "Creates a service accounts token for access without requiring basic authentication", + "summary": "Create a service account token", + "description": "Create a service accounts token for access without requiring basic authentication.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-create-service-token-2", "parameters": [ { @@ -27895,7 +27922,10 @@ "tags": [ "security" ], - "summary": "Retrieves application privileges", + "summary": "Get application privileges", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-get-privileges-2", "parameters": [ { @@ -27916,7 +27946,10 @@ "tags": [ "security" ], - "summary": "Removes application privileges", + "summary": "Delete application privileges", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-delete-privileges", "parameters": [ { @@ -27978,8 +28011,8 @@ "tags": [ "security" ], - "summary": "Get roles API", - "description": "Retrieves roles in the native realm.", + "summary": "Get roles", + "description": "Get roles in the native realm.", "operationId": "security-get-role", "parameters": [ { @@ -28044,8 +28077,8 @@ "tags": [ "security" ], - "summary": "Delete roles API", - "description": "Removes roles in the native realm.", + "summary": "Delete roles", + "description": "Remove roles in the native realm.", "operationId": "security-delete-role", "parameters": [ { @@ -28097,7 +28130,11 @@ "tags": [ "security" ], - "summary": "Retrieves role mappings", + "summary": "Get role mappings", + "description": "Role mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html" + }, "operationId": "security-get-role-mapping", "parameters": [ { @@ -28163,7 +28200,7 @@ "tags": [ "security" ], - "summary": "Removes role mappings", + "summary": "Delete role mappings", "operationId": "security-delete-role-mapping", "parameters": [ { @@ -28216,7 +28253,8 @@ "tags": [ "security" ], - "summary": "Retrieves information about users in the native realm and built-in users", + "summary": "Get users", + "description": "Get information about users in the native realm and built-in users.", "operationId": "security-get-user", "parameters": [ { @@ -28284,7 +28322,8 @@ "tags": [ "security" ], - "summary": "Deletes users from the native realm", + "summary": "Delete users", + "description": "Delete users from the native realm.", "operationId": "security-delete-user", "parameters": [ { @@ -28336,7 +28375,8 @@ "tags": [ "security" ], - "summary": "Disables users in the native realm", + "summary": "Deactivate users", + "description": "Deactivate users in the native realm.", "operationId": "security-disable-user", "parameters": [ { @@ -28356,7 +28396,8 @@ "tags": [ "security" ], - "summary": "Disables users in the native realm", + "summary": "Deactivate users", + "description": "Deactivate users in the native realm.", "operationId": "security-disable-user-1", "parameters": [ { @@ -28378,7 +28419,8 @@ "tags": [ "security" ], - "summary": "Disables a user profile so it's not visible in user profile searches", + "summary": "Deactivate a user profile", + "description": "Deactivated user profiles are not visible in user profile searches.", "operationId": "security-disable-user-profile", "parameters": [ { @@ -28399,7 +28441,8 @@ "tags": [ "security" ], - "summary": "Disables a user profile so it's not visible in user profile searches", + "summary": "Deactivate a user profile", + "description": "Deactivated user profiles are not visible in user profile searches.", "operationId": "security-disable-user-profile-1", "parameters": [ { @@ -28422,7 +28465,8 @@ "tags": [ "security" ], - "summary": "Enables users in the native realm", + "summary": "Activate users", + "description": "Activate users in the native realm.", "operationId": "security-enable-user", "parameters": [ { @@ -28442,7 +28486,8 @@ "tags": [ "security" ], - "summary": "Enables users in the native realm", + "summary": "Activate users", + "description": "Activate users in the native realm.", "operationId": "security-enable-user-1", "parameters": [ { @@ -28464,7 +28509,8 @@ "tags": [ "security" ], - "summary": "Enables a user profile so it's visible in user profile searches", + "summary": "Activate a user profile", + "description": "Activated user profiles are visible in user profile searches.", "operationId": "security-enable-user-profile", "parameters": [ { @@ -28485,7 +28531,8 @@ "tags": [ "security" ], - "summary": "Enables a user profile so it's visible in user profile searches", + "summary": "Activate a user profile", + "description": "Activated user profiles are visible in user profile searches.", "operationId": "security-enable-user-profile-1", "parameters": [ { @@ -28508,7 +28555,8 @@ "tags": [ "security" ], - "summary": "Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster", + "summary": "Enroll Kibana", + "description": "Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", "operationId": "security-enroll-kibana", "responses": { "200": { @@ -28542,7 +28590,8 @@ "tags": [ "security" ], - "summary": "Allows a new node to join an existing cluster with security features enabled", + "summary": "Enroll a node", + "description": "Enroll a new node to allow it to join an existing cluster with security features enabled.", "operationId": "security-enroll-node", "responses": { "200": { @@ -28595,8 +28644,11 @@ "tags": [ "security" ], - "summary": "Get builtin privileges API", - "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "summary": "Get builtin privileges", + "description": "Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-get-builtin-privileges", "responses": { "200": { @@ -28636,7 +28688,10 @@ "tags": [ "security" ], - "summary": "Retrieves application privileges", + "summary": "Get application privileges", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-get-privileges", "responses": { "200": { @@ -28693,7 +28748,10 @@ "tags": [ "security" ], - "summary": "Retrieves application privileges", + "summary": "Get application privileges", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-get-privileges-1", "parameters": [ { @@ -28713,7 +28771,11 @@ "tags": [ "security" ], - "summary": "Retrieves role mappings", + "summary": "Get role mappings", + "description": "Role mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html" + }, "operationId": "security-get-role-mapping-1", "responses": { "200": { @@ -28728,7 +28790,11 @@ "tags": [ "security" ], - "summary": "This API returns a list of service accounts that match the provided path parameter(s)", + "summary": "Get service accounts", + "description": "Get a list of service accounts that match the provided path parameters.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-get-service-accounts", "parameters": [ { @@ -28751,7 +28817,11 @@ "tags": [ "security" ], - "summary": "This API returns a list of service accounts that match the provided path parameter(s)", + "summary": "Get service accounts", + "description": "Get a list of service accounts that match the provided path parameters.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-get-service-accounts-1", "parameters": [ { @@ -28771,7 +28841,11 @@ "tags": [ "security" ], - "summary": "This API returns a list of service accounts that match the provided path parameter(s)", + "summary": "Get service accounts", + "description": "Get a list of service accounts that match the provided path parameters.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-get-service-accounts-2", "responses": { "200": { @@ -28786,7 +28860,10 @@ "tags": [ "security" ], - "summary": "Retrieves information of all service credentials for a service account", + "summary": "Get service account credentials", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-get-service-credentials", "parameters": [ { @@ -28855,7 +28932,8 @@ "tags": [ "security" ], - "summary": "Creates a bearer token for access without requiring basic authentication", + "summary": "Get a token", + "description": "Create a bearer token for access without requiring basic authentication.", "operationId": "security-get-token", "requestBody": { "content": { @@ -29002,7 +29080,8 @@ "tags": [ "security" ], - "summary": "Retrieves information about users in the native realm and built-in users", + "summary": "Get users", + "description": "Get information about users in the native realm and built-in users.", "operationId": "security-get-user-1", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 52179a01a6..ae06b8d980 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -16726,7 +16726,7 @@ "security" ], "summary": "Create an API key", - "description": "Creates an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "operationId": "security-create-api-key", "parameters": [ { @@ -16748,7 +16748,7 @@ "security" ], "summary": "Create an API key", - "description": "Creates an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "operationId": "security-create-api-key-1", "parameters": [ { @@ -16856,8 +16856,8 @@ "tags": [ "security" ], - "summary": "Get roles API", - "description": "Retrieves roles in the native realm.", + "summary": "Get roles", + "description": "Get roles in the native realm.", "operationId": "security-get-role", "parameters": [ { @@ -16922,8 +16922,8 @@ "tags": [ "security" ], - "summary": "Delete roles API", - "description": "Removes roles in the native realm.", + "summary": "Delete roles", + "description": "Remove roles in the native realm.", "operationId": "security-delete-role", "parameters": [ { @@ -16975,8 +16975,11 @@ "tags": [ "security" ], - "summary": "Get builtin privileges API", - "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "summary": "Get builtin privileges", + "description": "Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-get-builtin-privileges", "responses": { "200": { @@ -17016,8 +17019,8 @@ "tags": [ "security" ], - "summary": "Get roles API", - "description": "Retrieves roles in the native realm.", + "summary": "Get roles", + "description": "Get roles in the native realm.", "operationId": "security-get-role-1", "responses": { "200": { diff --git a/output/schema/schema.json b/output/schema/schema.json index 58eb213a8b..f68fdd1506 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -14962,7 +14962,7 @@ "stability": "stable" } }, - "description": "Creates or updates a user profile on behalf of another user.", + "description": "Create or update a user profile.\nCreate or update a user profile on behalf of another user.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html", "name": "security.activate_user_profile", "privileges": { @@ -15040,7 +15040,7 @@ "stability": "stable" } }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", + "description": "Bulk delete roles.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-delete-role.html", "name": "security.bulk_delete_role", "privileges": { @@ -15083,7 +15083,7 @@ "stability": "stable" } }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", + "description": "Bulk create or update roles.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-put-role.html", "name": "security.bulk_put_role", "privileges": { @@ -15149,7 +15149,7 @@ "stability": "stable" } }, - "description": "Changes the passwords of users in the native realm and built-in users.", + "description": "Change passwords.\nChange the passwords of users in the native realm and built-in users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html", "name": "security.change_password", "request": { @@ -15195,7 +15195,7 @@ "stability": "stable" } }, - "description": "Evicts a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", + "description": "Clear the API key cache.\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html", "name": "security.clear_api_key_cache", "privileges": { @@ -15235,7 +15235,7 @@ "stability": "stable" } }, - "description": "Evicts application privileges from the native application privileges cache.", + "description": "Clear the privileges cache.\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html", "name": "security.clear_cached_privileges", "request": { @@ -15269,7 +15269,7 @@ "stability": "stable" } }, - "description": "Evicts users from the user cache. Can completely clear the cache or evict specific users.", + "description": "Clear the user cache.\nEvict users from the user cache. You can completely clear the cache or evict specific users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html", "name": "security.clear_cached_realms", "request": { @@ -15303,7 +15303,7 @@ "stability": "stable" } }, - "description": "Evicts roles from the native role cache.", + "description": "Clear the roles cache.\nEvict roles from the native role cache.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", "name": "security.clear_cached_roles", "request": { @@ -15337,8 +15337,10 @@ "stability": "stable" } }, - "description": "Evicts tokens from the service account token caches.", + "description": "Clear service account token caches.\nEvict a subset of all entries from the service account token caches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", + "extDocId": "service-accounts", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.clear_cached_service_tokens", "request": { "name": "Request", @@ -15372,7 +15374,7 @@ "stability": "stable" } }, - "description": "Create an API key.\nCreates an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key.\nCreate an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", "name": "security.create_api_key", "privileges": { @@ -15443,8 +15445,10 @@ "stability": "stable" } }, - "description": "Creates a service accounts token for access without requiring basic authentication.", + "description": "Create a service account token.\nCreate a service accounts token for access without requiring basic authentication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", + "extDocId": "service-accounts", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.create_service_token", "request": { "name": "Request", @@ -15485,8 +15489,10 @@ "stability": "stable" } }, - "description": "Removes application privileges.", + "description": "Delete application privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html", + "extDocId": "security-privileges", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.delete_privileges", "request": { "name": "Request", @@ -15519,7 +15525,7 @@ "stability": "stable" } }, - "description": "Delete roles API.\n\nRemoves roles in the native realm.", + "description": "Delete roles.\nRemove roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", "request": { @@ -15554,7 +15560,7 @@ "stability": "stable" } }, - "description": "Removes role mappings.", + "description": "Delete role mappings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html", "name": "security.delete_role_mapping", "request": { @@ -15589,8 +15595,10 @@ "stability": "stable" } }, - "description": "Deletes a service account token.", + "description": "Delete service account tokens.\nDelete service account tokens for a service in a specified namespace.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", + "extDocId": "service-accounts", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.delete_service_token", "request": { "name": "Request", @@ -15619,7 +15627,7 @@ "stability": "stable" } }, - "description": "Deletes users from the native realm.", + "description": "Delete users.\nDelete users from the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", "name": "security.delete_user", "request": { @@ -15649,7 +15657,7 @@ "stability": "stable" } }, - "description": "Disables users in the native realm.", + "description": "Deactivate users.\nDeactivate users in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", "name": "security.disable_user", "request": { @@ -15685,7 +15693,7 @@ "stability": "stable" } }, - "description": "Disables a user profile so it's not visible in user profile searches.", + "description": "Deactivate a user profile.\nDeactivated user profiles are not visible in user profile searches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html", "name": "security.disable_user_profile", "privileges": { @@ -15721,7 +15729,7 @@ "stability": "stable" } }, - "description": "Enables users in the native realm.", + "description": "Activate users.\nActivate users in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", "name": "security.enable_user", "request": { @@ -15757,7 +15765,7 @@ "stability": "stable" } }, - "description": "Enables a user profile so it's visible in user profile searches.", + "description": "Activate a user profile.\nActivated user profiles are visible in user profile searches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html", "name": "security.enable_user_profile", "privileges": { @@ -15794,7 +15802,7 @@ "stability": "stable" } }, - "description": "Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", + "description": "Enroll Kibana.\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html", "name": "security.enroll_kibana", "request": { @@ -15828,7 +15836,7 @@ "stability": "stable" } }, - "description": "Allows a new node to join an existing cluster with security features enabled.", + "description": "Enroll a node.\nEnroll a new node to allow it to join an existing cluster with security features enabled.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html", "name": "security.enroll_node", "request": { @@ -15907,8 +15915,10 @@ "stability": "stable" } }, - "description": "Get builtin privileges API.\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges.\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", + "extDocId": "security-privileges", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.get_builtin_privileges", "privileges": { "cluster": [ @@ -15947,8 +15957,10 @@ "stability": "stable" } }, - "description": "Retrieves application privileges.", + "description": "Get application privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html", + "extDocId": "security-privileges", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.get_privileges", "request": { "name": "Request", @@ -15993,7 +16005,7 @@ "stability": "stable" } }, - "description": "Get roles API.\n\nRetrieves roles in the native realm.", + "description": "Get roles.\nGet roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { @@ -16039,8 +16051,10 @@ "stability": "stable" } }, - "description": "Retrieves role mappings.", + "description": "Get role mappings.\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", + "extDocId": "mapping-roles", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html", "name": "security.get_role_mapping", "privileges": { "cluster": [ @@ -16085,8 +16099,10 @@ "stability": "stable" } }, - "description": "This API returns a list of service accounts that match the provided path parameter(s).", + "description": "Get service accounts.\nGet a list of service accounts that match the provided path parameters.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", + "extDocId": "service-accounts", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.get_service_accounts", "privileges": { "cluster": [ @@ -16137,8 +16153,10 @@ "stability": "stable" } }, - "description": "Retrieves information of all service credentials for a service account.", + "description": "Get service account credentials.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html", + "extDocId": "service-accounts", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.get_service_credentials", "request": { "name": "Request", @@ -16200,7 +16218,7 @@ "stability": "stable" } }, - "description": "Creates a bearer token for access without requiring basic authentication.", + "description": "Get a token.\nCreate a bearer token for access without requiring basic authentication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html", "name": "security.get_token", "request": { @@ -16233,7 +16251,7 @@ "stability": "stable" } }, - "description": "Retrieves information about users in the native realm and built-in users.", + "description": "Get users.\nGet information about users in the native realm and built-in users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html", "name": "security.get_user", "request": { @@ -188442,7 +188460,7 @@ } ] }, - "description": "Creates or updates a user profile on behalf of another user.", + "description": "Create or update a user profile.\nCreate or update a user profile on behalf of another user.", "inherits": { "type": { "name": "RequestBase", @@ -188455,7 +188473,7 @@ }, "path": [], "query": [], - "specLocation": "security/activate_user_profile/Request.ts#L23-L37" + "specLocation": "security/activate_user_profile/Request.ts#L23-L38" }, { "kind": "response", @@ -188728,7 +188746,7 @@ } ] }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", + "description": "Bulk delete roles.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", "inherits": { "type": { "name": "RequestBase", @@ -188754,7 +188772,7 @@ } } ], - "specLocation": "security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L41" + "specLocation": "security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L42" }, { "kind": "response", @@ -188844,7 +188862,7 @@ } ] }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", + "description": "Bulk create or update roles.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", "inherits": { "type": { "name": "RequestBase", @@ -188870,7 +188888,7 @@ } } ], - "specLocation": "security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L43" + "specLocation": "security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L44" }, { "kind": "response", @@ -188976,7 +188994,7 @@ } ] }, - "description": "Changes the passwords of users in the native realm and built-in users.", + "description": "Change passwords.\nChange the passwords of users in the native realm and built-in users.", "inherits": { "type": { "name": "RequestBase", @@ -189015,7 +189033,7 @@ } } ], - "specLocation": "security/change_password/SecurityChangePasswordRequest.ts#L23-L51" + "specLocation": "security/change_password/SecurityChangePasswordRequest.ts#L23-L53" }, { "kind": "response", @@ -189037,7 +189055,7 @@ "body": { "kind": "no_body" }, - "description": "Evicts a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", + "description": "Clear the API key cache.\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "inherits": { "type": { "name": "RequestBase", @@ -189063,7 +189081,7 @@ } ], "query": [], - "specLocation": "security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts#L23-L40" + "specLocation": "security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts#L23-L41" }, { "kind": "response", @@ -189131,7 +189149,7 @@ "body": { "kind": "no_body" }, - "description": "Evicts application privileges from the native application privileges cache.", + "description": "Clear the privileges cache.\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "inherits": { "type": { "name": "RequestBase", @@ -189157,7 +189175,7 @@ } ], "query": [], - "specLocation": "security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts#L23-L32" + "specLocation": "security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts#L23-L35" }, { "kind": "response", @@ -189225,7 +189243,7 @@ "body": { "kind": "no_body" }, - "description": "Evicts users from the user cache. Can completely clear the cache or evict specific users.", + "description": "Clear the user cache.\nEvict users from the user cache. You can completely clear the cache or evict specific users.", "inherits": { "type": { "name": "RequestBase", @@ -189267,7 +189285,7 @@ } } ], - "specLocation": "security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts#L23-L35" + "specLocation": "security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts#L23-L37" }, { "kind": "response", @@ -189335,7 +189353,7 @@ "body": { "kind": "no_body" }, - "description": "Evicts roles from the native role cache.", + "description": "Clear the roles cache.\nEvict roles from the native role cache.", "inherits": { "type": { "name": "RequestBase", @@ -189361,7 +189379,7 @@ } ], "query": [], - "specLocation": "security/clear_cached_roles/ClearCachedRolesRequest.ts#L23-L32" + "specLocation": "security/clear_cached_roles/ClearCachedRolesRequest.ts#L23-L34" }, { "kind": "response", @@ -189429,7 +189447,7 @@ "body": { "kind": "no_body" }, - "description": "Evicts tokens from the service account token caches.", + "description": "Clear service account token caches.\nEvict a subset of all entries from the service account token caches.", "inherits": { "type": { "name": "RequestBase", @@ -189479,7 +189497,7 @@ } ], "query": [], - "specLocation": "security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts#L23-L34" + "specLocation": "security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts#L23-L37" }, { "kind": "response", @@ -189616,7 +189634,7 @@ } ] }, - "description": "Create an API key.\nCreates an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key.\nCreate an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "inherits": { "type": { "name": "RequestBase", @@ -189731,7 +189749,7 @@ "body": { "kind": "no_body" }, - "description": "Creates a service accounts token for access without requiring basic authentication.", + "description": "Create a service account token.\nCreate a service accounts token for access without requiring basic authentication.", "inherits": { "type": { "name": "RequestBase", @@ -189794,7 +189812,7 @@ } } ], - "specLocation": "security/create_service_token/CreateServiceTokenRequest.ts#L23-L38" + "specLocation": "security/create_service_token/CreateServiceTokenRequest.ts#L23-L40" }, { "kind": "response", @@ -189892,7 +189910,7 @@ "body": { "kind": "no_body" }, - "description": "Removes application privileges.", + "description": "Delete application privileges.", "inherits": { "type": { "name": "RequestBase", @@ -189943,7 +189961,7 @@ } } ], - "specLocation": "security/delete_privileges/SecurityDeletePrivilegesRequest.ts#L23-L36" + "specLocation": "security/delete_privileges/SecurityDeletePrivilegesRequest.ts#L23-L38" }, { "kind": "response", @@ -189993,7 +190011,7 @@ "body": { "kind": "no_body" }, - "description": "Delete roles API.\n\nRemoves roles in the native realm.", + "description": "Delete roles.\nRemove roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190032,7 +190050,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L38" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L37" }, { "kind": "response", @@ -190066,7 +190084,7 @@ "body": { "kind": "no_body" }, - "description": "Removes role mappings.", + "description": "Delete role mappings.", "inherits": { "type": { "name": "RequestBase", @@ -190105,7 +190123,7 @@ } } ], - "specLocation": "security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts#L23-L35" + "specLocation": "security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts#L23-L36" }, { "kind": "response", @@ -190139,7 +190157,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a service account token.", + "description": "Delete service account tokens.\nDelete service account tokens for a service in a specified namespace.", "inherits": { "type": { "name": "RequestBase", @@ -190202,7 +190220,7 @@ } } ], - "specLocation": "security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L37" + "specLocation": "security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L40" }, { "kind": "response", @@ -190236,7 +190254,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes users from the native realm.", + "description": "Delete users.\nDelete users from the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190275,7 +190293,7 @@ } } ], - "specLocation": "security/delete_user/SecurityDeleteUserRequest.ts#L23-L34" + "specLocation": "security/delete_user/SecurityDeleteUserRequest.ts#L23-L36" }, { "kind": "response", @@ -190309,7 +190327,7 @@ "body": { "kind": "no_body" }, - "description": "Disables users in the native realm.", + "description": "Deactivate users.\nDeactivate users in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190348,7 +190366,7 @@ } } ], - "specLocation": "security/disable_user/SecurityDisableUserRequest.ts#L23-L34" + "specLocation": "security/disable_user/SecurityDisableUserRequest.ts#L23-L36" }, { "kind": "response", @@ -190370,7 +190388,7 @@ "body": { "kind": "no_body" }, - "description": "Disables a user profile so it's not visible in user profile searches.", + "description": "Deactivate a user profile.\nDeactivated user profiles are not visible in user profile searches.", "inherits": { "type": { "name": "RequestBase", @@ -190410,7 +190428,7 @@ } } ], - "specLocation": "security/disable_user_profile/Request.ts#L24-L47" + "specLocation": "security/disable_user_profile/Request.ts#L24-L48" }, { "kind": "response", @@ -190438,7 +190456,7 @@ "body": { "kind": "no_body" }, - "description": "Enables users in the native realm.", + "description": "Activate users.\nActivate users in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190477,7 +190495,7 @@ } } ], - "specLocation": "security/enable_user/SecurityEnableUserRequest.ts#L23-L34" + "specLocation": "security/enable_user/SecurityEnableUserRequest.ts#L23-L36" }, { "kind": "response", @@ -190499,7 +190517,7 @@ "body": { "kind": "no_body" }, - "description": "Enables a user profile so it's visible in user profile searches.", + "description": "Activate a user profile.\nActivated user profiles are visible in user profile searches.", "inherits": { "type": { "name": "RequestBase", @@ -190539,7 +190557,7 @@ } } ], - "specLocation": "security/enable_user_profile/Request.ts#L24-L47" + "specLocation": "security/enable_user_profile/Request.ts#L24-L48" }, { "kind": "response", @@ -190567,7 +190585,7 @@ "body": { "kind": "no_body" }, - "description": "Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", + "description": "Enroll Kibana.\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", "inherits": { "type": { "name": "RequestBase", @@ -190580,7 +190598,7 @@ }, "path": [], "query": [], - "specLocation": "security/enroll_kibana/Request.ts#L22-L27" + "specLocation": "security/enroll_kibana/Request.ts#L22-L28" }, { "kind": "response", @@ -190657,7 +190675,7 @@ "body": { "kind": "no_body" }, - "description": "Allows a new node to join an existing cluster with security features enabled.", + "description": "Enroll a node.\nEnroll a new node to allow it to join an existing cluster with security features enabled.", "inherits": { "type": { "name": "RequestBase", @@ -190670,7 +190688,7 @@ }, "path": [], "query": [], - "specLocation": "security/enroll_node/Request.ts#L22-L27" + "specLocation": "security/enroll_node/Request.ts#L22-L28" }, { "kind": "response", @@ -190931,7 +190949,7 @@ "body": { "kind": "no_body" }, - "description": "Get builtin privileges API.\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges.\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -190995,7 +191013,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves application privileges.", + "description": "Get application privileges.", "inherits": { "type": { "name": "RequestBase", @@ -191033,7 +191051,7 @@ } ], "query": [], - "specLocation": "security/get_privileges/SecurityGetPrivilegesRequest.ts#L23-L33" + "specLocation": "security/get_privileges/SecurityGetPrivilegesRequest.ts#L23-L35" }, { "kind": "response", @@ -191083,7 +191101,7 @@ "body": { "kind": "no_body" }, - "description": "Get roles API.\n\nRetrieves roles in the native realm.", + "description": "Get roles.\nGet roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -191109,7 +191127,7 @@ } ], "query": [], - "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L39" + "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L38" }, { "kind": "response", @@ -191310,7 +191328,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves role mappings.", + "description": "Get role mappings.\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", "inherits": { "type": { "name": "RequestBase", @@ -191336,7 +191354,7 @@ } ], "query": [], - "specLocation": "security/get_role_mapping/SecurityGetRoleMappingRequest.ts#L23-L36" + "specLocation": "security/get_role_mapping/SecurityGetRoleMappingRequest.ts#L23-L41" }, { "kind": "response", @@ -191375,7 +191393,7 @@ "body": { "kind": "no_body" }, - "description": "This API returns a list of service accounts that match the provided path parameter(s).", + "description": "Get service accounts.\nGet a list of service accounts that match the provided path parameters.", "inherits": { "type": { "name": "RequestBase", @@ -191413,7 +191431,7 @@ } ], "query": [], - "specLocation": "security/get_service_accounts/GetServiceAccountsRequest.ts#L23-L41" + "specLocation": "security/get_service_accounts/GetServiceAccountsRequest.ts#L23-L43" }, { "kind": "response", @@ -191542,7 +191560,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information of all service credentials for a service account.", + "description": "Get service account credentials.", "inherits": { "type": { "name": "RequestBase", @@ -191580,7 +191598,7 @@ } ], "query": [], - "specLocation": "security/get_service_credentials/GetServiceCredentialsRequest.ts#L23-L39" + "specLocation": "security/get_service_credentials/GetServiceCredentialsRequest.ts#L23-L41" }, { "kind": "response", @@ -191841,7 +191859,7 @@ } ] }, - "description": "Creates a bearer token for access without requiring basic authentication.", + "description": "Get a token.\nCreate a bearer token for access without requiring basic authentication.", "inherits": { "type": { "name": "RequestBase", @@ -191854,7 +191872,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_token/GetUserAccessTokenRequest.ts#L25-L39" + "specLocation": "security/get_token/GetUserAccessTokenRequest.ts#L25-L41" }, { "kind": "response", @@ -191986,7 +192004,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about users in the native realm and built-in users.", + "description": "Get users.\nGet information about users in the native realm and built-in users.", "inherits": { "type": { "name": "RequestBase", @@ -192047,7 +192065,7 @@ } } ], - "specLocation": "security/get_user/SecurityGetUserRequest.ts#L23-L41" + "specLocation": "security/get_user/SecurityGetUserRequest.ts#L23-L43" }, { "kind": "response", diff --git a/specification/security/create_service_token/CreateServiceTokenRequest.ts b/specification/security/create_service_token/CreateServiceTokenRequest.ts index cfdddef301..ab18a69a3c 100644 --- a/specification/security/create_service_token/CreateServiceTokenRequest.ts +++ b/specification/security/create_service_token/CreateServiceTokenRequest.ts @@ -26,7 +26,7 @@ import { Name, Namespace, Refresh, Service } from '@_types/common' * @rest_spec_name security.create_service_token * @availability stack stability=stable * @availability serverless stability=stable visibility=private - * @ext_doc_id service-account + * @ext_doc_id service-accounts */ export interface Request extends RequestBase { path_parts: { From dc8609aa4cc030bb67a447c204418f23807ce143 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 22 Oct 2024 13:36:39 -0700 Subject: [PATCH 3/5] Add extra line after summaries --- specification/security/activate_user_profile/Request.ts | 3 ++- .../security/authenticate/SecurityAuthenticateRequest.ts | 1 + .../bulk_delete_role/SecurityBulkDeleteRoleRequest.ts | 1 + .../security/bulk_put_role/SecurityBulkPutRoleRequest.ts | 1 + .../change_password/SecurityChangePasswordRequest.ts | 1 + .../clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts | 1 + .../SecurityClearCachedPrivilegesRequest.ts | 1 + .../clear_cached_realms/SecurityClearCachedRealmsRequest.ts | 1 + .../security/clear_cached_roles/ClearCachedRolesRequest.ts | 1 + .../ClearCachedServiceTokensRequest.ts | 1 + .../security/create_api_key/SecurityCreateApiKeyRequest.ts | 1 + .../create_service_token/CreateServiceTokenRequest.ts | 1 + .../security/delete_role/SecurityDeleteRoleRequest.ts | 3 ++- .../delete_service_token/DeleteServiceTokenRequest.ts | 1 + .../security/delete_user/SecurityDeleteUserRequest.ts | 1 + .../security/disable_user/SecurityDisableUserRequest.ts | 5 +++-- specification/security/disable_user_profile/Request.ts | 5 +++-- .../security/enable_user/SecurityEnableUserRequest.ts | 5 +++-- specification/security/enable_user_profile/Request.ts | 5 +++-- specification/security/enroll_kibana/Request.ts | 1 + specification/security/enroll_node/Request.ts | 1 + .../security/get_api_key/SecurityGetApiKeyRequest.ts | 1 + .../SecurityGetBuiltinPrivilegesRequest.ts | 1 + specification/security/get_role/SecurityGetRoleRequest.ts | 1 + .../get_role_mapping/SecurityGetRoleMappingRequest.ts | 1 + .../get_service_accounts/GetServiceAccountsRequest.ts | 1 + .../security/get_token/GetUserAccessTokenRequest.ts | 1 + specification/security/get_user/SecurityGetUserRequest.ts | 1 + 28 files changed, 38 insertions(+), 10 deletions(-) diff --git a/specification/security/activate_user_profile/Request.ts b/specification/security/activate_user_profile/Request.ts index 41ba0d4f22..70671d09c3 100644 --- a/specification/security/activate_user_profile/Request.ts +++ b/specification/security/activate_user_profile/Request.ts @@ -21,7 +21,8 @@ import { GrantType } from '@security/_types/GrantType' import { RequestBase } from '@_types/Base' /** - * Create or update a user profile. + * Activate a user profile. + * * Create or update a user profile on behalf of another user. * @rest_spec_name security.activate_user_profile * @availability stack since=8.2.0 stability=stable diff --git a/specification/security/authenticate/SecurityAuthenticateRequest.ts b/specification/security/authenticate/SecurityAuthenticateRequest.ts index 608f90d0be..719433a523 100644 --- a/specification/security/authenticate/SecurityAuthenticateRequest.ts +++ b/specification/security/authenticate/SecurityAuthenticateRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Authenticate a user. + * * Authenticates a user and returns information about the authenticated user. * Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication). * A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. diff --git a/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts b/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts index efaa0b90f7..d4b2ac3385 100644 --- a/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts +++ b/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts @@ -22,6 +22,7 @@ import { Refresh } from '@_types/common' /** * Bulk delete roles. + * * The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. * The bulk delete roles API cannot delete roles that are defined in roles files. * @rest_spec_name security.bulk_delete_role diff --git a/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts b/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts index 230c8b271f..f942b08c7a 100644 --- a/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts +++ b/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts @@ -24,6 +24,7 @@ import { Refresh } from '@_types/common' /** * Bulk create or update roles. + * * The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. * The bulk create or update roles API cannot update roles that are defined in roles files. * @rest_spec_name security.bulk_put_role diff --git a/specification/security/change_password/SecurityChangePasswordRequest.ts b/specification/security/change_password/SecurityChangePasswordRequest.ts index 607e26162e..df97024748 100644 --- a/specification/security/change_password/SecurityChangePasswordRequest.ts +++ b/specification/security/change_password/SecurityChangePasswordRequest.ts @@ -22,6 +22,7 @@ import { Password, Refresh, Username } from '@_types/common' /** * Change passwords. + * * Change the passwords of users in the native realm and built-in users. * @rest_spec_name security.change_password * @availability stack stability=stable diff --git a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts index 946c95526f..22e0a27f7c 100644 --- a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts +++ b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts @@ -22,6 +22,7 @@ import { Ids } from '@_types/common' /** * Clear the API key cache. + * * Evict a subset of all entries from the API key cache. * The cache is also automatically cleared on state changes of the security index. * @rest_spec_name security.clear_api_key_cache diff --git a/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts b/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts index f214e73208..e6dd67ea97 100644 --- a/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts +++ b/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts @@ -22,6 +22,7 @@ import { Name } from '@_types/common' /** * Clear the privileges cache. + * * Evict privileges from the native application privilege cache. * The cache is also automatically cleared for applications that have their privileges updated. * @rest_spec_name security.clear_cached_privileges diff --git a/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts b/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts index 20b3fc74b5..522d0b8781 100644 --- a/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts +++ b/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts @@ -22,6 +22,7 @@ import { Names } from '@_types/common' /** * Clear the user cache. + * * Evict users from the user cache. You can completely clear the cache or evict specific users. * @rest_spec_name security.clear_cached_realms * @availability stack stability=stable diff --git a/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts b/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts index aa2f854d67..e4e7cc0950 100644 --- a/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts +++ b/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts @@ -22,6 +22,7 @@ import { Names } from '@_types/common' /** * Clear the roles cache. + * * Evict roles from the native role cache. * @rest_spec_name security.clear_cached_roles * @availability stack stability=stable diff --git a/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts b/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts index 30f16ea6c0..cbc1bf23ed 100644 --- a/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts +++ b/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts @@ -22,6 +22,7 @@ import { Names, Namespace, Service } from '@_types/common' /** * Clear service account token caches. + * * Evict a subset of all entries from the service account token caches. * @rest_spec_name security.clear_cached_service_tokens * @availability stack stability=stable diff --git a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts index a9cd7521cc..79bc7afeea 100644 --- a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts +++ b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts @@ -25,6 +25,7 @@ import { Duration } from '@_types/Time' /** * Create an API key. + * * Create an API key for access without requiring basic authentication. * A successful request returns a JSON structure that contains the API key, its unique id, and its name. * If applicable, it also returns expiration information for the API key in milliseconds. diff --git a/specification/security/create_service_token/CreateServiceTokenRequest.ts b/specification/security/create_service_token/CreateServiceTokenRequest.ts index ab18a69a3c..1b52805bfb 100644 --- a/specification/security/create_service_token/CreateServiceTokenRequest.ts +++ b/specification/security/create_service_token/CreateServiceTokenRequest.ts @@ -22,6 +22,7 @@ import { Name, Namespace, Refresh, Service } from '@_types/common' /** * Create a service account token. + * * Create a service accounts token for access without requiring basic authentication. * @rest_spec_name security.create_service_token * @availability stack stability=stable diff --git a/specification/security/delete_role/SecurityDeleteRoleRequest.ts b/specification/security/delete_role/SecurityDeleteRoleRequest.ts index 7717263791..d64af7e448 100644 --- a/specification/security/delete_role/SecurityDeleteRoleRequest.ts +++ b/specification/security/delete_role/SecurityDeleteRoleRequest.ts @@ -22,7 +22,8 @@ import { Name, Refresh } from '@_types/common' /** * Delete roles. - * Remove roles in the native realm. + * + * Delete roles in the native realm. * @rest_spec_name security.delete_role * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/security/delete_service_token/DeleteServiceTokenRequest.ts b/specification/security/delete_service_token/DeleteServiceTokenRequest.ts index 0f52e4148f..ec162c2ebf 100644 --- a/specification/security/delete_service_token/DeleteServiceTokenRequest.ts +++ b/specification/security/delete_service_token/DeleteServiceTokenRequest.ts @@ -22,6 +22,7 @@ import { Name, Namespace, Refresh, Service } from '@_types/common' /** * Delete service account tokens. + * * Delete service account tokens for a service in a specified namespace. * @rest_spec_name security.delete_service_token * @availability stack since=5.5.0 stability=stable diff --git a/specification/security/delete_user/SecurityDeleteUserRequest.ts b/specification/security/delete_user/SecurityDeleteUserRequest.ts index 505f352422..129b186212 100644 --- a/specification/security/delete_user/SecurityDeleteUserRequest.ts +++ b/specification/security/delete_user/SecurityDeleteUserRequest.ts @@ -22,6 +22,7 @@ import { Refresh, Username } from '@_types/common' /** * Delete users. + * * Delete users from the native realm. * @rest_spec_name security.delete_user * @availability stack stability=stable diff --git a/specification/security/disable_user/SecurityDisableUserRequest.ts b/specification/security/disable_user/SecurityDisableUserRequest.ts index 3333287fbd..c4d9de7ad9 100644 --- a/specification/security/disable_user/SecurityDisableUserRequest.ts +++ b/specification/security/disable_user/SecurityDisableUserRequest.ts @@ -21,8 +21,9 @@ import { RequestBase } from '@_types/Base' import { Refresh, Username } from '@_types/common' /** - * Deactivate users. - * Deactivate users in the native realm. + * Disable users. + * + * Disable users in the native realm. * @rest_spec_name security.disable_user * @availability stack stability=stable */ diff --git a/specification/security/disable_user_profile/Request.ts b/specification/security/disable_user_profile/Request.ts index afde74e4c5..119525be53 100644 --- a/specification/security/disable_user_profile/Request.ts +++ b/specification/security/disable_user_profile/Request.ts @@ -22,8 +22,9 @@ import { RequestBase } from '@_types/Base' import { Refresh } from '@_types/common' /** - * Deactivate a user profile. - * Deactivated user profiles are not visible in user profile searches. + * Disable a user profile. + * + * Disable user profiles so that they are not visible in user profile searches. * @rest_spec_name security.disable_user_profile * @availability stack since=8.2.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/enable_user/SecurityEnableUserRequest.ts b/specification/security/enable_user/SecurityEnableUserRequest.ts index 671a1f6953..e70509364b 100644 --- a/specification/security/enable_user/SecurityEnableUserRequest.ts +++ b/specification/security/enable_user/SecurityEnableUserRequest.ts @@ -21,8 +21,9 @@ import { RequestBase } from '@_types/Base' import { Refresh, Username } from '@_types/common' /** - * Activate users. - * Activate users in the native realm. + * Enable users. + * + * Enable users in the native realm. * @rest_spec_name security.enable_user * @availability stack stability=stable */ diff --git a/specification/security/enable_user_profile/Request.ts b/specification/security/enable_user_profile/Request.ts index 1170825797..a292c20cba 100644 --- a/specification/security/enable_user_profile/Request.ts +++ b/specification/security/enable_user_profile/Request.ts @@ -22,8 +22,9 @@ import { RequestBase } from '@_types/Base' import { Refresh } from '@_types/common' /** - * Activate a user profile. - * Activated user profiles are visible in user profile searches. + * Enable a user profile. + * + * Enable user profiles to make them visible in user profile searches. * @rest_spec_name security.enable_user_profile * @availability stack since=8.2.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/enroll_kibana/Request.ts b/specification/security/enroll_kibana/Request.ts index ee792e6863..fc1d0d391b 100644 --- a/specification/security/enroll_kibana/Request.ts +++ b/specification/security/enroll_kibana/Request.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Enroll Kibana. + * * Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. * @rest_spec_name security.enroll_kibana * @availability stack since=8.0.0 stability=stable diff --git a/specification/security/enroll_node/Request.ts b/specification/security/enroll_node/Request.ts index 213836e893..1af3c82285 100644 --- a/specification/security/enroll_node/Request.ts +++ b/specification/security/enroll_node/Request.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Enroll a node. + * * Enroll a new node to allow it to join an existing cluster with security features enabled. * @rest_spec_name security.enroll_node * @availability stack since=8.0.0 stability=stable diff --git a/specification/security/get_api_key/SecurityGetApiKeyRequest.ts b/specification/security/get_api_key/SecurityGetApiKeyRequest.ts index ed96c159f7..b069a61620 100644 --- a/specification/security/get_api_key/SecurityGetApiKeyRequest.ts +++ b/specification/security/get_api_key/SecurityGetApiKeyRequest.ts @@ -22,6 +22,7 @@ import { Id, Name, Username } from '@_types/common' /** * Get API key information. + * * Retrieves information for one or more API keys. * NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. * If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. diff --git a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts index 68e16f4f11..12c28678eb 100644 --- a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts +++ b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get builtin privileges. + * * Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. * @rest_spec_name security.get_builtin_privileges * @availability stack since=7.3.0 stability=stable diff --git a/specification/security/get_role/SecurityGetRoleRequest.ts b/specification/security/get_role/SecurityGetRoleRequest.ts index 08a988a278..df1eb06720 100644 --- a/specification/security/get_role/SecurityGetRoleRequest.ts +++ b/specification/security/get_role/SecurityGetRoleRequest.ts @@ -22,6 +22,7 @@ import { Names } from '@_types/common' /** * Get roles. + * * Get roles in the native realm. * @rest_spec_name security.get_role * @availability stack stability=stable diff --git a/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts b/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts index 4b7ae5e510..39342d3f81 100644 --- a/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts +++ b/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts @@ -22,6 +22,7 @@ import { Names } from '@_types/common' /** * Get role mappings. + * * Role mappings define which roles are assigned to each user. * The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. * The get role mappings API cannot retrieve role mappings that are defined in role mapping files. diff --git a/specification/security/get_service_accounts/GetServiceAccountsRequest.ts b/specification/security/get_service_accounts/GetServiceAccountsRequest.ts index 283ac138e0..63d92f3a6a 100644 --- a/specification/security/get_service_accounts/GetServiceAccountsRequest.ts +++ b/specification/security/get_service_accounts/GetServiceAccountsRequest.ts @@ -22,6 +22,7 @@ import { Namespace, Service } from '@_types/common' /** * Get service accounts. + * * Get a list of service accounts that match the provided path parameters. * @rest_spec_name security.get_service_accounts * @availability stack since=7.13.0 stability=stable diff --git a/specification/security/get_token/GetUserAccessTokenRequest.ts b/specification/security/get_token/GetUserAccessTokenRequest.ts index 9a7a127987..69b950c52c 100644 --- a/specification/security/get_token/GetUserAccessTokenRequest.ts +++ b/specification/security/get_token/GetUserAccessTokenRequest.ts @@ -24,6 +24,7 @@ import { AccessTokenGrantType } from './types' /** * Get a token. + * * Create a bearer token for access without requiring basic authentication. * @rest_spec_name security.get_token * @availability stack since=5.5.0 stability=stable diff --git a/specification/security/get_user/SecurityGetUserRequest.ts b/specification/security/get_user/SecurityGetUserRequest.ts index 3c1b978e09..7a18e86bd7 100644 --- a/specification/security/get_user/SecurityGetUserRequest.ts +++ b/specification/security/get_user/SecurityGetUserRequest.ts @@ -22,6 +22,7 @@ import { Username } from '@_types/common' /** * Get users. + * * Get information about users in the native realm and built-in users. * @rest_spec_name security.get_user * @availability stack stability=stable From 4a6fc5656886db01c9af7738db853a419a4d8383 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 22 Oct 2024 13:38:23 -0700 Subject: [PATCH 4/5] Regenerate output --- output/openapi/elasticsearch-openapi.json | 36 ++-- .../elasticsearch-serverless-openapi.json | 2 +- output/schema/schema.json | 168 +++++++++--------- 3 files changed, 103 insertions(+), 103 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 260b54a0ff..f77a6b7a10 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -26799,7 +26799,7 @@ "tags": [ "security" ], - "summary": "Create or update a user profile", + "summary": "Activate a user profile", "description": "Create or update a user profile on behalf of another user.", "operationId": "security-activate-user-profile", "requestBody": { @@ -28078,7 +28078,7 @@ "security" ], "summary": "Delete roles", - "description": "Remove roles in the native realm.", + "description": "Delete roles in the native realm.", "operationId": "security-delete-role", "parameters": [ { @@ -28375,8 +28375,8 @@ "tags": [ "security" ], - "summary": "Deactivate users", - "description": "Deactivate users in the native realm.", + "summary": "Disable users", + "description": "Disable users in the native realm.", "operationId": "security-disable-user", "parameters": [ { @@ -28396,8 +28396,8 @@ "tags": [ "security" ], - "summary": "Deactivate users", - "description": "Deactivate users in the native realm.", + "summary": "Disable users", + "description": "Disable users in the native realm.", "operationId": "security-disable-user-1", "parameters": [ { @@ -28419,8 +28419,8 @@ "tags": [ "security" ], - "summary": "Deactivate a user profile", - "description": "Deactivated user profiles are not visible in user profile searches.", + "summary": "Disable a user profile", + "description": "Disable user profiles so that they are not visible in user profile searches.", "operationId": "security-disable-user-profile", "parameters": [ { @@ -28441,8 +28441,8 @@ "tags": [ "security" ], - "summary": "Deactivate a user profile", - "description": "Deactivated user profiles are not visible in user profile searches.", + "summary": "Disable a user profile", + "description": "Disable user profiles so that they are not visible in user profile searches.", "operationId": "security-disable-user-profile-1", "parameters": [ { @@ -28465,8 +28465,8 @@ "tags": [ "security" ], - "summary": "Activate users", - "description": "Activate users in the native realm.", + "summary": "Enable users", + "description": "Enable users in the native realm.", "operationId": "security-enable-user", "parameters": [ { @@ -28486,8 +28486,8 @@ "tags": [ "security" ], - "summary": "Activate users", - "description": "Activate users in the native realm.", + "summary": "Enable users", + "description": "Enable users in the native realm.", "operationId": "security-enable-user-1", "parameters": [ { @@ -28509,8 +28509,8 @@ "tags": [ "security" ], - "summary": "Activate a user profile", - "description": "Activated user profiles are visible in user profile searches.", + "summary": "Enable a user profile", + "description": "Enable user profiles to make them visible in user profile searches.", "operationId": "security-enable-user-profile", "parameters": [ { @@ -28531,8 +28531,8 @@ "tags": [ "security" ], - "summary": "Activate a user profile", - "description": "Activated user profiles are visible in user profile searches.", + "summary": "Enable a user profile", + "description": "Enable user profiles to make them visible in user profile searches.", "operationId": "security-enable-user-profile-1", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index ae06b8d980..b2a2f62dcf 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -16923,7 +16923,7 @@ "security" ], "summary": "Delete roles", - "description": "Remove roles in the native realm.", + "description": "Delete roles in the native realm.", "operationId": "security-delete-role", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index f68fdd1506..ae78d65c70 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -14962,7 +14962,7 @@ "stability": "stable" } }, - "description": "Create or update a user profile.\nCreate or update a user profile on behalf of another user.", + "description": "Activate a user profile.\n\nCreate or update a user profile on behalf of another user.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html", "name": "security.activate_user_profile", "privileges": { @@ -15005,7 +15005,7 @@ "stability": "stable" } }, - "description": "Authenticate a user.\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.", + "description": "Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html", "name": "security.authenticate", "request": { @@ -15040,7 +15040,7 @@ "stability": "stable" } }, - "description": "Bulk delete roles.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", + "description": "Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-delete-role.html", "name": "security.bulk_delete_role", "privileges": { @@ -15083,7 +15083,7 @@ "stability": "stable" } }, - "description": "Bulk create or update roles.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", + "description": "Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-put-role.html", "name": "security.bulk_put_role", "privileges": { @@ -15149,7 +15149,7 @@ "stability": "stable" } }, - "description": "Change passwords.\nChange the passwords of users in the native realm and built-in users.", + "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html", "name": "security.change_password", "request": { @@ -15195,7 +15195,7 @@ "stability": "stable" } }, - "description": "Clear the API key cache.\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", + "description": "Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html", "name": "security.clear_api_key_cache", "privileges": { @@ -15235,7 +15235,7 @@ "stability": "stable" } }, - "description": "Clear the privileges cache.\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", + "description": "Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html", "name": "security.clear_cached_privileges", "request": { @@ -15269,7 +15269,7 @@ "stability": "stable" } }, - "description": "Clear the user cache.\nEvict users from the user cache. You can completely clear the cache or evict specific users.", + "description": "Clear the user cache.\n\nEvict users from the user cache. You can completely clear the cache or evict specific users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html", "name": "security.clear_cached_realms", "request": { @@ -15303,7 +15303,7 @@ "stability": "stable" } }, - "description": "Clear the roles cache.\nEvict roles from the native role cache.", + "description": "Clear the roles cache.\n\nEvict roles from the native role cache.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", "name": "security.clear_cached_roles", "request": { @@ -15337,7 +15337,7 @@ "stability": "stable" } }, - "description": "Clear service account token caches.\nEvict a subset of all entries from the service account token caches.", + "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", @@ -15374,7 +15374,7 @@ "stability": "stable" } }, - "description": "Create an API key.\nCreate an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", "name": "security.create_api_key", "privileges": { @@ -15445,7 +15445,7 @@ "stability": "stable" } }, - "description": "Create a service account token.\nCreate a service accounts token for access without requiring basic authentication.", + "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", @@ -15525,7 +15525,7 @@ "stability": "stable" } }, - "description": "Delete roles.\nRemove roles in the native realm.", + "description": "Delete roles.\n\nDelete roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", "request": { @@ -15595,7 +15595,7 @@ "stability": "stable" } }, - "description": "Delete service account tokens.\nDelete service account tokens for a service in a specified namespace.", + "description": "Delete service account tokens.\n\nDelete service account tokens for a service in a specified namespace.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", @@ -15627,7 +15627,7 @@ "stability": "stable" } }, - "description": "Delete users.\nDelete users from the native realm.", + "description": "Delete users.\n\nDelete users from the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", "name": "security.delete_user", "request": { @@ -15657,7 +15657,7 @@ "stability": "stable" } }, - "description": "Deactivate users.\nDeactivate users in the native realm.", + "description": "Disable users.\n\nDisable users in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", "name": "security.disable_user", "request": { @@ -15693,7 +15693,7 @@ "stability": "stable" } }, - "description": "Deactivate a user profile.\nDeactivated user profiles are not visible in user profile searches.", + "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html", "name": "security.disable_user_profile", "privileges": { @@ -15729,7 +15729,7 @@ "stability": "stable" } }, - "description": "Activate users.\nActivate users in the native realm.", + "description": "Enable users.\n\nEnable users in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", "name": "security.enable_user", "request": { @@ -15765,7 +15765,7 @@ "stability": "stable" } }, - "description": "Activate a user profile.\nActivated user profiles are visible in user profile searches.", + "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html", "name": "security.enable_user_profile", "privileges": { @@ -15802,7 +15802,7 @@ "stability": "stable" } }, - "description": "Enroll Kibana.\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", + "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html", "name": "security.enroll_kibana", "request": { @@ -15836,7 +15836,7 @@ "stability": "stable" } }, - "description": "Enroll a node.\nEnroll a new node to allow it to join an existing cluster with security features enabled.", + "description": "Enroll a node.\n\nEnroll a new node to allow it to join an existing cluster with security features enabled.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html", "name": "security.enroll_node", "request": { @@ -15874,7 +15874,7 @@ "stability": "stable" } }, - "description": "Get API key information.\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", + "description": "Get API key information.\n\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html", "name": "security.get_api_key", "privileges": { @@ -15915,7 +15915,7 @@ "stability": "stable" } }, - "description": "Get builtin privileges.\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges.\n\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "extDocId": "security-privileges", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", @@ -16005,7 +16005,7 @@ "stability": "stable" } }, - "description": "Get roles.\nGet roles in the native realm.", + "description": "Get roles.\n\nGet roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { @@ -16051,7 +16051,7 @@ "stability": "stable" } }, - "description": "Get role mappings.\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", + "description": "Get role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", "extDocId": "mapping-roles", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html", @@ -16099,7 +16099,7 @@ "stability": "stable" } }, - "description": "Get service accounts.\nGet a list of service accounts that match the provided path parameters.", + "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", @@ -16218,7 +16218,7 @@ "stability": "stable" } }, - "description": "Get a token.\nCreate a bearer token for access without requiring basic authentication.", + "description": "Get a token.\n\nCreate a bearer token for access without requiring basic authentication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html", "name": "security.get_token", "request": { @@ -16251,7 +16251,7 @@ "stability": "stable" } }, - "description": "Get users.\nGet information about users in the native realm and built-in users.", + "description": "Get users.\n\nGet information about users in the native realm and built-in users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html", "name": "security.get_user", "request": { @@ -188460,7 +188460,7 @@ } ] }, - "description": "Create or update a user profile.\nCreate or update a user profile on behalf of another user.", + "description": "Activate a user profile.\n\nCreate or update a user profile on behalf of another user.", "inherits": { "type": { "name": "RequestBase", @@ -188473,7 +188473,7 @@ }, "path": [], "query": [], - "specLocation": "security/activate_user_profile/Request.ts#L23-L38" + "specLocation": "security/activate_user_profile/Request.ts#L23-L39" }, { "kind": "response", @@ -188501,7 +188501,7 @@ "body": { "kind": "no_body" }, - "description": "Authenticate a user.\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.", + "description": "Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.", "inherits": { "type": { "name": "RequestBase", @@ -188514,7 +188514,7 @@ }, "path": [], "query": [], - "specLocation": "security/authenticate/SecurityAuthenticateRequest.ts#L22-L32" + "specLocation": "security/authenticate/SecurityAuthenticateRequest.ts#L22-L33" }, { "kind": "response", @@ -188746,7 +188746,7 @@ } ] }, - "description": "Bulk delete roles.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", + "description": "Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", "inherits": { "type": { "name": "RequestBase", @@ -188772,7 +188772,7 @@ } } ], - "specLocation": "security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L42" + "specLocation": "security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L43" }, { "kind": "response", @@ -188862,7 +188862,7 @@ } ] }, - "description": "Bulk create or update roles.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", + "description": "Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", "inherits": { "type": { "name": "RequestBase", @@ -188888,7 +188888,7 @@ } } ], - "specLocation": "security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L44" + "specLocation": "security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L45" }, { "kind": "response", @@ -188994,7 +188994,7 @@ } ] }, - "description": "Change passwords.\nChange the passwords of users in the native realm and built-in users.", + "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users.", "inherits": { "type": { "name": "RequestBase", @@ -189033,7 +189033,7 @@ } } ], - "specLocation": "security/change_password/SecurityChangePasswordRequest.ts#L23-L53" + "specLocation": "security/change_password/SecurityChangePasswordRequest.ts#L23-L54" }, { "kind": "response", @@ -189055,7 +189055,7 @@ "body": { "kind": "no_body" }, - "description": "Clear the API key cache.\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", + "description": "Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "inherits": { "type": { "name": "RequestBase", @@ -189081,7 +189081,7 @@ } ], "query": [], - "specLocation": "security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts#L23-L41" + "specLocation": "security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts#L23-L42" }, { "kind": "response", @@ -189149,7 +189149,7 @@ "body": { "kind": "no_body" }, - "description": "Clear the privileges cache.\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", + "description": "Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "inherits": { "type": { "name": "RequestBase", @@ -189175,7 +189175,7 @@ } ], "query": [], - "specLocation": "security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts#L23-L35" + "specLocation": "security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts#L23-L36" }, { "kind": "response", @@ -189243,7 +189243,7 @@ "body": { "kind": "no_body" }, - "description": "Clear the user cache.\nEvict users from the user cache. You can completely clear the cache or evict specific users.", + "description": "Clear the user cache.\n\nEvict users from the user cache. You can completely clear the cache or evict specific users.", "inherits": { "type": { "name": "RequestBase", @@ -189285,7 +189285,7 @@ } } ], - "specLocation": "security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts#L23-L37" + "specLocation": "security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts#L23-L38" }, { "kind": "response", @@ -189353,7 +189353,7 @@ "body": { "kind": "no_body" }, - "description": "Clear the roles cache.\nEvict roles from the native role cache.", + "description": "Clear the roles cache.\n\nEvict roles from the native role cache.", "inherits": { "type": { "name": "RequestBase", @@ -189379,7 +189379,7 @@ } ], "query": [], - "specLocation": "security/clear_cached_roles/ClearCachedRolesRequest.ts#L23-L34" + "specLocation": "security/clear_cached_roles/ClearCachedRolesRequest.ts#L23-L35" }, { "kind": "response", @@ -189447,7 +189447,7 @@ "body": { "kind": "no_body" }, - "description": "Clear service account token caches.\nEvict a subset of all entries from the service account token caches.", + "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.", "inherits": { "type": { "name": "RequestBase", @@ -189497,7 +189497,7 @@ } ], "query": [], - "specLocation": "security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts#L23-L37" + "specLocation": "security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts#L23-L38" }, { "kind": "response", @@ -189634,7 +189634,7 @@ } ] }, - "description": "Create an API key.\nCreate an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "inherits": { "type": { "name": "RequestBase", @@ -189660,7 +189660,7 @@ } } ], - "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L59" + "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L60" }, { "kind": "response", @@ -189749,7 +189749,7 @@ "body": { "kind": "no_body" }, - "description": "Create a service account token.\nCreate a service accounts token for access without requiring basic authentication.", + "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.", "inherits": { "type": { "name": "RequestBase", @@ -189812,7 +189812,7 @@ } } ], - "specLocation": "security/create_service_token/CreateServiceTokenRequest.ts#L23-L40" + "specLocation": "security/create_service_token/CreateServiceTokenRequest.ts#L23-L41" }, { "kind": "response", @@ -190011,7 +190011,7 @@ "body": { "kind": "no_body" }, - "description": "Delete roles.\nRemove roles in the native realm.", + "description": "Delete roles.\n\nDelete roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190050,7 +190050,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L37" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L38" }, { "kind": "response", @@ -190157,7 +190157,7 @@ "body": { "kind": "no_body" }, - "description": "Delete service account tokens.\nDelete service account tokens for a service in a specified namespace.", + "description": "Delete service account tokens.\n\nDelete service account tokens for a service in a specified namespace.", "inherits": { "type": { "name": "RequestBase", @@ -190220,7 +190220,7 @@ } } ], - "specLocation": "security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L40" + "specLocation": "security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L41" }, { "kind": "response", @@ -190254,7 +190254,7 @@ "body": { "kind": "no_body" }, - "description": "Delete users.\nDelete users from the native realm.", + "description": "Delete users.\n\nDelete users from the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190293,7 +190293,7 @@ } } ], - "specLocation": "security/delete_user/SecurityDeleteUserRequest.ts#L23-L36" + "specLocation": "security/delete_user/SecurityDeleteUserRequest.ts#L23-L37" }, { "kind": "response", @@ -190327,7 +190327,7 @@ "body": { "kind": "no_body" }, - "description": "Deactivate users.\nDeactivate users in the native realm.", + "description": "Disable users.\n\nDisable users in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190366,7 +190366,7 @@ } } ], - "specLocation": "security/disable_user/SecurityDisableUserRequest.ts#L23-L36" + "specLocation": "security/disable_user/SecurityDisableUserRequest.ts#L23-L37" }, { "kind": "response", @@ -190388,7 +190388,7 @@ "body": { "kind": "no_body" }, - "description": "Deactivate a user profile.\nDeactivated user profiles are not visible in user profile searches.", + "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.", "inherits": { "type": { "name": "RequestBase", @@ -190428,7 +190428,7 @@ } } ], - "specLocation": "security/disable_user_profile/Request.ts#L24-L48" + "specLocation": "security/disable_user_profile/Request.ts#L24-L49" }, { "kind": "response", @@ -190456,7 +190456,7 @@ "body": { "kind": "no_body" }, - "description": "Activate users.\nActivate users in the native realm.", + "description": "Enable users.\n\nEnable users in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190495,7 +190495,7 @@ } } ], - "specLocation": "security/enable_user/SecurityEnableUserRequest.ts#L23-L36" + "specLocation": "security/enable_user/SecurityEnableUserRequest.ts#L23-L37" }, { "kind": "response", @@ -190517,7 +190517,7 @@ "body": { "kind": "no_body" }, - "description": "Activate a user profile.\nActivated user profiles are visible in user profile searches.", + "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.", "inherits": { "type": { "name": "RequestBase", @@ -190557,7 +190557,7 @@ } } ], - "specLocation": "security/enable_user_profile/Request.ts#L24-L48" + "specLocation": "security/enable_user_profile/Request.ts#L24-L49" }, { "kind": "response", @@ -190585,7 +190585,7 @@ "body": { "kind": "no_body" }, - "description": "Enroll Kibana.\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", + "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", "inherits": { "type": { "name": "RequestBase", @@ -190598,7 +190598,7 @@ }, "path": [], "query": [], - "specLocation": "security/enroll_kibana/Request.ts#L22-L28" + "specLocation": "security/enroll_kibana/Request.ts#L22-L29" }, { "kind": "response", @@ -190675,7 +190675,7 @@ "body": { "kind": "no_body" }, - "description": "Enroll a node.\nEnroll a new node to allow it to join an existing cluster with security features enabled.", + "description": "Enroll a node.\n\nEnroll a new node to allow it to join an existing cluster with security features enabled.", "inherits": { "type": { "name": "RequestBase", @@ -190688,7 +190688,7 @@ }, "path": [], "query": [], - "specLocation": "security/enroll_node/Request.ts#L22-L28" + "specLocation": "security/enroll_node/Request.ts#L22-L29" }, { "kind": "response", @@ -190780,7 +190780,7 @@ "body": { "kind": "no_body" }, - "description": "Get API key information.\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", + "description": "Get API key information.\n\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", "inherits": { "type": { "name": "RequestBase", @@ -190912,7 +190912,7 @@ } } ], - "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L87" + "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L88" }, { "kind": "response", @@ -190949,7 +190949,7 @@ "body": { "kind": "no_body" }, - "description": "Get builtin privileges.\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges.\n\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -190962,7 +190962,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L31" + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L32" }, { "kind": "response", @@ -191101,7 +191101,7 @@ "body": { "kind": "no_body" }, - "description": "Get roles.\nGet roles in the native realm.", + "description": "Get roles.\n\nGet roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -191127,7 +191127,7 @@ } ], "query": [], - "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L38" + "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L39" }, { "kind": "response", @@ -191328,7 +191328,7 @@ "body": { "kind": "no_body" }, - "description": "Get role mappings.\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", + "description": "Get role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", "inherits": { "type": { "name": "RequestBase", @@ -191354,7 +191354,7 @@ } ], "query": [], - "specLocation": "security/get_role_mapping/SecurityGetRoleMappingRequest.ts#L23-L41" + "specLocation": "security/get_role_mapping/SecurityGetRoleMappingRequest.ts#L23-L42" }, { "kind": "response", @@ -191393,7 +191393,7 @@ "body": { "kind": "no_body" }, - "description": "Get service accounts.\nGet a list of service accounts that match the provided path parameters.", + "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.", "inherits": { "type": { "name": "RequestBase", @@ -191431,7 +191431,7 @@ } ], "query": [], - "specLocation": "security/get_service_accounts/GetServiceAccountsRequest.ts#L23-L43" + "specLocation": "security/get_service_accounts/GetServiceAccountsRequest.ts#L23-L44" }, { "kind": "response", @@ -191859,7 +191859,7 @@ } ] }, - "description": "Get a token.\nCreate a bearer token for access without requiring basic authentication.", + "description": "Get a token.\n\nCreate a bearer token for access without requiring basic authentication.", "inherits": { "type": { "name": "RequestBase", @@ -191872,7 +191872,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_token/GetUserAccessTokenRequest.ts#L25-L41" + "specLocation": "security/get_token/GetUserAccessTokenRequest.ts#L25-L42" }, { "kind": "response", @@ -192004,7 +192004,7 @@ "body": { "kind": "no_body" }, - "description": "Get users.\nGet information about users in the native realm and built-in users.", + "description": "Get users.\n\nGet information about users in the native realm and built-in users.", "inherits": { "type": { "name": "RequestBase", @@ -192065,7 +192065,7 @@ } } ], - "specLocation": "security/get_user/SecurityGetUserRequest.ts#L23-L43" + "specLocation": "security/get_user/SecurityGetUserRequest.ts#L23-L44" }, { "kind": "response", From 41133ccdacb422c0f4a90a9c2384b24908fcd167 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 22 Oct 2024 13:40:28 -0700 Subject: [PATCH 5/5] Fix whitespaces --- specification/security/activate_user_profile/Request.ts | 2 +- .../security/authenticate/SecurityAuthenticateRequest.ts | 2 +- .../security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts | 2 +- .../security/bulk_put_role/SecurityBulkPutRoleRequest.ts | 2 +- .../security/change_password/SecurityChangePasswordRequest.ts | 2 +- .../clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts | 2 +- .../SecurityClearCachedPrivilegesRequest.ts | 2 +- .../clear_cached_realms/SecurityClearCachedRealmsRequest.ts | 2 +- .../security/clear_cached_roles/ClearCachedRolesRequest.ts | 2 +- .../ClearCachedServiceTokensRequest.ts | 2 +- .../security/create_api_key/SecurityCreateApiKeyRequest.ts | 2 +- .../security/create_service_token/CreateServiceTokenRequest.ts | 2 +- specification/security/delete_role/SecurityDeleteRoleRequest.ts | 2 +- .../security/delete_service_token/DeleteServiceTokenRequest.ts | 2 +- specification/security/delete_user/SecurityDeleteUserRequest.ts | 2 +- .../security/disable_user/SecurityDisableUserRequest.ts | 2 +- specification/security/disable_user_profile/Request.ts | 2 +- specification/security/enable_user/SecurityEnableUserRequest.ts | 2 +- specification/security/enable_user_profile/Request.ts | 2 +- specification/security/enroll_kibana/Request.ts | 2 +- specification/security/enroll_node/Request.ts | 2 +- specification/security/get_api_key/SecurityGetApiKeyRequest.ts | 2 +- .../SecurityGetBuiltinPrivilegesRequest.ts | 2 +- specification/security/get_role/SecurityGetRoleRequest.ts | 2 +- .../security/get_role_mapping/SecurityGetRoleMappingRequest.ts | 2 +- .../security/get_service_accounts/GetServiceAccountsRequest.ts | 2 +- specification/security/get_token/GetUserAccessTokenRequest.ts | 2 +- specification/security/get_user/SecurityGetUserRequest.ts | 2 +- 28 files changed, 28 insertions(+), 28 deletions(-) diff --git a/specification/security/activate_user_profile/Request.ts b/specification/security/activate_user_profile/Request.ts index 70671d09c3..698ef10b0c 100644 --- a/specification/security/activate_user_profile/Request.ts +++ b/specification/security/activate_user_profile/Request.ts @@ -22,7 +22,7 @@ import { RequestBase } from '@_types/Base' /** * Activate a user profile. - * + * * Create or update a user profile on behalf of another user. * @rest_spec_name security.activate_user_profile * @availability stack since=8.2.0 stability=stable diff --git a/specification/security/authenticate/SecurityAuthenticateRequest.ts b/specification/security/authenticate/SecurityAuthenticateRequest.ts index 719433a523..66202c9440 100644 --- a/specification/security/authenticate/SecurityAuthenticateRequest.ts +++ b/specification/security/authenticate/SecurityAuthenticateRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Authenticate a user. - * + * * Authenticates a user and returns information about the authenticated user. * Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication). * A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. diff --git a/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts b/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts index d4b2ac3385..23e5358be6 100644 --- a/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts +++ b/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts @@ -22,7 +22,7 @@ import { Refresh } from '@_types/common' /** * Bulk delete roles. - * + * * The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. * The bulk delete roles API cannot delete roles that are defined in roles files. * @rest_spec_name security.bulk_delete_role diff --git a/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts b/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts index f942b08c7a..e9e89b2af3 100644 --- a/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts +++ b/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts @@ -24,7 +24,7 @@ import { Refresh } from '@_types/common' /** * Bulk create or update roles. - * + * * The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. * The bulk create or update roles API cannot update roles that are defined in roles files. * @rest_spec_name security.bulk_put_role diff --git a/specification/security/change_password/SecurityChangePasswordRequest.ts b/specification/security/change_password/SecurityChangePasswordRequest.ts index df97024748..ee61611c22 100644 --- a/specification/security/change_password/SecurityChangePasswordRequest.ts +++ b/specification/security/change_password/SecurityChangePasswordRequest.ts @@ -22,7 +22,7 @@ import { Password, Refresh, Username } from '@_types/common' /** * Change passwords. - * + * * Change the passwords of users in the native realm and built-in users. * @rest_spec_name security.change_password * @availability stack stability=stable diff --git a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts index 22e0a27f7c..f631422320 100644 --- a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts +++ b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts @@ -22,7 +22,7 @@ import { Ids } from '@_types/common' /** * Clear the API key cache. - * + * * Evict a subset of all entries from the API key cache. * The cache is also automatically cleared on state changes of the security index. * @rest_spec_name security.clear_api_key_cache diff --git a/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts b/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts index e6dd67ea97..7117880a7e 100644 --- a/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts +++ b/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts @@ -22,7 +22,7 @@ import { Name } from '@_types/common' /** * Clear the privileges cache. - * + * * Evict privileges from the native application privilege cache. * The cache is also automatically cleared for applications that have their privileges updated. * @rest_spec_name security.clear_cached_privileges diff --git a/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts b/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts index 522d0b8781..33e192a5aa 100644 --- a/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts +++ b/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts @@ -22,7 +22,7 @@ import { Names } from '@_types/common' /** * Clear the user cache. - * + * * Evict users from the user cache. You can completely clear the cache or evict specific users. * @rest_spec_name security.clear_cached_realms * @availability stack stability=stable diff --git a/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts b/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts index e4e7cc0950..14c852513e 100644 --- a/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts +++ b/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts @@ -22,7 +22,7 @@ import { Names } from '@_types/common' /** * Clear the roles cache. - * + * * Evict roles from the native role cache. * @rest_spec_name security.clear_cached_roles * @availability stack stability=stable diff --git a/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts b/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts index cbc1bf23ed..a0f7f6eea2 100644 --- a/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts +++ b/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts @@ -22,7 +22,7 @@ import { Names, Namespace, Service } from '@_types/common' /** * Clear service account token caches. - * + * * Evict a subset of all entries from the service account token caches. * @rest_spec_name security.clear_cached_service_tokens * @availability stack stability=stable diff --git a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts index 79bc7afeea..3478245347 100644 --- a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts +++ b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts @@ -25,7 +25,7 @@ import { Duration } from '@_types/Time' /** * Create an API key. - * + * * Create an API key for access without requiring basic authentication. * A successful request returns a JSON structure that contains the API key, its unique id, and its name. * If applicable, it also returns expiration information for the API key in milliseconds. diff --git a/specification/security/create_service_token/CreateServiceTokenRequest.ts b/specification/security/create_service_token/CreateServiceTokenRequest.ts index 1b52805bfb..06efbb0581 100644 --- a/specification/security/create_service_token/CreateServiceTokenRequest.ts +++ b/specification/security/create_service_token/CreateServiceTokenRequest.ts @@ -22,7 +22,7 @@ import { Name, Namespace, Refresh, Service } from '@_types/common' /** * Create a service account token. - * + * * Create a service accounts token for access without requiring basic authentication. * @rest_spec_name security.create_service_token * @availability stack stability=stable diff --git a/specification/security/delete_role/SecurityDeleteRoleRequest.ts b/specification/security/delete_role/SecurityDeleteRoleRequest.ts index d64af7e448..5f87c08478 100644 --- a/specification/security/delete_role/SecurityDeleteRoleRequest.ts +++ b/specification/security/delete_role/SecurityDeleteRoleRequest.ts @@ -22,7 +22,7 @@ import { Name, Refresh } from '@_types/common' /** * Delete roles. - * + * * Delete roles in the native realm. * @rest_spec_name security.delete_role * @availability stack stability=stable diff --git a/specification/security/delete_service_token/DeleteServiceTokenRequest.ts b/specification/security/delete_service_token/DeleteServiceTokenRequest.ts index ec162c2ebf..cb6a270a5f 100644 --- a/specification/security/delete_service_token/DeleteServiceTokenRequest.ts +++ b/specification/security/delete_service_token/DeleteServiceTokenRequest.ts @@ -22,7 +22,7 @@ import { Name, Namespace, Refresh, Service } from '@_types/common' /** * Delete service account tokens. - * + * * Delete service account tokens for a service in a specified namespace. * @rest_spec_name security.delete_service_token * @availability stack since=5.5.0 stability=stable diff --git a/specification/security/delete_user/SecurityDeleteUserRequest.ts b/specification/security/delete_user/SecurityDeleteUserRequest.ts index 129b186212..9fe555c480 100644 --- a/specification/security/delete_user/SecurityDeleteUserRequest.ts +++ b/specification/security/delete_user/SecurityDeleteUserRequest.ts @@ -22,7 +22,7 @@ import { Refresh, Username } from '@_types/common' /** * Delete users. - * + * * Delete users from the native realm. * @rest_spec_name security.delete_user * @availability stack stability=stable diff --git a/specification/security/disable_user/SecurityDisableUserRequest.ts b/specification/security/disable_user/SecurityDisableUserRequest.ts index c4d9de7ad9..6159d114ca 100644 --- a/specification/security/disable_user/SecurityDisableUserRequest.ts +++ b/specification/security/disable_user/SecurityDisableUserRequest.ts @@ -22,7 +22,7 @@ import { Refresh, Username } from '@_types/common' /** * Disable users. - * + * * Disable users in the native realm. * @rest_spec_name security.disable_user * @availability stack stability=stable diff --git a/specification/security/disable_user_profile/Request.ts b/specification/security/disable_user_profile/Request.ts index 119525be53..4cdcd929e1 100644 --- a/specification/security/disable_user_profile/Request.ts +++ b/specification/security/disable_user_profile/Request.ts @@ -23,7 +23,7 @@ import { Refresh } from '@_types/common' /** * Disable a user profile. - * + * * Disable user profiles so that they are not visible in user profile searches. * @rest_spec_name security.disable_user_profile * @availability stack since=8.2.0 stability=stable diff --git a/specification/security/enable_user/SecurityEnableUserRequest.ts b/specification/security/enable_user/SecurityEnableUserRequest.ts index e70509364b..372936212f 100644 --- a/specification/security/enable_user/SecurityEnableUserRequest.ts +++ b/specification/security/enable_user/SecurityEnableUserRequest.ts @@ -22,7 +22,7 @@ import { Refresh, Username } from '@_types/common' /** * Enable users. - * + * * Enable users in the native realm. * @rest_spec_name security.enable_user * @availability stack stability=stable diff --git a/specification/security/enable_user_profile/Request.ts b/specification/security/enable_user_profile/Request.ts index a292c20cba..b236cd5b94 100644 --- a/specification/security/enable_user_profile/Request.ts +++ b/specification/security/enable_user_profile/Request.ts @@ -23,7 +23,7 @@ import { Refresh } from '@_types/common' /** * Enable a user profile. - * + * * Enable user profiles to make them visible in user profile searches. * @rest_spec_name security.enable_user_profile * @availability stack since=8.2.0 stability=stable diff --git a/specification/security/enroll_kibana/Request.ts b/specification/security/enroll_kibana/Request.ts index fc1d0d391b..9dbf5ac3c7 100644 --- a/specification/security/enroll_kibana/Request.ts +++ b/specification/security/enroll_kibana/Request.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Enroll Kibana. - * + * * Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. * @rest_spec_name security.enroll_kibana * @availability stack since=8.0.0 stability=stable diff --git a/specification/security/enroll_node/Request.ts b/specification/security/enroll_node/Request.ts index 1af3c82285..a9a5b78e32 100644 --- a/specification/security/enroll_node/Request.ts +++ b/specification/security/enroll_node/Request.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Enroll a node. - * + * * Enroll a new node to allow it to join an existing cluster with security features enabled. * @rest_spec_name security.enroll_node * @availability stack since=8.0.0 stability=stable diff --git a/specification/security/get_api_key/SecurityGetApiKeyRequest.ts b/specification/security/get_api_key/SecurityGetApiKeyRequest.ts index b069a61620..b090158aa4 100644 --- a/specification/security/get_api_key/SecurityGetApiKeyRequest.ts +++ b/specification/security/get_api_key/SecurityGetApiKeyRequest.ts @@ -22,7 +22,7 @@ import { Id, Name, Username } from '@_types/common' /** * Get API key information. - * + * * Retrieves information for one or more API keys. * NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. * If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. diff --git a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts index 12c28678eb..f113492459 100644 --- a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts +++ b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get builtin privileges. - * + * * Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. * @rest_spec_name security.get_builtin_privileges * @availability stack since=7.3.0 stability=stable diff --git a/specification/security/get_role/SecurityGetRoleRequest.ts b/specification/security/get_role/SecurityGetRoleRequest.ts index df1eb06720..34c38d2c46 100644 --- a/specification/security/get_role/SecurityGetRoleRequest.ts +++ b/specification/security/get_role/SecurityGetRoleRequest.ts @@ -22,7 +22,7 @@ import { Names } from '@_types/common' /** * Get roles. - * + * * Get roles in the native realm. * @rest_spec_name security.get_role * @availability stack stability=stable diff --git a/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts b/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts index 39342d3f81..89af3fbd49 100644 --- a/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts +++ b/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts @@ -22,7 +22,7 @@ import { Names } from '@_types/common' /** * Get role mappings. - * + * * Role mappings define which roles are assigned to each user. * The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. * The get role mappings API cannot retrieve role mappings that are defined in role mapping files. diff --git a/specification/security/get_service_accounts/GetServiceAccountsRequest.ts b/specification/security/get_service_accounts/GetServiceAccountsRequest.ts index 63d92f3a6a..ba780e77c7 100644 --- a/specification/security/get_service_accounts/GetServiceAccountsRequest.ts +++ b/specification/security/get_service_accounts/GetServiceAccountsRequest.ts @@ -22,7 +22,7 @@ import { Namespace, Service } from '@_types/common' /** * Get service accounts. - * + * * Get a list of service accounts that match the provided path parameters. * @rest_spec_name security.get_service_accounts * @availability stack since=7.13.0 stability=stable diff --git a/specification/security/get_token/GetUserAccessTokenRequest.ts b/specification/security/get_token/GetUserAccessTokenRequest.ts index 69b950c52c..4e163fa9b9 100644 --- a/specification/security/get_token/GetUserAccessTokenRequest.ts +++ b/specification/security/get_token/GetUserAccessTokenRequest.ts @@ -24,7 +24,7 @@ import { AccessTokenGrantType } from './types' /** * Get a token. - * + * * Create a bearer token for access without requiring basic authentication. * @rest_spec_name security.get_token * @availability stack since=5.5.0 stability=stable diff --git a/specification/security/get_user/SecurityGetUserRequest.ts b/specification/security/get_user/SecurityGetUserRequest.ts index 7a18e86bd7..376a497879 100644 --- a/specification/security/get_user/SecurityGetUserRequest.ts +++ b/specification/security/get_user/SecurityGetUserRequest.ts @@ -22,7 +22,7 @@ import { Username } from '@_types/common' /** * Get users. - * + * * Get information about users in the native realm and built-in users. * @rest_spec_name security.get_user * @availability stack stability=stable