diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index 71953eb466..1a6e6dbfca 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 @@ -173,18 +165,8 @@ actions: # S - name: script x-displayName: Script - - name: get_script_context - x-displayName: Script - Get contexts - - name: get_script_languages - x-displayName: Script - Get languages - name: search x-displayName: Search - - name: msearch - x-displayName: Search - Multi search - - name: scroll - x-displayName: Search - Scroll - - name: terms_enum - x-displayName: Search - Terms enum - name: search_application x-displayName: Search application - name: searchable_snapshots diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 88108ffb77..9d6f1d5fed 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -2750,9 +2750,13 @@ "/_search/scroll": { "get": { "tags": [ - "scroll" + "search" ], - "summary": "Allows to retrieve a large numbers of results from a single search request", + "summary": "Run a scrolling search", + "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + }, "operationId": "scroll", "parameters": [ { @@ -2776,9 +2780,13 @@ }, "post": { "tags": [ - "scroll" + "search" ], - "summary": "Allows to retrieve a large numbers of results from a single search request", + "summary": "Run a scrolling search", + "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + }, "operationId": "scroll-1", "parameters": [ { @@ -2819,9 +2827,13 @@ "/_search/scroll/{scroll_id}": { "get": { "tags": [ - "scroll" + "search" ], - "summary": "Allows to retrieve a large numbers of results from a single search request", + "summary": "Run a scrolling search", + "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + }, "operationId": "scroll-2", "parameters": [ { @@ -2848,9 +2860,13 @@ }, "post": { "tags": [ - "scroll" + "search" ], - "summary": "Allows to retrieve a large numbers of results from a single search request", + "summary": "Run a scrolling search", + "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + }, "operationId": "scroll-3", "parameters": [ { @@ -6953,9 +6969,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": [ { @@ -9028,9 +9045,10 @@ "/_script_context": { "get": { "tags": [ - "get_script_context" + "script" ], - "summary": "Returns all script contexts", + "summary": "Get script contexts", + "description": "Get a list of supported script contexts and their methods.", "operationId": "get-script-context", "responses": { "200": { @@ -9060,9 +9078,10 @@ "/_script_language": { "get": { "tags": [ - "get_script_languages" + "script" ], - "summary": "Returns available script types, languages and contexts", + "summary": "Get script languages", + "description": "Get a list of available script types, languages, and contexts.", "operationId": "get-script-languages", "responses": { "200": { @@ -15907,9 +15926,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": [ { @@ -15952,9 +15972,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": [ { @@ -15999,9 +16020,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": [ { @@ -16047,9 +16069,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": [ { @@ -22297,9 +22320,10 @@ "/_msearch": { "get": { "tags": [ - "msearch" + "search" ], - "summary": "Allows to execute several search operations in one request", + "summary": "Run multiple searches", + "description": "The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "operationId": "msearch", "parameters": [ { @@ -22354,9 +22378,10 @@ }, "post": { "tags": [ - "msearch" + "search" ], - "summary": "Allows to execute several search operations in one request", + "summary": "Run multiple searches", + "description": "The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "operationId": "msearch-1", "parameters": [ { @@ -22413,9 +22438,10 @@ "/{index}/_msearch": { "get": { "tags": [ - "msearch" + "search" ], - "summary": "Allows to execute several search operations in one request", + "summary": "Run multiple searches", + "description": "The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "operationId": "msearch-2", "parameters": [ { @@ -22473,9 +22499,10 @@ }, "post": { "tags": [ - "msearch" + "search" ], - "summary": "Allows to execute several search operations in one request", + "summary": "Run multiple searches", + "description": "The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "operationId": "msearch-3", "parameters": [ { @@ -22677,9 +22704,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": [ { @@ -22730,9 +22758,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": [ { @@ -22785,9 +22814,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": [ { @@ -22841,9 +22871,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": [ { @@ -24503,7 +24534,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": [ { @@ -32754,10 +32786,10 @@ "/{index}/_terms_enum": { "get": { "tags": [ - "terms_enum" + "search" ], - "summary": "The terms enum API can be used to discover terms in the index that begin with the provided string", - "description": "It is designed for low-latency look-ups used in auto-complete scenarios.", + "summary": "Get terms in an index", + "description": "Discover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", "operationId": "terms-enum", "parameters": [ { @@ -32776,10 +32808,10 @@ }, "post": { "tags": [ - "terms_enum" + "search" ], - "summary": "The terms enum API can be used to discover terms in the index that begin with the provided string", - "description": "It is designed for low-latency look-ups used in auto-complete scenarios.", + "summary": "Get terms in an index", + "description": "Discover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", "operationId": "terms-enum-1", "parameters": [ { @@ -34859,9 +34891,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": [ { @@ -101371,6 +101404,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..414fce3549 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -1223,9 +1223,13 @@ "/_search/scroll": { "get": { "tags": [ - "scroll" + "search" ], - "summary": "Allows to retrieve a large numbers of results from a single search request", + "summary": "Run a scrolling search", + "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + }, "operationId": "scroll", "parameters": [ { @@ -1249,9 +1253,13 @@ }, "post": { "tags": [ - "scroll" + "search" ], - "summary": "Allows to retrieve a large numbers of results from a single search request", + "summary": "Run a scrolling search", + "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + }, "operationId": "scroll-1", "parameters": [ { @@ -1292,9 +1300,13 @@ "/_search/scroll/{scroll_id}": { "get": { "tags": [ - "scroll" + "search" ], - "summary": "Allows to retrieve a large numbers of results from a single search request", + "summary": "Run a scrolling search", + "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + }, "operationId": "scroll-2", "parameters": [ { @@ -1321,9 +1333,13 @@ }, "post": { "tags": [ - "scroll" + "search" ], - "summary": "Allows to retrieve a large numbers of results from a single search request", + "summary": "Run a scrolling search", + "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + }, "operationId": "scroll-3", "parameters": [ { @@ -9234,9 +9250,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 +9293,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 +9338,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 +9384,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": [ { @@ -13623,9 +13643,10 @@ "/_msearch": { "get": { "tags": [ - "msearch" + "search" ], - "summary": "Allows to execute several search operations in one request", + "summary": "Run multiple searches", + "description": "The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "operationId": "msearch", "parameters": [ { @@ -13680,9 +13701,10 @@ }, "post": { "tags": [ - "msearch" + "search" ], - "summary": "Allows to execute several search operations in one request", + "summary": "Run multiple searches", + "description": "The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "operationId": "msearch-1", "parameters": [ { @@ -13739,9 +13761,10 @@ "/{index}/_msearch": { "get": { "tags": [ - "msearch" + "search" ], - "summary": "Allows to execute several search operations in one request", + "summary": "Run multiple searches", + "description": "The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "operationId": "msearch-2", "parameters": [ { @@ -13799,9 +13822,10 @@ }, "post": { "tags": [ - "msearch" + "search" ], - "summary": "Allows to execute several search operations in one request", + "summary": "Run multiple searches", + "description": "The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "operationId": "msearch-3", "parameters": [ { @@ -14003,9 +14027,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 +14081,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 +14137,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 +14194,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": [ { @@ -18061,10 +18089,10 @@ "/{index}/_terms_enum": { "get": { "tags": [ - "terms_enum" + "search" ], - "summary": "The terms enum API can be used to discover terms in the index that begin with the provided string", - "description": "It is designed for low-latency look-ups used in auto-complete scenarios.", + "summary": "Get terms in an index", + "description": "Discover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", "operationId": "terms-enum", "parameters": [ { @@ -18083,10 +18111,10 @@ }, "post": { "tags": [ - "terms_enum" + "search" ], - "summary": "The terms enum API can be used to discover terms in the index that begin with the provided string", - "description": "It is designed for low-latency look-ups used in auto-complete scenarios.", + "summary": "Get terms in an index", + "description": "Discover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", "operationId": "terms-enum-1", "parameters": [ { @@ -61886,6 +61914,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..5929fcaf9c 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": { @@ -7117,7 +7118,8 @@ "stability": "stable" } }, - "description": "Allows to execute several search operations in one request.", + "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", "name": "msearch", "privileges": { @@ -7219,7 +7221,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": { @@ -7818,8 +7821,11 @@ "stability": "stable" } }, - "description": "Allows to retrieve a large numbers of results from a single search request.", + "description": "Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", + "extDocId": "scroll-search-results", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "scroll", "request": { "name": "Request", @@ -9281,7 +9287,8 @@ "stability": "stable" } }, - "description": "The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.", + "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", "name": "terms_enum", "request": { @@ -17375,6 +17382,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 +17501,7 @@ } } ], - "specLocation": "eql/search/EqlSearchRequest.ts#L28-L118" + "specLocation": "eql/search/EqlSearchRequest.ts#L28-L125" }, { "body": { @@ -25509,7 +25529,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", @@ -25642,7 +25662,7 @@ } } ], - "specLocation": "_global/mget/MultiGetRequest.ts#L25-L98" + "specLocation": "_global/mget/MultiGetRequest.ts#L25-L104" }, { "body": { @@ -33346,7 +33366,7 @@ } } }, - "description": "Allows to execute several search operations in one request.", + "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "inherits": { "type": { "name": "RequestBase", @@ -33538,7 +33558,7 @@ } } ], - "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L106" + "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L124" }, { "body": { @@ -33756,7 +33776,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", @@ -33939,7 +33959,7 @@ } } ], - "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L109" + "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L116" }, { "body": { @@ -35646,7 +35666,7 @@ } ] }, - "description": "Allows to retrieve a large numbers of results from a single search request.", + "description": "Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "inherits": { "type": { "name": "RequestBase", @@ -35722,7 +35742,7 @@ } } ], - "specLocation": "_global/scroll/ScrollRequest.ts#L24-L59" + "specLocation": "_global/scroll/ScrollRequest.ts#L24-L75" }, { "body": { @@ -41696,7 +41716,7 @@ } ] }, - "description": "The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.", + "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", "inherits": { "type": { "name": "RequestBase", @@ -41723,7 +41743,7 @@ } ], "query": [], - "specLocation": "_global/terms_enum/TermsEnumRequest.ts#L26-L65" + "specLocation": "_global/terms_enum/TermsEnumRequest.ts#L26-L75" }, { "body": { @@ -58080,7 +58100,7 @@ ], "meta": { "key": "field", - "value": "term" + "value": "terms" }, "type": { "name": "AdditionalProperty", diff --git a/output/schema/schema.json b/output/schema/schema.json index 05222fa425..a9788a9694 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -4341,7 +4341,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": { @@ -5334,7 +5335,8 @@ "stability": "stable" } }, - "description": "Returns all script contexts.", + "description": "Get script contexts.\n\nGet a list of supported script contexts and their methods.", + "docTag": "script", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html", "name": "get_script_context", "request": { @@ -5364,7 +5366,8 @@ "stability": "stable" } }, - "description": "Returns available script types, languages and contexts", + "description": "Get script languages.\n\nGet a list of available script types, languages, and contexts.", + "docTag": "script", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "get_script_languages", "request": { @@ -9269,7 +9272,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": { @@ -12762,7 +12766,8 @@ "stability": "stable" } }, - "description": "Allows to execute several search operations in one request.", + "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", "name": "msearch", "privileges": { @@ -12864,7 +12869,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": { @@ -13848,7 +13854,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", @@ -14242,8 +14248,11 @@ "stability": "stable" } }, - "description": "Allows to retrieve a large numbers of results from a single search request.", + "description": "Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", + "extDocId": "scroll-search-results", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "scroll", "request": { "name": "Request", @@ -18951,7 +18960,8 @@ "stability": "stable" } }, - "description": "The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.", + "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", "name": "terms_enum", "request": { @@ -19761,7 +19771,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": { @@ -22688,7 +22699,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", @@ -22727,7 +22738,7 @@ } } ], - "specLocation": "_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts#L24-L42" + "specLocation": "_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts#L24-L47" }, { "kind": "response", @@ -24655,7 +24666,7 @@ "body": { "kind": "no_body" }, - "description": "Returns all script contexts.", + "description": "Get script contexts.\n\nGet a list of supported script contexts and their methods.", "inherits": { "type": { "name": "RequestBase", @@ -24668,7 +24679,7 @@ }, "path": [], "query": [], - "specLocation": "_global/get_script_context/GetScriptContextRequest.ts#L22-L26" + "specLocation": "_global/get_script_context/GetScriptContextRequest.ts#L22-L30" }, { "kind": "response", @@ -24740,7 +24751,7 @@ "body": { "kind": "no_body" }, - "description": "Returns available script types, languages and contexts", + "description": "Get script languages.\n\nGet a list of available script types, languages, and contexts.", "inherits": { "type": { "name": "RequestBase", @@ -24753,7 +24764,7 @@ }, "path": [], "query": [], - "specLocation": "_global/get_script_languages/GetScriptLanguagesRequest.ts#L22-L26" + "specLocation": "_global/get_script_languages/GetScriptLanguagesRequest.ts#L22-L30" }, { "kind": "response", @@ -27255,7 +27266,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", @@ -27406,7 +27417,7 @@ } } ], - "specLocation": "_global/mget/MultiGetRequest.ts#L25-L98" + "specLocation": "_global/mget/MultiGetRequest.ts#L25-L104" }, { "kind": "response", @@ -28211,7 +28222,7 @@ } } }, - "description": "Allows to execute several search operations in one request.", + "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "inherits": { "type": { "name": "RequestBase", @@ -28402,7 +28413,7 @@ } } ], - "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L106" + "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L124" }, { "kind": "type_alias", @@ -28975,7 +28986,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", @@ -29157,7 +29168,7 @@ } } ], - "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L109" + "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L116" }, { "kind": "response", @@ -31422,7 +31433,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", @@ -31461,7 +31472,7 @@ } } ], - "specLocation": "_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L44" + "specLocation": "_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L46" }, { "kind": "response", @@ -31780,7 +31791,7 @@ } ] }, - "description": "Allows to retrieve a large numbers of results from a single search request.", + "description": "Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "inherits": { "type": { "name": "RequestBase", @@ -31855,7 +31866,7 @@ } } ], - "specLocation": "_global/scroll/ScrollRequest.ts#L24-L59" + "specLocation": "_global/scroll/ScrollRequest.ts#L24-L75" }, { "kind": "response", @@ -40300,7 +40311,7 @@ } ] }, - "description": "The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.", + "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", "inherits": { "type": { "name": "RequestBase", @@ -40326,7 +40337,7 @@ } ], "query": [], - "specLocation": "_global/terms_enum/TermsEnumRequest.ts#L26-L65" + "specLocation": "_global/terms_enum/TermsEnumRequest.ts#L26-L75" }, { "kind": "response", @@ -42111,7 +42122,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", @@ -42151,7 +42162,7 @@ } } ], - "specLocation": "_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts#L24-L43" + "specLocation": "_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts#L24-L48" }, { "kind": "response", @@ -86037,7 +86048,7 @@ ], "meta": { "key": "field", - "value": "term" + "value": "terms" }, "type": { "name": "AdditionalProperty", @@ -117377,6 +117388,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" + } + } } ] }, @@ -117482,7 +117506,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 } } 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/get_script_context/GetScriptContextRequest.ts b/specification/_global/get_script_context/GetScriptContextRequest.ts index 6ba1361ed4..69df067f0b 100644 --- a/specification/_global/get_script_context/GetScriptContextRequest.ts +++ b/specification/_global/get_script_context/GetScriptContextRequest.ts @@ -20,7 +20,11 @@ import { RequestBase } from '@_types/Base' /** + * Get script contexts. + * + * Get a list of supported script contexts and their methods. * @rest_spec_name get_script_context * @availability stack stability=stable + * @doc_tag script */ export interface Request extends RequestBase {} diff --git a/specification/_global/get_script_languages/GetScriptLanguagesRequest.ts b/specification/_global/get_script_languages/GetScriptLanguagesRequest.ts index 67f459b545..11d3449b4a 100644 --- a/specification/_global/get_script_languages/GetScriptLanguagesRequest.ts +++ b/specification/_global/get_script_languages/GetScriptLanguagesRequest.ts @@ -20,7 +20,11 @@ import { RequestBase } from '@_types/Base' /** + * Get script languages. + * + * Get a list of available script types, languages, and contexts. * @rest_spec_name get_script_languages * @availability stack stability=stable + * @doc_tag script */ export interface Request extends RequestBase {} 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/msearch/MultiSearchRequest.ts b/specification/_global/msearch/MultiSearchRequest.ts index 5c5aa55af4..8e396c271b 100644 --- a/specification/_global/msearch/MultiSearchRequest.ts +++ b/specification/_global/msearch/MultiSearchRequest.ts @@ -23,10 +23,28 @@ import { long } from '@_types/Numeric' import { RequestItem } from './types' /** + * Run multiple searches. + * + * The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + * The structure is as follows: + * + * ``` + * header\n + * body\n + * header\n + * body\n + * ``` + * + * This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + * + * IMPORTANT: The final line of data must end with a newline character `\n`. + * Each newline character may be preceded by a carriage return `\r`. + * When sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`. * @rest_spec_name msearch * @availability stack since=1.3.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges read + * @doc_tag search */ 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/scroll/ScrollRequest.ts b/specification/_global/scroll/ScrollRequest.ts index 85c85bf6b6..6643e5884f 100644 --- a/specification/_global/scroll/ScrollRequest.ts +++ b/specification/_global/scroll/ScrollRequest.ts @@ -22,9 +22,25 @@ import { ScrollId } from '@_types/common' import { Duration } from '@_types/Time' /** + * Run a scrolling search. + * + * IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT). + * + * The scroll API gets large sets of results from a single scrolling search request. + * To get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter. + * The `scroll` parameter indicates how long Elasticsearch should retain the search context for the request. + * The search response returns a scroll ID in the `_scroll_id` response body parameter. + * You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. + * If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. + * + * You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. + * + * IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. * @rest_spec_name scroll * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag search + * @ext_doc_id scroll-search-results */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/terms_enum/TermsEnumRequest.ts b/specification/_global/terms_enum/TermsEnumRequest.ts index 68ffaa3fbf..c2aae9ee99 100644 --- a/specification/_global/terms_enum/TermsEnumRequest.ts +++ b/specification/_global/terms_enum/TermsEnumRequest.ts @@ -24,9 +24,19 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' import { Duration } from '@_types/Time' /** + * Get terms in an index. + * + * Discover terms that match a partial string in an index. + * This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + * + * If the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + * This can occur due to a few reasons, such as a request timeout or a node error. + * + * NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. * @rest_spec_name terms_enum * @availability stack since=7.14.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { 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: { 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 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 } }