diff --git a/compiler/src/steps/add-description.ts b/compiler/src/steps/add-description.ts index e34c17b1c0..ab817db9af 100644 --- a/compiler/src/steps/add-description.ts +++ b/compiler/src/steps/add-description.ts @@ -32,28 +32,6 @@ export default async function addDescription (model: model.Model, jsonSpec: Map< const spec = jsonSpec.get(endpoint.name) assert(spec, `Can't find the json spec for ${endpoint.name}`) - for (const property of requestDefinition.path) { - const definition = spec.url.paths.find(path => { - if (path.parts == null) return false - return path.parts[property.name] != null - }) - if (definition?.parts != null) { - const { description } = definition.parts[property.name] - if (typeof description === 'string') { - property.description = property.description ?? description - } - } - } - - if (spec.params != null) { - for (const property of requestDefinition.query) { - const param = spec.params[property.name] - if (param != null && typeof param.description === 'string') { - property.description = property.description ?? param.description - } - } - } - if (spec.documentation.description != null) { requestDefinition.description = requestDefinition.description ?? spec.documentation.description } diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index e1aa1fea6b..88f52ee6d1 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -527,7 +527,7 @@ { "in": "path", "name": "name", - "description": "the name of the autoscaling policy", + "description": "Name of the autoscaling policy", "required": true, "deprecated": false, "schema": { @@ -588,7 +588,7 @@ { "in": "path", "name": "name", - "description": "the name of the autoscaling policy", + "description": "Name of the autoscaling policy", "required": true, "deprecated": false, "schema": { @@ -679,7 +679,7 @@ { "in": "path", "name": "name", - "description": "the name of the autoscaling policy", + "description": "Name of the autoscaling policy", "required": true, "deprecated": false, "schema": { @@ -3751,7 +3751,7 @@ { "in": "path", "name": "index", - "description": "the name of the leader index for which specified follower retention leases should be removed", + "description": "Name of the leader index for which specified follower retention leases should be removed", "required": true, "deprecated": false, "schema": { @@ -4076,7 +4076,7 @@ { "in": "path", "name": "index", - "description": "The name of the follow index to resume following.", + "description": "Name of the follow index to resume following", "required": true, "deprecated": false, "schema": { @@ -5201,7 +5201,7 @@ { "in": "query", "name": "flat_settings", - "description": "Return settings in flat format (default: false)", + "description": "Return settings in flat format", "deprecated": false, "schema": { "type": "boolean" @@ -5211,7 +5211,7 @@ { "in": "query", "name": "master_timeout", - "description": "Explicit operation timeout for connection to master node", + "description": "The period to wait for a connection to the master node.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -5221,7 +5221,7 @@ { "in": "query", "name": "timeout", - "description": "Explicit operation timeout", + "description": "The period to wait for a response.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -8583,7 +8583,7 @@ { "in": "query", "name": "master_timeout", - "description": "Specify timeout for connection to master", + "description": "The period to wait for a connection to the master node.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -8593,7 +8593,7 @@ { "in": "query", "name": "timeout", - "description": "Explicit operation timeout", + "description": "The period to wait for a response.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -8659,7 +8659,7 @@ { "in": "query", "name": "master_timeout", - "description": "Specify timeout for connection to master", + "description": "The period to wait for a connection to the master node.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -8669,7 +8669,7 @@ { "in": "query", "name": "timeout", - "description": "Explicit operation timeout", + "description": "The period to wait for a response.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -15959,7 +15959,7 @@ { "in": "path", "name": "name", - "description": "A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams", + "description": "A comma-separated list of data streams of which the data stream lifecycle will be deleted.\nUse `*` to get all data streams", "required": true, "deprecated": false, "schema": { @@ -15980,7 +15980,7 @@ { "in": "query", "name": "master_timeout", - "description": "Specify timeout for connection to master", + "description": "The period to wait for a connection to the master node.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -15990,7 +15990,7 @@ { "in": "query", "name": "timeout", - "description": "Explicit timestamp for the document", + "description": "The period to wait for a response.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -16197,7 +16197,7 @@ { "in": "path", "name": "name", - "description": "A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams", + "description": "A comma-separated list of data streams of which the data stream options will be deleted.\nUse `*` to get all data streams", "required": true, "deprecated": false, "schema": { @@ -16208,7 +16208,7 @@ { "in": "query", "name": "expand_wildcards", - "description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)", + "description": "Whether wildcard expressions should get expanded to open or closed indices", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.ExpandWildcards" @@ -16218,7 +16218,7 @@ { "in": "query", "name": "master_timeout", - "description": "Specify timeout for connection to master", + "description": "The period to wait for a connection to the master node.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -16228,7 +16228,7 @@ { "in": "query", "name": "timeout", - "description": "Explicit timestamp for the document", + "description": "The period to wait for a response.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -17016,7 +17016,7 @@ { "in": "path", "name": "index", - "description": "The name of the index to explain", + "description": "Comma-separated list of index names to explain", "required": true, "deprecated": false, "schema": { @@ -17027,7 +17027,7 @@ { "in": "query", "name": "include_defaults", - "description": "indicates if the API should return the default values the system uses for the index's lifecycle", + "description": "Indicates if the API should return the default values the system uses for the index's lifecycle", "deprecated": false, "schema": { "type": "boolean" @@ -17037,7 +17037,7 @@ { "in": "query", "name": "master_timeout", - "description": "Specify timeout for connection to master", + "description": "The period to wait for a connection to the master node.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -18835,7 +18835,7 @@ { "in": "path", "name": "name", - "description": "The name of the data stream", + "description": "The name of the data stream to promote", "required": true, "deprecated": false, "schema": { @@ -25074,7 +25074,7 @@ { "in": "query", "name": "acknowledge", - "description": "whether the user has acknowledged acknowledge messages (default: false)", + "description": "Whether the user has acknowledged acknowledge messages", "deprecated": false, "schema": { "type": "boolean" @@ -25179,7 +25179,7 @@ { "in": "query", "name": "acknowledge", - "description": "whether the user has acknowledged acknowledge messages (default: false)", + "description": "Whether the user has acknowledged acknowledge messages", "deprecated": false, "schema": { "type": "boolean" @@ -25189,7 +25189,7 @@ { "in": "query", "name": "type", - "description": "The type of trial license to generate (default: \"trial\")", + "description": "The type of trial license to generate", "deprecated": false, "schema": { "type": "string" @@ -31952,7 +31952,7 @@ { "in": "query", "name": "priority", - "description": "The deployment priority.", + "description": "The deployment priority", "deprecated": false, "schema": { "$ref": "#/components/schemas/ml._types.TrainingPriority" @@ -41025,7 +41025,7 @@ { "in": "query", "name": "refresh", - "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", + "description": "If `true` (the default) 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` then do nothing with refreshes.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Refresh" @@ -52968,7 +52968,7 @@ { "in": "query", "name": "accept_enterprise", - "description": "If this param is used it must be set to true", + "description": "If used, this otherwise ignored parameter must be set to true", "deprecated": true, "schema": { "type": "boolean" @@ -135888,7 +135888,7 @@ "async_search.submit-allow_no_indices": { "in": "query", "name": "allow_no_indices", - "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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "deprecated": false, "schema": { "type": "boolean" @@ -135918,7 +135918,7 @@ "async_search.submit-analyze_wildcard": { "in": "query", "name": "analyze_wildcard", - "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", + "description": "Specify whether wildcard and prefix queries should be analyzed", "deprecated": false, "schema": { "type": "boolean" @@ -135978,7 +135978,7 @@ "async_search.submit-expand_wildcards": { "in": "query", "name": "expand_wildcards", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.ExpandWildcards" @@ -136028,7 +136028,7 @@ "async_search.submit-max_concurrent_shard_requests": { "in": "query", "name": "max_concurrent_shard_requests", - "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", + "description": "The number of concurrent shard requests per node this search executes concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "deprecated": false, "schema": { "type": "number" @@ -136038,7 +136038,7 @@ "async_search.submit-preference": { "in": "query", "name": "preference", - "description": "Specify the node or shard the operation should be performed on (default: random)", + "description": "Specify the node or shard the operation should be performed on", "deprecated": false, "schema": { "type": "string" @@ -136141,7 +136141,7 @@ "async_search.submit-terminate_after": { "in": "query", "name": "terminate_after", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early", "deprecated": false, "schema": { "type": "number" @@ -136161,7 +136161,7 @@ "async_search.submit-track_total_hits": { "in": "query", "name": "track_total_hits", - "description": "Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.", + "description": "Indicate if the number of documents that match the query should be tracked.\nA number can also be specified, to accurately track the total hit count up to the number.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_global.search._types.TrackHits" @@ -136261,7 +136261,7 @@ "async_search.submit-size": { "in": "query", "name": "size", - "description": "Number of hits to return (default: 10)", + "description": "Number of hits to return", "deprecated": false, "schema": { "type": "number" @@ -136271,7 +136271,7 @@ "async_search.submit-from": { "in": "query", "name": "from", - "description": "Starting offset (default: 0)", + "description": "Starting offset", "deprecated": false, "schema": { "type": "number" @@ -137442,7 +137442,7 @@ "cluster.get_component_template-include_defaults": { "in": "query", "name": "include_defaults", - "description": "Return all default configurations for the component template (default: false)", + "description": "Return all default configurations for the component template", "deprecated": false, "schema": { "type": "boolean" @@ -137635,7 +137635,7 @@ "cluster.state-metric": { "in": "path", "name": "metric", - "description": "Limit the information returned to the specified metrics", + "description": "Limit the information returned to the specified metrics.", "required": true, "deprecated": false, "schema": { @@ -137657,7 +137657,7 @@ "cluster.state-allow_no_indices": { "in": "query", "name": "allow_no_indices", - "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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "deprecated": false, "schema": { "type": "boolean" @@ -137667,7 +137667,7 @@ "cluster.state-expand_wildcards": { "in": "query", "name": "expand_wildcards", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.ExpandWildcards" @@ -137677,7 +137677,7 @@ "cluster.state-flat_settings": { "in": "query", "name": "flat_settings", - "description": "Return settings in flat format (default: false)", + "description": "Return settings in flat format", "deprecated": false, "schema": { "type": "boolean" @@ -137697,7 +137697,7 @@ "cluster.state-local": { "in": "query", "name": "local", - "description": "Return local information, do not retrieve the state from master node (default: false)", + "description": "Return local information, do not retrieve the state from master node", "deprecated": true, "schema": { "type": "boolean" @@ -138073,7 +138073,7 @@ "eql.search-index": { "in": "path", "name": "index", - "description": "The name of the index to scope the operation", + "description": "Comma-separated list of index names to scope the operation", "required": true, "deprecated": false, "schema": { @@ -138084,7 +138084,7 @@ "eql.search-allow_no_indices": { "in": "query", "name": "allow_no_indices", - "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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "deprecated": false, "schema": { "type": "boolean" @@ -139637,7 +139637,7 @@ "indices.forcemerge-allow_no_indices": { "in": "query", "name": "allow_no_indices", - "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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "deprecated": false, "schema": { "type": "boolean" @@ -139657,7 +139657,7 @@ "indices.forcemerge-flush": { "in": "query", "name": "flush", - "description": "Specify whether the index should be flushed after performing the operation (default: true)", + "description": "Specify whether the index should be flushed after performing the operation", "deprecated": false, "schema": { "type": "boolean" @@ -139677,7 +139677,7 @@ "indices.forcemerge-max_num_segments": { "in": "query", "name": "max_num_segments", - "description": "The number of segments the index should be merged into (default: dynamic)", + "description": "The number of segments the index should be merged into (defayult: dynamic)", "deprecated": false, "schema": { "type": "number" @@ -139697,7 +139697,7 @@ "indices.forcemerge-wait_for_completion": { "in": "query", "name": "wait_for_completion", - "description": "Should the request wait until the force merge is completed.", + "description": "Should the request wait until the force merge is completed", "deprecated": false, "schema": { "type": "boolean" @@ -140202,7 +140202,7 @@ "indices.put_index_template-cause": { "in": "query", "name": "cause", - "description": "User defined reason for creating/updating the index template", + "description": "User defined reason for creating or updating the index template", "deprecated": false, "schema": { "type": "string" @@ -140212,7 +140212,7 @@ "indices.put_mapping-index": { "in": "path", "name": "index", - "description": "A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.", + "description": "A comma-separated list of index names the mapping should be added to (supports wildcards).\nUse `_all` or omit to add the mapping on all indices.", "required": true, "deprecated": false, "schema": { @@ -140415,7 +140415,7 @@ "indices.put_template-cause": { "in": "query", "name": "cause", - "description": "User defined reason for creating/updating the index template", + "description": "User defined reason for creating or updating the index template", "deprecated": false, "schema": { "type": "string" @@ -140538,7 +140538,7 @@ "indices.reload_search_analyzers-allow_no_indices": { "in": "query", "name": "allow_no_indices", - "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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "deprecated": false, "schema": { "type": "boolean" @@ -140969,7 +140969,7 @@ "indices.stats-metric": { "in": "path", "name": "metric", - "description": "Limit the information returned the specific metrics.", + "description": "Limit the information returned the specific metrics", "required": true, "deprecated": false, "schema": { @@ -141415,7 +141415,7 @@ "ingest.get_pipeline-summary": { "in": "query", "name": "summary", - "description": "Return pipelines without their definitions (default: false)", + "description": "Return pipelines without their definitions", "deprecated": false, "schema": { "type": "boolean" @@ -143079,7 +143079,7 @@ "nodes.hot_threads-sort": { "in": "query", "name": "sort", - "description": "The sort order for 'cpu' type (default: total)", + "description": "The sort order for 'cpu' type", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.ThreadType" @@ -143163,7 +143163,6 @@ "nodes.stats-metric": { "in": "path", "name": "metric", - "description": "Limit the information returned to the specified metrics", "required": true, "deprecated": false, "schema": { @@ -143278,7 +143277,7 @@ "nodes.usage-node_id": { "in": "path", "name": "node_id", - "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "description": "A comma-separated list of node IDs or names to limit the returned information.\nUse `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", "required": true, "deprecated": false, "schema": { @@ -143498,7 +143497,7 @@ "scroll-scroll_id_": { "in": "query", "name": "scroll_id", - "description": "The scroll ID for scrolled search", + "description": "The scroll ID", "deprecated": true, "schema": { "$ref": "#/components/schemas/_types.ScrollId" @@ -144008,7 +144007,7 @@ "search_mvt-index": { "in": "path", "name": "index", - "description": "Comma-separated list of data streams, indices, or aliases to search", + "description": "A list of indices, data streams, or aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.\nTo search a remote cluster, use the `:` syntax.", "required": true, "deprecated": false, "schema": { @@ -144019,7 +144018,7 @@ "search_mvt-field": { "in": "path", "name": "field", - "description": "Field containing geospatial data to return", + "description": "A field that contains the geospatial data to return.\nIt must be a `geo_point` or `geo_shape` field.\nThe field must have doc values enabled. It cannot be a nested field.\n\nNOTE: Vector tiles do not natively support geometry collections.\nFor `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection.\nThis behavior may change in a future release.", "required": true, "deprecated": false, "schema": { @@ -144030,7 +144029,7 @@ "search_mvt-zoom": { "in": "path", "name": "zoom", - "description": "Zoom level for the vector tile to search", + "description": "The zoom level of the vector tile to search. It accepts `0` to `29`.", "required": true, "deprecated": false, "schema": { @@ -144041,7 +144040,7 @@ "search_mvt-x": { "in": "path", "name": "x", - "description": "X coordinate for the vector tile to search", + "description": "The X coordinate for the vector tile to search.", "required": true, "deprecated": false, "schema": { @@ -144052,7 +144051,7 @@ "search_mvt-y": { "in": "path", "name": "y", - "description": "Y coordinate for the vector tile to search", + "description": "The Y coordinate for the vector tile to search.", "required": true, "deprecated": false, "schema": { @@ -144397,7 +144396,7 @@ "searchable_snapshots.clear_cache-expand_wildcards": { "in": "query", "name": "expand_wildcards", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.ExpandWildcards" @@ -144407,7 +144406,7 @@ "searchable_snapshots.clear_cache-allow_no_indices": { "in": "query", "name": "allow_no_indices", - "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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "deprecated": false, "schema": { "type": "boolean" @@ -144512,7 +144511,7 @@ "security.create_service_token-refresh": { "in": "query", "name": "refresh", - "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", + "description": "If `true` (the default) 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` then do nothing with refreshes.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Refresh" @@ -144892,7 +144891,7 @@ "shutdown.get_node-node_id": { "in": "path", "name": "node_id", - "description": "Which node for which to retrieve the shutdown status", + "description": "Comma-separated list of nodes for which to retrieve the shutdown status", "required": true, "deprecated": false, "schema": { @@ -144934,7 +144933,7 @@ "slm.get_lifecycle-policy_id": { "in": "path", "name": "policy_id", - "description": "Comma-separated list of snapshot lifecycle policies to retrieve", + "description": "A comma-separated list of snapshot lifecycle policy identifiers.", "required": true, "deprecated": false, "schema": { @@ -145616,7 +145615,7 @@ "watcher.put_watch-if_primary_term": { "in": "query", "name": "if_primary_term", - "description": "only update the watch if the last operation that has changed the watch has the specified primary term", + "description": "Only update the watch if the last operation that has changed the watch has the specified primary term", "deprecated": false, "schema": { "type": "number" @@ -145626,7 +145625,7 @@ "watcher.put_watch-if_seq_no": { "in": "query", "name": "if_seq_no", - "description": "only update the watch if the last operation that has changed the watch has the specified sequence number", + "description": "Only update the watch if the last operation that has changed the watch has the specified sequence number", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.SequenceNumber" diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 196e46413a..bd4837ea58 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -8970,7 +8970,7 @@ { "in": "path", "name": "index", - "description": "The name of the index to explain", + "description": "Comma-separated list of index names to explain", "required": true, "deprecated": false, "schema": { @@ -8981,7 +8981,7 @@ { "in": "query", "name": "include_defaults", - "description": "indicates if the API should return the default values the system uses for the index's lifecycle", + "description": "Indicates if the API should return the default values the system uses for the index's lifecycle", "deprecated": false, "schema": { "type": "boolean" @@ -8991,7 +8991,7 @@ { "in": "query", "name": "master_timeout", - "description": "Specify timeout for connection to master", + "description": "The period to wait for a connection to the master node.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -19697,7 +19697,7 @@ { "in": "query", "name": "priority", - "description": "The deployment priority.", + "description": "The deployment priority", "deprecated": false, "schema": { "$ref": "#/components/schemas/ml._types.TrainingPriority" @@ -82580,7 +82580,7 @@ "async_search.submit-allow_no_indices": { "in": "query", "name": "allow_no_indices", - "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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "deprecated": false, "schema": { "type": "boolean" @@ -82610,7 +82610,7 @@ "async_search.submit-analyze_wildcard": { "in": "query", "name": "analyze_wildcard", - "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", + "description": "Specify whether wildcard and prefix queries should be analyzed", "deprecated": false, "schema": { "type": "boolean" @@ -82670,7 +82670,7 @@ "async_search.submit-expand_wildcards": { "in": "query", "name": "expand_wildcards", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.ExpandWildcards" @@ -82720,7 +82720,7 @@ "async_search.submit-max_concurrent_shard_requests": { "in": "query", "name": "max_concurrent_shard_requests", - "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", + "description": "The number of concurrent shard requests per node this search executes concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "deprecated": false, "schema": { "type": "number" @@ -82730,7 +82730,7 @@ "async_search.submit-preference": { "in": "query", "name": "preference", - "description": "Specify the node or shard the operation should be performed on (default: random)", + "description": "Specify the node or shard the operation should be performed on", "deprecated": false, "schema": { "type": "string" @@ -82833,7 +82833,7 @@ "async_search.submit-terminate_after": { "in": "query", "name": "terminate_after", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early", "deprecated": false, "schema": { "type": "number" @@ -82853,7 +82853,7 @@ "async_search.submit-track_total_hits": { "in": "query", "name": "track_total_hits", - "description": "Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.", + "description": "Indicate if the number of documents that match the query should be tracked.\nA number can also be specified, to accurately track the total hit count up to the number.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_global.search._types.TrackHits" @@ -82953,7 +82953,7 @@ "async_search.submit-size": { "in": "query", "name": "size", - "description": "Number of hits to return (default: 10)", + "description": "Number of hits to return", "deprecated": false, "schema": { "type": "number" @@ -82963,7 +82963,7 @@ "async_search.submit-from": { "in": "query", "name": "from", - "description": "Starting offset (default: 0)", + "description": "Starting offset", "deprecated": false, "schema": { "type": "number" @@ -83635,7 +83635,7 @@ "cluster.get_component_template-include_defaults": { "in": "query", "name": "include_defaults", - "description": "Return all default configurations for the component template (default: false)", + "description": "Return all default configurations for the component template", "deprecated": false, "schema": { "type": "boolean" @@ -84012,7 +84012,7 @@ "eql.search-index": { "in": "path", "name": "index", - "description": "The name of the index to scope the operation", + "description": "Comma-separated list of index names to scope the operation", "required": true, "deprecated": false, "schema": { @@ -84023,7 +84023,7 @@ "eql.search-allow_no_indices": { "in": "query", "name": "allow_no_indices", - "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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "deprecated": false, "schema": { "type": "boolean" @@ -85052,7 +85052,7 @@ "indices.put_index_template-cause": { "in": "query", "name": "cause", - "description": "User defined reason for creating/updating the index template", + "description": "User defined reason for creating or updating the index template", "deprecated": false, "schema": { "type": "string" @@ -85062,7 +85062,7 @@ "indices.put_mapping-index": { "in": "path", "name": "index", - "description": "A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.", + "description": "A comma-separated list of index names the mapping should be added to (supports wildcards).\nUse `_all` or omit to add the mapping on all indices.", "required": true, "deprecated": false, "schema": { @@ -85669,7 +85669,7 @@ "ingest.get_pipeline-summary": { "in": "query", "name": "summary", - "description": "Return pipelines without their definitions (default: false)", + "description": "Return pipelines without their definitions", "deprecated": false, "schema": { "type": "boolean" @@ -86813,7 +86813,7 @@ "scroll-scroll_id_": { "in": "query", "name": "scroll_id", - "description": "The scroll ID for scrolled search", + "description": "The scroll ID", "deprecated": true, "schema": { "$ref": "#/components/schemas/_types.ScrollId" @@ -87323,7 +87323,7 @@ "search_mvt-index": { "in": "path", "name": "index", - "description": "Comma-separated list of data streams, indices, or aliases to search", + "description": "A list of indices, data streams, or aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.\nTo search a remote cluster, use the `:` syntax.", "required": true, "deprecated": false, "schema": { @@ -87334,7 +87334,7 @@ "search_mvt-field": { "in": "path", "name": "field", - "description": "Field containing geospatial data to return", + "description": "A field that contains the geospatial data to return.\nIt must be a `geo_point` or `geo_shape` field.\nThe field must have doc values enabled. It cannot be a nested field.\n\nNOTE: Vector tiles do not natively support geometry collections.\nFor `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection.\nThis behavior may change in a future release.", "required": true, "deprecated": false, "schema": { @@ -87345,7 +87345,7 @@ "search_mvt-zoom": { "in": "path", "name": "zoom", - "description": "Zoom level for the vector tile to search", + "description": "The zoom level of the vector tile to search. It accepts `0` to `29`.", "required": true, "deprecated": false, "schema": { @@ -87356,7 +87356,7 @@ "search_mvt-x": { "in": "path", "name": "x", - "description": "X coordinate for the vector tile to search", + "description": "The X coordinate for the vector tile to search.", "required": true, "deprecated": false, "schema": { @@ -87367,7 +87367,7 @@ "search_mvt-y": { "in": "path", "name": "y", - "description": "Y coordinate for the vector tile to search", + "description": "The Y coordinate for the vector tile to search.", "required": true, "deprecated": false, "schema": { diff --git a/output/schema/schema.json b/output/schema/schema.json index 4fb7fb3a7f..2a4370eebb 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -34887,7 +34887,7 @@ } } ], - "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L134" + "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L137" }, { "kind": "response", @@ -35182,7 +35182,7 @@ } } ], - "specLocation": "_global/open_point_in_time/OpenPointInTimeRequest.ts#L26-L127" + "specLocation": "_global/open_point_in_time/OpenPointInTimeRequest.ts#L26-L130" }, { "kind": "response", @@ -36167,7 +36167,7 @@ } } ], - "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L79" + "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L83" }, { "kind": "response", @@ -38417,7 +38417,7 @@ "description": "", "version": "7.0.0" }, - "description": "The scroll ID for scrolled search", + "description": "The scroll ID", "name": "scroll_id", "required": false, "type": { @@ -38442,7 +38442,7 @@ } } ], - "specLocation": "_global/scroll/ScrollRequest.ts#L24-L88" + "specLocation": "_global/scroll/ScrollRequest.ts#L24-L94" }, { "kind": "response", @@ -46460,7 +46460,7 @@ }, "path": [ { - "description": "Comma-separated list of data streams, indices, or aliases to search", + "description": "A list of indices, data streams, or aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.\nTo search a remote cluster, use the `:` syntax.", "name": "index", "required": true, "type": { @@ -46472,7 +46472,7 @@ } }, { - "description": "Field containing geospatial data to return", + "description": "A field that contains the geospatial data to return.\nIt must be a `geo_point` or `geo_shape` field.\nThe field must have doc values enabled. It cannot be a nested field.\n\nNOTE: Vector tiles do not natively support geometry collections.\nFor `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection.\nThis behavior may change in a future release.", "name": "field", "required": true, "type": { @@ -46484,7 +46484,7 @@ } }, { - "description": "Zoom level for the vector tile to search", + "description": "The zoom level of the vector tile to search. It accepts `0` to `29`.", "name": "zoom", "required": true, "type": { @@ -46496,7 +46496,7 @@ } }, { - "description": "X coordinate for the vector tile to search", + "description": "The X coordinate for the vector tile to search.", "name": "x", "required": true, "type": { @@ -46508,7 +46508,7 @@ } }, { - "description": "Y coordinate for the vector tile to search", + "description": "The Y coordinate for the vector tile to search.", "name": "y", "required": true, "type": { @@ -50196,7 +50196,7 @@ } } ], - "specLocation": "_global/update_by_query/UpdateByQueryRequest.ts#L37-L351" + "specLocation": "_global/update_by_query/UpdateByQueryRequest.ts#L37-L354" }, { "kind": "response", @@ -99577,7 +99577,7 @@ } } ], - "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L63" + "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L66" }, { "kind": "response", @@ -100399,7 +100399,7 @@ } }, { - "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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { @@ -100436,9 +100436,10 @@ } }, { - "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", + "description": "Specify whether wildcard and prefix queries should be analyzed", "name": "analyze_wildcard", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -100511,7 +100512,7 @@ } }, { - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both", "name": "expand_wildcards", "required": false, "serverDefault": "open", @@ -100572,7 +100573,7 @@ } }, { - "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", + "description": "The number of concurrent shard requests per node this search executes concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "name": "max_concurrent_shard_requests", "required": false, "serverDefault": 5, @@ -100585,9 +100586,10 @@ } }, { - "description": "Specify the node or shard the operation should be performed on (default: random)", + "description": "Specify the node or shard the operation should be performed on", "name": "preference", "required": false, + "serverDefault": "random", "type": { "kind": "instance_of", "type": { @@ -100710,7 +100712,7 @@ } }, { - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early", "name": "terminate_after", "required": false, "type": { @@ -100734,7 +100736,7 @@ } }, { - "description": "Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.", + "description": "Indicate if the number of documents that match the query should be tracked.\nA number can also be specified, to accurately track the total hit count up to the number.", "name": "track_total_hits", "required": false, "type": { @@ -100855,9 +100857,10 @@ } }, { - "description": "Number of hits to return (default: 10)", + "description": "Number of hits to return", "name": "size", "required": false, + "serverDefault": 10, "type": { "kind": "instance_of", "type": { @@ -100867,9 +100870,10 @@ } }, { - "description": "Starting offset (default: 0)", + "description": "Starting offset", "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -100906,7 +100910,7 @@ } } ], - "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L54-L312" + "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L54-L416" }, { "kind": "response", @@ -101074,7 +101078,7 @@ }, "path": [ { - "description": "the name of the autoscaling policy", + "description": "Name of the autoscaling policy", "name": "name", "required": true, "type": { @@ -101114,7 +101118,7 @@ } } ], - "specLocation": "autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts#L24-L54" + "specLocation": "autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts#L24-L55" }, { "kind": "response", @@ -101496,7 +101500,7 @@ }, "path": [ { - "description": "the name of the autoscaling policy", + "description": "Name of the autoscaling policy", "name": "name", "required": true, "type": { @@ -101523,7 +101527,7 @@ } } ], - "specLocation": "autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts#L24-L50" + "specLocation": "autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts#L24-L51" }, { "kind": "response", @@ -101645,7 +101649,7 @@ }, "path": [ { - "description": "the name of the autoscaling policy", + "description": "Name of the autoscaling policy", "name": "name", "required": true, "type": { @@ -101685,7 +101689,7 @@ } } ], - "specLocation": "autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L25-L57" + "specLocation": "autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L25-L58" }, { "kind": "response", @@ -111688,7 +111692,7 @@ } } ], - "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L23-L69" + "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L23-L70" }, { "kind": "response", @@ -122422,7 +122426,7 @@ }, "path": [ { - "description": "the name of the leader index for which specified follower retention leases should be removed", + "description": "Name of the leader index for which specified follower retention leases should be removed", "name": "index", "required": true, "type": { @@ -122449,7 +122453,7 @@ } } ], - "specLocation": "ccr/forget_follower/ForgetFollowerIndexRequest.ts#L24-L66" + "specLocation": "ccr/forget_follower/ForgetFollowerIndexRequest.ts#L24-L67" }, { "kind": "response", @@ -123507,7 +123511,7 @@ }, "path": [ { - "description": "The name of the follow index to resume following.", + "description": "Name of the follow index to resume following", "name": "index", "required": true, "type": { @@ -123534,7 +123538,7 @@ } } ], - "specLocation": "ccr/resume_follow/ResumeFollowIndexRequest.ts#L25-L66" + "specLocation": "ccr/resume_follow/ResumeFollowIndexRequest.ts#L25-L67" }, { "kind": "response", @@ -125855,7 +125859,7 @@ "stability": "stable" } }, - "description": "Return all default configurations for the component template (default: false)", + "description": "Return all default configurations for the component template", "name": "include_defaults", "required": false, "serverDefault": false, @@ -125898,7 +125902,7 @@ } } ], - "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateRequest.ts#L24-L83" + "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateRequest.ts#L24-L84" }, { "kind": "response", @@ -126697,7 +126701,7 @@ } } ], - "specLocation": "cluster/health/ClusterHealthRequest.ts#L32-L121" + "specLocation": "cluster/health/ClusterHealthRequest.ts#L32-L122" }, { "kind": "response", @@ -127615,9 +127619,10 @@ "path": [], "query": [ { - "description": "Return settings in flat format (default: false)", + "description": "Return settings in flat format", "name": "flat_settings", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -127627,7 +127632,7 @@ } }, { - "description": "Explicit operation timeout for connection to master node", + "description": "The period to wait for a connection to the master node.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -127640,7 +127645,7 @@ } }, { - "description": "Explicit operation timeout", + "description": "The period to wait for a response.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -127653,7 +127658,7 @@ } } ], - "specLocation": "cluster/put_settings/ClusterPutSettingsRequest.ts#L25-L71" + "specLocation": "cluster/put_settings/ClusterPutSettingsRequest.ts#L25-L81" }, { "kind": "response", @@ -128731,7 +128736,7 @@ }, "path": [ { - "description": "Limit the information returned to the specified metrics", + "description": "Limit the information returned to the specified metrics.", "name": "metric", "required": false, "type": { @@ -128757,7 +128762,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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "serverDefault": true, @@ -128770,7 +128775,7 @@ } }, { - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both", "name": "expand_wildcards", "required": false, "serverDefault": "open", @@ -128783,7 +128788,7 @@ } }, { - "description": "Return settings in flat format (default: false)", + "description": "Return settings in flat format", "name": "flat_settings", "required": false, "serverDefault": false, @@ -128813,7 +128818,7 @@ "description": "This parameter has no effect, is now deprecated, and will be removed in a future version.", "version": "9.0.0" }, - "description": "Return local information, do not retrieve the state from master node (default: false)", + "description": "Return local information, do not retrieve the state from master node", "name": "local", "required": false, "serverDefault": false, @@ -128863,7 +128868,7 @@ } } ], - "specLocation": "cluster/state/ClusterStateRequest.ts#L29-L97" + "specLocation": "cluster/state/ClusterStateRequest.ts#L29-L120" }, { "kind": "response", @@ -138981,7 +138986,7 @@ } }, { - "description": "Specify timeout for connection to master", + "description": "The period to wait for a connection to the master node.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -138994,9 +138999,10 @@ } }, { - "description": "Explicit operation timeout", + "description": "The period to wait for a response.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -139006,7 +139012,7 @@ } } ], - "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L60" + "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L65" }, { "kind": "response", @@ -139106,7 +139112,7 @@ } }, { - "description": "Specify timeout for connection to master", + "description": "The period to wait for a connection to the master node.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -139119,9 +139125,10 @@ } }, { - "description": "Explicit operation timeout", + "description": "The period to wait for a response.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -139131,7 +139138,7 @@ } } ], - "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L61" + "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L66" }, { "kind": "response", @@ -141377,7 +141384,7 @@ }, "path": [ { - "description": "The name of the index to scope the operation", + "description": "Comma-separated list of index names to scope the operation", "name": "index", "required": true, "type": { @@ -141391,7 +141398,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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "serverDefault": true, @@ -141507,7 +141514,7 @@ } } ], - "specLocation": "eql/search/EqlSearchRequest.ts#L28-L168" + "specLocation": "eql/search/EqlSearchRequest.ts#L28-L172" }, { "kind": "response", @@ -142919,7 +142926,7 @@ } ], "query": [], - "specLocation": "esql/get_query/GetQueryRequest.ts#L23-L44" + "specLocation": "esql/get_query/GetQueryRequest.ts#L23-L45" }, { "kind": "response", @@ -148160,7 +148167,7 @@ } ], "query": [], - "specLocation": "ilm/move_to_step/MoveToStepRequest.ts#L24-L65" + "specLocation": "ilm/move_to_step/MoveToStepRequest.ts#L24-L66" }, { "kind": "response", @@ -148432,7 +148439,7 @@ } ], "query": [], - "specLocation": "ilm/remove_policy/RemovePolicyRequest.ts#L23-L43" + "specLocation": "ilm/remove_policy/RemovePolicyRequest.ts#L23-L44" }, { "kind": "response", @@ -148543,7 +148550,7 @@ } ], "query": [], - "specLocation": "ilm/retry/RetryIlmRequest.ts#L23-L44" + "specLocation": "ilm/retry/RetryIlmRequest.ts#L23-L45" }, { "kind": "response", @@ -156705,7 +156712,7 @@ }, "path": [ { - "description": "A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams", + "description": "A comma-separated list of data streams of which the data stream lifecycle will be deleted.\nUse `*` to get all data streams", "name": "name", "required": true, "type": { @@ -156732,7 +156739,7 @@ } }, { - "description": "Specify timeout for connection to master", + "description": "The period to wait for a connection to the master node.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -156745,9 +156752,10 @@ } }, { - "description": "Explicit timestamp for the document", + "description": "The period to wait for a response.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -156757,7 +156765,7 @@ } } ], - "specLocation": "indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts#L24-L55" + "specLocation": "indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts#L24-L65" }, { "kind": "response", @@ -156918,7 +156926,7 @@ }, "path": [ { - "description": "A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams", + "description": "A comma-separated list of data streams of which the data stream options will be deleted.\nUse `*` to get all data streams", "name": "name", "required": true, "type": { @@ -156932,7 +156940,7 @@ ], "query": [ { - "description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)", + "description": "Whether wildcard expressions should get expanded to open or closed indices", "name": "expand_wildcards", "required": false, "serverDefault": "open", @@ -156945,7 +156953,7 @@ } }, { - "description": "Specify timeout for connection to master", + "description": "The period to wait for a connection to the master node.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -156958,9 +156966,10 @@ } }, { - "description": "Explicit timestamp for the document", + "description": "The period to wait for a response.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -156970,7 +156979,7 @@ } } ], - "specLocation": "indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts#L24-L55" + "specLocation": "indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts#L24-L65" }, { "kind": "response", @@ -158166,7 +158175,7 @@ }, "path": [ { - "description": "The name of the index to explain", + "description": "Comma-separated list of index names to explain", "name": "index", "required": true, "type": { @@ -158180,9 +158189,10 @@ ], "query": [ { - "description": "indicates if the API should return the default values the system uses for the index's lifecycle", + "description": "Indicates if the API should return the default values the system uses for the index's lifecycle", "name": "include_defaults", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -158192,7 +158202,7 @@ } }, { - "description": "Specify timeout for connection to master", + "description": "The period to wait for a connection to the master node.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -158205,7 +158215,7 @@ } } ], - "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L52" + "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L58" }, { "kind": "response", @@ -158982,7 +158992,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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { @@ -159007,9 +159017,10 @@ } }, { - "description": "Specify whether the index should be flushed after performing the operation (default: true)", + "description": "Specify whether the index should be flushed after performing the operation", "name": "flush", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -159031,7 +159042,7 @@ } }, { - "description": "The number of segments the index should be merged into (default: dynamic)", + "description": "The number of segments the index should be merged into (defayult: dynamic)", "name": "max_num_segments", "required": false, "type": { @@ -159046,6 +159057,7 @@ "description": "Specify whether the operation should only expunge deleted documents", "name": "only_expunge_deletes", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -159055,7 +159067,7 @@ } }, { - "description": "Should the request wait until the force merge is completed.", + "description": "Should the request wait until the force merge is completed", "name": "wait_for_completion", "required": false, "serverDefault": true, @@ -159068,7 +159080,7 @@ } } ], - "specLocation": "indices/forcemerge/IndicesForceMergeRequest.ts#L24-L115" + "specLocation": "indices/forcemerge/IndicesForceMergeRequest.ts#L24-L138" }, { "kind": "response", @@ -162357,7 +162369,7 @@ }, "path": [ { - "description": "The name of the data stream", + "description": "The name of the data stream to promote", "name": "name", "required": true, "type": { @@ -162384,7 +162396,7 @@ } } ], - "specLocation": "indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts#L24-L59" + "specLocation": "indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts#L24-L60" }, { "kind": "response", @@ -163320,7 +163332,7 @@ } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L162-L184" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L163-L185" }, { "kind": "request", @@ -163578,7 +163590,7 @@ } }, { - "description": "User defined reason for creating/updating the index template", + "description": "User defined reason for creating or updating the index template", "name": "cause", "required": false, "serverDefault": "api", @@ -163591,7 +163603,7 @@ } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L37-L160" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L37-L161" }, { "kind": "response", @@ -163830,7 +163842,7 @@ }, "path": [ { - "description": "A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.", + "description": "A comma-separated list of index names the mapping should be added to (supports wildcards).\nUse `_all` or omit to add the mapping on all indices.", "name": "index", "required": true, "type": { @@ -163922,7 +163934,7 @@ } } ], - "specLocation": "indices/put_mapping/IndicesPutMappingRequest.ts#L41-L165" + "specLocation": "indices/put_mapping/IndicesPutMappingRequest.ts#L41-L169" }, { "kind": "response", @@ -164442,7 +164454,7 @@ } }, { - "description": "User defined reason for creating/updating the index template", + "description": "User defined reason for creating or updating the index template", "name": "cause", "required": false, "serverDefault": "", @@ -164455,7 +164467,7 @@ } } ], - "specLocation": "indices/put_template/IndicesPutTemplateRequest.ts#L29-L127" + "specLocation": "indices/put_template/IndicesPutTemplateRequest.ts#L29-L129" }, { "kind": "response", @@ -165887,7 +165899,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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { @@ -165936,7 +165948,7 @@ } } ], - "specLocation": "indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts#L23-L65" + "specLocation": "indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts#L23-L76" }, { "kind": "response", @@ -169611,7 +169623,7 @@ }, "path": [ { - "description": "Limit the information returned the specific metrics.", + "description": "Limit the information returned the specific metrics", "name": "metric", "required": false, "type": { @@ -169765,7 +169777,7 @@ } } ], - "specLocation": "indices/stats/IndicesStatsRequest.ts#L29-L116" + "specLocation": "indices/stats/IndicesStatsRequest.ts#L29-L118" }, { "kind": "response", @@ -188058,7 +188070,7 @@ } }, { - "description": "Return pipelines without their definitions (default: false)", + "description": "Return pipelines without their definitions", "name": "summary", "required": false, "serverDefault": false, @@ -188071,7 +188083,7 @@ } } ], - "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L64" + "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L65" }, { "kind": "response", @@ -189873,9 +189885,10 @@ "path": [], "query": [ { - "description": "whether the user has acknowledged acknowledge messages (default: false)", + "description": "Whether the user has acknowledged acknowledge messages", "name": "acknowledge", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -189911,7 +189924,7 @@ } } ], - "specLocation": "license/post_start_basic/StartBasicLicenseRequest.ts#L23-L59" + "specLocation": "license/post_start_basic/StartBasicLicenseRequest.ts#L23-L63" }, { "kind": "response", @@ -190066,9 +190079,10 @@ "path": [], "query": [ { - "description": "whether the user has acknowledged acknowledge messages (default: false)", + "description": "Whether the user has acknowledged acknowledge messages", "name": "acknowledge", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -190078,9 +190092,10 @@ } }, { - "description": "The type of trial license to generate (default: \"trial\")", + "description": "The type of trial license to generate", "name": "type", "required": false, + "serverDefault": "trial", "type": { "kind": "instance_of", "type": { @@ -190103,7 +190118,7 @@ } } ], - "specLocation": "license/post_start_trial/StartTrialLicenseRequest.ts#L23-L53" + "specLocation": "license/post_start_trial/StartTrialLicenseRequest.ts#L23-L61" }, { "kind": "response", @@ -212810,7 +212825,7 @@ } } ], - "specLocation": "ml/preview_datafeed/MlPreviewDatafeedRequest.ts#L26-L82" + "specLocation": "ml/preview_datafeed/MlPreviewDatafeedRequest.ts#L26-L84" }, { "kind": "response", @@ -216801,7 +216816,7 @@ } }, { - "description": "The deployment priority.", + "description": "The deployment priority", "name": "priority", "required": false, "type": { @@ -216865,7 +216880,7 @@ } } ], - "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L30-L112" + "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L30-L113" }, { "kind": "response", @@ -224763,9 +224778,10 @@ } }, { - "description": "The sort order for 'cpu' type (default: total)", + "description": "The sort order for 'cpu' type", "name": "sort", "required": false, + "serverDefault": "total", "type": { "kind": "instance_of", "type": { @@ -224775,7 +224791,7 @@ } } ], - "specLocation": "nodes/hot_threads/NodesHotThreadsRequest.ts#L25-L89" + "specLocation": "nodes/hot_threads/NodesHotThreadsRequest.ts#L25-L93" }, { "kind": "response", @@ -228226,7 +228242,6 @@ } }, { - "description": "Limit the information returned to the specified metrics", "name": "metric", "required": false, "type": { @@ -228579,7 +228594,7 @@ }, "path": [ { - "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "description": "A comma-separated list of node IDs or names to limit the returned information.\nUse `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", "name": "node_id", "required": false, "type": { @@ -228618,7 +228633,7 @@ } } ], - "specLocation": "nodes/usage/NodesUsageRequest.ts#L24-L69" + "specLocation": "nodes/usage/NodesUsageRequest.ts#L24-L73" }, { "kind": "response", @@ -231927,6 +231942,7 @@ "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", "name": "typed_keys", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -231936,7 +231952,7 @@ } } ], - "specLocation": "rollup/rollup_search/RollupSearchRequest.ts#L27-L90" + "specLocation": "rollup/rollup_search/RollupSearchRequest.ts#L27-L95" }, { "kind": "response", @@ -233941,7 +233957,7 @@ ], "query": [ { - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both", "name": "expand_wildcards", "required": false, "serverDefault": "open", @@ -233954,7 +233970,7 @@ } }, { - "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": "Whether to ignore if a wildcard indices expression resolves into no concrete indices.\n(This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { @@ -233978,7 +233994,7 @@ } } ], - "specLocation": "searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts#L23-L58" + "specLocation": "searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts#L23-L68" }, { "kind": "response", @@ -234323,7 +234339,7 @@ } } ], - "specLocation": "searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts#L24-L56" + "specLocation": "searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts#L24-L57" }, { "kind": "response", @@ -237743,7 +237759,7 @@ } } ], - "specLocation": "security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L50" + "specLocation": "security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L53" }, { "kind": "response", @@ -237974,7 +237990,7 @@ } } ], - "specLocation": "security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L52" + "specLocation": "security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L55" }, { "kind": "response", @@ -238385,7 +238401,7 @@ } } ], - "specLocation": "security/change_password/SecurityChangePasswordRequest.ts#L23-L65" + "specLocation": "security/change_password/SecurityChangePasswordRequest.ts#L23-L68" }, { "kind": "response", @@ -239200,7 +239216,7 @@ } } ], - "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L86" + "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L89" }, { "kind": "response", @@ -239571,7 +239587,7 @@ ], "query": [ { - "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", + "description": "If `true` (the default) 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` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -239583,7 +239599,7 @@ } } ], - "specLocation": "security/create_service_token/CreateServiceTokenRequest.ts#L23-L72" + "specLocation": "security/create_service_token/CreateServiceTokenRequest.ts#L23-L75" }, { "kind": "response", @@ -240131,7 +240147,7 @@ } } ], - "specLocation": "security/delete_privileges/SecurityDeletePrivilegesRequest.ts#L23-L58" + "specLocation": "security/delete_privileges/SecurityDeletePrivilegesRequest.ts#L23-L61" }, { "kind": "response", @@ -240258,7 +240274,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L49" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L52" }, { "kind": "response", @@ -240369,7 +240385,7 @@ } } ], - "specLocation": "security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts#L23-L53" + "specLocation": "security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts#L23-L56" }, { "kind": "response", @@ -240492,7 +240508,7 @@ ], "query": [ { - "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", + "description": "If `true` (the default) 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` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -240504,7 +240520,7 @@ } } ], - "specLocation": "security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L58" + "specLocation": "security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L61" }, { "kind": "response", @@ -240615,7 +240631,7 @@ } } ], - "specLocation": "security/delete_user/SecurityDeleteUserRequest.ts#L23-L48" + "specLocation": "security/delete_user/SecurityDeleteUserRequest.ts#L23-L51" }, { "kind": "response", @@ -240726,7 +240742,7 @@ } } ], - "specLocation": "security/disable_user/SecurityDisableUserRequest.ts#L23-L50" + "specLocation": "security/disable_user/SecurityDisableUserRequest.ts#L23-L53" }, { "kind": "response", @@ -240918,7 +240934,7 @@ } } ], - "specLocation": "security/enable_user/SecurityEnableUserRequest.ts#L23-L49" + "specLocation": "security/enable_user/SecurityEnableUserRequest.ts#L23-L52" }, { "kind": "response", @@ -244195,7 +244211,7 @@ } ], "query": [], - "specLocation": "security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L59" + "specLocation": "security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L60" }, { "kind": "type_alias", @@ -245941,7 +245957,7 @@ } } ], - "specLocation": "security/put_privileges/SecurityPutPrivilegesRequest.ts#L25-L67" + "specLocation": "security/put_privileges/SecurityPutPrivilegesRequest.ts#L25-L70" }, { "kind": "response", @@ -246308,7 +246324,7 @@ } } ], - "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L32-L111" + "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L32-L114" }, { "kind": "response", @@ -246760,7 +246776,7 @@ } } ], - "specLocation": "security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L25-L103" + "specLocation": "security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L25-L106" }, { "kind": "response", @@ -250878,7 +250894,7 @@ } } ], - "specLocation": "shutdown/delete_node/ShutdownDeleteNodeRequest.ts#L24-L62" + "specLocation": "shutdown/delete_node/ShutdownDeleteNodeRequest.ts#L24-L63" }, { "kind": "response", @@ -251106,7 +251122,7 @@ }, "path": [ { - "description": "Which node for which to retrieve the shutdown status", + "description": "Comma-separated list of nodes for which to retrieve the shutdown status", "name": "node_id", "required": false, "type": { @@ -251133,7 +251149,7 @@ } } ], - "specLocation": "shutdown/get_node/ShutdownGetNodeRequest.ts#L24-L59" + "specLocation": "shutdown/get_node/ShutdownGetNodeRequest.ts#L24-L60" }, { "kind": "response", @@ -252625,7 +252641,7 @@ } } ], - "specLocation": "slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts#L24-L59" + "specLocation": "slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts#L24-L60" }, { "kind": "response", @@ -252738,7 +252754,7 @@ } } ], - "specLocation": "slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts#L24-L59" + "specLocation": "slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts#L24-L60" }, { "kind": "response", @@ -252922,7 +252938,7 @@ }, "path": [ { - "description": "Comma-separated list of snapshot lifecycle policies to retrieve", + "description": "A comma-separated list of snapshot lifecycle policy identifiers.", "name": "policy_id", "required": false, "type": { @@ -252962,7 +252978,7 @@ } } ], - "specLocation": "slm/get_lifecycle/GetSnapshotLifecycleRequest.ts#L24-L65" + "specLocation": "slm/get_lifecycle/GetSnapshotLifecycleRequest.ts#L24-L63" }, { "kind": "response", @@ -266428,6 +266444,7 @@ "description": "Controls the time to wait for the stats", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -266437,7 +266454,7 @@ } } ], - "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L25-L77" + "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L25-L81" }, { "kind": "response", @@ -274372,7 +274389,7 @@ } }, { - "description": "only update the watch if the last operation that has changed the watch has the specified primary term", + "description": "Only update the watch if the last operation that has changed the watch has the specified primary term", "name": "if_primary_term", "required": false, "type": { @@ -274384,7 +274401,7 @@ } }, { - "description": "only update the watch if the last operation that has changed the watch has the specified sequence number", + "description": "Only update the watch if the last operation that has changed the watch has the specified sequence number", "name": "if_seq_no", "required": false, "type": { @@ -274408,7 +274425,7 @@ } } ], - "specLocation": "watcher/put_watch/WatcherPutWatchRequest.ts#L31-L111" + "specLocation": "watcher/put_watch/WatcherPutWatchRequest.ts#L31-L116" }, { "kind": "response", @@ -275985,7 +276002,7 @@ "description": "Supported for backwards compatibility with 7.x", "version": "8.0.0" }, - "description": "If this param is used it must be set to true", + "description": "If used, this otherwise ignored parameter must be set to true", "name": "accept_enterprise", "required": false, "type": { @@ -276010,7 +276027,7 @@ } } ], - "specLocation": "xpack/info/XPackInfoRequest.ts#L22-L60" + "specLocation": "xpack/info/XPackInfoRequest.ts#L22-L61" }, { "kind": "response", @@ -276092,7 +276109,7 @@ "name": "XPackCategory", "namespace": "xpack.info" }, - "specLocation": "xpack/info/XPackInfoRequest.ts#L62-L66" + "specLocation": "xpack/info/XPackInfoRequest.ts#L63-L67" }, { "kind": "interface", diff --git a/specification/_global/mtermvectors/MultiTermVectorsRequest.ts b/specification/_global/mtermvectors/MultiTermVectorsRequest.ts index ae979954b8..4373531571 100644 --- a/specification/_global/mtermvectors/MultiTermVectorsRequest.ts +++ b/specification/_global/mtermvectors/MultiTermVectorsRequest.ts @@ -66,6 +66,9 @@ export interface Request extends RequestBase { index?: IndexName } query_parameters: { + /** + * A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body + */ ids?: Id[] /** * A comma-separated list or wildcard expressions of fields to include in the statistics. diff --git a/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts index c935925da0..1a16fe49fb 100644 --- a/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts +++ b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts @@ -77,6 +77,9 @@ export interface Request extends RequestBase { } ] path_parts: { + /** + * A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices + */ index: Indices } query_parameters: { diff --git a/specification/_global/rank_eval/RankEvalRequest.ts b/specification/_global/rank_eval/RankEvalRequest.ts index 56ff06a8e2..22f1842c97 100644 --- a/specification/_global/rank_eval/RankEvalRequest.ts +++ b/specification/_global/rank_eval/RankEvalRequest.ts @@ -58,6 +58,7 @@ export interface Request extends RequestBase { */ allow_no_indices?: boolean /** + * Whether to expand wildcard expression to concrete indices that are open, closed or both. * @server_default open */ expand_wildcards?: ExpandWildcards @@ -66,6 +67,9 @@ export interface Request extends RequestBase { * @server_default false */ ignore_unavailable?: boolean + /** + * Search operation type + */ search_type?: string } body: { diff --git a/specification/_global/scroll/ScrollRequest.ts b/specification/_global/scroll/ScrollRequest.ts index 2bf16e9b46..61799fcf02 100644 --- a/specification/_global/scroll/ScrollRequest.ts +++ b/specification/_global/scroll/ScrollRequest.ts @@ -57,7 +57,10 @@ export interface Request extends RequestBase { } ] path_parts: { - /** @deprecated 7.0.0 */ + /** + * The scroll ID + * @deprecated 7.0.0 + */ scroll_id?: ScrollId } query_parameters: { @@ -67,7 +70,10 @@ export interface Request extends RequestBase { * @server_default 1d */ scroll?: Duration - /** @deprecated 7.0.0 */ + /** + * The scroll ID + * @deprecated 7.0.0 + */ scroll_id?: ScrollId /** * If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. diff --git a/specification/_global/search_mvt/SearchMvtRequest.ts b/specification/_global/search_mvt/SearchMvtRequest.ts index f532cce9d2..d3a3fda223 100644 --- a/specification/_global/search_mvt/SearchMvtRequest.ts +++ b/specification/_global/search_mvt/SearchMvtRequest.ts @@ -136,14 +136,14 @@ export interface Request extends RequestBase { } ] path_parts: { - /* + /** * A list of indices, data streams, or aliases to search. * It supports wildcards (`*`). * To search all data streams and indices, omit this parameter or use `*` or `_all`. * To search a remote cluster, use the `:` syntax. */ index: Indices - /* + /** * A field that contains the geospatial data to return. * It must be a `geo_point` or `geo_shape` field. * The field must have doc values enabled. It cannot be a nested field. @@ -153,11 +153,11 @@ export interface Request extends RequestBase { * This behavior may change in a future release. */ field: Field - /* The zoom level of the vector tile to search. It accepts `0` to `29`. */ + /** The zoom level of the vector tile to search. It accepts `0` to `29`. */ zoom: ZoomLevel - /* The X coordinate for the vector tile to search. */ + /** The X coordinate for the vector tile to search. */ x: Coordinate - /* The Y coordinate for the vector tile to search. */ + /** The Y coordinate for the vector tile to search. */ y: Coordinate } query_parameters: { diff --git a/specification/_global/update_by_query/UpdateByQueryRequest.ts b/specification/_global/update_by_query/UpdateByQueryRequest.ts index a4ccf4d6a4..855351522f 100644 --- a/specification/_global/update_by_query/UpdateByQueryRequest.ts +++ b/specification/_global/update_by_query/UpdateByQueryRequest.ts @@ -307,6 +307,9 @@ export interface Request extends RequestBase { * If `true`, returns the document version as part of a hit. */ version?: boolean + /** + * Should the document increment the version number (internal) on hit or not (reindex) + */ version_type?: boolean /** * The number of shard copies that must be active before proceeding with the operation. diff --git a/specification/async_search/get/AsyncSearchGetRequest.ts b/specification/async_search/get/AsyncSearchGetRequest.ts index 3c29b4d7a3..bd0abc8f75 100644 --- a/specification/async_search/get/AsyncSearchGetRequest.ts +++ b/specification/async_search/get/AsyncSearchGetRequest.ts @@ -52,6 +52,9 @@ export interface Request extends RequestBase { * If the search is completed, its saved results are deleted. */ keep_alive?: Duration + /** + * Specify whether aggregation and suggester names should be prefixed by their respective types in the response + */ typed_keys?: boolean /** * Specifies to wait for the search to be completed up until the provided timeout. diff --git a/specification/async_search/submit/AsyncSearchSubmitRequest.ts b/specification/async_search/submit/AsyncSearchSubmitRequest.ts index ec70198b35..6c8d87d461 100644 --- a/specification/async_search/submit/AsyncSearchSubmitRequest.ts +++ b/specification/async_search/submit/AsyncSearchSubmitRequest.ts @@ -81,6 +81,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices */ index?: Indices } query_parameters: { @@ -101,12 +102,24 @@ export interface Request extends RequestBase { * @server_default false */ keep_on_completion?: boolean + /** + * Whether to ignore if a wildcard indices expression resolves into no concrete indices. + * (This includes `_all` string or when no indices have been specified) + */ allow_no_indices?: boolean /** + * Indicate if an error should be returned if there is a partial search failure or timeout * @server_default true */ allow_partial_search_results?: boolean + /** + * The analyzer to use for the query string + */ analyzer?: string + /** + * Specify whether wildcard and prefix queries should be analyzed + * @server_default false + */ analyze_wildcard?: boolean /** * Affects how often partial results become available, which happens whenever shard results are reduced. @@ -120,60 +133,151 @@ export interface Request extends RequestBase { */ ccs_minimize_roundtrips?: boolean /** + * The default operator for query string query (AND or OR) * @server_default or */ default_operator?: Operator + /** + * The field to use as default where no field prefix is given in the query string + */ df?: string + /** + * A comma-separated list of fields to return as the docvalue representation of a field for each hit + */ docvalue_fields?: Fields /** + * Whether to expand wildcard expression to concrete indices that are open, closed or both * @server_default open */ expand_wildcards?: ExpandWildcards + /** + * Specify whether to return detailed information about score computation as part of a hit + */ explain?: boolean + /** + * Whether specified concrete, expanded or aliased indices should be ignored when throttled + */ ignore_throttled?: boolean + /** + * Whether specified concrete indices should be ignored when unavailable (missing or closed) + */ ignore_unavailable?: boolean + /** + * Specify whether format-based query failures (such as providing text to a numeric field) should be ignored + */ lenient?: boolean /** + * The number of concurrent shard requests per node this search executes concurrently. + * This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests * @server_default 5 */ max_concurrent_shard_requests?: integer + /** + * Specify the node or shard the operation should be performed on + * @server_default random + */ preference?: string - /** @server_default true */ + /** + * Specify if request cache should be used for this request or not, defaults to true + * @server_default true + */ request_cache?: boolean + /** + * A comma-separated list of specific routing values + */ routing?: Routing + /** + * Search operation type + */ search_type?: SearchType + /** + * Specific 'tag' of the request for logging and statistical purposes + */ stats?: string[] + /** + * A comma-separated list of stored fields to return as part of a hit + */ stored_fields?: Fields /** * Specifies which field to use for suggestions. */ suggest_field?: Field /** + * Specify suggest mode * @server_default missing */ suggest_mode?: SuggestMode + /** + * How many suggestions to return in response + */ suggest_size?: long /** * The source text for which the suggestions should be returned. */ suggest_text?: string + /** + * The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early + */ terminate_after?: long + /** + * Explicit operation timeout + */ timeout?: Duration + /** + * Indicate if the number of documents that match the query should be tracked. + * A number can also be specified, to accurately track the total hit count up to the number. + */ track_total_hits?: TrackHits + /** + * Whether to calculate and return scores even if they are not used for sorting + */ track_scores?: boolean + /** + * Specify whether aggregation and suggester names should be prefixed by their respective types in the response + */ typed_keys?: boolean /** + * Indicates whether hits.total should be rendered as an integer or an object in the rest search response * @server_default false */ rest_total_hits_as_int?: boolean + /** + * Specify whether to return document version as part of a hit + */ version?: boolean + /** + * True or false to return the _source field or not, or a list of fields to return + */ _source?: SourceConfigParam + /** + * A list of fields to exclude from the returned _source field + */ _source_excludes?: Fields + /** + * A list of fields to extract and return from the _source field + */ _source_includes?: Fields + /** + * Specify whether to return sequence number and primary term of the last modification of each hit + */ seq_no_primary_term?: boolean + /** + * Query in the Lucene query string syntax + */ q?: string + /** + * Number of hits to return + * @server_default 10 + */ size?: integer + /** + * Starting offset + * @server_default 0 + */ from?: integer + /** + * A comma-separated list of : pairs + */ sort?: string | string[] } body?: { diff --git a/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts b/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts index 2fd2c3ca72..af93f8dbed 100644 --- a/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts +++ b/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts @@ -38,6 +38,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** Name of the autoscaling policy */ name: Name } query_parameters: { diff --git a/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts b/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts index d0881cc13c..1a34420285 100644 --- a/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts +++ b/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts @@ -38,6 +38,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** Name of the autoscaling policy */ name: Name } query_parameters: { diff --git a/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts b/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts index 7672d23156..9fcb9de543 100644 --- a/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts +++ b/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts @@ -39,6 +39,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** Name of the autoscaling policy */ name: Name } query_parameters: { diff --git a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts index 44138f5ba6..65dd92fa84 100644 --- a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts +++ b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts @@ -47,6 +47,7 @@ export interface Request extends CatRequestBase { } ] path_parts: { + /** The ID of the data frame analytics to fetch */ id?: Id } query_parameters: { diff --git a/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts b/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts index 55a16f1da2..b8e079ecbf 100644 --- a/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts +++ b/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts @@ -48,6 +48,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** Name of the leader index for which specified follower retention leases should be removed */ index: IndexName } query_parameters: { diff --git a/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts b/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts index 54e3e7c929..5405a773f7 100644 --- a/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts +++ b/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts @@ -42,6 +42,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** Name of the follow index to resume following */ index: IndexName } query_parameters: { diff --git a/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts b/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts index fc61458df3..f31da08465 100644 --- a/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts +++ b/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts @@ -61,6 +61,7 @@ export interface Request extends RequestBase { */ settings_filter?: string | string[] /** + * Return all default configurations for the component template * @server_default false * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable diff --git a/specification/cluster/health/ClusterHealthRequest.ts b/specification/cluster/health/ClusterHealthRequest.ts index 23b5cd83d5..5bc4a77f3c 100644 --- a/specification/cluster/health/ClusterHealthRequest.ts +++ b/specification/cluster/health/ClusterHealthRequest.ts @@ -67,6 +67,7 @@ export interface Request extends RequestBase { } query_parameters: { /** + * Whether to expand wildcard expression to concrete indices that are open, closed or both. * @server_default all */ expand_wildcards?: ExpandWildcards diff --git a/specification/cluster/put_settings/ClusterPutSettingsRequest.ts b/specification/cluster/put_settings/ClusterPutSettingsRequest.ts index 2afee78799..6f2236cdfd 100644 --- a/specification/cluster/put_settings/ClusterPutSettingsRequest.ts +++ b/specification/cluster/put_settings/ClusterPutSettingsRequest.ts @@ -56,10 +56,20 @@ export interface Request extends RequestBase { } ] query_parameters: { + /** + * Return settings in flat format + * @server_default false + */ flat_settings?: boolean - /** @server_default 30s */ + /** + * The period to wait for a connection to the master node. + * @server_default 30s + */ master_timeout?: Duration - /** @server_default 30s */ + /** + * The period to wait for a response. + * @server_default 30s + */ timeout?: Duration } body: { diff --git a/specification/cluster/state/ClusterStateRequest.ts b/specification/cluster/state/ClusterStateRequest.ts index 49e107bc3a..a4fd3db442 100644 --- a/specification/cluster/state/ClusterStateRequest.ts +++ b/specification/cluster/state/ClusterStateRequest.ts @@ -69,19 +69,36 @@ export interface Request extends RequestBase { } ] path_parts: { + /** Limit the information returned to the specified metrics. */ metric?: Metrics + /** + * A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + */ index?: Indices } query_parameters: { - /** @server_default true */ + /** + * Whether to ignore if a wildcard indices expression resolves into no concrete indices. + * (This includes `_all` string or when no indices have been specified) + * @server_default true */ allow_no_indices?: boolean - /** @server_default open */ + /** + * Whether to expand wildcard expression to concrete indices that are open, closed or both + * @server_default open + */ expand_wildcards?: ExpandWildcards - /** @server_default false */ + /** + * Return settings in flat format + * @server_default false + */ flat_settings?: boolean - /** @server_default false */ + /** + * Whether specified concrete indices should be ignored when unavailable (missing or closed) + * @server_default false + */ ignore_unavailable?: boolean /** + * Return local information, do not retrieve the state from master node * @deprecated 9.0.0 This parameter has no effect, is now deprecated, and will be removed in a future version. * @server_default false */ @@ -91,7 +108,13 @@ export interface Request extends RequestBase { * @server_default 30s * */ master_timeout?: Duration + /** + * Wait for the metadata version to be equal or greater than the specified metadata version + */ wait_for_metadata_version?: VersionNumber + /** + * The maximum time to wait for wait_for_metadata_version before timing out + */ wait_for_timeout?: Duration } } diff --git a/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts b/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts index 2f798884af..5d8ab06f5b 100644 --- a/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts +++ b/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts @@ -52,9 +52,14 @@ export interface Request extends RequestBase { */ accept_data_loss?: boolean /** + * The period to wait for a connection to the master node. * @server_default 30s */ master_timeout?: Duration + /** + * The period to wait for a response. + * @server_default 30s + */ timeout?: Duration } } diff --git a/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts b/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts index 21c4e97314..14e6a1823b 100644 --- a/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts +++ b/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts @@ -53,9 +53,14 @@ export interface Request extends RequestBase { */ accept_data_loss?: boolean /** + * The period to wait for a connection to the master node. * @server_default 30s */ master_timeout?: Duration + /** + * The period to wait for a response. + * @server_default 30s + */ timeout?: Duration } } diff --git a/specification/eql/search/EqlSearchRequest.ts b/specification/eql/search/EqlSearchRequest.ts index 5f661786c7..ec82627fb9 100644 --- a/specification/eql/search/EqlSearchRequest.ts +++ b/specification/eql/search/EqlSearchRequest.ts @@ -44,10 +44,13 @@ export interface Request extends RequestBase { } ] path_parts: { + /** Comma-separated list of index names to scope the operation */ index: Indices } query_parameters: { /** + * Whether to ignore if a wildcard indices expression resolves into no concrete indices. + * (This includes `_all` string or when no indices have been specified) * @server_default true */ allow_no_indices?: boolean @@ -63,6 +66,7 @@ export interface Request extends RequestBase { */ allow_partial_sequence_results?: boolean /** + * Whether to expand wildcard expression to concrete indices that are open, closed or both. * @server_default open */ expand_wildcards?: ExpandWildcards diff --git a/specification/esql/get_query/GetQueryRequest.ts b/specification/esql/get_query/GetQueryRequest.ts index 995e218506..2979f598ac 100644 --- a/specification/esql/get_query/GetQueryRequest.ts +++ b/specification/esql/get_query/GetQueryRequest.ts @@ -39,6 +39,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The query ID */ id: Id } } diff --git a/specification/ilm/move_to_step/MoveToStepRequest.ts b/specification/ilm/move_to_step/MoveToStepRequest.ts index fe5c89802e..6ca3ec7da4 100644 --- a/specification/ilm/move_to_step/MoveToStepRequest.ts +++ b/specification/ilm/move_to_step/MoveToStepRequest.ts @@ -50,6 +50,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The name of the index whose lifecycle step is to change */ index: IndexName } body: { diff --git a/specification/ilm/remove_policy/RemovePolicyRequest.ts b/specification/ilm/remove_policy/RemovePolicyRequest.ts index 9fd35b78c9..cb9bfcd603 100644 --- a/specification/ilm/remove_policy/RemovePolicyRequest.ts +++ b/specification/ilm/remove_policy/RemovePolicyRequest.ts @@ -38,6 +38,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The name of the index to remove policy on */ index: IndexName } } diff --git a/specification/ilm/retry/RetryIlmRequest.ts b/specification/ilm/retry/RetryIlmRequest.ts index 67c6d7340d..baaf3a369f 100644 --- a/specification/ilm/retry/RetryIlmRequest.ts +++ b/specification/ilm/retry/RetryIlmRequest.ts @@ -39,6 +39,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The name of the indices (comma-separated) whose failed lifecycle step is to be retry */ index: IndexName } } diff --git a/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts b/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts index 6529e29c1c..538b062695 100644 --- a/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts +++ b/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts @@ -39,17 +39,27 @@ export interface Request extends RequestBase { } ] path_parts: { + /** + * A comma-separated list of data streams of which the data stream lifecycle will be deleted. + * Use `*` to get all data streams + */ name: DataStreamNames } query_parameters: { /** + * Whether wildcard expressions should get expanded to open or closed indices (default: open) * @server_default open */ expand_wildcards?: ExpandWildcards /** + * The period to wait for a connection to the master node. * @server_default 30s */ master_timeout?: Duration + /** + * The period to wait for a response. + * @server_default 30s + */ timeout?: Duration } } diff --git a/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts b/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts index 3815320b39..35edb921dd 100644 --- a/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts +++ b/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts @@ -39,17 +39,27 @@ export interface Request extends RequestBase { } ] path_parts: { + /** + * A comma-separated list of data streams of which the data stream options will be deleted. + * Use `*` to get all data streams + */ name: DataStreamNames } query_parameters: { /** + * Whether wildcard expressions should get expanded to open or closed indices * @server_default open */ expand_wildcards?: ExpandWildcards /** + * The period to wait for a connection to the master node. * @server_default 30s */ master_timeout?: Duration + /** + * The period to wait for a response. + * @server_default 30s + */ timeout?: Duration } } diff --git a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts index f2904a0993..ca81510cb3 100644 --- a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts +++ b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts @@ -40,11 +40,17 @@ export interface Request extends RequestBase { } ] path_parts: { + /** Comma-separated list of index names to explain */ index: Indices } query_parameters: { + /** + * Indicates if the API should return the default values the system uses for the index's lifecycle + * @server_default false + */ include_defaults?: boolean /** + * The period to wait for a connection to the master node. * @server_default 30s */ master_timeout?: Duration diff --git a/specification/indices/forcemerge/IndicesForceMergeRequest.ts b/specification/indices/forcemerge/IndicesForceMergeRequest.ts index 708302f587..f60d4d2464 100644 --- a/specification/indices/forcemerge/IndicesForceMergeRequest.ts +++ b/specification/indices/forcemerge/IndicesForceMergeRequest.ts @@ -95,19 +95,42 @@ export interface Request extends RequestBase { } ] path_parts: { + /** + * A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + */ index?: Indices } query_parameters: { + /** + * Whether to ignore if a wildcard indices expression resolves into no concrete indices. + * (This includes `_all` string or when no indices have been specified) + */ allow_no_indices?: boolean /** + * Whether to expand wildcard expression to concrete indices that are open, closed or both. * @server_default open */ expand_wildcards?: ExpandWildcards + /** + * Specify whether the index should be flushed after performing the operation + * @server_default true + */ flush?: boolean + /** + * Whether specified concrete indices should be ignored when unavailable (missing or closed) + */ ignore_unavailable?: boolean + /** + * The number of segments the index should be merged into (defayult: dynamic) + */ max_num_segments?: long + /** + * Specify whether the operation should only expunge deleted documents + * @server_default false + */ only_expunge_deletes?: boolean /** + * Should the request wait until the force merge is completed * @server_default true */ wait_for_completion?: boolean diff --git a/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts b/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts index c694ba0e28..32c4ddb17f 100644 --- a/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts +++ b/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts @@ -47,6 +47,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The name of the data stream to promote */ name: IndexName } query_parameters: { diff --git a/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts b/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts index dfe9e8f53c..f41b2fc796 100644 --- a/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts +++ b/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts @@ -153,6 +153,7 @@ export interface Request extends RequestBase { * @server_default 30s */ master_timeout?: Duration /** + * User defined reason for creating or updating the index template * @server_default api */ cause?: string diff --git a/specification/indices/put_mapping/IndicesPutMappingRequest.ts b/specification/indices/put_mapping/IndicesPutMappingRequest.ts index 69061bec0a..495dce8872 100644 --- a/specification/indices/put_mapping/IndicesPutMappingRequest.ts +++ b/specification/indices/put_mapping/IndicesPutMappingRequest.ts @@ -68,6 +68,10 @@ export interface Request extends RequestBase { } ] path_parts: { + /** + * A comma-separated list of index names the mapping should be added to (supports wildcards). + * Use `_all` or omit to add the mapping on all indices. + */ index: Indices } query_parameters: { diff --git a/specification/indices/put_template/IndicesPutTemplateRequest.ts b/specification/indices/put_template/IndicesPutTemplateRequest.ts index b378c728e3..8e8eb601ec 100644 --- a/specification/indices/put_template/IndicesPutTemplateRequest.ts +++ b/specification/indices/put_template/IndicesPutTemplateRequest.ts @@ -64,6 +64,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The name of the template */ name: Name } query_parameters: { @@ -87,6 +88,7 @@ export interface Request extends RequestBase { */ order?: integer /** + * User defined reason for creating or updating the index template * @server_default */ cause?: string diff --git a/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts b/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts index 1575944e8c..4389fa9b98 100644 --- a/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts +++ b/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts @@ -50,12 +50,23 @@ export interface Request extends RequestBase { } ] path_parts: { + /** A comma-separated list of index names to reload analyzers for */ index: Indices } query_parameters: { + /** + * Whether to ignore if a wildcard indices expression resolves into no concrete indices. + * (This includes `_all` string or when no indices have been specified) + */ allow_no_indices?: boolean - /** @server_default open */ + /** + * Whether to expand wildcard expression to concrete indices that are open, closed or both. + * @server_default open + */ expand_wildcards?: ExpandWildcards + /** + * Whether specified concrete indices should be ignored when unavailable (missing or closed) + */ ignore_unavailable?: boolean /** * Changed resource to reload analyzers from if applicable diff --git a/specification/indices/stats/IndicesStatsRequest.ts b/specification/indices/stats/IndicesStatsRequest.ts index 9e7fb9f345..ea5001a62f 100644 --- a/specification/indices/stats/IndicesStatsRequest.ts +++ b/specification/indices/stats/IndicesStatsRequest.ts @@ -65,7 +65,9 @@ export interface Request extends RequestBase { } ] path_parts: { + /** Limit the information returned the specific metrics */ metric?: Metrics + /** A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices */ index?: Indices } query_parameters: { diff --git a/specification/ingest/get_pipeline/GetPipelineRequest.ts b/specification/ingest/get_pipeline/GetPipelineRequest.ts index 9b4a680784..51c69151a6 100644 --- a/specification/ingest/get_pipeline/GetPipelineRequest.ts +++ b/specification/ingest/get_pipeline/GetPipelineRequest.ts @@ -58,6 +58,7 @@ export interface Request extends RequestBase { * @server_default 30s */ master_timeout?: Duration /** + * Return pipelines without their definitions * @server_default false */ summary?: boolean } diff --git a/specification/license/post_start_basic/StartBasicLicenseRequest.ts b/specification/license/post_start_basic/StartBasicLicenseRequest.ts index b9bfadd74d..429792316a 100644 --- a/specification/license/post_start_basic/StartBasicLicenseRequest.ts +++ b/specification/license/post_start_basic/StartBasicLicenseRequest.ts @@ -44,6 +44,10 @@ export interface Request extends RequestBase { } ] query_parameters: { + /** + * Whether the user has acknowledged acknowledge messages + * @server_default false + */ acknowledge?: boolean /** * Period to wait for a connection to the master node. diff --git a/specification/license/post_start_trial/StartTrialLicenseRequest.ts b/specification/license/post_start_trial/StartTrialLicenseRequest.ts index 9ff4b5eb18..3e9ee40e3d 100644 --- a/specification/license/post_start_trial/StartTrialLicenseRequest.ts +++ b/specification/license/post_start_trial/StartTrialLicenseRequest.ts @@ -42,7 +42,15 @@ export interface Request extends RequestBase { } ] query_parameters: { + /** + * Whether the user has acknowledged acknowledge messages + * @server_default false + */ acknowledge?: boolean + /** + * The type of trial license to generate + * @server_default trial + */ type?: string /** * Period to wait for a connection to the master node. diff --git a/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts b/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts index 434dc52c9f..f1aff0392b 100644 --- a/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts +++ b/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts @@ -63,7 +63,9 @@ export interface Request extends RequestBase { datafeed_id?: Id } query_parameters: { + /** The start time from where the datafeed preview should begin */ start?: DateTime + /** The end time when the datafeed preview should stop */ end?: DateTime } body?: { diff --git a/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts b/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts index 33008ff949..670d07fcd7 100644 --- a/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts +++ b/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts @@ -74,6 +74,7 @@ export interface Request extends RequestBase { * @server_default 1 */ number_of_allocations?: integer + /** The deployment priority */ priority?: TrainingPriority /** * Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds diff --git a/specification/nodes/hot_threads/NodesHotThreadsRequest.ts b/specification/nodes/hot_threads/NodesHotThreadsRequest.ts index eac346a324..9404685126 100644 --- a/specification/nodes/hot_threads/NodesHotThreadsRequest.ts +++ b/specification/nodes/hot_threads/NodesHotThreadsRequest.ts @@ -84,6 +84,10 @@ export interface Request extends RequestBase { * @server_default cpu */ type?: ThreadType + /** + * The sort order for 'cpu' type + * @server_default total + */ sort?: ThreadType } } diff --git a/specification/nodes/usage/NodesUsageRequest.ts b/specification/nodes/usage/NodesUsageRequest.ts index 683fabd429..5ec8b8ac04 100644 --- a/specification/nodes/usage/NodesUsageRequest.ts +++ b/specification/nodes/usage/NodesUsageRequest.ts @@ -51,6 +51,10 @@ export interface Request extends RequestBase { } ] path_parts: { + /** + * A comma-separated list of node IDs or names to limit the returned information. + * Use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. + */ node_id?: NodeIds /** * Limits the information returned to the specific metrics. diff --git a/specification/rollup/rollup_search/RollupSearchRequest.ts b/specification/rollup/rollup_search/RollupSearchRequest.ts index 65983912a9..a3b1caf1e7 100644 --- a/specification/rollup/rollup_search/RollupSearchRequest.ts +++ b/specification/rollup/rollup_search/RollupSearchRequest.ts @@ -65,9 +65,14 @@ export interface Request extends RequestBase { } query_parameters: { /** + * Indicates whether hits.total should be rendered as an integer or an object in the rest search response * @server_default false */ rest_total_hits_as_int?: boolean + /** + * Specify whether aggregation and suggester names should be prefixed by their respective types in the response + * @server_default false + */ typed_keys?: boolean } body: { diff --git a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts index 6fa43ab6ab..b363a438a5 100644 --- a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts +++ b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts @@ -50,9 +50,19 @@ export interface Request extends RequestBase { index?: Indices } query_parameters: { - /** @server_default open */ + /** + * Whether to expand wildcard expression to concrete indices that are open, closed or both + * @server_default open + */ expand_wildcards?: ExpandWildcards + /** + * Whether to ignore if a wildcard indices expression resolves into no concrete indices. + * (This includes `_all` string or when no indices have been specified) + */ allow_no_indices?: boolean + /** + * Whether specified concrete indices should be ignored when unavailable (missing or closed) + */ ignore_unavailable?: boolean } } diff --git a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts index 76fb3761fc..f8cdf9cc0f 100644 --- a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts +++ b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts @@ -49,6 +49,7 @@ export interface Request extends RequestBase { } query_parameters: { /** + * Return stats aggregated at cluster, index or shard level * @server_default indices */ level?: StatsLevel diff --git a/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts b/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts index da7feb5b66..81c8eba87e 100644 --- a/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts +++ b/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts @@ -39,6 +39,9 @@ export interface Request extends RequestBase { } ] query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } body: { diff --git a/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts b/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts index 866d913dd0..3ff7981b55 100644 --- a/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts +++ b/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts @@ -41,6 +41,9 @@ export interface Request extends RequestBase { } ] query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } body: { diff --git a/specification/security/change_password/SecurityChangePasswordRequest.ts b/specification/security/change_password/SecurityChangePasswordRequest.ts index 59f58d96cd..faf27fbde7 100644 --- a/specification/security/change_password/SecurityChangePasswordRequest.ts +++ b/specification/security/change_password/SecurityChangePasswordRequest.ts @@ -47,6 +47,9 @@ export interface Request extends RequestBase { username?: Username } query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } body: { diff --git a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts index 2075d8bbb4..55476916e5 100644 --- a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts +++ b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts @@ -53,6 +53,9 @@ export interface Request extends RequestBase { } ] query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } body: { diff --git a/specification/security/create_service_token/CreateServiceTokenRequest.ts b/specification/security/create_service_token/CreateServiceTokenRequest.ts index b7eb0f778f..9215033b27 100644 --- a/specification/security/create_service_token/CreateServiceTokenRequest.ts +++ b/specification/security/create_service_token/CreateServiceTokenRequest.ts @@ -67,6 +67,9 @@ export interface Request extends RequestBase { name?: Name } query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } } diff --git a/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts b/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts index 21494e9b76..3514ca1f4e 100644 --- a/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts +++ b/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts @@ -53,6 +53,9 @@ export interface Request extends RequestBase { name: Names } query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } } diff --git a/specification/security/delete_role/SecurityDeleteRoleRequest.ts b/specification/security/delete_role/SecurityDeleteRoleRequest.ts index 4f08620f13..deec1dd119 100644 --- a/specification/security/delete_role/SecurityDeleteRoleRequest.ts +++ b/specification/security/delete_role/SecurityDeleteRoleRequest.ts @@ -44,6 +44,9 @@ export interface Request extends RequestBase { name: Name } query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } } diff --git a/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts b/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts index 860caa17fa..e516afb02d 100644 --- a/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts +++ b/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts @@ -48,6 +48,9 @@ export interface Request extends RequestBase { name: Name } query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } } diff --git a/specification/security/delete_service_token/DeleteServiceTokenRequest.ts b/specification/security/delete_service_token/DeleteServiceTokenRequest.ts index 3507949cf0..77629dd408 100644 --- a/specification/security/delete_service_token/DeleteServiceTokenRequest.ts +++ b/specification/security/delete_service_token/DeleteServiceTokenRequest.ts @@ -53,6 +53,9 @@ export interface Request extends RequestBase { name: Name } query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } } diff --git a/specification/security/delete_user/SecurityDeleteUserRequest.ts b/specification/security/delete_user/SecurityDeleteUserRequest.ts index bc39856160..871d781a2f 100644 --- a/specification/security/delete_user/SecurityDeleteUserRequest.ts +++ b/specification/security/delete_user/SecurityDeleteUserRequest.ts @@ -43,6 +43,9 @@ export interface Request extends RequestBase { username: Username } query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } } diff --git a/specification/security/disable_user/SecurityDisableUserRequest.ts b/specification/security/disable_user/SecurityDisableUserRequest.ts index cbbba7450a..a5e4ce404c 100644 --- a/specification/security/disable_user/SecurityDisableUserRequest.ts +++ b/specification/security/disable_user/SecurityDisableUserRequest.ts @@ -45,6 +45,9 @@ export interface Request extends RequestBase { username: Username } query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } } diff --git a/specification/security/enable_user/SecurityEnableUserRequest.ts b/specification/security/enable_user/SecurityEnableUserRequest.ts index 60c53228a4..5e7558a4a1 100644 --- a/specification/security/enable_user/SecurityEnableUserRequest.ts +++ b/specification/security/enable_user/SecurityEnableUserRequest.ts @@ -44,6 +44,9 @@ export interface Request extends RequestBase { username: Username } query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } } diff --git a/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts b/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts index 4aa616a508..8fc7670211 100644 --- a/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts +++ b/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts @@ -46,6 +46,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** Username */ user?: Name } body: { diff --git a/specification/security/put_privileges/SecurityPutPrivilegesRequest.ts b/specification/security/put_privileges/SecurityPutPrivilegesRequest.ts index 213c612a44..b047583d6f 100644 --- a/specification/security/put_privileges/SecurityPutPrivilegesRequest.ts +++ b/specification/security/put_privileges/SecurityPutPrivilegesRequest.ts @@ -57,6 +57,9 @@ export interface Request extends RequestBase { } ] query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } /** diff --git a/specification/security/put_role/SecurityPutRoleRequest.ts b/specification/security/put_role/SecurityPutRoleRequest.ts index e00051f74c..ed437f3d61 100644 --- a/specification/security/put_role/SecurityPutRoleRequest.ts +++ b/specification/security/put_role/SecurityPutRoleRequest.ts @@ -56,6 +56,9 @@ export interface Request extends RequestBase { name: Name } query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } body: { diff --git a/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts b/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts index 7aef398301..9c72b7b79f 100644 --- a/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts +++ b/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts @@ -71,6 +71,9 @@ export interface Request extends RequestBase { name: Name } query_parameters: { + /** + * If `true` (the default) 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` then do nothing with refreshes. + */ refresh?: Refresh } body: { diff --git a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts index 8b95c4e325..aa2fbe01dd 100644 --- a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts +++ b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts @@ -45,6 +45,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The node id of node to be removed from the shutdown state */ node_id: NodeId } query_parameters: { diff --git a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts index 9c19f823c4..0763eb731a 100644 --- a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts +++ b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts @@ -47,6 +47,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** Comma-separated list of nodes for which to retrieve the shutdown status */ node_id?: NodeIds } query_parameters: { diff --git a/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts b/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts index 452bc50be5..8d2a22cb0d 100644 --- a/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts +++ b/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts @@ -40,6 +40,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The id of the snapshot lifecycle policy to remove */ policy_id: Name } query_parameters: { diff --git a/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts b/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts index 2285c0db98..8842b04972 100644 --- a/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts +++ b/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts @@ -40,6 +40,7 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The id of the snapshot lifecycle policy to be executed */ policy_id: Name } query_parameters: { diff --git a/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts b/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts index 1ab5a2e87c..9e52123540 100644 --- a/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts +++ b/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts @@ -43,9 +43,7 @@ export interface Request extends RequestBase { } ] path_parts: { - /* - A comma-separate list of snapshot lifecycle policy identifiers. - */ + /** A comma-separated list of snapshot lifecycle policy identifiers. */ policy_id?: Names } query_parameters: { diff --git a/specification/transform/get_transform_stats/GetTransformStatsRequest.ts b/specification/transform/get_transform_stats/GetTransformStatsRequest.ts index c01aeffcd1..6bac02dbf3 100644 --- a/specification/transform/get_transform_stats/GetTransformStatsRequest.ts +++ b/specification/transform/get_transform_stats/GetTransformStatsRequest.ts @@ -72,6 +72,10 @@ export interface Request extends RequestBase { * @server_default 100 */ size?: long + /** + * Controls the time to wait for the stats + * @server_default 30s + */ timeout?: Duration } } diff --git a/specification/watcher/put_watch/WatcherPutWatchRequest.ts b/specification/watcher/put_watch/WatcherPutWatchRequest.ts index 9106fee23c..cd84cc40a9 100644 --- a/specification/watcher/put_watch/WatcherPutWatchRequest.ts +++ b/specification/watcher/put_watch/WatcherPutWatchRequest.ts @@ -67,8 +67,13 @@ export interface Request extends RequestBase { * @server_default true */ active?: boolean + /** + * Only update the watch if the last operation that has changed the watch has the specified primary term + */ if_primary_term?: long + /** Only update the watch if the last operation that has changed the watch has the specified sequence number */ if_seq_no?: SequenceNumber + /** Explicit version number for concurrency control */ version?: VersionNumber } body: { diff --git a/specification/xpack/info/XPackInfoRequest.ts b/specification/xpack/info/XPackInfoRequest.ts index 275e91afd3..cdcced575f 100644 --- a/specification/xpack/info/XPackInfoRequest.ts +++ b/specification/xpack/info/XPackInfoRequest.ts @@ -47,6 +47,7 @@ export interface Request extends RequestBase { */ categories?: XPackCategory[] /** + * If used, this otherwise ignored parameter must be set to true * @deprecated 8.0.0 Supported for backwards compatibility with 7.x */ accept_enterprise?: boolean