diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index c1084b7bcb..b557c011e8 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -646,8 +646,8 @@ "tags": [ "bulk" ], - "summary": "Performs multiple indexing or delete operations in a single API call", - "description": "This reduces overhead and can greatly increase indexing speed.", + "summary": "Bulk index or delete documents", + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html" }, @@ -694,8 +694,8 @@ "tags": [ "bulk" ], - "summary": "Performs multiple indexing or delete operations in a single API call", - "description": "This reduces overhead and can greatly increase indexing speed.", + "summary": "Bulk index or delete documents", + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html" }, @@ -744,8 +744,8 @@ "tags": [ "bulk" ], - "summary": "Performs multiple indexing or delete operations in a single API call", - "description": "This reduces overhead and can greatly increase indexing speed.", + "summary": "Bulk index or delete documents", + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html" }, @@ -795,8 +795,8 @@ "tags": [ "bulk" ], - "summary": "Performs multiple indexing or delete operations in a single API call", - "description": "This reduces overhead and can greatly increase indexing speed.", + "summary": "Bulk index or delete documents", + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html" }, @@ -3225,7 +3225,8 @@ "tags": [ "cluster.get_component_template" ], - "summary": "Retrieves information about component templates", + "summary": "Get component templates", + "description": "Retrieves information about component templates.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -3258,8 +3259,8 @@ "tags": [ "cluster.put_component_template" ], - "summary": "Creates or updates a component template", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", + "summary": "Create or update a component template", + "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -3289,8 +3290,8 @@ "tags": [ "cluster.put_component_template" ], - "summary": "Creates or updates a component template", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", + "summary": "Create or update a component template", + "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -3320,8 +3321,8 @@ "tags": [ "cluster.delete_component_template" ], - "summary": "Deletes component templates", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", + "summary": "Delete component templates", + "description": "Deletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -3377,7 +3378,8 @@ "tags": [ "cluster.exists_component_template" ], - "summary": "Returns information about whether a particular component template exist", + "summary": "Check component templates", + "description": "Returns information about whether a particular component template exists.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -3515,7 +3517,8 @@ "tags": [ "cluster.get_component_template" ], - "summary": "Retrieves information about component templates", + "summary": "Get component templates", + "description": "Retrieves information about component templates.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -7427,7 +7430,8 @@ "tags": [ "get_script" ], - "summary": "Retrieves a stored script or search template", + "summary": "Get a script or search template", + "description": "Retrieves a stored script or search template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, @@ -7487,7 +7491,8 @@ "tags": [ "put_script" ], - "summary": "Creates or updates a stored script or search template", + "summary": "Create or update a script or search template", + "description": "Creates or updates a stored script or search template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, @@ -7516,7 +7521,8 @@ "tags": [ "put_script" ], - "summary": "Creates or updates a stored script or search template", + "summary": "Create or update a script or search template", + "description": "Creates or updates a stored script or search template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, @@ -7545,7 +7551,8 @@ "tags": [ "delete_script" ], - "summary": "Deletes a stored script or search template", + "summary": "Delete a script or search template", + "description": "Deletes a stored script or search template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, @@ -24899,7 +24906,8 @@ "tags": [ "put_script" ], - "summary": "Creates or updates a stored script or search template", + "summary": "Create or update a script or search template", + "description": "Creates or updates a stored script or search template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, @@ -24931,7 +24939,8 @@ "tags": [ "put_script" ], - "summary": "Creates or updates a stored script or search template", + "summary": "Create or update a script or search template", + "description": "Creates or updates a stored script or search template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, @@ -26290,7 +26299,8 @@ "tags": [ "scripts_painless_execute" ], - "summary": "Runs a script and returns a result", + "summary": "Run a script", + "description": "Runs a script and returns a result.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html" }, @@ -26310,7 +26320,8 @@ "tags": [ "scripts_painless_execute" ], - "summary": "Runs a script and returns a result", + "summary": "Run a script", + "description": "Runs a script and returns a result.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html" }, @@ -28208,8 +28219,8 @@ "tags": [ "security.authenticate" ], - "summary": "Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user", - "description": "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.\nIf the user cannot be authenticated, this API returns a 401 status code.", + "summary": "Authenticate a user", + "description": "Authenticates 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html" }, @@ -28897,8 +28908,8 @@ "tags": [ "security.get_api_key" ], - "summary": "Retrieves information for one or more API keys", - "description": "NOTE: 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.", + "summary": "Get API key information", + "description": "Retrieves 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html" }, @@ -29014,8 +29025,8 @@ "tags": [ "security.create_api_key" ], - "summary": "Creates an API key for access without requiring basic authentication", - "description": "A 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.", + "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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html" }, @@ -29039,8 +29050,8 @@ "tags": [ "security.create_api_key" ], - "summary": "Creates an API key for access without requiring basic authentication", - "description": "A 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.", + "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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html" }, @@ -29064,8 +29075,8 @@ "tags": [ "security.invalidate_api_key" ], - "summary": "Invalidates one or more API keys", - "description": "The `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "summary": "Invalidate API keys", + "description": "Invalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html" }, @@ -30819,7 +30830,8 @@ "tags": [ "security.has_privileges" ], - "summary": "Determines whether the specified user has a specified list of privileges", + "summary": "Check user privileges", + "description": "Determines whether the specified user has a specified list of privileges.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html" }, @@ -30838,7 +30850,8 @@ "tags": [ "security.has_privileges" ], - "summary": "Determines whether the specified user has a specified list of privileges", + "summary": "Check user privileges", + "description": "Determines whether the specified user has a specified list of privileges.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html" }, @@ -30859,7 +30872,8 @@ "tags": [ "security.has_privileges" ], - "summary": "Determines whether the specified user has a specified list of privileges", + "summary": "Check user privileges", + "description": "Determines whether the specified user has a specified list of privileges.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html" }, @@ -30883,7 +30897,8 @@ "tags": [ "security.has_privileges" ], - "summary": "Determines whether the specified user has a specified list of privileges", + "summary": "Check user privileges", + "description": "Determines whether the specified user has a specified list of privileges.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html" }, @@ -30949,8 +30964,8 @@ "tags": [ "security.query_api_keys" ], - "summary": "Retrieves information for API keys in a paginated manner", - "description": "You can optionally filter the results with a query.", + "summary": "Query API keys", + "description": "Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html" }, @@ -30980,8 +30995,8 @@ "tags": [ "security.query_api_keys" ], - "summary": "Retrieves information for API keys in a paginated manner", - "description": "You can optionally filter the results with a query.", + "summary": "Query API keys", + "description": "Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html" }, @@ -31520,8 +31535,8 @@ "tags": [ "security.update_api_key" ], - "summary": "Updates attributes of an existing API key", - "description": "Users can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", + "summary": "Update an API key", + "description": "Updates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html" }, @@ -34063,7 +34078,8 @@ "tags": [ "tasks.get" ], - "summary": "Returns information about a task", + "summary": "Get task information", + "description": "Returns information about the tasks currently executing in the cluster.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html" }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 6ae0d12d12..13c58fab55 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -486,8 +486,8 @@ "tags": [ "bulk" ], - "summary": "Performs multiple indexing or delete operations in a single API call", - "description": "This reduces overhead and can greatly increase indexing speed.", + "summary": "Bulk index or delete documents", + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html" }, @@ -534,8 +534,8 @@ "tags": [ "bulk" ], - "summary": "Performs multiple indexing or delete operations in a single API call", - "description": "This reduces overhead and can greatly increase indexing speed.", + "summary": "Bulk index or delete documents", + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html" }, @@ -584,8 +584,8 @@ "tags": [ "bulk" ], - "summary": "Performs multiple indexing or delete operations in a single API call", - "description": "This reduces overhead and can greatly increase indexing speed.", + "summary": "Bulk index or delete documents", + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html" }, @@ -635,8 +635,8 @@ "tags": [ "bulk" ], - "summary": "Performs multiple indexing or delete operations in a single API call", - "description": "This reduces overhead and can greatly increase indexing speed.", + "summary": "Bulk index or delete documents", + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html" }, @@ -1529,7 +1529,8 @@ "tags": [ "cluster.get_component_template" ], - "summary": "Retrieves information about component templates", + "summary": "Get component templates", + "description": "Retrieves information about component templates.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -1562,8 +1563,8 @@ "tags": [ "cluster.put_component_template" ], - "summary": "Creates or updates a component template", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", + "summary": "Create or update a component template", + "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -1593,8 +1594,8 @@ "tags": [ "cluster.put_component_template" ], - "summary": "Creates or updates a component template", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", + "summary": "Create or update a component template", + "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -1624,8 +1625,8 @@ "tags": [ "cluster.delete_component_template" ], - "summary": "Deletes component templates", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", + "summary": "Delete component templates", + "description": "Deletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -1681,7 +1682,8 @@ "tags": [ "cluster.exists_component_template" ], - "summary": "Returns information about whether a particular component template exist", + "summary": "Check component templates", + "description": "Returns information about whether a particular component template exists.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -1735,7 +1737,8 @@ "tags": [ "cluster.get_component_template" ], - "summary": "Retrieves information about component templates", + "summary": "Get component templates", + "description": "Retrieves information about component templates.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -4612,7 +4615,8 @@ "tags": [ "get_script" ], - "summary": "Retrieves a stored script or search template", + "summary": "Get a script or search template", + "description": "Retrieves a stored script or search template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, @@ -4672,7 +4676,8 @@ "tags": [ "put_script" ], - "summary": "Creates or updates a stored script or search template", + "summary": "Create or update a script or search template", + "description": "Creates or updates a stored script or search template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, @@ -4701,7 +4706,8 @@ "tags": [ "put_script" ], - "summary": "Creates or updates a stored script or search template", + "summary": "Create or update a script or search template", + "description": "Creates or updates a stored script or search template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, @@ -4730,7 +4736,8 @@ "tags": [ "delete_script" ], - "summary": "Deletes a stored script or search template", + "summary": "Delete a script or search template", + "description": "Deletes a stored script or search template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, @@ -15318,7 +15325,8 @@ "tags": [ "put_script" ], - "summary": "Creates or updates a stored script or search template", + "summary": "Create or update a script or search template", + "description": "Creates or updates a stored script or search template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, @@ -15350,7 +15358,8 @@ "tags": [ "put_script" ], - "summary": "Creates or updates a stored script or search template", + "summary": "Create or update a script or search template", + "description": "Creates or updates a stored script or search template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, @@ -16206,7 +16215,8 @@ "tags": [ "scripts_painless_execute" ], - "summary": "Runs a script and returns a result", + "summary": "Run a script", + "description": "Runs a script and returns a result.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html" }, @@ -16226,7 +16236,8 @@ "tags": [ "scripts_painless_execute" ], - "summary": "Runs a script and returns a result", + "summary": "Run a script", + "description": "Runs a script and returns a result.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html" }, @@ -17615,8 +17626,8 @@ "tags": [ "security.authenticate" ], - "summary": "Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user", - "description": "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.\nIf the user cannot be authenticated, this API returns a 401 status code.", + "summary": "Authenticate a user", + "description": "Authenticates 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html" }, @@ -17704,8 +17715,8 @@ "tags": [ "security.get_api_key" ], - "summary": "Retrieves information for one or more API keys", - "description": "NOTE: 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.", + "summary": "Get API key information", + "description": "Retrieves 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html" }, @@ -17821,8 +17832,8 @@ "tags": [ "security.create_api_key" ], - "summary": "Creates an API key for access without requiring basic authentication", - "description": "A 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.", + "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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html" }, @@ -17846,8 +17857,8 @@ "tags": [ "security.create_api_key" ], - "summary": "Creates an API key for access without requiring basic authentication", - "description": "A 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.", + "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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html" }, @@ -17871,8 +17882,8 @@ "tags": [ "security.invalidate_api_key" ], - "summary": "Invalidates one or more API keys", - "description": "The `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "summary": "Invalidate API keys", + "description": "Invalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html" }, @@ -17961,7 +17972,8 @@ "tags": [ "security.has_privileges" ], - "summary": "Determines whether the specified user has a specified list of privileges", + "summary": "Check user privileges", + "description": "Determines whether the specified user has a specified list of privileges.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html" }, @@ -17980,7 +17992,8 @@ "tags": [ "security.has_privileges" ], - "summary": "Determines whether the specified user has a specified list of privileges", + "summary": "Check user privileges", + "description": "Determines whether the specified user has a specified list of privileges.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html" }, @@ -18001,7 +18014,8 @@ "tags": [ "security.has_privileges" ], - "summary": "Determines whether the specified user has a specified list of privileges", + "summary": "Check user privileges", + "description": "Determines whether the specified user has a specified list of privileges.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html" }, @@ -18025,7 +18039,8 @@ "tags": [ "security.has_privileges" ], - "summary": "Determines whether the specified user has a specified list of privileges", + "summary": "Check user privileges", + "description": "Determines whether the specified user has a specified list of privileges.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html" }, @@ -18051,8 +18066,8 @@ "tags": [ "security.query_api_keys" ], - "summary": "Retrieves information for API keys in a paginated manner", - "description": "You can optionally filter the results with a query.", + "summary": "Query API keys", + "description": "Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html" }, @@ -18082,8 +18097,8 @@ "tags": [ "security.query_api_keys" ], - "summary": "Retrieves information for API keys in a paginated manner", - "description": "You can optionally filter the results with a query.", + "summary": "Query API keys", + "description": "Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html" }, @@ -18115,8 +18130,8 @@ "tags": [ "security.update_api_key" ], - "summary": "Updates attributes of an existing API key", - "description": "Users can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", + "summary": "Update an API key", + "description": "Updates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html" }, @@ -18956,7 +18971,8 @@ "tags": [ "tasks.get" ], - "summary": "Returns information about a task", + "summary": "Get task information", + "description": "Returns information about the tasks currently executing in the cluster.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html" }, diff --git a/output/schema/schema.json b/output/schema/schema.json index 8d7da9b92b..b958ea48c7 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -454,7 +454,7 @@ "stability": "stable" } }, - "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", + "description": "Bulk index or delete documents.\nPerforms multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "docId": "docs-bulk", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html", "name": "bulk", @@ -2271,7 +2271,7 @@ "stability": "stable" } }, - "description": "Deletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", + "description": "Delete component templates.\nDeletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", "docId": "indices-component-template", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.delete_component_template", @@ -2344,7 +2344,7 @@ "stability": "stable" } }, - "description": "Returns information about whether a particular component template exist", + "description": "Check component templates.\nReturns information about whether a particular component template exists.", "docId": "indices-component-template", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.exists_component_template", @@ -2380,7 +2380,7 @@ "stability": "stable" } }, - "description": "Retrieves information about component templates.", + "description": "Get component templates.\nRetrieves information about component templates.", "docId": "indices-component-template", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.get_component_template", @@ -2623,7 +2623,7 @@ "stability": "stable" } }, - "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", + "description": "Create or update a component template.\nCreates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", "docId": "indices-component-template", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.put_component_template", @@ -4355,7 +4355,7 @@ "stability": "stable" } }, - "description": "Deletes a stored script or search template.", + "description": "Delete a script or search template.\nDeletes a stored script or search template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "delete_script", "request": { @@ -5277,7 +5277,7 @@ "stability": "stable" } }, - "description": "Retrieves a stored script or search template.", + "description": "Get a script or search template.\nRetrieves a stored script or search template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "get_script", "request": { @@ -13285,7 +13285,7 @@ "stability": "stable" } }, - "description": "Creates or updates a stored script or search template.", + "description": "Create or update a script or search template.\nCreates or updates a stored script or search template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "put_script", "request": { @@ -14024,7 +14024,7 @@ "stability": "experimental" } }, - "description": "Runs a script and returns a result.", + "description": "Run a script.\nRuns a script and returns a result.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html", "name": "scripts_painless_execute", "request": { @@ -14822,7 +14822,7 @@ "stability": "stable" } }, - "description": "Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user.\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.\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": { @@ -15189,7 +15189,7 @@ "stability": "stable" } }, - "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.\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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", "name": "security.create_api_key", "privileges": { @@ -15683,7 +15683,7 @@ "stability": "stable" } }, - "description": "Retrieves 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.\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": { @@ -16209,7 +16209,7 @@ "stability": "stable" } }, - "description": "Determines whether the specified user has a specified list of privileges.", + "description": "Check user privileges.\nDetermines whether the specified user has a specified list of privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html", "name": "security.has_privileges", "request": { @@ -16299,7 +16299,7 @@ "stability": "stable" } }, - "description": "Invalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "description": "Invalidate API keys.\nInvalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", "name": "security.invalidate_api_key", "privileges": { @@ -16620,7 +16620,7 @@ "stability": "stable" } }, - "description": "Retrieves information for API keys in a paginated manner. You can optionally filter the results with a query.", + "description": "Query API keys.\nRetrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html", "name": "security.query_api_keys", "privileges": { @@ -17020,7 +17020,7 @@ "stability": "stable" } }, - "description": "Updates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", + "description": "Update an API key.\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html", "name": "security.update_api_key", "privileges": { @@ -18627,7 +18627,7 @@ "stability": "experimental" } }, - "description": "Returns information about a task.", + "description": "Get task information.\nReturns information about the tasks currently executing in the cluster.", "docId": "tasks", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", "name": "tasks.get", @@ -20318,7 +20318,7 @@ } } }, - "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", + "description": "Bulk index or delete documents.\nPerforms multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "generics": [ { "name": "TDocument", @@ -20468,7 +20468,7 @@ } } ], - "specLocation": "_global/bulk/BulkRequest.ts#L32-L103" + "specLocation": "_global/bulk/BulkRequest.ts#L32-L104" }, { "body": { @@ -22505,7 +22505,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a stored script or search template.", + "description": "Delete a script or search template.\nDeletes a stored script or search template.", "inherits": { "type": { "name": "RequestBase", @@ -22559,7 +22559,7 @@ } } ], - "specLocation": "_global/delete_script/DeleteScriptRequest.ts#L24-L51" + "specLocation": "_global/delete_script/DeleteScriptRequest.ts#L24-L52" }, { "body": { @@ -24183,7 +24183,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a stored script or search template.", + "description": "Get a script or search template.\nRetrieves a stored script or search template.", "inherits": { "type": { "name": "RequestBase", @@ -24223,7 +24223,7 @@ } } ], - "specLocation": "_global/get_script/GetScriptRequest.ts#L24-L41" + "specLocation": "_global/get_script/GetScriptRequest.ts#L24-L42" }, { "body": { @@ -29056,7 +29056,7 @@ } ] }, - "description": "Creates or updates a stored script or search template.", + "description": "Create or update a script or search template.\nCreates or updates a stored script or search template.", "inherits": { "type": { "name": "RequestBase", @@ -29122,7 +29122,7 @@ } } ], - "specLocation": "_global/put_script/PutScriptRequest.ts#L25-L64" + "specLocation": "_global/put_script/PutScriptRequest.ts#L25-L65" }, { "body": { @@ -31265,7 +31265,7 @@ } ] }, - "description": "Runs a script and returns a result.", + "description": "Run a script.\nRuns a script and returns a result.", "inherits": { "type": { "name": "RequestBase", @@ -31279,7 +31279,7 @@ }, "path": [], "query": [], - "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts#L24-L46" + "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts#L24-L47" }, { "body": { @@ -101367,7 +101367,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", + "description": "Delete component templates.\nDeletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", "inherits": { "type": { "name": "RequestBase", @@ -101421,7 +101421,7 @@ } } ], - "specLocation": "cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts#L24-L54" + "specLocation": "cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts#L24-L55" }, { "body": { @@ -101496,7 +101496,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about whether a particular component template exist", + "description": "Check component templates.\nReturns information about whether a particular component template exists.", "inherits": { "type": { "name": "RequestBase", @@ -101550,7 +101550,7 @@ } } ], - "specLocation": "cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts#L24-L53" + "specLocation": "cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts#L24-L55" }, { "body": { @@ -101570,7 +101570,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about component templates.", + "description": "Get component templates.\nRetrieves information about component templates.", "inherits": { "type": { "name": "RequestBase", @@ -101659,7 +101659,7 @@ } } ], - "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateRequest.ts#L24-L65" + "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateRequest.ts#L24-L66" }, { "body": { @@ -102894,7 +102894,7 @@ } ] }, - "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", + "description": "Create or update a component template.\nCreates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", "inherits": { "type": { "name": "RequestBase", @@ -102948,7 +102948,7 @@ } } ], - "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L25-L93" + "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L25-L94" }, { "body": { @@ -181038,7 +181038,7 @@ "body": { "kind": "no_body" }, - "description": "Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user.\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.\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", @@ -181052,7 +181052,7 @@ }, "path": [], "query": [], - "specLocation": "security/authenticate/SecurityAuthenticateRequest.ts#L22-L30" + "specLocation": "security/authenticate/SecurityAuthenticateRequest.ts#L22-L32" }, { "body": { @@ -182171,7 +182171,7 @@ } ] }, - "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.\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.", "inherits": { "type": { "name": "RequestBase", @@ -182198,7 +182198,7 @@ } } ], - "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L58" + "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L59" }, { "body": { @@ -183317,7 +183317,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves 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.\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", @@ -183450,7 +183450,7 @@ } } ], - "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L86" + "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L87" }, { "body": { @@ -185434,7 +185434,7 @@ } ] }, - "description": "Determines whether the specified user has a specified list of privileges.", + "description": "Check user privileges.\nDetermines whether the specified user has a specified list of privileges.", "inherits": { "type": { "name": "RequestBase", @@ -185461,7 +185461,7 @@ } ], "query": [], - "specLocation": "security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L42" + "specLocation": "security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L44" }, { "kind": "type_alias", @@ -185850,7 +185850,7 @@ } ] }, - "description": "Invalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "description": "Invalidate API keys.\nInvalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", "inherits": { "type": { "name": "RequestBase", @@ -185864,7 +185864,7 @@ }, "path": [], "query": [], - "specLocation": "security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts#L23-L66" + "specLocation": "security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts#L23-L67" }, { "body": { @@ -187456,7 +187456,7 @@ } ] }, - "description": "Retrieves information for API keys in a paginated manner. You can optionally filter the results with a query.", + "description": "Query API keys.\nRetrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", "inherits": { "type": { "name": "RequestBase", @@ -187527,7 +187527,7 @@ } } ], - "specLocation": "security/query_api_keys/QueryApiKeysRequest.ts#L26-L99" + "specLocation": "security/query_api_keys/QueryApiKeysRequest.ts#L26-L100" }, { "body": { @@ -189290,7 +189290,7 @@ } ] }, - "description": "Updates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", + "description": "Update an API key.\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", "inherits": { "type": { "name": "RequestBase", @@ -189317,7 +189317,7 @@ } ], "query": [], - "specLocation": "security/update_api_key/Request.ts#L26-L65" + "specLocation": "security/update_api_key/Request.ts#L26-L66" }, { "body": { @@ -197119,7 +197119,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about a task.", + "description": "Get task information.\nReturns information about the tasks currently executing in the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -197173,7 +197173,7 @@ } } ], - "specLocation": "tasks/get/GetTaskRequest.ts#L24-L50" + "specLocation": "tasks/get/GetTaskRequest.ts#L24-L52" }, { "body": { diff --git a/specification/_global/bulk/BulkRequest.ts b/specification/_global/bulk/BulkRequest.ts index 850bb4defa..fab1803066 100644 --- a/specification/_global/bulk/BulkRequest.ts +++ b/specification/_global/bulk/BulkRequest.ts @@ -30,6 +30,7 @@ import { OperationContainer, UpdateAction } from './types' import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** + * Bulk index or delete documents. * Performs multiple indexing or delete operations in a single API call. * This reduces overhead and can greatly increase indexing speed. * @rest_spec_name bulk diff --git a/specification/_global/delete_script/DeleteScriptRequest.ts b/specification/_global/delete_script/DeleteScriptRequest.ts index 024f6dd836..209450bfab 100644 --- a/specification/_global/delete_script/DeleteScriptRequest.ts +++ b/specification/_global/delete_script/DeleteScriptRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** + * Delete a script or search template. * Deletes a stored script or search template. * @rest_spec_name delete_script * @availability stack stability=stable diff --git a/specification/_global/get_script/GetScriptRequest.ts b/specification/_global/get_script/GetScriptRequest.ts index 2b02ba02d4..1384917aff 100644 --- a/specification/_global/get_script/GetScriptRequest.ts +++ b/specification/_global/get_script/GetScriptRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get a script or search template. * Retrieves a stored script or search template. * @rest_spec_name get_script * @availability stack stability=stable diff --git a/specification/_global/put_script/PutScriptRequest.ts b/specification/_global/put_script/PutScriptRequest.ts index 850f4d47b4..0119f68d18 100644 --- a/specification/_global/put_script/PutScriptRequest.ts +++ b/specification/_global/put_script/PutScriptRequest.ts @@ -23,6 +23,7 @@ import { StoredScript } from '@_types/Scripting' import { Duration } from '@_types/Time' /** + * Create or update a script or search template. * Creates or updates a stored script or search template. * @rest_spec_name put_script * @availability stack stability=stable diff --git a/specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts b/specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts index 1442f08875..136542af78 100644 --- a/specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts +++ b/specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts @@ -22,6 +22,7 @@ import { Script } from '@_types/Scripting' import { PainlessContextSetup } from './types' /** + * Run a script. * Runs a script and returns a result. * @rest_spec_name scripts_painless_execute * @availability stack since=6.3.0 stability=experimental diff --git a/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts b/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts index 1d695916f8..f0bfd02836 100644 --- a/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts +++ b/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts @@ -22,6 +22,7 @@ import { Names } from '@_types/common' import { Duration } from '@_types/Time' /** + * Delete component templates. * Deletes component templates. * Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. * @rest_spec_name cluster.delete_component_template diff --git a/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts b/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts index bfbcdc6179..426586fe82 100644 --- a/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts +++ b/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts @@ -22,6 +22,8 @@ import { Names } from '@_types/common' import { Duration } from '@_types/Time' /** + * Check component templates. + * Returns information about whether a particular component template exists. * @rest_spec_name cluster.exists_component_template * @availability stack since=7.8.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts b/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts index 319f3335ee..1318dc53fe 100644 --- a/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts +++ b/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts @@ -22,6 +22,7 @@ import { Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get component templates. * Retrieves information about component templates. * @rest_spec_name cluster.get_component_template * @availability stack since=7.8.0 stability=stable diff --git a/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts b/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts index 8c1b406feb..ce8c0772f1 100644 --- a/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts +++ b/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts @@ -23,6 +23,7 @@ import { Metadata, Name, VersionNumber } from '@_types/common' import { Duration } from '@_types/Time' /** + * Create or update a component template. * Creates or updates a component template. * Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. * diff --git a/specification/security/authenticate/SecurityAuthenticateRequest.ts b/specification/security/authenticate/SecurityAuthenticateRequest.ts index b4ec877c7e..608f90d0be 100644 --- a/specification/security/authenticate/SecurityAuthenticateRequest.ts +++ b/specification/security/authenticate/SecurityAuthenticateRequest.ts @@ -20,7 +20,9 @@ import { RequestBase } from '@_types/Base' /** - * Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user. + * 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. * If the user cannot be authenticated, this API returns a 401 status code. * @rest_spec_name security.authenticate diff --git a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts index a376a7c512..427538f874 100644 --- a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts +++ b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' import { RoleDescriptor } from '@security/_types/RoleDescriptor' /** + * Create an API key. * Creates 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/get_api_key/SecurityGetApiKeyRequest.ts b/specification/security/get_api_key/SecurityGetApiKeyRequest.ts index 309f591cf2..ed96c159f7 100644 --- a/specification/security/get_api_key/SecurityGetApiKeyRequest.ts +++ b/specification/security/get_api_key/SecurityGetApiKeyRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' 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/has_privileges/SecurityHasPrivilegesRequest.ts b/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts index 178dafab39..ee25210b71 100644 --- a/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts +++ b/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts @@ -23,6 +23,8 @@ import { Name } from '@_types/common' import { ApplicationPrivilegesCheck, IndexPrivilegesCheck } from './types' /** + * Check user privileges. + * Determines whether the specified user has a specified list of privileges. * @rest_spec_name security.has_privileges * @availability stack since=6.4.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts b/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts index e8a36be88e..438ce35765 100644 --- a/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts +++ b/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id, Name, Username } from '@_types/common' /** + * Invalidate API keys. * Invalidates one or more API keys. * The `manage_api_key` privilege allows deleting any API keys. * The `manage_own_api_key` only allows deleting API keys that are owned by the user. diff --git a/specification/security/query_api_keys/QueryApiKeysRequest.ts b/specification/security/query_api_keys/QueryApiKeysRequest.ts index 80f3c66866..8e34409834 100644 --- a/specification/security/query_api_keys/QueryApiKeysRequest.ts +++ b/specification/security/query_api_keys/QueryApiKeysRequest.ts @@ -24,7 +24,8 @@ import { integer } from '@_types/Numeric' import { Sort, SortResults } from '@_types/sort' /** - * Retrieves information for API keys in a paginated manner. You can optionally filter the results with a query. + * Query API keys. + * Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. * @rest_spec_name security.query_api_keys * @availability stack since=7.15.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/security/update_api_key/Request.ts b/specification/security/update_api_key/Request.ts index c6ce07fde2..7e14a5c740 100644 --- a/specification/security/update_api_key/Request.ts +++ b/specification/security/update_api_key/Request.ts @@ -24,6 +24,7 @@ import { RoleDescriptor } from '@security/_types/RoleDescriptor' import { Duration } from '@_types/Time' /** + * Update an API key. * Updates attributes of an existing API key. * Users can only update API keys that they created or that were granted to them. * Use this API to update API keys created by the create API Key or grant API Key APIs. diff --git a/specification/tasks/get/GetTaskRequest.ts b/specification/tasks/get/GetTaskRequest.ts index 14d97a820b..6126a7746b 100644 --- a/specification/tasks/get/GetTaskRequest.ts +++ b/specification/tasks/get/GetTaskRequest.ts @@ -22,6 +22,8 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get task information. + * Returns information about the tasks currently executing in the cluster. * @rest_spec_name tasks.get * @availability stack since=5.0.0 stability=experimental * @availability serverless stability=experimental visibility=public