From 2c8307f98f3ab667ca168c9adb051ab1c7648762 Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Mon, 27 Jan 2025 16:26:58 +0000 Subject: [PATCH] Update specification output --- output/schema/schema-serverless.json | 164 +++++++++++++++++---------- 1 file changed, 106 insertions(+), 58 deletions(-) diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 7116725468..4d2bd7e7c0 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -2586,10 +2586,16 @@ "stability": "stable" } }, - "description": "Explain a document match result.\nReturns information about why a specific document matches, or doesn’t match, a query.", + "description": "Explain a document match result.\nGet information about why a specific document matches, or doesn't match, a query.\nIt computes a score explanation for a query and a specific document.", + "docId": "search-explain", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-explain.html", "name": "explain", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", "namespace": "_global.explain" @@ -7569,10 +7575,16 @@ "stability": "stable" } }, - "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.", + "description": "Get multiple term vectors.\n\nGet multiple term vectors with a single request.\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.", + "docId": "docs-multi-termvectors", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-multi-termvectors.html", "name": "mtermvectors", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", "namespace": "_global.mtermvectors" @@ -8189,9 +8201,15 @@ } }, "description": "Render a search template.\n\nRender a search template as a search request body.", + "docId": "render-search-template-api", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/render-search-template-api.html", "name": "render_search_template", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", "namespace": "_global.render_search_template" @@ -8742,11 +8760,17 @@ } }, "description": "Run a search with a search template.", + "docId": "search-template-api", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template-api.html", "extDocId": "search-template", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html", "name": "search_template", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", "namespace": "_global.search_template" @@ -9725,10 +9749,16 @@ "stability": "stable" } }, - "description": "Get term vector information.\n\nGet 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.\n\nYou can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.\nYou can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.\nFor example:\n\n```\nGET /my-index-000001/_termvectors/1?fields=message\n```\n\nFields can be specified using wildcards, similar to the multi match query.\n\nTerm vectors are real-time by default, not near real-time.\nThis can be changed by setting `realtime` parameter to `false`.\n\nYou can request three types of values: _term information_, _term statistics_, and _field statistics_.\nBy default, all term information and field statistics are returned for all fields but term statistics are excluded.\n\n**Term information**\n\n* term frequency in the field (always returned)\n* term positions (`positions: true`)\n* start and end offsets (`offsets: true`)\n* term payloads (`payloads: true`), as base64 encoded bytes\n\nIf the requested information wasn't stored in the index, it will be computed on the fly if possible.\nAdditionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.\n\n> warn\n> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.\n\n**Behaviour**\n\nThe term and field statistics are not accurate.\nDeleted documents are not taken into account.\nThe information is only retrieved for the shard the requested document resides in.\nThe term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.\nBy default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.\nUse `routing` only to hit a particular shard.", + "docId": "docs-termvectors", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-termvectors.html", "name": "termvectors", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", "namespace": "_global.termvectors" @@ -18692,7 +18722,7 @@ } ] }, - "description": "Explain a document match result.\nReturns information about why a specific document matches, or doesn’t match, a query.", + "description": "Explain a document match result.\nGet information about why a specific document matches, or doesn't match, a query.\nIt computes a score explanation for a query and a specific document.", "inherits": { "type": { "name": "RequestBase", @@ -18706,7 +18736,7 @@ }, "path": [ { - "description": "Defines the document ID.", + "description": "The document identifier.", "name": "id", "required": true, "type": { @@ -18718,7 +18748,7 @@ } }, { - "description": "Index names used to limit the request.\nOnly a single index name can be provided to this parameter.", + "description": "Index names that are used to limit the request.\nOnly a single index name can be provided to this parameter.", "name": "index", "required": true, "type": { @@ -18732,7 +18762,7 @@ ], "query": [ { - "description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", + "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "name": "analyzer", "required": false, "type": { @@ -18744,7 +18774,7 @@ } }, { - "description": "If `true`, wildcard and prefix queries are analyzed.", + "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.", "name": "analyze_wildcard", "required": false, "serverDefault": false, @@ -18757,7 +18787,7 @@ } }, { - "description": "The default operator for query string query: `AND` or `OR`.", + "description": "The default operator for query string query: `AND` or `OR`.\nThis parameter can be used only when the `q` query string parameter is specified.", "name": "default_operator", "required": false, "serverDefault": "OR", @@ -18770,7 +18800,7 @@ } }, { - "description": "Field to use as default where no field prefix is given in the query string.", + "description": "The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "name": "df", "required": false, "type": { @@ -18782,7 +18812,7 @@ } }, { - "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", + "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.", "name": "lenient", "required": false, "serverDefault": false, @@ -18795,7 +18825,7 @@ } }, { - "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "description": "The node or shard the operation should be performed on.\nIt is random by default.", "name": "preference", "required": false, "type": { @@ -18807,7 +18837,7 @@ } }, { - "description": "Custom value used to route operations to a specific shard.", + "description": "A custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -18819,7 +18849,7 @@ } }, { - "description": "True or false to return the `_source` field or not, or a list of fields to return.", + "description": "`True` or `false` to return the `_source` field or not or a list of fields to return.", "name": "_source", "required": false, "type": { @@ -18831,7 +18861,7 @@ } }, { - "description": "A comma-separated list of source fields to exclude from the response.", + "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "name": "_source_excludes", "required": false, "type": { @@ -18843,7 +18873,7 @@ } }, { - "description": "A comma-separated list of source fields to include in the response.", + "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "name": "_source_includes", "required": false, "type": { @@ -18867,7 +18897,7 @@ } }, { - "description": "Query in the Lucene query string syntax.", + "description": "The query in the Lucene query string syntax.", "name": "q", "required": false, "type": { @@ -18879,7 +18909,7 @@ } } ], - "specLocation": "_global/explain/ExplainRequest.ts#L26-L107" + "specLocation": "_global/explain/ExplainRequest.ts#L26-L119" }, { "body": { @@ -34911,7 +34941,7 @@ "kind": "properties", "properties": [ { - "description": "Array of existing or artificial documents.", + "description": "An array of existing or artificial documents.", "name": "docs", "required": false, "type": { @@ -34926,7 +34956,7 @@ } }, { - "description": "Simplified syntax to specify documents by their ID if they're in the same index.", + "description": "A simplified syntax to specify documents by their ID if they're in the same index.", "name": "ids", "required": false, "type": { @@ -34942,7 +34972,7 @@ } ] }, - "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.", + "description": "Get multiple term vectors.\n\nGet multiple term vectors with a single request.\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", @@ -34956,7 +34986,7 @@ }, "path": [ { - "description": "Name of the index that contains the documents.", + "description": "The name of the index that contains the documents.", "name": "index", "required": false, "type": { @@ -34985,7 +35015,7 @@ } }, { - "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.\nUsed as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", + "description": "A comma-separated list or wildcard expressions of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", "name": "fields", "required": false, "type": { @@ -35049,7 +35079,7 @@ } }, { - "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "description": "The node or shard the operation should be performed on.\nIt is random by default.", "name": "preference", "required": false, "type": { @@ -35076,7 +35106,7 @@ } }, { - "description": "Custom value used to route operations to a specific shard.", + "description": "A custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -35113,7 +35143,7 @@ } }, { - "description": "Specific version type.", + "description": "The version type.", "name": "version_type", "required": false, "type": { @@ -35125,7 +35155,7 @@ } } ], - "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L116" + "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L119" }, { "body": { @@ -36740,6 +36770,18 @@ "body": { "kind": "properties", "properties": [ + { + "description": "The ID of the search template to render.\nIf no `source` is specified, this or the `` request path parameter is required.\nIf you specify both this parameter and the `` parameter, the API uses only ``.", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, { "name": "file", "required": false, @@ -36771,7 +36813,7 @@ } }, { - "description": "An inline search template.\nSupports the same parameters as the search API's request body.\nThese parameters also support Mustache variables.\nIf no `id` or `` is specified, this parameter is required.", + "description": "An inline search template.\nIt supports the same parameters as the search API's request body.\nThese parameters also support Mustache variables.\nIf no `id` or `` is specified, this parameter is required.", "name": "source", "required": false, "type": { @@ -36798,7 +36840,7 @@ }, "path": [ { - "description": "ID of the search template to render.\nIf no `source` is specified, this or the `id` request body parameter is required.", + "description": "The ID of the search template to render.\nIf no `source` is specified, this or the `id` request body parameter is required.", "name": "id", "required": false, "type": { @@ -36811,7 +36853,7 @@ } ], "query": [], - "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L58" + "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L66" }, { "body": { @@ -39229,7 +39271,7 @@ "kind": "properties", "properties": [ { - "description": "If `true`, returns detailed information about score calculation as part of each hit.", + "description": "If `true`, returns detailed information about score calculation as part of each hit.\nIf you specify both this and the `explain` query parameter, the API uses only the query parameter.", "name": "explain", "required": false, "serverDefault": false, @@ -39242,7 +39284,7 @@ } }, { - "description": "ID of the search template to use. If no source is specified,\nthis parameter is required.", + "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.", "name": "id", "required": false, "type": { @@ -39286,7 +39328,7 @@ } }, { - "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. Also supports Mustache variables. If no id is specified, this\nparameter is required.", + "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.", "name": "source", "required": false, "type": { @@ -39313,7 +39355,7 @@ }, "path": [ { - "description": "Comma-separated list of data streams, indices,\nand aliases to search. Supports wildcards (*).", + "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).", "name": "index", "required": false, "type": { @@ -39353,7 +39395,7 @@ } }, { - "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "description": "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", "name": "expand_wildcards", "required": false, "type": { @@ -39378,6 +39420,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.16.0" + }, "description": "If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.", "name": "ignore_throttled", "required": false, @@ -39404,7 +39450,7 @@ } }, { - "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "description": "The node or shard the operation should be performed on.\nIt is random by default.", "name": "preference", "required": false, "type": { @@ -39429,7 +39475,7 @@ } }, { - "description": "Custom value used to route operations to a specific shard.", + "description": "A custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -39471,7 +39517,7 @@ "since": "7.0.0" } }, - "description": "If true, hits.total are rendered as an integer in the response.", + "description": "If `true`, `hits.total` is rendered as an integer in the response.\nIf `false`, it is rendered as an object.", "name": "rest_total_hits_as_int", "required": false, "serverDefault": false, @@ -39497,7 +39543,7 @@ } } ], - "specLocation": "_global/search_template/SearchTemplateRequest.ts#L32-L136" + "specLocation": "_global/search_template/SearchTemplateRequest.ts#L32-L143" }, { "body": { @@ -42802,7 +42848,9 @@ } }, { - "description": "Filter terms based on their tf-idf scores.", + "description": "Filter terms based on their tf-idf scores.\nThis could be useful in order find out a good characteristic vector of a document.\nThis feature works in a similar manner to the second phase of the More Like This Query.", + "extDocId": "query-dsl-mlt-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html", "name": "filter", "required": false, "type": { @@ -42814,7 +42862,7 @@ } }, { - "description": "Overrides the default per-field analyzer.", + "description": "Override the default per-field analyzer.\nThis is useful in order to generate term vectors in any fashion, especially when using artificial documents.\nWhen providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.", "name": "per_field_analyzer", "required": false, "type": { @@ -42838,7 +42886,7 @@ } ] }, - "description": "Get term vector information.\n\nGet 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.\n\nYou can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.\nYou can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.\nFor example:\n\n```\nGET /my-index-000001/_termvectors/1?fields=message\n```\n\nFields can be specified using wildcards, similar to the multi match query.\n\nTerm vectors are real-time by default, not near real-time.\nThis can be changed by setting `realtime` parameter to `false`.\n\nYou can request three types of values: _term information_, _term statistics_, and _field statistics_.\nBy default, all term information and field statistics are returned for all fields but term statistics are excluded.\n\n**Term information**\n\n* term frequency in the field (always returned)\n* term positions (`positions: true`)\n* start and end offsets (`offsets: true`)\n* term payloads (`payloads: true`), as base64 encoded bytes\n\nIf the requested information wasn't stored in the index, it will be computed on the fly if possible.\nAdditionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.\n\n> warn\n> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.\n\n**Behaviour**\n\nThe term and field statistics are not accurate.\nDeleted documents are not taken into account.\nThe information is only retrieved for the shard the requested document resides in.\nThe term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.\nBy default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.\nUse `routing` only to hit a particular shard.", "generics": [ { "name": "TDocument", @@ -42858,7 +42906,7 @@ }, "path": [ { - "description": "Name of the index that contains the document.", + "description": "The name of the index that contains the document.", "name": "index", "required": true, "type": { @@ -42870,7 +42918,7 @@ } }, { - "description": "Unique identifier of the document.", + "description": "A unique identifier for the document.", "name": "id", "required": false, "type": { @@ -42884,7 +42932,7 @@ ], "query": [ { - "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.\nUsed as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", + "description": "A comma-separated list or wildcard expressions of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", "name": "fields", "required": false, "type": { @@ -42896,7 +42944,7 @@ } }, { - "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", + "description": "If `true`, the response includes:\n\n* The document count (how many documents contain this field).\n* The sum of document frequencies (the sum of document frequencies for all terms in this field).\n* The sum of total term frequencies (the sum of total term frequencies of each term in this field).", "name": "field_statistics", "required": false, "serverDefault": true, @@ -42948,7 +42996,7 @@ } }, { - "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "description": "The node or shard the operation should be performed on.\nIt is random by default.", "name": "preference", "required": false, "type": { @@ -42975,7 +43023,7 @@ } }, { - "description": "Custom value used to route operations to a specific shard.", + "description": "A custom value that is used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -42987,7 +43035,7 @@ } }, { - "description": "If `true`, the response includes term frequency and document frequency.", + "description": "If `true`, the response includes:\n\n* The total term frequency (how often a term occurs in all documents).\n* The document frequency (the number of documents containing the current term).\n\nBy default these values are not returned since term statistics can have a serious performance impact.", "name": "term_statistics", "required": false, "serverDefault": false, @@ -43012,7 +43060,7 @@ } }, { - "description": "Specific version type.", + "description": "The version type.", "name": "version_type", "required": false, "type": { @@ -43024,7 +43072,7 @@ } } ], - "specLocation": "_global/termvectors/TermVectorsRequest.ts#L33-L122" + "specLocation": "_global/termvectors/TermVectorsRequest.ts#L33-L177" }, { "body": { @@ -139172,7 +139220,7 @@ } }, { - "description": "Maximum number of terms that must be returned per field.", + "description": "The maximum number of terms that must be returned per field.", "name": "max_num_terms", "required": false, "serverDefault": 25, @@ -139185,7 +139233,7 @@ } }, { - "description": "Ignore words with more than this frequency in the source doc.\nDefaults to unbounded.", + "description": "Ignore words with more than this frequency in the source doc.\nIt defaults to unbounded.", "name": "max_term_freq", "required": false, "type": {