From 5293edd62158e9a092f693b2a4016b2cef5e33a9 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 24 Oct 2024 18:23:04 -0700 Subject: [PATCH 1/8] [OpenAPI] Edit search operation summaries --- specification/_doc_ids/table.csv | 1 + .../_global/clear_scroll/ClearScrollRequest.ts | 4 +++- .../close_point_in_time/ClosePointInTimeRequest.ts | 7 ++++++- .../_global/field_caps/FieldCapabilitiesRequest.ts | 10 +++++++--- .../msearch_template/MultiSearchTemplateRequest.ts | 3 ++- .../open_point_in_time/OpenPointInTimeRequest.ts | 7 ++++++- specification/_global/rank_eval/RankEvalRequest.ts | 4 +++- .../RenderSearchTemplateRequest.ts | 4 +++- .../_global/search_template/SearchTemplateRequest.ts | 3 ++- 9 files changed, 33 insertions(+), 10 deletions(-) diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index a534c32bca..60940332a8 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -531,6 +531,7 @@ search-validate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch} search-vector-tile-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-vector-tile-api.html searchable-snapshots-api-mount-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-mount-snapshot.html searchable-snapshots-apis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-apis.html +search-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html secure-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/secure-settings.html security-api-authenticate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-authenticate.html security-api-change-password,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-change-password.html diff --git a/specification/_global/clear_scroll/ClearScrollRequest.ts b/specification/_global/clear_scroll/ClearScrollRequest.ts index 570721ba42..1388e0a1fb 100644 --- a/specification/_global/clear_scroll/ClearScrollRequest.ts +++ b/specification/_global/clear_scroll/ClearScrollRequest.ts @@ -21,7 +21,9 @@ import { RequestBase } from '@_types/Base' import { ScrollIds } from '@_types/common' /** - * Clears the search context and results for a scrolling search. + * Clear a scrolling search. + * + * Clear the search context and results for a scrolling search. * @rest_spec_name clear_scroll * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts b/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts index 5f9f66ee79..93224768a1 100644 --- a/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts +++ b/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts @@ -21,7 +21,12 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Closes a point-in-time. + * Close a point in time. + * + * A point in time must be opened explicitly before being used in search requests. + * The `keep_alive` parameter tells Elasticsearch how long it should persist. + * A point in time is automatically closed when the `keep_alive` period has elapsed. + * However, keeping points in time has a cost; close them as soon as they are no lwonger required for search requests. * @rest_spec_name close_point_in_time * @availability stack since=7.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/field_caps/FieldCapabilitiesRequest.ts b/specification/_global/field_caps/FieldCapabilitiesRequest.ts index 98a430ab1b..44e17bba60 100644 --- a/specification/_global/field_caps/FieldCapabilitiesRequest.ts +++ b/specification/_global/field_caps/FieldCapabilitiesRequest.ts @@ -23,9 +23,13 @@ import { RuntimeFields } from '@_types/mapping/RuntimeFields' import { QueryContainer } from '@_types/query_dsl/abstractions' /** - * The field capabilities API returns the information about the capabilities of fields among multiple indices. - * The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - * of keyword is returned as any other field that belongs to the `keyword` family. + * Get the field capabilities. + * + * Get information about the capabilities of fields among multiple indices. + * + * For data streams, the API returns field capabilities among the stream’s backing indices. + * It returns runtime fields like any other field. + * For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family. * @rest_spec_name field_caps * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts index 48fb5df389..9c6552faf8 100644 --- a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts +++ b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts @@ -23,12 +23,13 @@ import { long } from '@_types/Numeric' import { RequestItem } from './types' /** - * Runs multiple templated searches with a single request. + * Run multiple templated searches. * @rest_spec_name msearch_template * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges read * @doc_tag search + * @ext_doc_id search-templates */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts index f66605eb3a..ff39e85c8d 100644 --- a/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts +++ b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts @@ -23,12 +23,17 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' import { Duration } from '@_types/Time' /** - * A search request by default executes against the most recent visible data of the target indices, + * Open a point in time. + * + * A search request by default runs against the most recent visible data of the target indices, * which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the * state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple * search requests using the same point in time. For example, if refreshes happen between * `search_after` requests, then the results of those requests might not be consistent as changes happening * between searches are only visible to the more recent point in time. + * + * A point in time must be opened explicitly before being used in search requests. + * The `keep_alive` parameter tells Elasticsearch how long it should persist. * @rest_spec_name open_point_in_time * @availability stack since=7.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/rank_eval/RankEvalRequest.ts b/specification/_global/rank_eval/RankEvalRequest.ts index 563629ece6..f93bd9da7a 100644 --- a/specification/_global/rank_eval/RankEvalRequest.ts +++ b/specification/_global/rank_eval/RankEvalRequest.ts @@ -22,7 +22,9 @@ import { ExpandWildcards, Indices } from '@_types/common' import { RankEvalMetric, RankEvalRequestItem } from './types' /** - * Enables you to evaluate the quality of ranked search results over a set of typical search queries. + * Evaluate ranked search results. + * + * Evaluate the quality of ranked search results over a set of typical search queries. * @rest_spec_name rank_eval * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/render_search_template/RenderSearchTemplateRequest.ts b/specification/_global/render_search_template/RenderSearchTemplateRequest.ts index 98213554d3..42ebefb286 100644 --- a/specification/_global/render_search_template/RenderSearchTemplateRequest.ts +++ b/specification/_global/render_search_template/RenderSearchTemplateRequest.ts @@ -23,7 +23,9 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Renders a search template as a search request body. + * Render a search template. + * + * Render a search template as a search request body. * @rest_spec_name render_search_template * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/search_template/SearchTemplateRequest.ts b/specification/_global/search_template/SearchTemplateRequest.ts index f09e716501..baa6b8e7c4 100644 --- a/specification/_global/search_template/SearchTemplateRequest.ts +++ b/specification/_global/search_template/SearchTemplateRequest.ts @@ -30,11 +30,12 @@ import { import { Duration } from '@_types/Time' /** - * Runs a search with a search template. + * Run a search with a search template. * @rest_spec_name search_template * @availability stack since=2.0.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_tag search + * @ext_doc_id search-teamplate */ export interface Request extends RequestBase { path_parts: { From aac4409727aa19561977d778d6051d899bad16a5 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 24 Oct 2024 18:24:46 -0700 Subject: [PATCH 2/8] Generate output --- output/openapi/elasticsearch-openapi.json | 93 +++++++++++++------ .../elasticsearch-serverless-openapi.json | 93 +++++++++++++------ output/schema/schema.json | 52 ++++++----- .../search_template/SearchTemplateRequest.ts | 2 +- 4 files changed, 157 insertions(+), 83 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index bd2b7eab24..8875b761fc 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -2812,7 +2812,8 @@ "tags": [ "search" ], - "summary": "Clears the search context and results for a scrolling search", + "summary": "Clear a scrolling search", + "description": "Clear the search context and results for a scrolling search.", "operationId": "clear-scroll", "requestBody": { "$ref": "#/components/requestBodies/clear_scroll" @@ -2895,7 +2896,8 @@ "tags": [ "search" ], - "summary": "Clears the search context and results for a scrolling search", + "summary": "Clear a scrolling search", + "description": "Clear the search context and results for a scrolling search.", "operationId": "clear-scroll-1", "parameters": [ { @@ -2917,7 +2919,8 @@ "tags": [ "search" ], - "summary": "Closes a point-in-time", + "summary": "Close a point in time", + "description": "A point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no lwonger required for search requests.", "operationId": "close-point-in-time", "requestBody": { "content": { @@ -8230,8 +8233,8 @@ "tags": [ "search" ], - "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "summary": "Get the field capabilities", + "description": "Get information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "operationId": "field-caps", "parameters": [ { @@ -8273,8 +8276,8 @@ "tags": [ "search" ], - "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "summary": "Get the field capabilities", + "description": "Get information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "operationId": "field-caps-1", "parameters": [ { @@ -8318,8 +8321,8 @@ "tags": [ "search" ], - "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "summary": "Get the field capabilities", + "description": "Get information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "operationId": "field-caps-2", "parameters": [ { @@ -8364,8 +8367,8 @@ "tags": [ "search" ], - "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "summary": "Get the field capabilities", + "description": "Get information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "operationId": "field-caps-3", "parameters": [ { @@ -22582,7 +22585,10 @@ "tags": [ "search" ], - "summary": "Runs multiple templated searches with a single request", + "summary": "Run multiple templated searches", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "msearch-template", "parameters": [ { @@ -22615,7 +22621,10 @@ "tags": [ "search" ], - "summary": "Runs multiple templated searches with a single request", + "summary": "Run multiple templated searches", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "msearch-template-1", "parameters": [ { @@ -22650,7 +22659,10 @@ "tags": [ "search" ], - "summary": "Runs multiple templated searches with a single request", + "summary": "Run multiple templated searches", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "msearch-template-2", "parameters": [ { @@ -22686,7 +22698,10 @@ "tags": [ "search" ], - "summary": "Runs multiple templated searches with a single request", + "summary": "Run multiple templated searches", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "msearch-template-3", "parameters": [ { @@ -23677,8 +23692,8 @@ "tags": [ "search" ], - "summary": "A search request by default executes against the most recent visible data of the target indices,\n", - "description": "which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.", + "summary": "Open a point in time", + "description": "A search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.", "operationId": "open-point-in-time", "parameters": [ { @@ -24300,7 +24315,8 @@ "tags": [ "search" ], - "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", + "summary": "Evaluate ranked search results", + "description": "Evaluate the quality of ranked search results over a set of typical search queries.", "operationId": "rank-eval", "parameters": [ { @@ -24330,7 +24346,8 @@ "tags": [ "search" ], - "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", + "summary": "Evaluate ranked search results", + "description": "Evaluate the quality of ranked search results over a set of typical search queries.", "operationId": "rank-eval-1", "parameters": [ { @@ -24362,7 +24379,8 @@ "tags": [ "search" ], - "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", + "summary": "Evaluate ranked search results", + "description": "Evaluate the quality of ranked search results over a set of typical search queries.", "operationId": "rank-eval-2", "parameters": [ { @@ -24395,7 +24413,8 @@ "tags": [ "search" ], - "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", + "summary": "Evaluate ranked search results", + "description": "Evaluate the quality of ranked search results over a set of typical search queries.", "operationId": "rank-eval-3", "parameters": [ { @@ -24680,7 +24699,8 @@ "tags": [ "search" ], - "summary": "Renders a search template as a search request body", + "summary": "Render a search template", + "description": "Render a search template as a search request body.", "operationId": "render-search-template", "requestBody": { "$ref": "#/components/requestBodies/render_search_template" @@ -24695,7 +24715,8 @@ "tags": [ "search" ], - "summary": "Renders a search template as a search request body", + "summary": "Render a search template", + "description": "Render a search template as a search request body.", "operationId": "render-search-template-1", "requestBody": { "$ref": "#/components/requestBodies/render_search_template" @@ -24712,7 +24733,8 @@ "tags": [ "search" ], - "summary": "Renders a search template as a search request body", + "summary": "Render a search template", + "description": "Render a search template as a search request body.", "operationId": "render-search-template-2", "parameters": [ { @@ -24732,7 +24754,8 @@ "tags": [ "search" ], - "summary": "Renders a search template as a search request body", + "summary": "Render a search template", + "description": "Render a search template as a search request body.", "operationId": "render-search-template-3", "parameters": [ { @@ -26415,7 +26438,10 @@ "tags": [ "search" ], - "summary": "Runs a search with a search template", + "summary": "Run a search with a search template", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "search-template", "parameters": [ { @@ -26472,7 +26498,10 @@ "tags": [ "search" ], - "summary": "Runs a search with a search template", + "summary": "Run a search with a search template", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "search-template-1", "parameters": [ { @@ -26531,7 +26560,10 @@ "tags": [ "search" ], - "summary": "Runs a search with a search template", + "summary": "Run a search with a search template", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "search-template-2", "parameters": [ { @@ -26591,7 +26623,10 @@ "tags": [ "search" ], - "summary": "Runs a search with a search template", + "summary": "Run a search with a search template", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "search-template-3", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 44fc5ea466..533fce8091 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -1285,7 +1285,8 @@ "tags": [ "search" ], - "summary": "Clears the search context and results for a scrolling search", + "summary": "Clear a scrolling search", + "description": "Clear the search context and results for a scrolling search.", "operationId": "clear-scroll", "requestBody": { "$ref": "#/components/requestBodies/clear_scroll" @@ -1368,7 +1369,8 @@ "tags": [ "search" ], - "summary": "Clears the search context and results for a scrolling search", + "summary": "Clear a scrolling search", + "description": "Clear the search context and results for a scrolling search.", "operationId": "clear-scroll-1", "parameters": [ { @@ -1390,7 +1392,8 @@ "tags": [ "search" ], - "summary": "Closes a point-in-time", + "summary": "Close a point in time", + "description": "A point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no lwonger required for search requests.", "operationId": "close-point-in-time", "requestBody": { "content": { @@ -5471,8 +5474,8 @@ "tags": [ "search" ], - "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "summary": "Get the field capabilities", + "description": "Get information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "operationId": "field-caps", "parameters": [ { @@ -5514,8 +5517,8 @@ "tags": [ "search" ], - "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "summary": "Get the field capabilities", + "description": "Get information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "operationId": "field-caps-1", "parameters": [ { @@ -5559,8 +5562,8 @@ "tags": [ "search" ], - "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "summary": "Get the field capabilities", + "description": "Get information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "operationId": "field-caps-2", "parameters": [ { @@ -5605,8 +5608,8 @@ "tags": [ "search" ], - "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "summary": "Get the field capabilities", + "description": "Get information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "operationId": "field-caps-3", "parameters": [ { @@ -13904,7 +13907,10 @@ "tags": [ "search" ], - "summary": "Runs multiple templated searches with a single request", + "summary": "Run multiple templated searches", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "msearch-template", "parameters": [ { @@ -13937,7 +13943,10 @@ "tags": [ "search" ], - "summary": "Runs multiple templated searches with a single request", + "summary": "Run multiple templated searches", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "msearch-template-1", "parameters": [ { @@ -13972,7 +13981,10 @@ "tags": [ "search" ], - "summary": "Runs multiple templated searches with a single request", + "summary": "Run multiple templated searches", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "msearch-template-2", "parameters": [ { @@ -14008,7 +14020,10 @@ "tags": [ "search" ], - "summary": "Runs multiple templated searches with a single request", + "summary": "Run multiple templated searches", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "msearch-template-3", "parameters": [ { @@ -14272,8 +14287,8 @@ "tags": [ "search" ], - "summary": "A search request by default executes against the most recent visible data of the target indices,\n", - "description": "which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.", + "summary": "Open a point in time", + "description": "A search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.", "operationId": "open-point-in-time", "parameters": [ { @@ -14895,7 +14910,8 @@ "tags": [ "search" ], - "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", + "summary": "Evaluate ranked search results", + "description": "Evaluate the quality of ranked search results over a set of typical search queries.", "operationId": "rank-eval", "parameters": [ { @@ -14925,7 +14941,8 @@ "tags": [ "search" ], - "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", + "summary": "Evaluate ranked search results", + "description": "Evaluate the quality of ranked search results over a set of typical search queries.", "operationId": "rank-eval-1", "parameters": [ { @@ -14957,7 +14974,8 @@ "tags": [ "search" ], - "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", + "summary": "Evaluate ranked search results", + "description": "Evaluate the quality of ranked search results over a set of typical search queries.", "operationId": "rank-eval-2", "parameters": [ { @@ -14990,7 +15008,8 @@ "tags": [ "search" ], - "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", + "summary": "Evaluate ranked search results", + "description": "Evaluate the quality of ranked search results over a set of typical search queries.", "operationId": "rank-eval-3", "parameters": [ { @@ -15218,7 +15237,8 @@ "tags": [ "search" ], - "summary": "Renders a search template as a search request body", + "summary": "Render a search template", + "description": "Render a search template as a search request body.", "operationId": "render-search-template", "requestBody": { "$ref": "#/components/requestBodies/render_search_template" @@ -15233,7 +15253,8 @@ "tags": [ "search" ], - "summary": "Renders a search template as a search request body", + "summary": "Render a search template", + "description": "Render a search template as a search request body.", "operationId": "render-search-template-1", "requestBody": { "$ref": "#/components/requestBodies/render_search_template" @@ -15250,7 +15271,8 @@ "tags": [ "search" ], - "summary": "Renders a search template as a search request body", + "summary": "Render a search template", + "description": "Render a search template as a search request body.", "operationId": "render-search-template-2", "parameters": [ { @@ -15270,7 +15292,8 @@ "tags": [ "search" ], - "summary": "Renders a search template as a search request body", + "summary": "Render a search template", + "description": "Render a search template as a search request body.", "operationId": "render-search-template-3", "parameters": [ { @@ -16403,7 +16426,10 @@ "tags": [ "search" ], - "summary": "Runs a search with a search template", + "summary": "Run a search with a search template", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "search-template", "parameters": [ { @@ -16460,7 +16486,10 @@ "tags": [ "search" ], - "summary": "Runs a search with a search template", + "summary": "Run a search with a search template", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "search-template-1", "parameters": [ { @@ -16519,7 +16548,10 @@ "tags": [ "search" ], - "summary": "Runs a search with a search template", + "summary": "Run a search with a search template", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "search-template-2", "parameters": [ { @@ -16579,7 +16611,10 @@ "tags": [ "search" ], - "summary": "Runs a search with a search template", + "summary": "Run a search with a search template", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, "operationId": "search-template-3", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 0a17eba331..82cf662cae 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -2147,7 +2147,7 @@ "stability": "stable" } }, - "description": "Clears the search context and results for a scrolling search.", + "description": "Clear a scrolling search.\n\nClear the search context and results for a scrolling search.", "docId": "clear-scroll-api", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-scroll-api.html", @@ -2198,7 +2198,7 @@ "stability": "stable" } }, - "description": "Closes a point-in-time.", + "description": "Close a point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no lwonger required for search requests.", "docId": "point-in-time-api", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", @@ -5008,7 +5008,7 @@ "stability": "stable" } }, - "description": "The field capabilities API returns the information about the capabilities of fields among multiple indices.\nThe field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "description": "Get the field capabilities.\n\nGet information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html", "name": "field_caps", @@ -12818,9 +12818,11 @@ "stability": "stable" } }, - "description": "Runs multiple templated searches with a single request.", + "description": "Run multiple templated searches.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html", + "extDocId": "search-templates", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html", "name": "msearch_template", "privileges": { "index": [ @@ -13277,7 +13279,7 @@ "stability": "stable" } }, - "description": "A search request by default executes against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.", + "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.", "docId": "point-in-time-api", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", @@ -13801,7 +13803,7 @@ "stability": "stable" } }, - "description": "Enables you to evaluate the quality of ranked search results over a set of typical search queries.", + "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", "name": "rank_eval", @@ -13927,7 +13929,7 @@ "stability": "stable" } }, - "description": "Renders a search template as a search request body.", + "description": "Render a search template.\n\nRender a search template as a search request body.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html", "name": "render_search_template", @@ -14820,9 +14822,11 @@ "stability": "stable" } }, - "description": "Runs a search with a search template.", + "description": "Run a search with a search template.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", + "extDocId": "search-template", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html", "name": "search_template", "request": { "name": "Request", @@ -21242,7 +21246,7 @@ } ] }, - "description": "Clears the search context and results for a scrolling search.", + "description": "Clear a scrolling search.\n\nClear the search context and results for a scrolling search.", "inherits": { "type": { "name": "RequestBase", @@ -21268,7 +21272,7 @@ } ], "query": [], - "specLocation": "_global/clear_scroll/ClearScrollRequest.ts#L23-L46" + "specLocation": "_global/clear_scroll/ClearScrollRequest.ts#L23-L48" }, { "kind": "response", @@ -21361,7 +21365,7 @@ } ] }, - "description": "Closes a point-in-time.", + "description": "Close a point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no lwonger required for search requests.", "inherits": { "type": { "name": "RequestBase", @@ -21374,7 +21378,7 @@ }, "path": [], "query": [], - "specLocation": "_global/close_point_in_time/ClosePointInTimeRequest.ts#L23-L38" + "specLocation": "_global/close_point_in_time/ClosePointInTimeRequest.ts#L23-L43" }, { "kind": "response", @@ -23880,7 +23884,7 @@ } ] }, - "description": "The field capabilities API returns the information about the capabilities of fields among multiple indices.\nThe field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "description": "Get the field capabilities.\n\nGet information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "inherits": { "type": { "name": "RequestBase", @@ -24029,7 +24033,7 @@ } } ], - "specLocation": "_global/field_caps/FieldCapabilitiesRequest.ts#L25-L107" + "specLocation": "_global/field_caps/FieldCapabilitiesRequest.ts#L25-L111" }, { "kind": "response", @@ -28585,7 +28589,7 @@ } } }, - "description": "Runs multiple templated searches with a single request.", + "description": "Run multiple templated searches.", "inherits": { "type": { "name": "RequestBase", @@ -28675,7 +28679,7 @@ } } ], - "specLocation": "_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L71" + "specLocation": "_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L72" }, { "kind": "type_alias", @@ -29358,7 +29362,7 @@ } ] }, - "description": "A search request by default executes against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.", + "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.", "inherits": { "type": { "name": "RequestBase", @@ -29447,7 +29451,7 @@ } } ], - "specLocation": "_global/open_point_in_time/OpenPointInTimeRequest.ts#L25-L76" + "specLocation": "_global/open_point_in_time/OpenPointInTimeRequest.ts#L25-L81" }, { "kind": "response", @@ -30240,7 +30244,7 @@ } ] }, - "description": "Enables you to evaluate the quality of ranked search results over a set of typical search queries.", + "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", "inherits": { "type": { "name": "RequestBase", @@ -30317,7 +30321,7 @@ } } ], - "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L62" + "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L64" }, { "kind": "response", @@ -31602,7 +31606,7 @@ } ] }, - "description": "Renders a search template as a search request body.", + "description": "Render a search template.\n\nRender a search template as a search request body.", "inherits": { "type": { "name": "RequestBase", @@ -31628,7 +31632,7 @@ } ], "query": [], - "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L56" + "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L58" }, { "kind": "response", @@ -39834,7 +39838,7 @@ } ] }, - "description": "Runs a search with a search template.", + "description": "Run a search with a search template.", "inherits": { "type": { "name": "RequestBase", @@ -40031,7 +40035,7 @@ } } ], - "specLocation": "_global/search_template/SearchTemplateRequest.ts#L32-L135" + "specLocation": "_global/search_template/SearchTemplateRequest.ts#L32-L136" }, { "kind": "response", diff --git a/specification/_global/search_template/SearchTemplateRequest.ts b/specification/_global/search_template/SearchTemplateRequest.ts index baa6b8e7c4..8ef681d9c6 100644 --- a/specification/_global/search_template/SearchTemplateRequest.ts +++ b/specification/_global/search_template/SearchTemplateRequest.ts @@ -35,7 +35,7 @@ import { Duration } from '@_types/Time' * @availability stack since=2.0.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_tag search - * @ext_doc_id search-teamplate + * @ext_doc_id search-template */ export interface Request extends RequestBase { path_parts: { From 90108dc17cfbb108332140f1493f69ccfe956061 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 24 Oct 2024 18:29:35 -0700 Subject: [PATCH 3/8] Fix style --- .../_global/open_point_in_time/OpenPointInTimeRequest.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts index ff39e85c8d..8b1da5da5e 100644 --- a/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts +++ b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts @@ -31,7 +31,7 @@ import { Duration } from '@_types/Time' * search requests using the same point in time. For example, if refreshes happen between * `search_after` requests, then the results of those requests might not be consistent as changes happening * between searches are only visible to the more recent point in time. - * + * * A point in time must be opened explicitly before being used in search requests. * The `keep_alive` parameter tells Elasticsearch how long it should persist. * @rest_spec_name open_point_in_time From 5e11b73cab46fc222b2ff13d442ccce434704d85 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 24 Oct 2024 18:47:44 -0700 Subject: [PATCH 4/8] [OpenAPI] More search summary edits --- .../_global/knn_search/KnnSearchRequest.ts | 13 +++++++++++++ specification/_global/search/SearchRequest.ts | 4 +++- .../_global/search_mvt/SearchMvtRequest.ts | 3 ++- .../_global/search_shards/SearchShardsRequest.ts | 5 +++++ .../_global/termvectors/TermVectorsRequest.ts | 3 ++- .../async_search/delete/AsyncSearchDeleteRequest.ts | 1 + .../async_search/get/AsyncSearchGetRequest.ts | 1 + .../async_search/status/AsyncSearchStatusRequest.ts | 5 +++-- .../async_search/submit/AsyncSearchSubmitRequest.ts | 1 + 9 files changed, 31 insertions(+), 5 deletions(-) diff --git a/specification/_global/knn_search/KnnSearchRequest.ts b/specification/_global/knn_search/KnnSearchRequest.ts index eaaf545dba..751d575704 100644 --- a/specification/_global/knn_search/KnnSearchRequest.ts +++ b/specification/_global/knn_search/KnnSearchRequest.ts @@ -24,6 +24,19 @@ import { FieldAndFormat, QueryContainer } from '@_types/query_dsl/abstractions' import { Query } from './_types/Knn' /** + * Run a knn search. + * + * NOTE: The kNN search API has been replaced by the `knn` option in the search API. + * + * Perform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents. + * Given a query vector, the API finds the k closest vectors and returns those documents as search hits. + * + * Elasticsearch uses the HNSW algorithm to support efficient kNN search. + * Like most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed. + * This means the results returned are not always the true k closest neighbors. + * + * The kNN search API supports restricting the search using a filter. + * The search will return the top k documents that also match the filter query. * @rest_spec_name knn_search * @availability stack since=8.0.0 stability=experimental * @deprecated 8.4.0 diff --git a/specification/_global/search/SearchRequest.ts b/specification/_global/search/SearchRequest.ts index 9fec2b244d..c30f03bc2e 100644 --- a/specification/_global/search/SearchRequest.ts +++ b/specification/_global/search/SearchRequest.ts @@ -52,7 +52,9 @@ import { SourceConfig, SourceConfigParam } from './_types/SourceFilter' import { Suggester } from './_types/suggester' /** - * Returns search hits that match the query defined in the request. + * Run a search. + * + * Get search hits that match the query defined in the request. * You can provide search queries using the `q` query string parameter or the request body. * If both are specified, only the query parameter is used. * @rest_spec_name search diff --git a/specification/_global/search_mvt/SearchMvtRequest.ts b/specification/_global/search_mvt/SearchMvtRequest.ts index 9ec4803a7e..d8db29efc2 100644 --- a/specification/_global/search_mvt/SearchMvtRequest.ts +++ b/specification/_global/search_mvt/SearchMvtRequest.ts @@ -32,7 +32,8 @@ import { ZoomLevel } from './_types/ZoomLevel' /** * Search a vector tile. - * Searches a vector tile for geospatial values. + * + * Search a vector tile for geospatial values. * @rest_spec_name search_mvt * @availability stack since=7.15.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/search_shards/SearchShardsRequest.ts b/specification/_global/search_shards/SearchShardsRequest.ts index ee3f985563..ee6fd48fe3 100644 --- a/specification/_global/search_shards/SearchShardsRequest.ts +++ b/specification/_global/search_shards/SearchShardsRequest.ts @@ -21,6 +21,11 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Indices, Routing } from '@_types/common' /** + * Get the search shards. + * + * Get the indices and shards that a search request would be run against. + * This information can be useful for working out issues or planning optimizations with routing and shard preferences. + * When filtered aliases are used, the filter is returned as part of the indices section. * @rest_spec_name search_shards * @availability stack stability=stable * @doc_tag search diff --git a/specification/_global/termvectors/TermVectorsRequest.ts b/specification/_global/termvectors/TermVectorsRequest.ts index 4f16e93562..50293fd046 100644 --- a/specification/_global/termvectors/TermVectorsRequest.ts +++ b/specification/_global/termvectors/TermVectorsRequest.ts @@ -32,7 +32,8 @@ import { Filter } from './types' /** * Get term vector information. - * Returns information and statistics about terms in the fields of a particular document. + * + * Get information and statistics about terms in the fields of a particular document. * @rest_spec_name termvectors * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/async_search/delete/AsyncSearchDeleteRequest.ts b/specification/async_search/delete/AsyncSearchDeleteRequest.ts index 3349954c83..daf827e8f3 100644 --- a/specification/async_search/delete/AsyncSearchDeleteRequest.ts +++ b/specification/async_search/delete/AsyncSearchDeleteRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Delete an async search. + * * If the asynchronous search is still running, it is cancelled. * Otherwise, the saved search results are deleted. * If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. diff --git a/specification/async_search/get/AsyncSearchGetRequest.ts b/specification/async_search/get/AsyncSearchGetRequest.ts index abc7c4f60a..66dd3b49be 100644 --- a/specification/async_search/get/AsyncSearchGetRequest.ts +++ b/specification/async_search/get/AsyncSearchGetRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get async search results. + * * Retrieve the results of a previously submitted asynchronous search request. * If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. * @rest_spec_name async_search.get diff --git a/specification/async_search/status/AsyncSearchStatusRequest.ts b/specification/async_search/status/AsyncSearchStatusRequest.ts index 2b21d4daad..4a8f4f7816 100644 --- a/specification/async_search/status/AsyncSearchStatusRequest.ts +++ b/specification/async_search/status/AsyncSearchStatusRequest.ts @@ -21,8 +21,9 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Get async search status. - * Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results. + * Get the async search status. + * + * Get the status of a previously submitted async search request given its identifier, without retrieving search results. * If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. * @rest_spec_name async_search.status * @availability stack since=7.11.0 stability=stable diff --git a/specification/async_search/submit/AsyncSearchSubmitRequest.ts b/specification/async_search/submit/AsyncSearchSubmitRequest.ts index 5be3d05841..1bc571dc43 100644 --- a/specification/async_search/submit/AsyncSearchSubmitRequest.ts +++ b/specification/async_search/submit/AsyncSearchSubmitRequest.ts @@ -54,6 +54,7 @@ import { Duration } from '@_types/Time' /** * Run an async search. + * * When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. * * Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. From efe7a7322d8fec96bfbf0a3926a27ca4b97091cf Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 24 Oct 2024 18:48:38 -0700 Subject: [PATCH 5/8] Generate output --- output/openapi/elasticsearch-openapi.json | 50 +++++++++-------- .../elasticsearch-serverless-openapi.json | 32 +++++------ output/schema/schema.json | 54 +++++++++---------- 3 files changed, 71 insertions(+), 65 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 8875b761fc..3e7a49184c 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -114,8 +114,8 @@ "tags": [ "search" ], - "summary": "Get async search status", - "description": "Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "summary": "Get the async search status", + "description": "Get the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "operationId": "async-search-status", "parameters": [ { @@ -15493,7 +15493,8 @@ "tags": [ "search" ], - "summary": "Performs a kNN search", + "summary": "Run a knn search", + "description": "NOTE: The kNN search API has been replaced by the `knn` option in the search API.\n\nPerform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents.\nGiven a query vector, the API finds the k closest vectors and returns those documents as search hits.\n\nElasticsearch uses the HNSW algorithm to support efficient kNN search.\nLike most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed.\nThis means the results returned are not always the true k closest neighbors.\n\nThe kNN search API supports restricting the search using a filter.\nThe search will return the top k documents that also match the filter query.", "operationId": "knn-search", "parameters": [ { @@ -15518,7 +15519,8 @@ "tags": [ "search" ], - "summary": "Performs a kNN search", + "summary": "Run a knn search", + "description": "NOTE: The kNN search API has been replaced by the `knn` option in the search API.\n\nPerform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents.\nGiven a query vector, the API finds the k closest vectors and returns those documents as search hits.\n\nElasticsearch uses the HNSW algorithm to support efficient kNN search.\nLike most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed.\nThis means the results returned are not always the true k closest neighbors.\n\nThe kNN search API supports restricting the search using a filter.\nThe search will return the top k documents that also match the filter query.", "operationId": "knn-search-1", "parameters": [ { @@ -25213,8 +25215,8 @@ "tags": [ "search" ], - "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "summary": "Run a search", + "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "operationId": "search", "parameters": [ { @@ -25366,8 +25368,8 @@ "tags": [ "search" ], - "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "summary": "Run a search", + "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "operationId": "search-1", "parameters": [ { @@ -25521,8 +25523,8 @@ "tags": [ "search" ], - "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "summary": "Run a search", + "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "operationId": "search-2", "parameters": [ { @@ -25677,8 +25679,8 @@ "tags": [ "search" ], - "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "summary": "Run a search", + "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "operationId": "search-3", "parameters": [ { @@ -26189,7 +26191,7 @@ "search" ], "summary": "Search a vector tile", - "description": "Searches a vector tile for geospatial values.", + "description": "Search a vector tile for geospatial values.", "operationId": "search-mvt-1", "parameters": [ { @@ -26244,7 +26246,7 @@ "search" ], "summary": "Search a vector tile", - "description": "Searches a vector tile for geospatial values.", + "description": "Search a vector tile for geospatial values.", "operationId": "search-mvt", "parameters": [ { @@ -26300,7 +26302,8 @@ "tags": [ "search" ], - "summary": "Returns information about the indices and shards that a search request would be executed against", + "summary": "Get the search shards", + "description": "Get the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the indices section.", "operationId": "search-shards", "parameters": [ { @@ -26332,7 +26335,8 @@ "tags": [ "search" ], - "summary": "Returns information about the indices and shards that a search request would be executed against", + "summary": "Get the search shards", + "description": "Get the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the indices section.", "operationId": "search-shards-1", "parameters": [ { @@ -26366,7 +26370,8 @@ "tags": [ "search" ], - "summary": "Returns information about the indices and shards that a search request would be executed against", + "summary": "Get the search shards", + "description": "Get the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the indices section.", "operationId": "search-shards-2", "parameters": [ { @@ -26401,7 +26406,8 @@ "tags": [ "search" ], - "summary": "Returns information about the indices and shards that a search request would be executed against", + "summary": "Get the search shards", + "description": "Get the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the indices section.", "operationId": "search-shards-3", "parameters": [ { @@ -32960,7 +32966,7 @@ "document" ], "summary": "Get term vector information", - "description": "Returns information and statistics about terms in the fields of a particular document.", + "description": "Get information and statistics about terms in the fields of a particular document.", "operationId": "termvectors", "parameters": [ { @@ -33017,7 +33023,7 @@ "document" ], "summary": "Get term vector information", - "description": "Returns information and statistics about terms in the fields of a particular document.", + "description": "Get information and statistics about terms in the fields of a particular document.", "operationId": "termvectors-1", "parameters": [ { @@ -33076,7 +33082,7 @@ "document" ], "summary": "Get term vector information", - "description": "Returns information and statistics about terms in the fields of a particular document.", + "description": "Get information and statistics about terms in the fields of a particular document.", "operationId": "termvectors-2", "parameters": [ { @@ -33130,7 +33136,7 @@ "document" ], "summary": "Get term vector information", - "description": "Returns information and statistics about terms in the fields of a particular document.", + "description": "Get information and statistics about terms in the fields of a particular document.", "operationId": "termvectors-3", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 533fce8091..d24d431460 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -114,8 +114,8 @@ "tags": [ "search" ], - "summary": "Get async search status", - "description": "Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "summary": "Get the async search status", + "description": "Get the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "operationId": "async-search-status", "parameters": [ { @@ -15351,8 +15351,8 @@ "tags": [ "search" ], - "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "summary": "Run a search", + "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "operationId": "search", "parameters": [ { @@ -15501,8 +15501,8 @@ "tags": [ "search" ], - "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "summary": "Run a search", + "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "operationId": "search-1", "parameters": [ { @@ -15653,8 +15653,8 @@ "tags": [ "search" ], - "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "summary": "Run a search", + "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "operationId": "search-2", "parameters": [ { @@ -15806,8 +15806,8 @@ "tags": [ "search" ], - "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "summary": "Run a search", + "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "operationId": "search-3", "parameters": [ { @@ -16315,7 +16315,7 @@ "search" ], "summary": "Search a vector tile", - "description": "Searches a vector tile for geospatial values.", + "description": "Search a vector tile for geospatial values.", "operationId": "search-mvt-1", "parameters": [ { @@ -16370,7 +16370,7 @@ "search" ], "summary": "Search a vector tile", - "description": "Searches a vector tile for geospatial values.", + "description": "Search a vector tile for geospatial values.", "operationId": "search-mvt", "parameters": [ { @@ -18261,7 +18261,7 @@ "document" ], "summary": "Get term vector information", - "description": "Returns information and statistics about terms in the fields of a particular document.", + "description": "Get information and statistics about terms in the fields of a particular document.", "operationId": "termvectors", "parameters": [ { @@ -18318,7 +18318,7 @@ "document" ], "summary": "Get term vector information", - "description": "Returns information and statistics about terms in the fields of a particular document.", + "description": "Get information and statistics about terms in the fields of a particular document.", "operationId": "termvectors-1", "parameters": [ { @@ -18377,7 +18377,7 @@ "document" ], "summary": "Get term vector information", - "description": "Returns information and statistics about terms in the fields of a particular document.", + "description": "Get information and statistics about terms in the fields of a particular document.", "operationId": "termvectors-2", "parameters": [ { @@ -18431,7 +18431,7 @@ "document" ], "summary": "Get term vector information", - "description": "Returns information and statistics about terms in the fields of a particular document.", + "description": "Get information and statistics about terms in the fields of a particular document.", "operationId": "termvectors-3", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 82cf662cae..6b06e3321c 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -171,7 +171,7 @@ "stability": "stable" } }, - "description": "Delete an async search.\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", + "description": "Delete an async search.\n\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -208,7 +208,7 @@ "stability": "stable" } }, - "description": "Get async search results.\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", + "description": "Get async search results.\n\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -245,7 +245,7 @@ "stability": "stable" } }, - "description": "Get async search status.\nRetrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -282,7 +282,7 @@ "stability": "stable" } }, - "description": "Run an async search.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "description": "Run an async search.\n\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -8871,7 +8871,7 @@ "description": "", "version": "8.4.0" }, - "description": "Performs a kNN search.", + "description": "Run a knn search.\n\nNOTE: The kNN search API has been replaced by the `knn` option in the search API.\n\nPerform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents.\nGiven a query vector, the API finds the k closest vectors and returns those documents as search hits.\n\nElasticsearch uses the HNSW algorithm to support efficient kNN search.\nLike most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed.\nThis means the results returned are not always the true k closest neighbors.\n\nThe kNN search API supports restricting the search using a filter.\nThe search will return the top k documents that also match the filter query.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", "name": "knn_search", @@ -14340,7 +14340,7 @@ "stability": "stable" } }, - "description": "Returns search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "description": "Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", "name": "search", "privileges": { @@ -14743,7 +14743,7 @@ "stability": "stable" } }, - "description": "Search a vector tile.\nSearches a vector tile for geospatial values.", + "description": "Search a vector tile.\n\nSearch a vector tile for geospatial values.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html", "name": "search_mvt", @@ -14778,7 +14778,7 @@ "stability": "stable" } }, - "description": "Returns information about the indices and shards that a search request would be executed against.", + "description": "Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the indices section.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html", "name": "search_shards", @@ -19042,7 +19042,7 @@ "stability": "stable" } }, - "description": "Get term vector information.\nReturns information and statistics about terms in the fields of a particular document.", + "description": "Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html", "name": "termvectors", @@ -26931,7 +26931,7 @@ "description": "", "version": "8.4.0" }, - "description": "Performs a kNN search.", + "description": "Run a knn search.\n\nNOTE: The kNN search API has been replaced by the `knn` option in the search API.\n\nPerform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents.\nGiven a query vector, the API finds the k closest vectors and returns those documents as search hits.\n\nElasticsearch uses the HNSW algorithm to support efficient kNN search.\nLike most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed.\nThis means the results returned are not always the true k closest neighbors.\n\nThe kNN search API supports restricting the search using a filter.\nThe search will return the top k documents that also match the filter query.", "inherits": { "type": { "name": "RequestBase", @@ -26970,7 +26970,7 @@ } } ], - "specLocation": "_global/knn_search/KnnSearchRequest.ts#L26-L83" + "specLocation": "_global/knn_search/KnnSearchRequest.ts#L26-L96" }, { "kind": "response", @@ -32476,7 +32476,7 @@ } ] }, - "description": "Returns search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "description": "Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "inherits": { "type": { "name": "RequestBase", @@ -33096,7 +33096,7 @@ } } ], - "specLocation": "_global/search/SearchRequest.ts#L54-L529" + "specLocation": "_global/search/SearchRequest.ts#L54-L531" }, { "kind": "response", @@ -39152,7 +39152,7 @@ } ] }, - "description": "Search a vector tile.\nSearches a vector tile for geospatial values.", + "description": "Search a vector tile.\n\nSearch a vector tile for geospatial values.", "inherits": { "type": { "name": "RequestBase", @@ -39316,7 +39316,7 @@ } } ], - "specLocation": "_global/search_mvt/SearchMvtRequest.ts#L33-L192" + "specLocation": "_global/search_mvt/SearchMvtRequest.ts#L33-L193" }, { "kind": "response", @@ -39415,7 +39415,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about the indices and shards that a search request would be executed against.", + "description": "Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the indices section.", "inherits": { "type": { "name": "RequestBase", @@ -39518,7 +39518,7 @@ } } ], - "specLocation": "_global/search_shards/SearchShardsRequest.ts#L23-L71" + "specLocation": "_global/search_shards/SearchShardsRequest.ts#L23-L76" }, { "kind": "response", @@ -40634,7 +40634,7 @@ } ] }, - "description": "Get term vector information.\nReturns information and statistics about terms in the fields of a particular document.", + "description": "Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.", "generics": [ { "name": "TDocument", @@ -40819,7 +40819,7 @@ } } ], - "specLocation": "_global/termvectors/TermVectorsRequest.ts#L33-L121" + "specLocation": "_global/termvectors/TermVectorsRequest.ts#L33-L122" }, { "kind": "response", @@ -87083,7 +87083,7 @@ "body": { "kind": "no_body" }, - "description": "Delete an async search.\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", + "description": "Delete an async search.\n\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "inherits": { "type": { "name": "RequestBase", @@ -87109,7 +87109,7 @@ } ], "query": [], - "specLocation": "async_search/delete/AsyncSearchDeleteRequest.ts#L23-L39" + "specLocation": "async_search/delete/AsyncSearchDeleteRequest.ts#L23-L40" }, { "kind": "response", @@ -87137,7 +87137,7 @@ "body": { "kind": "no_body" }, - "description": "Get async search results.\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", + "description": "Get async search results.\n\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "inherits": { "type": { "name": "RequestBase", @@ -87200,7 +87200,7 @@ } } ], - "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L56" + "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L57" }, { "kind": "response", @@ -87243,7 +87243,7 @@ "body": { "kind": "no_body" }, - "description": "Get async search status.\nRetrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "inherits": { "type": { "name": "RequestBase", @@ -87269,7 +87269,7 @@ } ], "query": [], - "specLocation": "async_search/status/AsyncSearchStatusRequest.ts#L23-L38" + "specLocation": "async_search/status/AsyncSearchStatusRequest.ts#L23-L39" }, { "kind": "response", @@ -87824,7 +87824,7 @@ } ] }, - "description": "Run an async search.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "description": "Run an async search.\n\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "inherits": { "type": { "name": "RequestBase", @@ -88425,7 +88425,7 @@ } } ], - "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L289" + "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L290" }, { "kind": "response", From 2c3146a88ea74391f9884299aa5975e534c5246d Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 24 Oct 2024 19:34:19 -0700 Subject: [PATCH 6/8] Fix whitespace --- specification/_global/knn_search/KnnSearchRequest.ts | 2 +- specification/_global/search_shards/SearchShardsRequest.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/_global/knn_search/KnnSearchRequest.ts b/specification/_global/knn_search/KnnSearchRequest.ts index 751d575704..2e826c9c82 100644 --- a/specification/_global/knn_search/KnnSearchRequest.ts +++ b/specification/_global/knn_search/KnnSearchRequest.ts @@ -25,7 +25,7 @@ import { Query } from './_types/Knn' /** * Run a knn search. - * + * * NOTE: The kNN search API has been replaced by the `knn` option in the search API. * * Perform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents. diff --git a/specification/_global/search_shards/SearchShardsRequest.ts b/specification/_global/search_shards/SearchShardsRequest.ts index ee6fd48fe3..55cfecbf64 100644 --- a/specification/_global/search_shards/SearchShardsRequest.ts +++ b/specification/_global/search_shards/SearchShardsRequest.ts @@ -22,7 +22,7 @@ import { ExpandWildcards, Indices, Routing } from '@_types/common' /** * Get the search shards. - * + * * Get the indices and shards that a search request would be run against. * This information can be useful for working out issues or planning optimizations with routing and shard preferences. * When filtered aliases are used, the filter is returned as part of the indices section. From f090a2ed007eb342a7550cccb00e002192f2a3af Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Tue, 5 Nov 2024 08:43:36 -0800 Subject: [PATCH 7/8] Update specification/_global/close_point_in_time/ClosePointInTimeRequest.ts Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> --- .../_global/close_point_in_time/ClosePointInTimeRequest.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts b/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts index 93224768a1..d54897fd66 100644 --- a/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts +++ b/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts @@ -26,7 +26,7 @@ import { Id } from '@_types/common' * A point in time must be opened explicitly before being used in search requests. * The `keep_alive` parameter tells Elasticsearch how long it should persist. * A point in time is automatically closed when the `keep_alive` period has elapsed. - * However, keeping points in time has a cost; close them as soon as they are no lwonger required for search requests. + * However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. * @rest_spec_name close_point_in_time * @availability stack since=7.10.0 stability=stable * @availability serverless stability=stable visibility=public From d2fceda4e67a28dc48234fa184834f44ecfdcee7 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 5 Nov 2024 08:46:26 -0800 Subject: [PATCH 8/8] Refresh output --- output/openapi/elasticsearch-openapi.json | 2 +- output/openapi/elasticsearch-serverless-openapi.json | 2 +- output/schema/schema.json | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index c4b2270304..a54b56c3e9 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -2920,7 +2920,7 @@ "search" ], "summary": "Close a point in time", - "description": "A point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no lwonger required for search requests.", + "description": "A point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", "operationId": "close-point-in-time", "requestBody": { "content": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 60e5ed54ac..5402baf1ab 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -1393,7 +1393,7 @@ "search" ], "summary": "Close a point in time", - "description": "A point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no lwonger required for search requests.", + "description": "A point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", "operationId": "close-point-in-time", "requestBody": { "content": { diff --git a/output/schema/schema.json b/output/schema/schema.json index 9ac031bf34..002b7d8086 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -2198,7 +2198,7 @@ "stability": "stable" } }, - "description": "Close a point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no lwonger required for search requests.", + "description": "Close a point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", "docId": "point-in-time-api", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", @@ -21384,7 +21384,7 @@ } ] }, - "description": "Close a point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no lwonger required for search requests.", + "description": "Close a point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", "inherits": { "type": { "name": "RequestBase",