diff --git a/output/schema/schema.json b/output/schema/schema.json index 84fbe65da0..47c9d9501a 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -21518,7 +21518,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about whether a document exists in an index.", + "description": "Checks if a document in an index exists.", "inherits": { "type": { "name": "RequestBase", @@ -21532,7 +21532,7 @@ }, "path": [ { - "description": "The document ID", + "description": "Identifier of the document.", "name": "id", "required": true, "type": { @@ -21544,7 +21544,7 @@ } }, { - "description": "The name of the index", + "description": "Comma-separated list of data streams, indices, and aliases.\nSupports wildcards (`*`).", "name": "index", "required": true, "type": { @@ -21558,7 +21558,7 @@ ], "query": [ { - "description": "Specify the node or shard the operation should be performed on (default: random)", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -21570,9 +21570,12 @@ } }, { - "description": "Specify whether to perform the operation in realtime or search mode", + "description": "If true, the request is real-time as opposed to near-real-time.", + "docId": "realtime", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -21582,9 +21585,10 @@ } }, { - "description": "Refresh the shard containing the document before performing the operation", + "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", "name": "refresh", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -21594,7 +21598,9 @@ } }, { - "description": "Specific routing value", + "description": "Target the specified primary shard.", + "docId": "routing", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing", "name": "routing", "required": false, "type": { @@ -21606,7 +21612,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": { @@ -21618,7 +21624,7 @@ } }, { - "description": "A list of fields to exclude from the returned _source field", + "description": "A comma-separated list of source fields to exclude in the response.", "name": "_source_excludes", "required": false, "type": { @@ -21630,7 +21636,7 @@ } }, { - "description": "A list of fields to extract and return from the _source field", + "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { @@ -21642,7 +21648,7 @@ } }, { - "description": "A comma-separated list of stored fields to return in the response", + "description": "List of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to false.", "name": "stored_fields", "required": false, "type": { @@ -21654,7 +21660,7 @@ } }, { - "description": "Explicit version number for concurrency control", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { @@ -21666,7 +21672,7 @@ } }, { - "description": "Specific version type", + "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { @@ -21678,7 +21684,7 @@ } } ], - "specLocation": "_global/exists/DocumentExistsRequest.ts#L31-L53" + "specLocation": "_global/exists/DocumentExistsRequest.ts#L31-L99" }, { "body": { @@ -21698,7 +21704,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about whether a document source exists in an index.", + "description": "Checks if a document is stored in the `source`.", "inherits": { "type": { "name": "RequestBase", @@ -21712,7 +21718,7 @@ }, "path": [ { - "description": "The document ID", + "description": "Identifier of the document.", "name": "id", "required": true, "type": { @@ -21724,7 +21730,7 @@ } }, { - "description": "The name of the index", + "description": "Comma-separated list of data streams, indices, and aliases.\nSupports wildcards (`*`).", "name": "index", "required": true, "type": { @@ -21738,7 +21744,7 @@ ], "query": [ { - "description": "Specify the node or shard the operation should be performed on (default: random)", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -21750,9 +21756,12 @@ } }, { - "description": "Specify whether to perform the operation in realtime or search mode", + "description": "If true, the request is real-time as opposed to near-real-time.", + "docId": "realtime", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -21762,9 +21771,10 @@ } }, { - "description": "Refresh the shard containing the document before performing the operation", + "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", "name": "refresh", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -21774,7 +21784,9 @@ } }, { - "description": "Specific routing value", + "description": "Target the specified primary shard.", + "docId": "routing", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing", "name": "routing", "required": false, "type": { @@ -21786,7 +21798,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": { @@ -21798,7 +21810,7 @@ } }, { - "description": "A list of fields to exclude from the returned _source field", + "description": "A comma-separated list of source fields to exclude in the response.", "name": "_source_excludes", "required": false, "type": { @@ -21810,7 +21822,7 @@ } }, { - "description": "A list of fields to extract and return from the _source field", + "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { @@ -21822,7 +21834,7 @@ } }, { - "description": "Explicit version number for concurrency control", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { @@ -21834,7 +21846,7 @@ } }, { - "description": "Specific version type", + "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { @@ -21846,7 +21858,7 @@ } } ], - "specLocation": "_global/exists_source/SourceExistsRequest.ts#L31-L52" + "specLocation": "_global/exists_source/SourceExistsRequest.ts#L31-L93" }, { "body": { @@ -21959,6 +21971,7 @@ "kind": "properties", "properties": [ { + "description": "Defines the search definition using the Query DSL.", "name": "query", "required": false, "type": { @@ -21971,7 +21984,7 @@ } ] }, - "description": "Returns information about why a specific matches (or doesn't match) a query.", + "description": "Returns information about why a specific document matches (or doesn’t match) a query.", "inherits": { "type": { "name": "RequestBase", @@ -21985,7 +21998,7 @@ }, "path": [ { - "description": "The document ID", + "description": "Defines the document ID.", "name": "id", "required": true, "type": { @@ -21997,7 +22010,7 @@ } }, { - "description": "The name of the index", + "description": "Index names used to limit the request.\nOnly a single index name can be provided to this parameter.", "name": "index", "required": true, "type": { @@ -22011,7 +22024,7 @@ ], "query": [ { - "description": "The analyzer for the query string query", + "description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "analyzer", "required": false, "type": { @@ -22023,9 +22036,10 @@ } }, { - "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)", + "description": "If `true`, wildcard and prefix queries are analyzed.", "name": "analyze_wildcard", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -22035,9 +22049,10 @@ } }, { - "description": "The default operator for query string query (AND or OR)", + "description": "The default operator for query string query: `AND` or `OR`.", "name": "default_operator", "required": false, + "serverDefault": "OR", "type": { "kind": "instance_of", "type": { @@ -22047,7 +22062,7 @@ } }, { - "description": "The default field for query string query (default: _all)", + "description": "Field to use as default where no field prefix is given in the query string.", "name": "df", "required": false, "type": { @@ -22059,9 +22074,10 @@ } }, { - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", + "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", "name": "lenient", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -22071,7 +22087,7 @@ } }, { - "description": "Specify the node or shard the operation should be performed on (default: random)", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -22083,7 +22099,7 @@ } }, { - "description": "Specific routing value", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -22095,7 +22111,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": { @@ -22107,7 +22123,7 @@ } }, { - "description": "A list of fields to exclude from the returned _source field", + "description": "A comma-separated list of source fields to exclude from the response.", "name": "_source_excludes", "required": false, "type": { @@ -22119,7 +22135,7 @@ } }, { - "description": "A list of fields to extract and return from the _source field", + "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { @@ -22131,7 +22147,7 @@ } }, { - "description": "A comma-separated list of stored fields to return in the response", + "description": "A comma-separated list of stored fields to return in the response.", "name": "stored_fields", "required": false, "type": { @@ -22143,7 +22159,7 @@ } }, { - "description": "Query in the Lucene query string syntax", + "description": "Query in the Lucene query string syntax.", "name": "q", "required": false, "type": { @@ -22155,7 +22171,7 @@ } } ], - "specLocation": "_global/explain/ExplainRequest.ts#L26-L52" + "specLocation": "_global/explain/ExplainRequest.ts#L26-L104" }, { "body": { @@ -22879,7 +22895,7 @@ } }, { - "description": "Boolean) If true, the request is real-time as opposed to near-real-time.", + "description": "If true, the request is real-time as opposed to near-real-time.", "docId": "realtime", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", @@ -22957,7 +22973,7 @@ } }, { - "description": "A comma-separated list of stored fields to return in the response", + "description": "List of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to false.", "name": "stored_fields", "required": false, "type": { @@ -22993,7 +23009,7 @@ } } ], - "specLocation": "_global/get/GetRequest.ts#L31-L86" + "specLocation": "_global/get/GetRequest.ts#L31-L91" }, { "body": { @@ -24950,7 +24966,7 @@ } } }, - "description": "Creates or updates a document in an index.", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "generics": [ { "name": "TDocument", @@ -24970,7 +24986,7 @@ }, "path": [ { - "description": "Document ID", + "description": "Unique identifier for the document.", "name": "id", "required": false, "type": { @@ -24982,7 +24998,7 @@ } }, { - "description": "The name of the index", + "description": "Name of the data stream or index to target.", "name": "index", "required": true, "type": { @@ -24996,7 +25012,7 @@ ], "query": [ { - "description": "only perform the index operation if the last operation that has changed the document has the specified primary term", + "description": "Only perform the operation if the document has this primary term.", "name": "if_primary_term", "required": false, "type": { @@ -25008,7 +25024,7 @@ } }, { - "description": "only perform the index operation if the last operation that has changed the document has the specified sequence number", + "description": "Only perform the operation if the document has this sequence number.", "name": "if_seq_no", "required": false, "type": { @@ -25020,7 +25036,7 @@ } }, { - "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID", + "description": "Set to create to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nSame as using the `/_create` endpoint.\nValid values: `index`, `create`.\nIf document id is specified, it defaults to `index`.\nOtherwise, it defaults to `create`.", "name": "op_type", "required": false, "type": { @@ -25032,7 +25048,7 @@ } }, { - "description": "The pipeline id to preprocess incoming documents with", + "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "name": "pipeline", "required": false, "type": { @@ -25044,7 +25060,7 @@ } }, { - "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.", + "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "name": "refresh", "required": false, "type": { @@ -25056,7 +25072,7 @@ } }, { - "description": "Specific routing value", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -25068,9 +25084,10 @@ } }, { - "description": "Explicit operation timeout", + "description": "Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.", "name": "timeout", "required": false, + "serverDefault": "1m", "type": { "kind": "instance_of", "type": { @@ -25080,7 +25097,7 @@ } }, { - "description": "Explicit version number for concurrency control", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { @@ -25092,7 +25109,7 @@ } }, { - "description": "Specific version type", + "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { @@ -25104,9 +25121,10 @@ } }, { - "description": "Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", + "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "name": "wait_for_active_shards", "required": false, + "serverDefault": "1", "type": { "kind": "instance_of", "type": { @@ -25116,9 +25134,10 @@ } }, { - "description": "When true, requires destination to be an alias. Default is false", + "description": "If `true`, the destination must be an index alias.", "name": "require_alias", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -25128,7 +25147,7 @@ } } ], - "specLocation": "_global/index/IndexRequest.ts#L35-L60" + "specLocation": "_global/index/IndexRequest.ts#L35-L117" }, { "body": { @@ -26988,7 +27007,7 @@ }, "path": [ { - "description": "A comma-separated list of index names to use as default", + "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*`.", "name": "index", "required": false, "type": { @@ -27002,9 +27021,10 @@ ], "query": [ { - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", + "description": "If `true`, network round-trips are minimized for cross-cluster search requests.", "name": "ccs_minimize_roundtrips", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -27014,7 +27034,7 @@ } }, { - "description": "Controls the maximum number of concurrent searches the multi search api will execute", + "description": "Maximum number of concurrent searches the API can run.", "name": "max_concurrent_searches", "required": false, "type": { @@ -27026,7 +27046,7 @@ } }, { - "description": "Search operation type", + "description": "The type of the search operation.\nAvailable options: `query_then_fetch`, `dfs_query_then_fetch`.", "name": "search_type", "required": false, "type": { @@ -27038,9 +27058,10 @@ } }, { - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", + "description": "If `true`, the response returns hits.total as an integer.\nIf `false`, it returns hits.total as an object.", "name": "rest_total_hits_as_int", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -27050,9 +27071,10 @@ } }, { - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", + "description": "If `true`, the response prefixes aggregation and suggester names with their respective types.", "name": "typed_keys", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -27062,7 +27084,7 @@ } } ], - "specLocation": "_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L45" + "specLocation": "_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L70" }, { "codegenNames": [ @@ -27136,6 +27158,7 @@ }, "properties": [ { + "description": "If `true`, returns detailed information about score calculation as part of each hit.", "name": "explain", "required": false, "serverDefault": false, @@ -27160,6 +27183,7 @@ } }, { + "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", "name": "params", "required": false, "type": { @@ -27178,6 +27202,7 @@ } }, { + "description": "If `true`, the query execution is profiled.", "name": "profile", "required": false, "serverDefault": false, @@ -27202,7 +27227,7 @@ } } ], - "specLocation": "_global/msearch_template/types.ts#L28-L45" + "specLocation": "_global/msearch_template/types.ts#L28-L54" }, { "kind": "interface", @@ -29511,6 +29536,7 @@ }, "properties": [ { + "description": "The number of scroll responses pulled back by the reindex.", "name": "batches", "required": true, "type": { @@ -29522,6 +29548,7 @@ } }, { + "description": "The number of documents that were successfully created.", "name": "created", "required": true, "type": { @@ -29533,6 +29560,7 @@ } }, { + "description": "The number of documents that were successfully deleted.", "name": "deleted", "required": true, "type": { @@ -29544,6 +29572,7 @@ } }, { + "description": "The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`.", "name": "noops", "required": true, "type": { @@ -29555,6 +29584,7 @@ } }, { + "description": "The number of requests per second effectively executed during the reindex.", "name": "requests_per_second", "required": true, "type": { @@ -29566,6 +29596,7 @@ } }, { + "description": "The number of retries attempted by reindex. `bulk` is the number of bulk actions retried and `search` is the number of search actions retried.", "name": "retries", "required": true, "type": { @@ -29577,6 +29608,7 @@ } }, { + "description": "", "name": "throttled", "required": false, "type": { @@ -29588,6 +29620,7 @@ } }, { + "description": "Number of milliseconds the request slept to conform to `requests_per_second`.", "name": "throttled_millis", "required": true, "type": { @@ -29619,6 +29652,7 @@ } }, { + "description": "This field should always be equal to zero in a `_reindex` response.\nIt only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to `requests_per_second`.", "name": "throttled_until_millis", "required": true, "type": { @@ -29639,6 +29673,7 @@ } }, { + "description": "The number of documents that were successfully processed.", "name": "total", "required": true, "type": { @@ -29650,6 +29685,7 @@ } }, { + "description": "The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it.", "name": "updated", "required": true, "type": { @@ -29661,6 +29697,7 @@ } }, { + "description": "The number of version conflicts that reindex hits.", "name": "version_conflicts", "required": true, "type": { @@ -29672,7 +29709,7 @@ } } ], - "specLocation": "_global/reindex_rethrottle/types.ts#L37-L51" + "specLocation": "_global/reindex_rethrottle/types.ts#L37-L88" }, { "kind": "interface", @@ -29810,7 +29847,7 @@ } } ], - "specLocation": "_global/reindex_rethrottle/types.ts#L53-L64" + "specLocation": "_global/reindex_rethrottle/types.ts#L90-L101" }, { "attachedBehaviors": [ @@ -29819,7 +29856,7 @@ "body": { "kind": "no_body" }, - "description": "Changes the number of requests per second for a particular Reindex operation.", + "description": "Copies documents from a source to a destination.", "inherits": { "type": { "name": "RequestBase", @@ -29833,7 +29870,7 @@ }, "path": [ { - "description": "The task id to rethrottle", + "description": "Identifier for the task.", "name": "task_id", "required": true, "type": { @@ -29847,7 +29884,7 @@ ], "query": [ { - "description": "The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.", + "description": "The throttle for this request in sub-requests per second.", "name": "requests_per_second", "required": false, "type": { @@ -29859,7 +29896,7 @@ } } ], - "specLocation": "_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L35" + "specLocation": "_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L42" }, { "body": { @@ -29915,6 +29952,7 @@ } }, { + "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", "name": "params", "required": false, "type": { @@ -29933,6 +29971,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.", "name": "source", "required": false, "type": { @@ -29945,7 +29984,7 @@ } ] }, - "description": "Allows to use the Mustache language to pre-render a search definition.", + "description": "Renders a search template as a search request body.", "inherits": { "type": { "name": "RequestBase", @@ -29959,7 +29998,7 @@ }, "path": [ { - "description": "The id of the stored search template", + "description": "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": { @@ -29972,7 +30011,7 @@ } ], "query": [], - "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L39" + "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L55" }, { "body": { @@ -36803,7 +36842,7 @@ }, "path": [ { - "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "description": "Returns the indices and shards that a search request would be executed against.", "name": "index", "required": false, "type": { @@ -36817,9 +36856,10 @@ ], "query": [ { - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", "name": "allow_no_indices", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -36829,9 +36869,10 @@ } }, { - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "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`.", "name": "expand_wildcards", "required": false, + "serverDefault": "open", "type": { "kind": "instance_of", "type": { @@ -36841,9 +36882,10 @@ } }, { - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -36853,9 +36895,10 @@ } }, { - "description": "Return local information, do not retrieve the state from master node (default: false)", + "description": "If `true`, the request retrieves information from the local node only.", "name": "local", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -36865,7 +36908,7 @@ } }, { - "description": "Specify the node or shard the operation should be performed on (default: random)", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -36877,7 +36920,7 @@ } }, { - "description": "Specific routing value", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -36889,7 +36932,7 @@ } } ], - "specLocation": "_global/search_shards/SearchShardsRequest.ts#L23-L39" + "specLocation": "_global/search_shards/SearchShardsRequest.ts#L23-L70" }, { "body": { @@ -37008,6 +37051,7 @@ "kind": "properties", "properties": [ { + "description": "If `true`, returns detailed information about score calculation as part of each hit.", "name": "explain", "required": false, "serverDefault": false, @@ -37032,6 +37076,7 @@ } }, { + "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", "name": "params", "required": false, "type": { @@ -37050,6 +37095,7 @@ } }, { + "description": "If `true`, the query execution is profiled.", "name": "profile", "required": false, "serverDefault": false, @@ -37075,7 +37121,7 @@ } ] }, - "description": "Allows to use the Mustache language to pre-render a search definition.", + "description": "Runs a search with a search template.", "inherits": { "type": { "name": "RequestBase", @@ -37103,7 +37149,7 @@ ], "query": [ { - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", "name": "allow_no_indices", "required": false, "serverDefault": true, @@ -37116,7 +37162,7 @@ } }, { - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", + "description": "If `true`, network round-trips are minimized for cross-cluster search requests.", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": false, @@ -37129,7 +37175,7 @@ } }, { - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "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`.", "name": "expand_wildcards", "required": false, "type": { @@ -37141,7 +37187,7 @@ } }, { - "description": "Specify whether to return detailed information about score computation as part of a hit", + "description": "If `true`, the response includes additional details about score computation as part of a hit.", "name": "explain", "required": false, "serverDefault": false, @@ -37154,7 +37200,7 @@ } }, { - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", + "description": "If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.", "name": "ignore_throttled", "required": false, "serverDefault": true, @@ -37167,7 +37213,7 @@ } }, { - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", "name": "ignore_unavailable", "required": false, "serverDefault": false, @@ -37180,7 +37226,7 @@ } }, { - "description": "Specify the node or shard the operation should be performed on (default: random)", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -37192,7 +37238,7 @@ } }, { - "description": "Specify whether to profile the query execution", + "description": "If `true`, the query execution is profiled.", "name": "profile", "required": false, "serverDefault": false, @@ -37261,7 +37307,7 @@ } }, { - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", + "description": "If `true`, the response prefixes aggregation and suggester names with their respective types.", "name": "typed_keys", "required": false, "serverDefault": false, @@ -37274,7 +37320,7 @@ } } ], - "specLocation": "_global/search_template/SearchTemplateRequest.ts#L32-L97" + "specLocation": "_global/search_template/SearchTemplateRequest.ts#L32-L134" }, { "body": { diff --git a/specification/_global/exists/DocumentExistsRequest.ts b/specification/_global/exists/DocumentExistsRequest.ts index dcde4be552..0500641230 100644 --- a/specification/_global/exists/DocumentExistsRequest.ts +++ b/specification/_global/exists/DocumentExistsRequest.ts @@ -29,25 +29,71 @@ import { import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** + * Checks if a document in an index exists. * @rest_spec_name exists * @availability stack since=0.0.0 stability=stable * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier of the document. + */ id: Id + /** + * Comma-separated list of data streams, indices, and aliases. + * Supports wildcards (`*`). + */ index: IndexName } query_parameters: { + /** + * Specifies the node or shard the operation should be performed on. + * Random by default. + */ preference?: string + /** + * If true, the request is real-time as opposed to near-real-time. + * @server_default true + * @doc_id realtime + */ realtime?: boolean + /** + * If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + * @server_default false + */ refresh?: boolean + /** + * Target the specified primary shard. + * @doc_id routing + */ routing?: Routing + /** + * True or false to return the _source field or not, or a list of fields to return. + */ _source?: SourceConfigParam + /** + * A comma-separated list of source fields to exclude in the response. + */ _source_excludes?: Fields + /** + * A comma-separated list of source fields to include in the response. + */ _source_includes?: Fields + /** + * List of stored fields to return as part of a hit. + * If no fields are specified, no stored fields are included in the response. + * If this field is specified, the `_source` parameter defaults to false. + */ stored_fields?: Fields + /** + * Explicit version number for concurrency control. + * The specified version must match the current version of the document for the request to succeed. + */ version?: VersionNumber + /** + * Specific version type: `external`, `external_gte`. + */ version_type?: VersionType } } diff --git a/specification/_global/exists_source/SourceExistsRequest.ts b/specification/_global/exists_source/SourceExistsRequest.ts index aefa7ef041..bae5912959 100644 --- a/specification/_global/exists_source/SourceExistsRequest.ts +++ b/specification/_global/exists_source/SourceExistsRequest.ts @@ -29,24 +29,65 @@ import { import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** + * Checks if a document is stored in the `source`. * @rest_spec_name exists_source * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier of the document. + */ id: Id + /** + * Comma-separated list of data streams, indices, and aliases. + * Supports wildcards (`*`). + */ index: IndexName } query_parameters: { + /** + * Specifies the node or shard the operation should be performed on. + * Random by default. + */ preference?: string + /** + * If true, the request is real-time as opposed to near-real-time. + * @server_default true + * @doc_id realtime + */ realtime?: boolean + /** + * If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + * @server_default false + */ refresh?: boolean + /** + * Target the specified primary shard. + * @doc_id routing + */ routing?: Routing + /** + * True or false to return the _source field or not, or a list of fields to return. + */ _source?: SourceConfigParam + /** + * A comma-separated list of source fields to exclude in the response. + */ _source_excludes?: Fields + /** + * A comma-separated list of source fields to include in the response. + */ _source_includes?: Fields + /** + * Explicit version number for concurrency control. + * The specified version must match the current version of the document for the request to succeed. + */ version?: VersionNumber + /** + * Specific version type: `external`, `external_gte`. + */ version_type?: VersionType } } diff --git a/specification/_global/explain/ExplainRequest.ts b/specification/_global/explain/ExplainRequest.ts index 1e79ba8148..3fe5de0fa2 100644 --- a/specification/_global/explain/ExplainRequest.ts +++ b/specification/_global/explain/ExplainRequest.ts @@ -24,29 +24,81 @@ import { SourceConfigParam } from '@global/search/_types/SourceFilter' import { Operator } from '@_types/query_dsl/Operator' /** + * Returns information about why a specific document matches (or doesn’t match) a query. * @rest_spec_name explain * @availability stack since=0.0.0 stability=stable */ export interface Request extends RequestBase { path_parts: { + /** + * Defines the document ID. + */ id: Id + /** + * Index names used to limit the request. + * Only a single index name can be provided to this parameter. + */ index: IndexName } query_parameters: { + /** + * Analyzer to use for the query string. + * This parameter can only be used when the `q` query string parameter is specified. + */ analyzer?: string + /** + * If `true`, wildcard and prefix queries are analyzed. + * @server_default false + */ analyze_wildcard?: boolean + /** + * The default operator for query string query: `AND` or `OR`. + * @server_default OR + */ default_operator?: Operator + /** + * Field to use as default where no field prefix is given in the query string. + */ df?: string + /** + * If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + * @server_default false + */ lenient?: boolean + /** + * Specifies the node or shard the operation should be performed on. + * Random by default. + */ preference?: string + /** + * Custom value used to route operations to a specific shard. + */ routing?: Routing + /** + * True or false to return the `_source` field or not, or a list of fields to return. + */ _source?: SourceConfigParam + /** + * A comma-separated list of source fields to exclude from the response. + */ _source_excludes?: Fields + /** + * A comma-separated list of source fields to include in the response. + */ _source_includes?: Fields + /** + * A comma-separated list of stored fields to return in the response. + */ stored_fields?: Fields + /** + * Query in the Lucene query string syntax. + */ q?: string } body: { + /** + * Defines the search definition using the Query DSL. + */ query?: QueryContainer } } diff --git a/specification/_global/get/GetRequest.ts b/specification/_global/get/GetRequest.ts index 7e03efa8b8..4fa0380ddf 100644 --- a/specification/_global/get/GetRequest.ts +++ b/specification/_global/get/GetRequest.ts @@ -46,7 +46,7 @@ export interface Request extends RequestBase { */ preference?: string /** - * Boolean) If true, the request is real-time as opposed to near-real-time. + * If true, the request is real-time as opposed to near-real-time. * @server_default true * @doc_id realtime */ @@ -73,6 +73,11 @@ export interface Request extends RequestBase { * A comma-separated list of source fields to include in the response. */ _source_includes?: Fields + /** + * List of stored fields to return as part of a hit. + * If no fields are specified, no stored fields are included in the response. + * If this field is specified, the `_source` parameter defaults to false. + */ stored_fields?: Fields /** * Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. diff --git a/specification/_global/index/IndexRequest.ts b/specification/_global/index/IndexRequest.ts index dd8c4daa7f..4056890c48 100644 --- a/specification/_global/index/IndexRequest.ts +++ b/specification/_global/index/IndexRequest.ts @@ -33,28 +33,85 @@ import { long } from '@_types/Numeric' import { Duration } from '@_types/Time' /** + * Adds a JSON document to the specified data stream or index and makes it searchable. + * If the target is an index and the document already exists, the request updates the document and increments its version. * @rest_spec_name index * @availability stack since=0.0.0 stability=stable * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { + /** + * Unique identifier for the document. + */ id?: Id + /** + * Name of the data stream or index to target. + */ index: IndexName } query_parameters: { + /** + * Only perform the operation if the document has this primary term. + */ if_primary_term?: long + /** + * Only perform the operation if the document has this sequence number. + */ if_seq_no?: SequenceNumber + /** + * Set to create to only index the document if it does not already exist (put if absent). + * If a document with the specified `_id` already exists, the indexing operation will fail. + * Same as using the `/_create` endpoint. + * Valid values: `index`, `create`. + * If document id is specified, it defaults to `index`. + * Otherwise, it defaults to `create`. + */ op_type?: OpType + /** + * ID of the pipeline to use to preprocess incoming documents. + * If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + * If a final pipeline is configured it will always run, regardless of the value of this parameter. + */ pipeline?: string + /** + * If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. + * Valid values: `true`, `false`, `wait_for`. + */ refresh?: Refresh + /** + * Custom value used to route operations to a specific shard. + */ routing?: Routing + /** + * Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + * @server_default 1m + */ timeout?: Duration + /** + * Explicit version number for concurrency control. + * The specified version must match the current version of the document for the request to succeed. + */ version?: VersionNumber + /** + * Specific version type: `external`, `external_gte`. + */ version_type?: VersionType + /** + * The number of shard copies that must be active before proceeding with the operation. + * Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + * @server_default 1 + */ wait_for_active_shards?: WaitForActiveShards + /** + * If `true`, the destination must be an index alias. + * @server_default false + */ require_alias?: boolean } /** @codegen_name document */ + /** + * Request body contains the JSON source for the document data. + */ body?: TDocument } diff --git a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts index 17a696cca0..362e34ee77 100644 --- a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts +++ b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts @@ -31,13 +31,38 @@ import { RequestItem } from './types' */ export interface Request extends RequestBase { path_parts: { + /** + * Comma-separated list of data streams, indices, and aliases to search. + * Supports wildcards (`*`). + * To search all data streams and indices, omit this parameter or use `*`. + */ index?: Indices } query_parameters: { + /** + * If `true`, network round-trips are minimized for cross-cluster search requests. + * @server_default true + */ ccs_minimize_roundtrips?: boolean + /** + * Maximum number of concurrent searches the API can run. + */ max_concurrent_searches?: long + /** + * The type of the search operation. + * Available options: `query_then_fetch`, `dfs_query_then_fetch`. + */ search_type?: SearchType + /** + * If `true`, the response returns hits.total as an integer. + * If `false`, it returns hits.total as an object. + * @server_default false + */ rest_total_hits_as_int?: boolean + /** + * If `true`, the response prefixes aggregation and suggester names with their respective types. + * @server_default false + */ typed_keys?: boolean } /** @codegen_name search_templates */ diff --git a/specification/_global/msearch_template/types.ts b/specification/_global/msearch_template/types.ts index 59d71c35ec..88114b1e8e 100644 --- a/specification/_global/msearch_template/types.ts +++ b/specification/_global/msearch_template/types.ts @@ -26,15 +26,24 @@ import { MultisearchHeader } from '@global/msearch/types' export type RequestItem = MultisearchHeader | TemplateConfig export class TemplateConfig { - /** @server_default false */ + /** + * If `true`, returns detailed information about score calculation as part of each hit. + * @server_default false */ explain?: boolean /** * ID of the search template to use. If no source is specified, * this parameter is required. */ id?: Id + /** + * Key-value pairs used to replace Mustache variables in the template. + * The key is the variable name. + * The value is the variable value. + */ params?: Dictionary - /** @server_default false */ + /** + * If `true`, the query execution is profiled. + * @server_default false */ profile?: boolean /** * An inline search template. Supports the same parameters as the search API's diff --git a/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts b/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts index 7087131747..053b451b4b 100644 --- a/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts +++ b/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts @@ -22,14 +22,21 @@ import { Id } from '@_types/common' import { float } from '@_types/Numeric' /** + * Copies documents from a source to a destination. * @rest_spec_name reindex_rethrottle * @availability stack since=2.4.0 stability=stable */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier for the task. + */ task_id: Id } query_parameters: { + /** + * The throttle for this request in sub-requests per second. + */ requests_per_second?: float } } diff --git a/specification/_global/reindex_rethrottle/types.ts b/specification/_global/reindex_rethrottle/types.ts index e717a6eb57..1057d6a429 100644 --- a/specification/_global/reindex_rethrottle/types.ts +++ b/specification/_global/reindex_rethrottle/types.ts @@ -35,18 +35,55 @@ export class ReindexNode extends BaseNode { } export class ReindexStatus { + /** + * The number of scroll responses pulled back by the reindex. + */ batches: long + /** + * The number of documents that were successfully created. + */ created: long + /** + * The number of documents that were successfully deleted. + */ deleted: long + /** + * The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`. + */ noops: long + /** + * The number of requests per second effectively executed during the reindex. + */ requests_per_second: float + /** + * The number of retries attempted by reindex. `bulk` is the number of bulk actions retried and `search` is the number of search actions retried. + */ retries: Retries + /** + * + */ throttled?: Duration + /** + * Number of milliseconds the request slept to conform to `requests_per_second`. + */ throttled_millis: DurationValue throttled_until?: Duration + /** + * This field should always be equal to zero in a `_reindex` response. + * It only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to `requests_per_second`. + */ throttled_until_millis: DurationValue + /** + * The number of documents that were successfully processed. + */ total: long + /** + * The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it. + */ updated: long + /** + * The number of version conflicts that reindex hits. + */ version_conflicts: long } diff --git a/specification/_global/render_search_template/RenderSearchTemplateRequest.ts b/specification/_global/render_search_template/RenderSearchTemplateRequest.ts index 5591bc4c41..3f388e0b1c 100644 --- a/specification/_global/render_search_template/RenderSearchTemplateRequest.ts +++ b/specification/_global/render_search_template/RenderSearchTemplateRequest.ts @@ -23,17 +23,33 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Renders a search template as a search request body. * @rest_spec_name render_search_template * @availability stack since=0.0.0 stability=stable * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { + /** + * ID of the search template to render. + * If no `source` is specified, this or the `id` request body parameter is required. + */ id?: Id } body: { file?: string + /** + * Key-value pairs used to replace Mustache variables in the template. + * The key is the variable name. + * The value is the variable value. + */ params?: Dictionary + /** + * An inline search template. + * Supports the same parameters as the search API's request body. + * These parameters also support Mustache variables. + * If no `id` or `` is specified, this parameter is required. + */ source?: string } } diff --git a/specification/_global/search_shards/SearchShardsRequest.ts b/specification/_global/search_shards/SearchShardsRequest.ts index da8bbcaead..4094b20390 100644 --- a/specification/_global/search_shards/SearchShardsRequest.ts +++ b/specification/_global/search_shards/SearchShardsRequest.ts @@ -26,14 +26,45 @@ import { ExpandWildcards, Indices, Routing } from '@_types/common' */ export interface Request extends RequestBase { path_parts: { + /** + * Returns the indices and shards that a search request would be executed against. + */ index?: Indices } query_parameters: { + /** + * If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. + * This behavior applies even if the request targets other open indices. + * For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * @server_default false + */ allow_no_indices?: boolean + /** + * Type of index that wildcard patterns can match. + * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + * Supports comma-separated values, such as `open,hidden`. + * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + * @server_default open + */ expand_wildcards?: ExpandWildcards + /** + * If `false`, the request returns an error if it targets a missing or closed index. + * @server_default false + */ ignore_unavailable?: boolean + /** + * If `true`, the request retrieves information from the local node only. + * @server_default false + */ local?: boolean + /** + * Specifies the node or shard the operation should be performed on. + * Random by default. + */ preference?: string + /** + * Custom value used to route operations to a specific shard. + */ routing?: Routing } } diff --git a/specification/_global/search_template/SearchTemplateRequest.ts b/specification/_global/search_template/SearchTemplateRequest.ts index f5292d67d5..4d040db71f 100644 --- a/specification/_global/search_template/SearchTemplateRequest.ts +++ b/specification/_global/search_template/SearchTemplateRequest.ts @@ -30,6 +30,7 @@ import { import { Duration } from '@_types/Time' /** + * Runs 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 @@ -43,19 +44,44 @@ export interface Request extends RequestBase { index?: Indices } query_parameters: { - /** @server_default true */ + /** + * If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. + * This behavior applies even if the request targets other open indices. + * For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * @server_default true + */ allow_no_indices?: boolean - /** @server_default false */ + /** + * If `true`, network round-trips are minimized for cross-cluster search requests. + * @server_default false */ ccs_minimize_roundtrips?: boolean + /** + * Type of index that wildcard patterns can match. + * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + * Supports comma-separated values, such as `open,hidden`. + * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + */ expand_wildcards?: ExpandWildcards - /** @server_default false */ + /** + * If `true`, the response includes additional details about score computation as part of a hit. + * @server_default false */ explain?: boolean - /** @server_default true */ + /** + * If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + * @server_default true */ ignore_throttled?: boolean - /** @server_default false */ + /** + * If `false`, the request returns an error if it targets a missing or closed index. + * @server_default false */ ignore_unavailable?: boolean + /** + * Specifies the node or shard the operation should be performed on. + * Random by default. + */ preference?: string - /** @server_default false */ + /** + * If `true`, the query execution is profiled. + * @server_default false */ profile?: boolean /** Custom value used to route operations to a specific shard. */ routing?: Routing @@ -73,19 +99,30 @@ export interface Request extends RequestBase { * @availability serverless */ rest_total_hits_as_int?: boolean - /** @server_default false */ + /** + * If `true`, the response prefixes aggregation and suggester names with their respective types. + * @server_default false */ typed_keys?: boolean } body: { - /** @server_default false */ + /** + * If `true`, returns detailed information about score calculation as part of each hit. + * @server_default false */ explain?: boolean /** * ID of the search template to use. If no source is specified, * this parameter is required. */ id?: Id + /** + * Key-value pairs used to replace Mustache variables in the template. + * The key is the variable name. + * The value is the variable value. + */ params?: Dictionary - /** @server_default false */ + /** + * If `true`, the query execution is profiled. + * @server_default false */ profile?: boolean /** * An inline search template. Supports the same parameters as the search API's