From dc8609aa4cc030bb67a447c204418f23807ce143 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 22 Oct 2024 13:36:39 -0700 Subject: [PATCH] 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