From d8f6289dee578f9f33f485038afbadf4d9119796 Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Fri, 19 Jul 2024 11:55:19 -0400 Subject: [PATCH 1/4] add summaries to root operations --- specification/_global/create/CreateRequest.ts | 1 + specification/_global/delete/DeleteRequest.ts | 1 + specification/_global/exists/DocumentExistsRequest.ts | 3 ++- specification/_global/exists_source/SourceExistsRequest.ts | 1 + specification/_global/explain/ExplainRequest.ts | 3 ++- specification/_global/get/GetRequest.ts | 2 ++ specification/_global/get_source/SourceRequest.ts | 2 ++ specification/_global/index/IndexRequest.ts | 1 + specification/_global/search_mvt/SearchMvtRequest.ts | 2 ++ specification/_global/termvectors/TermVectorsRequest.ts | 2 ++ specification/_global/update/UpdateRequest.ts | 2 ++ specification/cluster/info/ClusterInfoRequest.ts | 2 ++ specification/cluster/reroute/ClusterRerouteRequest.ts | 2 +- specification/indices/add_block/IndicesAddBlockRequest.ts | 2 ++ specification/indices/create/IndicesCreateRequest.ts | 1 + specification/indices/delete/IndicesDeleteRequest.ts | 1 + .../indices/delete_alias/IndicesDeleteAliasRequest.ts | 1 + specification/indices/exists/IndicesExistsRequest.ts | 3 ++- .../indices/exists_alias/IndicesExistsAliasRequest.ts | 1 + specification/indices/get/IndicesGetRequest.ts | 1 + specification/indices/get_alias/IndicesGetAliasRequest.ts | 1 + .../indices/get_settings/IndicesGetSettingsRequest.ts | 1 + specification/indices/put_alias/IndicesPutAliasRequest.ts | 1 + specification/indices/rollover/IndicesRolloverRequest.ts | 1 + .../indices/update_aliases/IndicesUpdateAliasesRequest.ts | 1 + 25 files changed, 35 insertions(+), 4 deletions(-) diff --git a/specification/_global/create/CreateRequest.ts b/specification/_global/create/CreateRequest.ts index 212a22a3cf..5da39bc552 100644 --- a/specification/_global/create/CreateRequest.ts +++ b/specification/_global/create/CreateRequest.ts @@ -30,6 +30,7 @@ import { import { Duration } from '@_types/Time' /** + * Index a document. * Adds a JSON document to the specified data stream or index and makes it searchable. * If the target is an index and the document already exists, the request updates the document and increments its version. * @rest_spec_name create diff --git a/specification/_global/delete/DeleteRequest.ts b/specification/_global/delete/DeleteRequest.ts index e6b97879bb..d07b026033 100644 --- a/specification/_global/delete/DeleteRequest.ts +++ b/specification/_global/delete/DeleteRequest.ts @@ -32,6 +32,7 @@ import { long } from '@_types/Numeric' import { Duration } from '@_types/Time' /** + * Delete a document. * Removes a JSON document from the specified index. * @rest_spec_name delete * @availability stack stability=stable diff --git a/specification/_global/exists/DocumentExistsRequest.ts b/specification/_global/exists/DocumentExistsRequest.ts index 0fe875864e..cce7aff33b 100644 --- a/specification/_global/exists/DocumentExistsRequest.ts +++ b/specification/_global/exists/DocumentExistsRequest.ts @@ -29,7 +29,8 @@ import { import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** - * Checks if a document in an index exists. + * Check a document. + * Checks if a specified document exists. * @rest_spec_name exists * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/exists_source/SourceExistsRequest.ts b/specification/_global/exists_source/SourceExistsRequest.ts index 440eb819ef..95039f3396 100644 --- a/specification/_global/exists_source/SourceExistsRequest.ts +++ b/specification/_global/exists_source/SourceExistsRequest.ts @@ -29,6 +29,7 @@ import { import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** + * Check for a document source. * Checks if a document's `_source` is stored. * @rest_spec_name exists_source * @availability stack since=5.4.0 stability=stable diff --git a/specification/_global/explain/ExplainRequest.ts b/specification/_global/explain/ExplainRequest.ts index 7a3098cf91..3781ab9918 100644 --- a/specification/_global/explain/ExplainRequest.ts +++ b/specification/_global/explain/ExplainRequest.ts @@ -24,7 +24,8 @@ import { SourceConfigParam } from '@global/search/_types/SourceFilter' import { Operator } from '@_types/query_dsl/Operator' /** - * Returns information about why a specific document matches (or doesn’t match) a query. + * Explain a document match result. + * Returns information about why a specific document matches, or doesn’t match, a query. * @rest_spec_name explain * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/get/GetRequest.ts b/specification/_global/get/GetRequest.ts index 0365a64d6a..6f5a7d94fc 100644 --- a/specification/_global/get/GetRequest.ts +++ b/specification/_global/get/GetRequest.ts @@ -29,6 +29,8 @@ import { import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** + * Get a document by its ID. + * Retrieves the document with the specified ID from an index. * @rest_spec_name get * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/get_source/SourceRequest.ts b/specification/_global/get_source/SourceRequest.ts index dc96afdb40..bd4b9b607e 100644 --- a/specification/_global/get_source/SourceRequest.ts +++ b/specification/_global/get_source/SourceRequest.ts @@ -29,6 +29,8 @@ import { import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** + * Get a document's source. + * Returns the source of a document. * @rest_spec_name get_source * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/index/IndexRequest.ts b/specification/_global/index/IndexRequest.ts index d6bd51a8c3..afdb4f3d83 100644 --- a/specification/_global/index/IndexRequest.ts +++ b/specification/_global/index/IndexRequest.ts @@ -33,6 +33,7 @@ import { long } from '@_types/Numeric' import { Duration } from '@_types/Time' /** + * Index a document. * Adds a JSON document to the specified data stream or index and makes it searchable. * If the target is an index and the document already exists, the request updates the document and increments its version. * @rest_spec_name index diff --git a/specification/_global/search_mvt/SearchMvtRequest.ts b/specification/_global/search_mvt/SearchMvtRequest.ts index 5f2657ff2c..275e2b5d46 100644 --- a/specification/_global/search_mvt/SearchMvtRequest.ts +++ b/specification/_global/search_mvt/SearchMvtRequest.ts @@ -31,6 +31,8 @@ import { ZoomLevel } from './_types/ZoomLevel' import { TrackHits } from '@global/search/_types/hits' /** + * Search a vector tile. + * Searches a vector tile for geospatial values. * @rest_spec_name search_mvt * @availability stack since=7.15.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/termvectors/TermVectorsRequest.ts b/specification/_global/termvectors/TermVectorsRequest.ts index d9f5671b96..f0285d63c9 100644 --- a/specification/_global/termvectors/TermVectorsRequest.ts +++ b/specification/_global/termvectors/TermVectorsRequest.ts @@ -31,6 +31,8 @@ import { import { Filter } from './types' /** + * Get term vector information. + * Returns information and statistics about terms in the fields of a particular document. * @rest_spec_name termvectors * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/update/UpdateRequest.ts b/specification/_global/update/UpdateRequest.ts index 68aec710e0..1ff4fd69d1 100644 --- a/specification/_global/update/UpdateRequest.ts +++ b/specification/_global/update/UpdateRequest.ts @@ -36,6 +36,8 @@ import { Script } from '@_types/Scripting' import { Duration } from '@_types/Time' /** + * Update a document. + * Updates a document by running a script or passing a partial document. * @rest_spec_name update * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/cluster/info/ClusterInfoRequest.ts b/specification/cluster/info/ClusterInfoRequest.ts index 4c20ccccbe..216bccfdc8 100644 --- a/specification/cluster/info/ClusterInfoRequest.ts +++ b/specification/cluster/info/ClusterInfoRequest.ts @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base' import { ClusterInfoTargets } from '@_types/common' /** + * Get cluster info. + * Returns basic information about the cluster. * @rest_spec_name cluster.info * @availability stack since=8.9.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/cluster/reroute/ClusterRerouteRequest.ts b/specification/cluster/reroute/ClusterRerouteRequest.ts index 1b07ae501a..161e211c0f 100644 --- a/specification/cluster/reroute/ClusterRerouteRequest.ts +++ b/specification/cluster/reroute/ClusterRerouteRequest.ts @@ -46,7 +46,7 @@ export interface Request extends RequestBase { */ metric?: Metrics /** - * If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + * If true, then retries allocation of shards that are ed due to too many subsequent allocation failures. * @server_default false */ retry_failed?: boolean diff --git a/specification/indices/add_block/IndicesAddBlockRequest.ts b/specification/indices/add_block/IndicesAddBlockRequest.ts index 3f017f72be..07ed793e20 100644 --- a/specification/indices/add_block/IndicesAddBlockRequest.ts +++ b/specification/indices/add_block/IndicesAddBlockRequest.ts @@ -22,6 +22,8 @@ import { ExpandWildcards, IndexName } from '@_types/common' import { Duration } from '@_types/Time' /** + * Add an index block. + * Limits the operations allowed on an index by blocking specific operation types. * @rest_spec_name indices.add_block * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/indices/create/IndicesCreateRequest.ts b/specification/indices/create/IndicesCreateRequest.ts index f8df41fe16..b4dd6380bd 100644 --- a/specification/indices/create/IndicesCreateRequest.ts +++ b/specification/indices/create/IndicesCreateRequest.ts @@ -26,6 +26,7 @@ import { TypeMapping } from '@_types/mapping/TypeMapping' import { Duration } from '@_types/Time' /** + * Create an index. * Creates a new index. * @doc_id indices-create-index * @rest_spec_name indices.create diff --git a/specification/indices/delete/IndicesDeleteRequest.ts b/specification/indices/delete/IndicesDeleteRequest.ts index c57685eac0..dde2510600 100644 --- a/specification/indices/delete/IndicesDeleteRequest.ts +++ b/specification/indices/delete/IndicesDeleteRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common' import { Duration } from '@_types/Time' /** + * Delete indices. * Deletes one or more indices. * @rest_spec_name indices.delete * @availability stack stability=stable diff --git a/specification/indices/delete_alias/IndicesDeleteAliasRequest.ts b/specification/indices/delete_alias/IndicesDeleteAliasRequest.ts index 3fe20a2d57..fca8072253 100644 --- a/specification/indices/delete_alias/IndicesDeleteAliasRequest.ts +++ b/specification/indices/delete_alias/IndicesDeleteAliasRequest.ts @@ -22,6 +22,7 @@ import { Indices, Names } from '@_types/common' import { Duration } from '@_types/Time' /** + * Delete an alias. * Removes a data stream or index from an alias. * @rest_spec_name indices.delete_alias * @availability stack stability=stable diff --git a/specification/indices/exists/IndicesExistsRequest.ts b/specification/indices/exists/IndicesExistsRequest.ts index 69db3abbbd..f44573ffd4 100644 --- a/specification/indices/exists/IndicesExistsRequest.ts +++ b/specification/indices/exists/IndicesExistsRequest.ts @@ -21,7 +21,8 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Indices } from '@_types/common' /** - * Checks if a data stream, index, or alias exists. + * Check indices. + * Checks if one or more indices, index aliases, or data streams exist. * @rest_spec_name indices.exists * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/indices/exists_alias/IndicesExistsAliasRequest.ts b/specification/indices/exists_alias/IndicesExistsAliasRequest.ts index 6310f0a69d..0a1ae9a07a 100644 --- a/specification/indices/exists_alias/IndicesExistsAliasRequest.ts +++ b/specification/indices/exists_alias/IndicesExistsAliasRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Indices, Names } from '@_types/common' /** + * Check aliases. * Checks if an alias exists. * @rest_spec_name indices.exists_alias * @availability stack stability=stable diff --git a/specification/indices/get/IndicesGetRequest.ts b/specification/indices/get/IndicesGetRequest.ts index 28254d06cb..2304bbd2df 100644 --- a/specification/indices/get/IndicesGetRequest.ts +++ b/specification/indices/get/IndicesGetRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get index information. * Returns information about one or more indices. For data streams, the API returns information about the * stream’s backing indices. * @rest_spec_name indices.get diff --git a/specification/indices/get_alias/IndicesGetAliasRequest.ts b/specification/indices/get_alias/IndicesGetAliasRequest.ts index 8a43d2fc66..8b74b74148 100644 --- a/specification/indices/get_alias/IndicesGetAliasRequest.ts +++ b/specification/indices/get_alias/IndicesGetAliasRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Indices, Names } from '@_types/common' /** + * Get alias information. * Retrieves information for one or more aliases. * @rest_spec_name indices.get_alias * @availability stack stability=stable diff --git a/specification/indices/get_settings/IndicesGetSettingsRequest.ts b/specification/indices/get_settings/IndicesGetSettingsRequest.ts index dd4344e791..711694cb5a 100644 --- a/specification/indices/get_settings/IndicesGetSettingsRequest.ts +++ b/specification/indices/get_settings/IndicesGetSettingsRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices, Names } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get index settings. * Returns setting information for one or more indices. For data streams, * returns setting information for the stream’s backing indices. * @rest_spec_name indices.get_settings diff --git a/specification/indices/put_alias/IndicesPutAliasRequest.ts b/specification/indices/put_alias/IndicesPutAliasRequest.ts index 04b7729651..014a5d5ec0 100644 --- a/specification/indices/put_alias/IndicesPutAliasRequest.ts +++ b/specification/indices/put_alias/IndicesPutAliasRequest.ts @@ -23,6 +23,7 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' import { Duration } from '@_types/Time' /** + * Create or update an alias. * Adds a data stream or index to an alias. * @rest_spec_name indices.put_alias * @availability stack stability=stable diff --git a/specification/indices/rollover/IndicesRolloverRequest.ts b/specification/indices/rollover/IndicesRolloverRequest.ts index 6f74c1d7a9..4ab9fb051d 100644 --- a/specification/indices/rollover/IndicesRolloverRequest.ts +++ b/specification/indices/rollover/IndicesRolloverRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' import { RolloverConditions } from './types' /** + * Roll over an index. * Creates a new index for a data stream or index alias. * @doc_id indices-rollover-index * @rest_spec_name indices.rollover diff --git a/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts b/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts index db3c7737fc..47435cad32 100644 --- a/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts +++ b/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' import { Action } from './types' /** + * Update an alias. * Adds a data stream or index to an alias. * @rest_spec_name indices.update_aliases * @availability stack since=1.3.0 stability=stable From abf33091899d66672fc9281e9e819f79c36dd1fe Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Fri, 19 Jul 2024 12:00:15 -0400 Subject: [PATCH 2/4] cleanup --- specification/_global/info/RootNodeInfoRequest.ts | 2 ++ specification/_global/ping/PingRequest.ts | 2 ++ 2 files changed, 4 insertions(+) diff --git a/specification/_global/info/RootNodeInfoRequest.ts b/specification/_global/info/RootNodeInfoRequest.ts index ec501a206c..a0d20dd32b 100644 --- a/specification/_global/info/RootNodeInfoRequest.ts +++ b/specification/_global/info/RootNodeInfoRequest.ts @@ -20,6 +20,8 @@ import { RequestBase } from '@_types/Base' /** + * Get cluster info. + * Returns basic information about the cluster. * @rest_spec_name info * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/ping/PingRequest.ts b/specification/_global/ping/PingRequest.ts index 442050cff8..e8033036f5 100644 --- a/specification/_global/ping/PingRequest.ts +++ b/specification/_global/ping/PingRequest.ts @@ -20,6 +20,8 @@ import { RequestBase } from '@_types/Base' /** + * Ping the cluster. + * Returns whether the cluster is running. * @rest_spec_name ping * @availability stack stability=stable * @availability serverless stability=stable visibility=public From 0d73c511de637c68940b1970ada5d7870d7d8804 Mon Sep 17 00:00:00 2001 From: shainaraskas <58563081+shainaraskas@users.noreply.github.com> Date: Fri, 26 Jul 2024 14:09:48 -0400 Subject: [PATCH 3/4] Update specification/cluster/reroute/ClusterRerouteRequest.ts Co-authored-by: Lisa Cawley --- specification/cluster/reroute/ClusterRerouteRequest.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cluster/reroute/ClusterRerouteRequest.ts b/specification/cluster/reroute/ClusterRerouteRequest.ts index 161e211c0f..1b07ae501a 100644 --- a/specification/cluster/reroute/ClusterRerouteRequest.ts +++ b/specification/cluster/reroute/ClusterRerouteRequest.ts @@ -46,7 +46,7 @@ export interface Request extends RequestBase { */ metric?: Metrics /** - * If true, then retries allocation of shards that are ed due to too many subsequent allocation failures. + * If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. * @server_default false */ retry_failed?: boolean From 54ab8662ca223dd4ede472f0d640da833ebe1a4e Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Fri, 26 Jul 2024 14:12:59 -0400 Subject: [PATCH 4/4] regenerate --- output/openapi/elasticsearch-openapi.json | 95 ++++++++----- .../elasticsearch-serverless-openapi.json | 95 ++++++++----- output/schema/schema.json | 126 +++++++++--------- 3 files changed, 179 insertions(+), 137 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index c1084b7bcb..8f65811816 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -3849,7 +3849,8 @@ "tags": [ "cluster.info" ], - "summary": "Returns different information about the cluster", + "summary": "Get cluster info", + "description": "Returns basic information about the cluster.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-info.html" }, @@ -6152,8 +6153,8 @@ "tags": [ "create" ], - "summary": "Adds a JSON document to the specified data stream or index and makes it searchable", - "description": "If the target is an index and the document already exists, the request updates the document and increments its version.", + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, @@ -6201,8 +6202,8 @@ "tags": [ "create" ], - "summary": "Adds a JSON document to the specified data stream or index and makes it searchable", - "description": "If the target is an index and the document already exists, the request updates the document and increments its version.", + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, @@ -6424,7 +6425,8 @@ "tags": [ "get" ], - "summary": "Returns a document", + "summary": "Get a document by its ID", + "description": "Retrieves the document with the specified ID from an index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" }, @@ -6580,8 +6582,8 @@ "tags": [ "index" ], - "summary": "Adds a JSON document to the specified data stream or index and makes it searchable", - "description": "If the target is an index and the document already exists, the request updates the document and increments its version.", + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, @@ -6640,8 +6642,8 @@ "tags": [ "index" ], - "summary": "Adds a JSON document to the specified data stream or index and makes it searchable", - "description": "If the target is an index and the document already exists, the request updates the document and increments its version.", + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, @@ -6700,7 +6702,8 @@ "tags": [ "delete" ], - "summary": "Removes a JSON document from the specified index", + "summary": "Delete a document", + "description": "Removes a JSON document from the specified index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html" }, @@ -6826,7 +6829,8 @@ "tags": [ "exists" ], - "summary": "Checks if a document in an index exists", + "summary": "Check a document", + "description": "Checks if a specified document exists.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" }, @@ -8202,7 +8206,8 @@ "tags": [ "get_source" ], - "summary": "Returns the source of a document", + "summary": "Get a document's source", + "description": "Returns the source of a document.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" }, @@ -8347,7 +8352,8 @@ "tags": [ "exists_source" ], - "summary": "Checks if a document's `_source` is stored", + "summary": "Check for a document source", + "description": "Checks if a document's `_source` is stored.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" }, @@ -8482,7 +8488,8 @@ "tags": [ "explain" ], - "summary": "Returns information about why a specific document matches (or doesn’t match) a query", + "summary": "Explain a document match result", + "description": "Returns information about why a specific document matches, or doesn’t match, a query.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html" }, @@ -8544,7 +8551,8 @@ "tags": [ "explain" ], - "summary": "Returns information about why a specific document matches (or doesn’t match) a query", + "summary": "Explain a document match result", + "description": "Returns information about why a specific document matches, or doesn’t match, a query.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html" }, @@ -10376,8 +10384,8 @@ "tags": [ "index" ], - "summary": "Adds a JSON document to the specified data stream or index and makes it searchable", - "description": "If the target is an index and the document already exists, the request updates the document and increments its version.", + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, @@ -10435,7 +10443,8 @@ "tags": [ "indices.add_block" ], - "summary": "Adds a block to an index", + "summary": "Add an index block", + "description": "Limits the operations allowed on an index by blocking specific operation types.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html" }, @@ -10914,8 +10923,8 @@ "tags": [ "indices.get" ], - "summary": "Returns information about one or more indices", - "description": "For data streams, the API returns information about the\nstream’s backing indices.", + "summary": "Get index information", + "description": "Returns information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html" }, @@ -11033,7 +11042,8 @@ "tags": [ "indices.create" ], - "summary": "Creates a new index", + "summary": "Create an index", + "description": "Creates a new index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html" }, @@ -11138,7 +11148,8 @@ "tags": [ "indices.delete" ], - "summary": "Deletes one or more indices", + "summary": "Delete indices", + "description": "Deletes one or more indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html" }, @@ -11223,7 +11234,8 @@ "tags": [ "indices.exists" ], - "summary": "Checks if a data stream, index, or alias exists", + "summary": "Check indices", + "description": "Checks if one or more indices, index aliases, or data streams exist.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html" }, @@ -11583,7 +11595,8 @@ "tags": [ "indices.delete_alias" ], - "summary": "Removes a data stream or index from an alias", + "summary": "Delete an alias", + "description": "Removes a data stream or index from an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -11716,7 +11729,8 @@ "tags": [ "indices.delete_alias" ], - "summary": "Removes a data stream or index from an alias", + "summary": "Delete an alias", + "description": "Removes a data stream or index from an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -15654,7 +15668,8 @@ "tags": [ "info" ], - "summary": "Returns basic information about the cluster", + "summary": "Get cluster info", + "description": "Returns basic information about the cluster.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" }, @@ -15700,7 +15715,8 @@ "tags": [ "ping" ], - "summary": "Returns whether the cluster is running", + "summary": "Ping the cluster", + "description": "Returns whether the cluster is running.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" }, @@ -27343,8 +27359,8 @@ "tags": [ "search_mvt" ], - "summary": "Searches a vector tile for geospatial values", - "description": "Returns results as a binary Mapbox vector tile.", + "summary": "Search a vector tile", + "description": "Searches a vector tile for geospatial values.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html" }, @@ -27401,8 +27417,8 @@ "tags": [ "search_mvt" ], - "summary": "Searches a vector tile for geospatial values", - "description": "Returns results as a binary Mapbox vector tile.", + "summary": "Search a vector tile", + "description": "Searches a vector tile for geospatial values.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html" }, @@ -34313,7 +34329,8 @@ "tags": [ "termvectors" ], - "summary": "Returns information and statistics about terms in the fields of a particular document", + "summary": "Get term vector information", + "description": "Returns information and statistics about terms in the fields of a particular document.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html" }, @@ -34372,7 +34389,8 @@ "tags": [ "termvectors" ], - "summary": "Returns information and statistics about terms in the fields of a particular document", + "summary": "Get term vector information", + "description": "Returns information and statistics about terms in the fields of a particular document.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html" }, @@ -34433,7 +34451,8 @@ "tags": [ "termvectors" ], - "summary": "Returns information and statistics about terms in the fields of a particular document", + "summary": "Get term vector information", + "description": "Returns information and statistics about terms in the fields of a particular document.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html" }, @@ -34489,7 +34508,8 @@ "tags": [ "termvectors" ], - "summary": "Returns information and statistics about terms in the fields of a particular document", + "summary": "Get term vector information", + "description": "Returns information and statistics about terms in the fields of a particular document.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html" }, @@ -35793,7 +35813,8 @@ "tags": [ "update" ], - "summary": "Updates a document with a script or partial document", + "summary": "Update a document", + "description": "Updates a document by running a script or passing a partial document.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html" }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 6ae0d12d12..c39474a0ef 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -1767,7 +1767,8 @@ "tags": [ "cluster.info" ], - "summary": "Returns different information about the cluster", + "summary": "Get cluster info", + "description": "Returns basic information about the cluster.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-info.html" }, @@ -3567,8 +3568,8 @@ "tags": [ "create" ], - "summary": "Adds a JSON document to the specified data stream or index and makes it searchable", - "description": "If the target is an index and the document already exists, the request updates the document and increments its version.", + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, @@ -3616,8 +3617,8 @@ "tags": [ "create" ], - "summary": "Adds a JSON document to the specified data stream or index and makes it searchable", - "description": "If the target is an index and the document already exists, the request updates the document and increments its version.", + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, @@ -3667,7 +3668,8 @@ "tags": [ "get" ], - "summary": "Returns a document", + "summary": "Get a document by its ID", + "description": "Retrieves the document with the specified ID from an index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" }, @@ -3813,8 +3815,8 @@ "tags": [ "index" ], - "summary": "Adds a JSON document to the specified data stream or index and makes it searchable", - "description": "If the target is an index and the document already exists, the request updates the document and increments its version.", + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, @@ -3873,8 +3875,8 @@ "tags": [ "index" ], - "summary": "Adds a JSON document to the specified data stream or index and makes it searchable", - "description": "If the target is an index and the document already exists, the request updates the document and increments its version.", + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, @@ -3933,7 +3935,8 @@ "tags": [ "delete" ], - "summary": "Removes a JSON document from the specified index", + "summary": "Delete a document", + "description": "Removes a JSON document from the specified index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html" }, @@ -4059,7 +4062,8 @@ "tags": [ "exists" ], - "summary": "Checks if a document in an index exists", + "summary": "Check a document", + "description": "Checks if a specified document exists.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" }, @@ -5387,7 +5391,8 @@ "tags": [ "get_source" ], - "summary": "Returns the source of a document", + "summary": "Get a document's source", + "description": "Returns the source of a document.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" }, @@ -5532,7 +5537,8 @@ "tags": [ "exists_source" ], - "summary": "Checks if a document's `_source` is stored", + "summary": "Check for a document source", + "description": "Checks if a document's `_source` is stored.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" }, @@ -5667,7 +5673,8 @@ "tags": [ "explain" ], - "summary": "Returns information about why a specific document matches (or doesn’t match) a query", + "summary": "Explain a document match result", + "description": "Returns information about why a specific document matches, or doesn’t match, a query.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html" }, @@ -5729,7 +5736,8 @@ "tags": [ "explain" ], - "summary": "Returns information about why a specific document matches (or doesn’t match) a query", + "summary": "Explain a document match result", + "description": "Returns information about why a specific document matches, or doesn’t match, a query.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html" }, @@ -6047,8 +6055,8 @@ "tags": [ "index" ], - "summary": "Adds a JSON document to the specified data stream or index and makes it searchable", - "description": "If the target is an index and the document already exists, the request updates the document and increments its version.", + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, @@ -6106,7 +6114,8 @@ "tags": [ "indices.add_block" ], - "summary": "Adds a block to an index", + "summary": "Add an index block", + "description": "Limits the operations allowed on an index by blocking specific operation types.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html" }, @@ -6310,8 +6319,8 @@ "tags": [ "indices.get" ], - "summary": "Returns information about one or more indices", - "description": "For data streams, the API returns information about the\nstream’s backing indices.", + "summary": "Get index information", + "description": "Returns information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html" }, @@ -6429,7 +6438,8 @@ "tags": [ "indices.create" ], - "summary": "Creates a new index", + "summary": "Create an index", + "description": "Creates a new index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html" }, @@ -6534,7 +6544,8 @@ "tags": [ "indices.delete" ], - "summary": "Deletes one or more indices", + "summary": "Delete indices", + "description": "Deletes one or more indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html" }, @@ -6619,7 +6630,8 @@ "tags": [ "indices.exists" ], - "summary": "Checks if a data stream, index, or alias exists", + "summary": "Check indices", + "description": "Checks if one or more indices, index aliases, or data streams exist.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html" }, @@ -6979,7 +6991,8 @@ "tags": [ "indices.delete_alias" ], - "summary": "Removes a data stream or index from an alias", + "summary": "Delete an alias", + "description": "Removes a data stream or index from an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -7112,7 +7125,8 @@ "tags": [ "indices.delete_alias" ], - "summary": "Removes a data stream or index from an alias", + "summary": "Delete an alias", + "description": "Removes a data stream or index from an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -9371,7 +9385,8 @@ "tags": [ "info" ], - "summary": "Returns basic information about the cluster", + "summary": "Get cluster info", + "description": "Returns basic information about the cluster.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" }, @@ -9417,7 +9432,8 @@ "tags": [ "ping" ], - "summary": "Returns whether the cluster is running", + "summary": "Ping the cluster", + "description": "Returns whether the cluster is running.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" }, @@ -17247,8 +17263,8 @@ "tags": [ "search_mvt" ], - "summary": "Searches a vector tile for geospatial values", - "description": "Returns results as a binary Mapbox vector tile.", + "summary": "Search a vector tile", + "description": "Searches a vector tile for geospatial values.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html" }, @@ -17305,8 +17321,8 @@ "tags": [ "search_mvt" ], - "summary": "Searches a vector tile for geospatial values", - "description": "Returns results as a binary Mapbox vector tile.", + "summary": "Search a vector tile", + "description": "Searches a vector tile for geospatial values.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html" }, @@ -19085,7 +19101,8 @@ "tags": [ "termvectors" ], - "summary": "Returns information and statistics about terms in the fields of a particular document", + "summary": "Get term vector information", + "description": "Returns information and statistics about terms in the fields of a particular document.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html" }, @@ -19144,7 +19161,8 @@ "tags": [ "termvectors" ], - "summary": "Returns information and statistics about terms in the fields of a particular document", + "summary": "Get term vector information", + "description": "Returns information and statistics about terms in the fields of a particular document.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html" }, @@ -19205,7 +19223,8 @@ "tags": [ "termvectors" ], - "summary": "Returns information and statistics about terms in the fields of a particular document", + "summary": "Get term vector information", + "description": "Returns information and statistics about terms in the fields of a particular document.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html" }, @@ -19261,7 +19280,8 @@ "tags": [ "termvectors" ], - "summary": "Returns information and statistics about terms in the fields of a particular document", + "summary": "Get term vector information", + "description": "Returns information and statistics about terms in the fields of a particular document.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html" }, @@ -20162,7 +20182,8 @@ "tags": [ "update" ], - "summary": "Updates a document with a script or partial document", + "summary": "Update a document", + "description": "Updates a document by running a script or passing a partial document.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html" }, diff --git a/output/schema/schema.json b/output/schema/schema.json index 8d7da9b92b..6643d4998b 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -2515,7 +2515,7 @@ "stability": "stable" } }, - "description": "Returns different information about the cluster.", + "description": "Get cluster info.\nReturns basic information about the cluster.", "docId": "cluster-info", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-info.html", "name": "cluster.info", @@ -4117,7 +4117,7 @@ "stability": "stable" } }, - "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", + "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "name": "create", "request": { @@ -4248,7 +4248,7 @@ "stability": "stable" } }, - "description": "Removes a JSON document from the specified index.", + "description": "Delete a document.\nRemoves a JSON document from the specified index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html", "name": "delete", "request": { @@ -4809,7 +4809,7 @@ "stability": "stable" } }, - "description": "Checks if a document in an index exists.", + "description": "Check a document.\nChecks if a specified document exists.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "exists", "request": { @@ -4844,7 +4844,7 @@ "stability": "stable" } }, - "description": "Checks if a document's `_source` is stored.", + "description": "Check for a document source.\nChecks if a document's `_source` is stored.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "exists_source", "request": { @@ -4878,7 +4878,7 @@ "stability": "stable" } }, - "description": "Returns information about why a specific document matches (or doesn’t match) a query.", + "description": "Explain a document match result.\nReturns information about why a specific document matches, or doesn’t match, a query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html", "name": "explain", "request": { @@ -5243,7 +5243,7 @@ "stability": "stable" } }, - "description": "Returns a document.", + "description": "Get a document by its ID.\nRetrieves the document with the specified ID from an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "get", "request": { @@ -5371,7 +5371,7 @@ "stability": "stable" } }, - "description": "Returns the source of a document.", + "description": "Get a document's source.\nReturns the source of a document.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "get_source", "request": { @@ -5866,7 +5866,7 @@ "stability": "stable" } }, - "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", + "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "name": "index", "request": { @@ -5911,7 +5911,7 @@ "stability": "stable" } }, - "description": "Adds a block to an index.", + "description": "Add an index block.\nLimits the operations allowed on an index by blocking specific operation types.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", "name": "indices.add_block", "request": { @@ -6101,7 +6101,7 @@ "stability": "stable" } }, - "description": "Creates a new index.", + "description": "Create an index.\nCreates a new index.", "docId": "indices-create-index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-index.html", "name": "indices.create", @@ -6231,7 +6231,7 @@ "stability": "stable" } }, - "description": "Deletes one or more indices.", + "description": "Delete indices.\nDeletes one or more indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html", "name": "indices.delete", "request": { @@ -6265,7 +6265,7 @@ "stability": "stable" } }, - "description": "Removes a data stream or index from an alias.", + "description": "Delete an alias.\nRemoves a data stream or index from an alias.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.delete_alias", "request": { @@ -6532,7 +6532,7 @@ "stability": "stable" } }, - "description": "Checks if a data stream, index, or alias exists.", + "description": "Check indices.\nChecks if one or more indices, index aliases, or data streams exist.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html", "name": "indices.exists", "request": { @@ -6829,7 +6829,7 @@ "stability": "stable" } }, - "description": "Returns information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", + "description": "Get index information.\nReturns information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html", "name": "indices.get", "privileges": { @@ -8424,7 +8424,7 @@ "stability": "stable" } }, - "description": "Returns basic information about the cluster.", + "description": "Get cluster info.\nReturns basic information about the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "name": "info", "request": { @@ -13142,7 +13142,7 @@ "stability": "stable" } }, - "description": "Returns whether the cluster is running.", + "description": "Ping the cluster.\nReturns whether the cluster is running.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "name": "ping", "request": { @@ -14511,7 +14511,7 @@ "stability": "stable" } }, - "description": "Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.", + "description": "Search a vector tile.\nSearches a vector tile for geospatial values.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html", "name": "search_mvt", "request": { @@ -18743,7 +18743,7 @@ "stability": "stable" } }, - "description": "Returns information and statistics about terms in the fields of a particular document.", + "description": "Get term vector information.\nReturns information and statistics about terms in the fields of a particular document.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html", "name": "termvectors", "request": { @@ -19436,7 +19436,7 @@ "stability": "stable" } }, - "description": "Updates a document with a script or partial document.", + "description": "Update a document.\nUpdates a document by running a script or passing a partial document.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html", "name": "update", "request": { @@ -21421,7 +21421,7 @@ } } }, - "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", + "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "generics": [ { "name": "TDocument", @@ -21554,7 +21554,7 @@ } } ], - "specLocation": "_global/create/CreateRequest.ts#L32-L95" + "specLocation": "_global/create/CreateRequest.ts#L32-L96" }, { "body": { @@ -21581,7 +21581,7 @@ "body": { "kind": "no_body" }, - "description": "Removes a JSON document from the specified index.", + "description": "Delete a document.\nRemoves a JSON document from the specified index.", "inherits": { "type": { "name": "RequestBase", @@ -21720,7 +21720,7 @@ } } ], - "specLocation": "_global/delete/DeleteRequest.ts#L34-L91" + "specLocation": "_global/delete/DeleteRequest.ts#L34-L92" }, { "body": { @@ -22586,7 +22586,7 @@ "body": { "kind": "no_body" }, - "description": "Checks if a document in an index exists.", + "description": "Check a document.\nChecks if a specified document exists.", "inherits": { "type": { "name": "RequestBase", @@ -22752,7 +22752,7 @@ } } ], - "specLocation": "_global/exists/DocumentExistsRequest.ts#L31-L99" + "specLocation": "_global/exists/DocumentExistsRequest.ts#L31-L100" }, { "body": { @@ -22772,7 +22772,7 @@ "body": { "kind": "no_body" }, - "description": "Checks if a document's `_source` is stored.", + "description": "Check for a document source.\nChecks if a document's `_source` is stored.", "inherits": { "type": { "name": "RequestBase", @@ -22926,7 +22926,7 @@ } } ], - "specLocation": "_global/exists_source/SourceExistsRequest.ts#L31-L93" + "specLocation": "_global/exists_source/SourceExistsRequest.ts#L31-L94" }, { "body": { @@ -23052,7 +23052,7 @@ } ] }, - "description": "Returns information about why a specific document matches (or doesn’t match) a query.", + "description": "Explain a document match result.\nReturns information about why a specific document matches, or doesn’t match, a query.", "inherits": { "type": { "name": "RequestBase", @@ -23239,7 +23239,7 @@ } } ], - "specLocation": "_global/explain/ExplainRequest.ts#L26-L105" + "specLocation": "_global/explain/ExplainRequest.ts#L26-L106" }, { "body": { @@ -23918,7 +23918,7 @@ "body": { "kind": "no_body" }, - "description": "Returns a document.", + "description": "Get a document by its ID.\nRetrieves the document with the specified ID from an index.", "inherits": { "type": { "name": "RequestBase", @@ -24103,7 +24103,7 @@ } } ], - "specLocation": "_global/get/GetRequest.ts#L31-L98" + "specLocation": "_global/get/GetRequest.ts#L31-L100" }, { "body": { @@ -24540,7 +24540,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the source of a document.", + "description": "Get a document's source.\nReturns the source of a document.", "inherits": { "type": { "name": "RequestBase", @@ -24704,7 +24704,7 @@ } } ], - "specLocation": "_global/get_source/SourceRequest.ts#L31-L86" + "specLocation": "_global/get_source/SourceRequest.ts#L31-L88" }, { "body": { @@ -26082,7 +26082,7 @@ } } }, - "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", + "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "generics": [ { "name": "TDocument", @@ -26263,7 +26263,7 @@ } } ], - "specLocation": "_global/index/IndexRequest.ts#L35-L117" + "specLocation": "_global/index/IndexRequest.ts#L35-L118" }, { "body": { @@ -26290,7 +26290,7 @@ "body": { "kind": "no_body" }, - "description": "Returns basic information about the cluster.", + "description": "Get cluster info.\nReturns basic information about the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -26304,7 +26304,7 @@ }, "path": [], "query": [], - "specLocation": "_global/info/RootNodeInfoRequest.ts#L22-L27" + "specLocation": "_global/info/RootNodeInfoRequest.ts#L22-L29" }, { "body": { @@ -29008,7 +29008,7 @@ "body": { "kind": "no_body" }, - "description": "Returns whether the cluster is running.", + "description": "Ping the cluster.\nReturns whether the cluster is running.", "inherits": { "type": { "name": "RequestBase", @@ -29022,7 +29022,7 @@ }, "path": [], "query": [], - "specLocation": "_global/ping/PingRequest.ts#L22-L27" + "specLocation": "_global/ping/PingRequest.ts#L22-L29" }, { "body": { @@ -37804,7 +37804,7 @@ } ] }, - "description": "Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.", + "description": "Search a vector tile.\nSearches a vector tile for geospatial values.", "inherits": { "type": { "name": "RequestBase", @@ -37969,7 +37969,7 @@ } } ], - "specLocation": "_global/search_mvt/SearchMvtRequest.ts#L33-L188" + "specLocation": "_global/search_mvt/SearchMvtRequest.ts#L33-L190" }, { "body": { @@ -39156,7 +39156,7 @@ } ] }, - "description": "Returns information and statistics about terms in the fields of a particular document.", + "description": "Get term vector information.\nReturns information and statistics about terms in the fields of a particular document.", "generics": [ { "name": "TDocument", @@ -39342,7 +39342,7 @@ } } ], - "specLocation": "_global/termvectors/TermVectorsRequest.ts#L33-L118" + "specLocation": "_global/termvectors/TermVectorsRequest.ts#L33-L120" }, { "body": { @@ -39696,7 +39696,7 @@ } ] }, - "description": "Updates a document with a script or partial document.", + "description": "Update a document.\nUpdates a document by running a script or passing a partial document.", "generics": [ { "name": "TDocument", @@ -39897,7 +39897,7 @@ } } ], - "specLocation": "_global/update/UpdateRequest.ts#L38-L151" + "specLocation": "_global/update/UpdateRequest.ts#L38-L153" }, { "body": { @@ -102489,7 +102489,7 @@ "body": { "kind": "no_body" }, - "description": "Returns different information about the cluster.", + "description": "Get cluster info.\nReturns basic information about the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -102516,7 +102516,7 @@ } ], "query": [], - "specLocation": "cluster/info/ClusterInfoRequest.ts#L23-L34" + "specLocation": "cluster/info/ClusterInfoRequest.ts#L23-L36" }, { "body": { @@ -121540,7 +121540,7 @@ "name": "IndicesBlockOptions", "namespace": "indices.add_block" }, - "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L43-L48" + "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L45-L50" }, { "kind": "interface", @@ -121581,7 +121581,7 @@ "body": { "kind": "no_body" }, - "description": "Adds a block to an index.", + "description": "Add an index block.\nLimits the operations allowed on an index by blocking specific operation types.", "inherits": { "type": { "name": "RequestBase", @@ -121681,7 +121681,7 @@ } } ], - "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L24-L41" + "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L24-L43" }, { "body": { @@ -122977,7 +122977,7 @@ } ] }, - "description": "Creates a new index.", + "description": "Create an index.\nCreates a new index.", "inherits": { "type": { "name": "RequestBase", @@ -123044,7 +123044,7 @@ } } ], - "specLocation": "indices/create/IndicesCreateRequest.ts#L28-L81" + "specLocation": "indices/create/IndicesCreateRequest.ts#L28-L82" }, { "body": { @@ -123370,7 +123370,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes one or more indices.", + "description": "Delete indices.\nDeletes one or more indices.", "inherits": { "type": { "name": "RequestBase", @@ -123463,7 +123463,7 @@ } } ], - "specLocation": "indices/delete/IndicesDeleteRequest.ts#L24-L73" + "specLocation": "indices/delete/IndicesDeleteRequest.ts#L24-L74" }, { "body": { @@ -123490,7 +123490,7 @@ "body": { "kind": "no_body" }, - "description": "Removes a data stream or index from an alias.", + "description": "Delete an alias.\nRemoves a data stream or index from an alias.", "inherits": { "type": { "name": "RequestBase", @@ -123556,7 +123556,7 @@ } } ], - "specLocation": "indices/delete_alias/IndicesDeleteAliasRequest.ts#L24-L57" + "specLocation": "indices/delete_alias/IndicesDeleteAliasRequest.ts#L24-L58" }, { "body": { @@ -124090,7 +124090,7 @@ "body": { "kind": "no_body" }, - "description": "Checks if a data stream, index, or alias exists.", + "description": "Check indices.\nChecks if one or more indices, index aliases, or data streams exist.", "inherits": { "type": { "name": "RequestBase", @@ -124196,7 +124196,7 @@ } } ], - "specLocation": "indices/exists/IndicesExistsRequest.ts#L23-L72" + "specLocation": "indices/exists/IndicesExistsRequest.ts#L23-L73" }, { "body": { @@ -125503,7 +125503,7 @@ "name": "Feature", "namespace": "indices.get" }, - "specLocation": "indices/get/IndicesGetRequest.ts#L90-L94" + "specLocation": "indices/get/IndicesGetRequest.ts#L91-L95" }, { "kind": "type_alias", @@ -125511,7 +125511,7 @@ "name": "Features", "namespace": "indices.get" }, - "specLocation": "indices/get/IndicesGetRequest.ts#L95-L95", + "specLocation": "indices/get/IndicesGetRequest.ts#L96-L96", "type": { "items": [ { @@ -125542,7 +125542,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", + "description": "Get index information.\nReturns information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -125680,7 +125680,7 @@ } } ], - "specLocation": "indices/get/IndicesGetRequest.ts#L24-L88" + "specLocation": "indices/get/IndicesGetRequest.ts#L24-L89" }, { "body": {