From 4a6fc5656886db01c9af7738db853a419a4d8383 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 22 Oct 2024 13:38:23 -0700 Subject: [PATCH] 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",