From 67591e6e893f60c2e9a09528816947ae6e5fa97a Mon Sep 17 00:00:00 2001 From: Florian Bernd Date: Wed, 23 Oct 2024 13:28:32 +0200 Subject: [PATCH 1/5] Add `max_sample_per_keys` to `EqlSearchRequest` (#3041) --- specification/eql/search/EqlSearchRequest.ts | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/specification/eql/search/EqlSearchRequest.ts b/specification/eql/search/EqlSearchRequest.ts index 99d661d673..efb4fea993 100644 --- a/specification/eql/search/EqlSearchRequest.ts +++ b/specification/eql/search/EqlSearchRequest.ts @@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Field, Indices } from '@_types/common' import { RuntimeFields } from '@_types/mapping/RuntimeFields' -import { uint } from '@_types/Numeric' +import { integer, uint } from '@_types/Numeric' import { FieldAndFormat, QueryContainer } from '@_types/query_dsl/abstractions' import { Duration } from '@_types/Time' import { ResultPosition } from './types' @@ -114,5 +114,12 @@ export interface Request extends RequestBase { * @availability serverless */ runtime_mappings?: RuntimeFields + /** + * By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size` + * parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the + * `max_samples_per_key` parameter. Pipes are not supported for sample queries. + * @server_default 1 + */ + max_samples_per_key?: integer } } From 16130b9a2f165a445d3201043ea47278eed1c164 Mon Sep 17 00:00:00 2001 From: Florian Bernd Date: Wed, 23 Oct 2024 13:28:39 +0200 Subject: [PATCH 2/5] Fix additional property name for `TermsQuery` (#3038) --- specification/_types/query_dsl/term.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/_types/query_dsl/term.ts b/specification/_types/query_dsl/term.ts index 1dc362165b..2bcc2bd41e 100644 --- a/specification/_types/query_dsl/term.ts +++ b/specification/_types/query_dsl/term.ts @@ -255,7 +255,7 @@ export class TermQuery extends QueryBase { } /** - * @behavior_meta AdditionalProperty key=field value=term + * @behavior_meta AdditionalProperty key=field value=terms * @ext_doc_id query-dsl-terms-query */ export class TermsQuery From d3cf5bc9e07facc0b7b693797a94e820b3361756 Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Wed, 23 Oct 2024 11:29:56 +0000 Subject: [PATCH 3/5] Update specification output --- output/openapi/elasticsearch-openapi.json | 4 ++++ .../elasticsearch-serverless-openapi.json | 4 ++++ output/schema/schema-serverless.json | 17 +++++++++++++++-- output/schema/schema.json | 17 +++++++++++++++-- output/typescript/types.ts | 1 + 5 files changed, 39 insertions(+), 4 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index be06e8e079..973f077103 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -101368,6 +101368,10 @@ }, "runtime_mappings": { "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "max_samples_per_key": { + "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.", + "type": "number" } }, "required": [ diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 2e4c9f2fa5..f9f1f0a3ce 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -61886,6 +61886,10 @@ }, "runtime_mappings": { "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "max_samples_per_key": { + "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.", + "type": "number" } }, "required": [ diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 911bde3990..31d9b2b8c6 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -17375,6 +17375,19 @@ "namespace": "_types.mapping" } } + }, + { + "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.", + "name": "max_samples_per_key", + "required": false, + "serverDefault": 1, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } ] }, @@ -17481,7 +17494,7 @@ } } ], - "specLocation": "eql/search/EqlSearchRequest.ts#L28-L118" + "specLocation": "eql/search/EqlSearchRequest.ts#L28-L125" }, { "body": { @@ -58080,7 +58093,7 @@ ], "meta": { "key": "field", - "value": "term" + "value": "terms" }, "type": { "name": "AdditionalProperty", diff --git a/output/schema/schema.json b/output/schema/schema.json index 09518e42d5..420eea7f91 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -86034,7 +86034,7 @@ ], "meta": { "key": "field", - "value": "term" + "value": "terms" }, "type": { "name": "AdditionalProperty", @@ -117374,6 +117374,19 @@ "namespace": "_types.mapping" } } + }, + { + "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.", + "name": "max_samples_per_key", + "required": false, + "serverDefault": 1, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } ] }, @@ -117479,7 +117492,7 @@ } } ], - "specLocation": "eql/search/EqlSearchRequest.ts#L28-L118" + "specLocation": "eql/search/EqlSearchRequest.ts#L28-L125" }, { "kind": "response", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 58fe8c541d..586a24ea70 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -10328,6 +10328,7 @@ export interface EqlSearchRequest extends RequestBase { fields?: QueryDslFieldAndFormat | Field | (QueryDslFieldAndFormat | Field)[] result_position?: EqlSearchResultPosition runtime_mappings?: MappingRuntimeFields + max_samples_per_key?: integer } } From bfbe862fceb2dc6c4d3379646885f1efd650fdcd Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Wed, 23 Oct 2024 07:45:43 -0700 Subject: [PATCH 4/5] [OpenAPI] Edit mget, multi term vectors, and terms enum APIs (#3052) --- .../elasticsearch-shared-overlays.yaml | 8 --- output/openapi/elasticsearch-openapi.json | 53 +++++++++++-------- .../elasticsearch-serverless-openapi.json | 40 ++++++++------ output/schema/schema.json | 34 ++++++------ .../DeleteByQueryRethrottleRequest.ts | 5 ++ specification/_global/mget/MultiGetRequest.ts | 6 +++ .../mtermvectors/MultiTermVectorsRequest.ts | 7 +++ .../ReindexRethrottleRequest.ts | 4 +- .../UpdateByQueryRethrottleRequest.ts | 5 ++ 9 files changed, 101 insertions(+), 61 deletions(-) diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index 6150292046..077dab496c 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -55,14 +55,6 @@ actions: externalDocs: description: Reading and writing documents url: https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-replication.html - - name: mget - x-displayName: Document - Multi get - - name: mtermvectors - x-displayName: Document - Multi term vectors - - name: delete_by_query_rethrottle - x-displayName: Document - Rethrottle delete by query - - name: update_by_query_rethrottle - x-displayName: Document - Rethrottle update by query # E - name: enrich x-displayName: Enrich diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 973f077103..2254d2d6cb 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -6950,9 +6950,10 @@ "/_delete_by_query/{task_id}/_rethrottle": { "post": { "tags": [ - "delete_by_query_rethrottle" + "document" ], - "summary": "Changes the number of requests per second for a particular Delete By Query operation", + "summary": "Throttle a delete by query operation", + "description": "Change the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", "operationId": "delete-by-query-rethrottle", "parameters": [ { @@ -15904,9 +15905,10 @@ "/_mget": { "get": { "tags": [ - "mget" + "document" ], - "summary": "Allows to get multiple documents in one request", + "summary": "Get multiple documents", + "description": "Get multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "operationId": "mget", "parameters": [ { @@ -15949,9 +15951,10 @@ }, "post": { "tags": [ - "mget" + "document" ], - "summary": "Allows to get multiple documents in one request", + "summary": "Get multiple documents", + "description": "Get multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "operationId": "mget-1", "parameters": [ { @@ -15996,9 +15999,10 @@ "/{index}/_mget": { "get": { "tags": [ - "mget" + "document" ], - "summary": "Allows to get multiple documents in one request", + "summary": "Get multiple documents", + "description": "Get multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "operationId": "mget-2", "parameters": [ { @@ -16044,9 +16048,10 @@ }, "post": { "tags": [ - "mget" + "document" ], - "summary": "Allows to get multiple documents in one request", + "summary": "Get multiple documents", + "description": "Get multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "operationId": "mget-3", "parameters": [ { @@ -22674,9 +22679,10 @@ "/_mtermvectors": { "get": { "tags": [ - "mtermvectors" + "document" ], - "summary": "Returns multiple termvectors in one request", + "summary": "Get multiple term vectors", + "description": "You can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "operationId": "mtermvectors", "parameters": [ { @@ -22727,9 +22733,10 @@ }, "post": { "tags": [ - "mtermvectors" + "document" ], - "summary": "Returns multiple termvectors in one request", + "summary": "Get multiple term vectors", + "description": "You can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "operationId": "mtermvectors-1", "parameters": [ { @@ -22782,9 +22789,10 @@ "/{index}/_mtermvectors": { "get": { "tags": [ - "mtermvectors" + "document" ], - "summary": "Returns multiple termvectors in one request", + "summary": "Get multiple term vectors", + "description": "You can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "operationId": "mtermvectors-2", "parameters": [ { @@ -22838,9 +22846,10 @@ }, "post": { "tags": [ - "mtermvectors" + "document" ], - "summary": "Returns multiple termvectors in one request", + "summary": "Get multiple term vectors", + "description": "You can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "operationId": "mtermvectors-3", "parameters": [ { @@ -24500,7 +24509,8 @@ "tags": [ "document" ], - "summary": "Copies documents from a source to a destination", + "summary": "Throttle a reindex operation", + "description": "Change the number of requests per second for a particular reindex operation.", "operationId": "reindex-rethrottle", "parameters": [ { @@ -34856,9 +34866,10 @@ "/_update_by_query/{task_id}/_rethrottle": { "post": { "tags": [ - "update_by_query_rethrottle" + "document" ], - "summary": "Changes the number of requests per second for a particular Update By Query operation", + "summary": "Throttle an update by query operation", + "description": "Change the number of requests per second for a particular update by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", "operationId": "update-by-query-rethrottle", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index f9f1f0a3ce..965c6cb8ca 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -9234,9 +9234,10 @@ "/_mget": { "get": { "tags": [ - "mget" + "document" ], - "summary": "Allows to get multiple documents in one request", + "summary": "Get multiple documents", + "description": "Get multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "operationId": "mget", "parameters": [ { @@ -9276,9 +9277,10 @@ }, "post": { "tags": [ - "mget" + "document" ], - "summary": "Allows to get multiple documents in one request", + "summary": "Get multiple documents", + "description": "Get multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "operationId": "mget-1", "parameters": [ { @@ -9320,9 +9322,10 @@ "/{index}/_mget": { "get": { "tags": [ - "mget" + "document" ], - "summary": "Allows to get multiple documents in one request", + "summary": "Get multiple documents", + "description": "Get multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "operationId": "mget-2", "parameters": [ { @@ -9365,9 +9368,10 @@ }, "post": { "tags": [ - "mget" + "document" ], - "summary": "Allows to get multiple documents in one request", + "summary": "Get multiple documents", + "description": "Get multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "operationId": "mget-3", "parameters": [ { @@ -14003,9 +14007,10 @@ "/_mtermvectors": { "get": { "tags": [ - "mtermvectors" + "document" ], - "summary": "Returns multiple termvectors in one request", + "summary": "Get multiple term vectors", + "description": "You can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "operationId": "mtermvectors", "parameters": [ { @@ -14056,9 +14061,10 @@ }, "post": { "tags": [ - "mtermvectors" + "document" ], - "summary": "Returns multiple termvectors in one request", + "summary": "Get multiple term vectors", + "description": "You can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "operationId": "mtermvectors-1", "parameters": [ { @@ -14111,9 +14117,10 @@ "/{index}/_mtermvectors": { "get": { "tags": [ - "mtermvectors" + "document" ], - "summary": "Returns multiple termvectors in one request", + "summary": "Get multiple term vectors", + "description": "You can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "operationId": "mtermvectors-2", "parameters": [ { @@ -14167,9 +14174,10 @@ }, "post": { "tags": [ - "mtermvectors" + "document" ], - "summary": "Returns multiple termvectors in one request", + "summary": "Get multiple term vectors", + "description": "You can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "operationId": "mtermvectors-3", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 420eea7f91..dee9af9b93 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -4338,7 +4338,8 @@ "stability": "stable" } }, - "description": "Changes the number of requests per second for a particular Delete By Query operation.", + "description": "Throttle a delete by query operation.\n\nChange the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html", "name": "delete_by_query_rethrottle", "request": { @@ -9266,7 +9267,8 @@ "stability": "stable" } }, - "description": "Allows to get multiple documents in one request.", + "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", "name": "mget", "privileges": { @@ -12861,7 +12863,8 @@ "stability": "stable" } }, - "description": "Returns multiple termvectors in one request.", + "description": "Get multiple term vectors.\n\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", "name": "mtermvectors", "request": { @@ -13845,7 +13848,7 @@ "stability": "stable" } }, - "description": "Copies documents from a source to a destination.", + "description": "Throttle a reindex operation.\n\nChange the number of requests per second for a particular reindex operation.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", "name": "reindex_rethrottle", @@ -19758,7 +19761,8 @@ "stability": "stable" } }, - "description": "Changes the number of requests per second for a particular Update By Query operation.", + "description": "Throttle an update by query operation.\n\nChange the number of requests per second for a particular update by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html", "name": "update_by_query_rethrottle", "request": { @@ -22685,7 +22689,7 @@ "body": { "kind": "no_body" }, - "description": "Changes the number of requests per second for a particular Delete By Query operation.", + "description": "Throttle a delete by query operation.\n\nChange the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", "inherits": { "type": { "name": "RequestBase", @@ -22724,7 +22728,7 @@ } } ], - "specLocation": "_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts#L24-L42" + "specLocation": "_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts#L24-L47" }, { "kind": "response", @@ -27252,7 +27256,7 @@ } ] }, - "description": "Allows to get multiple documents in one request.", + "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "inherits": { "type": { "name": "RequestBase", @@ -27403,7 +27407,7 @@ } } ], - "specLocation": "_global/mget/MultiGetRequest.ts#L25-L98" + "specLocation": "_global/mget/MultiGetRequest.ts#L25-L104" }, { "kind": "response", @@ -28972,7 +28976,7 @@ } ] }, - "description": "Returns multiple termvectors in one request.", + "description": "Get multiple term vectors.\n\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "inherits": { "type": { "name": "RequestBase", @@ -29154,7 +29158,7 @@ } } ], - "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L109" + "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L116" }, { "kind": "response", @@ -31419,7 +31423,7 @@ "body": { "kind": "no_body" }, - "description": "Copies documents from a source to a destination.", + "description": "Throttle a reindex operation.\n\nChange the number of requests per second for a particular reindex operation.", "inherits": { "type": { "name": "RequestBase", @@ -31458,7 +31462,7 @@ } } ], - "specLocation": "_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L44" + "specLocation": "_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L46" }, { "kind": "response", @@ -42108,7 +42112,7 @@ "body": { "kind": "no_body" }, - "description": "Changes the number of requests per second for a particular Update By Query operation.", + "description": "Throttle an update by query operation.\n\nChange the number of requests per second for a particular update by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", "inherits": { "type": { "name": "RequestBase", @@ -42148,7 +42152,7 @@ } } ], - "specLocation": "_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts#L24-L43" + "specLocation": "_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts#L24-L48" }, { "kind": "response", diff --git a/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts b/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts index defc8559cf..22f1cd171c 100644 --- a/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts +++ b/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts @@ -22,9 +22,14 @@ import { TaskId } from '@_types/common' import { float } from '@_types/Numeric' /** + * Throttle a delete by query operation. + * + * Change the number of requests per second for a particular delete by query operation. + * Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. * @rest_spec_name delete_by_query_rethrottle * @availability stack since=6.5.0 stability=stable * @availability serverless stability=stable visibility=private + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/mget/MultiGetRequest.ts b/specification/_global/mget/MultiGetRequest.ts index 4b2271b3b4..a76d011a63 100644 --- a/specification/_global/mget/MultiGetRequest.ts +++ b/specification/_global/mget/MultiGetRequest.ts @@ -23,10 +23,16 @@ import { Fields, Ids, IndexName, Routing } from '@_types/common' import { Operation } from './types' /** + * Get multiple documents. + * + * Get multiple JSON documents by ID from one or more indices. + * If you specify an index in the request URI, you only need to specify the document IDs in the request body. + * To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. * @rest_spec_name mget * @availability stack since=1.3.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges read + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/mtermvectors/MultiTermVectorsRequest.ts b/specification/_global/mtermvectors/MultiTermVectorsRequest.ts index e5a4e8d573..83a5ba4212 100644 --- a/specification/_global/mtermvectors/MultiTermVectorsRequest.ts +++ b/specification/_global/mtermvectors/MultiTermVectorsRequest.ts @@ -29,9 +29,16 @@ import { import { Operation } from './types' /** + * Get multiple term vectors. + * + * You can specify existing documents by index and ID or provide artificial documents in the body of the request. + * You can specify the index in the request body or request URI. + * The response contains a `docs` array with all the fetched termvectors. + * Each element has the structure provided by the termvectors API. * @rest_spec_name mtermvectors * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts b/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts index e955a60dbc..8a2841b40e 100644 --- a/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts +++ b/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts @@ -22,7 +22,9 @@ import { Id } from '@_types/common' import { float } from '@_types/Numeric' /** - * Copies documents from a source to a destination. + * Throttle a reindex operation. + * + * Change the number of requests per second for a particular reindex operation. * @rest_spec_name reindex_rethrottle * @availability stack since=2.4.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts b/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts index deddea2a59..abc6810490 100644 --- a/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts +++ b/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts @@ -22,9 +22,14 @@ import { Id } from '@_types/common' import { float } from '@_types/Numeric' /** + * Throttle an update by query operation. + * + * Change the number of requests per second for a particular update by query operation. + * Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. * @rest_spec_name update_by_query_rethrottle * @availability stack since=6.5.0 stability=stable * @availability serverless stability=stable visibility=private + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { From 9a119711060f8dffd7a6e2cf2c5c480a50b69af5 Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Wed, 23 Oct 2024 14:46:28 +0000 Subject: [PATCH 5/5] Update specification output --- output/schema/schema-serverless.json | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 31d9b2b8c6..2e06b51c81 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -4722,7 +4722,8 @@ "stability": "stable" } }, - "description": "Allows to get multiple documents in one request.", + "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", "name": "mget", "privileges": { @@ -7219,7 +7220,8 @@ "stability": "stable" } }, - "description": "Returns multiple termvectors in one request.", + "description": "Get multiple term vectors.\n\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", "name": "mtermvectors", "request": { @@ -25522,7 +25524,7 @@ } ] }, - "description": "Allows to get multiple documents in one request.", + "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "inherits": { "type": { "name": "RequestBase", @@ -25655,7 +25657,7 @@ } } ], - "specLocation": "_global/mget/MultiGetRequest.ts#L25-L98" + "specLocation": "_global/mget/MultiGetRequest.ts#L25-L104" }, { "body": { @@ -33769,7 +33771,7 @@ } ] }, - "description": "Returns multiple termvectors in one request.", + "description": "Get multiple term vectors.\n\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "inherits": { "type": { "name": "RequestBase", @@ -33952,7 +33954,7 @@ } } ], - "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L109" + "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L116" }, { "body": {