Add more summaries (#2719)

shainaraskas · web-flow · commit 04d4a2643785 · 2024-07-26T18:09:30.000Z
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
