diff --git a/output/schema/schema.json b/output/schema/schema.json index 9ece015346..b56385cc47 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -8914,6 +8914,34 @@ } ] }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Configure sampling for an index or data stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-sample-configuration", + "name": "indices.put_sample_configuration", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/{index}/_sample/config" + } + ] + }, { "availability": { "serverless": { @@ -11807,7 +11835,7 @@ "docUrl": null, "name": "knn_search", "request": null, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 9b7efa5d7a..58ee2ecd9f 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -1,5 +1,16 @@ { - "endpointErrors": {}, + "endpointErrors": { + "cat.segments": { + "request": [ + "Request: missing json spec query parameter 'ignore_unavailable'", + "Request: missing json spec query parameter 'ignore_throttled'", + "Request: missing json spec query parameter 'allow_no_indices'", + "Request: missing json spec query parameter 'expand_wildcards'", + "Request: missing json spec query parameter 'allow_closed'" + ], + "response": [] + } + }, "generalErrors": [ "Dangling type '_global.scripts_painless_execute:PainlessExecutionPosition'", "Dangling type '_global.scripts_painless_execute:PainlessScript'", diff --git a/specification/_json_spec/_internal.update_desired_nodes.json b/specification/_json_spec/_internal.update_desired_nodes.json index 0b49c16c62..72c16720c1 100644 --- a/specification/_json_spec/_internal.update_desired_nodes.json +++ b/specification/_json_spec/_internal.update_desired_nodes.json @@ -21,7 +21,7 @@ "description": "the history id" }, "version": { - "type": "integer", + "type": "int", "description": "the version number" } } diff --git a/specification/_json_spec/async_search.submit.json b/specification/_json_spec/async_search.submit.json index 3a48f94d4b..5fff0dd9ae 100644 --- a/specification/_json_spec/async_search.submit.json +++ b/specification/_json_spec/async_search.submit.json @@ -45,7 +45,7 @@ "default": "5d" }, "batched_reduce_size": { - "type": "number", + "type": "long", "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.", "default": 5 }, @@ -90,7 +90,7 @@ "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit" }, "from": { - "type": "number", + "type": "int", "description": "Starting offset (default: 0)" }, "ignore_unavailable": { @@ -142,7 +142,7 @@ "description": "Search operation type" }, "size": { - "type": "number", + "type": "int", "description": "Number of hits to return (default: 10)" }, "sort": { @@ -162,7 +162,7 @@ "description": "A list of fields to extract and return from the _source field" }, "terminate_after": { - "type": "number", + "type": "long", "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." }, "stats": { @@ -180,7 +180,7 @@ "description": "Specify suggest mode" }, "suggest_size": { - "type": "number", + "type": "long", "description": "How many suggestions to return in response" }, "suggest_text": { @@ -217,13 +217,14 @@ "description": "Specify whether to return sequence number and primary term of the last modification of each hit" }, "max_concurrent_shard_requests": { - "type": "number", + "type": "int", "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", "default": 5 } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/cat.segments.json b/specification/_json_spec/cat.segments.json index 25740964f8..d33bb93cd4 100644 --- a/specification/_json_spec/cat.segments.json +++ b/specification/_json_spec/cat.segments.json @@ -71,6 +71,29 @@ "type": "enum", "description": "The unit in which to display time values", "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] + }, + "ignore_unavailable": { + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression." + }, + "ignore_throttled": { + "type": "boolean", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression." + }, + "allow_no_indices": { + "type": "boolean", + "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). Only allowed when providing an index expression." + }, + "expand_wildcards": { + "type": "enum", + "options": ["open", "closed", "hidden", "none", "all"], + "default": "open", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." + }, + "allow_closed": { + "type": "boolean", + "description": "If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices", + "default": false } } } diff --git a/specification/_json_spec/clear_scroll.json b/specification/_json_spec/clear_scroll.json index 31881b7c3a..ae8974a419 100644 --- a/specification/_json_spec/clear_scroll.json +++ b/specification/_json_spec/clear_scroll.json @@ -35,7 +35,8 @@ }, "params": {}, "body": { - "description": "A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter" + "description": "A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter", + "required": false } } } diff --git a/specification/_json_spec/close_point_in_time.json b/specification/_json_spec/close_point_in_time.json index d81eb9f46d..19dec7215b 100644 --- a/specification/_json_spec/close_point_in_time.json +++ b/specification/_json_spec/close_point_in_time.json @@ -20,7 +20,8 @@ }, "params": {}, "body": { - "description": "a point-in-time id to close" + "description": "a point-in-time id to close", + "required": true } } } diff --git a/specification/_json_spec/cluster.allocation_explain.json b/specification/_json_spec/cluster.allocation_explain.json index abaa8db3db..47056bfda4 100644 --- a/specification/_json_spec/cluster.allocation_explain.json +++ b/specification/_json_spec/cluster.allocation_explain.json @@ -24,7 +24,7 @@ "description": "Specifies the name of the index that you would like an explanation for" }, "shard": { - "type": "number", + "type": "int", "description": "Specifies the ID of the shard that you would like an explanation for" }, "primary": { @@ -52,7 +52,8 @@ } }, "body": { - "description": "The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'" + "description": "The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'", + "required": false } } } diff --git a/specification/_json_spec/cluster.reroute.json b/specification/_json_spec/cluster.reroute.json index 18bd6459b9..41f86859c0 100644 --- a/specification/_json_spec/cluster.reroute.json +++ b/specification/_json_spec/cluster.reroute.json @@ -61,7 +61,8 @@ } }, "body": { - "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)" + "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)", + "required": false } } } diff --git a/specification/_json_spec/cluster.state.json b/specification/_json_spec/cluster.state.json index 968664f0ff..265ba6c010 100644 --- a/specification/_json_spec/cluster.state.json +++ b/specification/_json_spec/cluster.state.json @@ -79,7 +79,7 @@ "description": "Return settings in flat format (default: false)" }, "wait_for_metadata_version": { - "type": "number", + "type": "long", "description": "Wait for the metadata version to be equal or greater than the specified metadata version" }, "wait_for_timeout": { diff --git a/specification/_json_spec/count.json b/specification/_json_spec/count.json index c5955e34c5..06f4355473 100644 --- a/specification/_json_spec/count.json +++ b/specification/_json_spec/count.json @@ -51,7 +51,7 @@ "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." }, "min_score": { - "type": "number", + "type": "double", "description": "Include only documents with a specific `_score` value in the result" }, "preference": { @@ -95,12 +95,13 @@ "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "terminate_after": { - "type": "number", + "type": "long", "description": "The maximum count for each shard, upon reaching which the query execution will terminate early" } }, "body": { - "description": "A query to restrict the results specified with the Query DSL (optional)" + "description": "A query to restrict the results specified with the Query DSL (optional)", + "required": false } } } diff --git a/specification/_json_spec/create.json b/specification/_json_spec/create.json index 913c4e0f88..e472328289 100644 --- a/specification/_json_spec/create.json +++ b/specification/_json_spec/create.json @@ -50,7 +50,7 @@ "description": "Explicit operation timeout" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/delete.json b/specification/_json_spec/delete.json index 42e6a5210e..d59aad041b 100644 --- a/specification/_json_spec/delete.json +++ b/specification/_json_spec/delete.json @@ -49,15 +49,15 @@ "description": "Explicit operation timeout" }, "if_seq_no": { - "type": "number", + "type": "long", "description": "only perform the delete operation if the last operation that has changed the document has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only perform the delete operation if the last operation that has changed the document has the specified primary term" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/delete_by_query.json b/specification/_json_spec/delete_by_query.json index 8f31179187..f6608f6e7c 100644 --- a/specification/_json_spec/delete_by_query.json +++ b/specification/_json_spec/delete_by_query.json @@ -45,7 +45,7 @@ "description": "The field to use as default where no field prefix is given in the query string" }, "from": { - "type": "number", + "type": "long", "default": 0, "description": "Starting offset (default: 0)" }, @@ -102,7 +102,7 @@ "description": "Explicit timeout for each search request. Defaults to no timeout." }, "max_docs": { - "type": "number", + "type": "long", "description": "Maximum number of documents to process (default: all documents)" }, "sort": { @@ -110,7 +110,7 @@ "description": "A comma-separated list of : pairs" }, "terminate_after": { - "type": "number", + "type": "long", "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." }, "stats": { @@ -141,7 +141,7 @@ "description": "Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)" }, "scroll_size": { - "type": "number", + "type": "long", "default": 1000, "description": "Size on the scroll request powering the delete by query" }, diff --git a/specification/_json_spec/exists.json b/specification/_json_spec/exists.json index 0ec195bb2b..93b53476fd 100644 --- a/specification/_json_spec/exists.json +++ b/specification/_json_spec/exists.json @@ -63,7 +63,7 @@ "description": "A list of fields to extract and return from the _source field" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/exists_source.json b/specification/_json_spec/exists_source.json index aa8d8f0c7c..574a433543 100644 --- a/specification/_json_spec/exists_source.json +++ b/specification/_json_spec/exists_source.json @@ -59,7 +59,7 @@ "description": "A list of fields to extract and return from the _source field" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/explain.json b/specification/_json_spec/explain.json index e2612abbe1..4f9af89a24 100644 --- a/specification/_json_spec/explain.json +++ b/specification/_json_spec/explain.json @@ -83,7 +83,8 @@ } }, "body": { - "description": "The query definition using the Query DSL" + "description": "The query definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/field_caps.json b/specification/_json_spec/field_caps.json index 7920a8e9e0..1ae6d2794f 100644 --- a/specification/_json_spec/field_caps.json +++ b/specification/_json_spec/field_caps.json @@ -73,7 +73,8 @@ } }, "body": { - "description": "An index filter specified with the Query DSL" + "description": "An index filter specified with the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/fleet.search.json b/specification/_json_spec/fleet.search.json index 7737316d8e..80d62ef84c 100644 --- a/specification/_json_spec/fleet.search.json +++ b/specification/_json_spec/fleet.search.json @@ -41,7 +41,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": true } } } diff --git a/specification/_json_spec/get.json b/specification/_json_spec/get.json index 6f30ec09f6..776455f993 100644 --- a/specification/_json_spec/get.json +++ b/specification/_json_spec/get.json @@ -74,7 +74,7 @@ "description": "Whether vectors should be excluded from _source" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/get_source.json b/specification/_json_spec/get_source.json index 32589e71db..6f784c0f55 100644 --- a/specification/_json_spec/get_source.json +++ b/specification/_json_spec/get_source.json @@ -59,7 +59,7 @@ "description": "A list of fields to extract and return from the _source field" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/graph.explore.json b/specification/_json_spec/graph.explore.json index af8e6bfb55..f68a153c7e 100644 --- a/specification/_json_spec/graph.explore.json +++ b/specification/_json_spec/graph.explore.json @@ -35,7 +35,8 @@ } }, "body": { - "description": "Graph Query DSL" + "description": "Graph Query DSL", + "required": true } } } diff --git a/specification/_json_spec/ilm.move_to_step.json b/specification/_json_spec/ilm.move_to_step.json index f8c9fd3e36..5f3554637c 100644 --- a/specification/_json_spec/ilm.move_to_step.json +++ b/specification/_json_spec/ilm.move_to_step.json @@ -26,7 +26,8 @@ }, "params": {}, "body": { - "description": "The new lifecycle step to move to" + "description": "The new lifecycle step to move to", + "required": true } } } diff --git a/specification/_json_spec/ilm.put_lifecycle.json b/specification/_json_spec/ilm.put_lifecycle.json index 663c16d3a9..6bdae191ca 100644 --- a/specification/_json_spec/ilm.put_lifecycle.json +++ b/specification/_json_spec/ilm.put_lifecycle.json @@ -37,7 +37,8 @@ } }, "body": { - "description": "The lifecycle policy definition to register" + "description": "The lifecycle policy definition to register", + "required": true } } } diff --git a/specification/_json_spec/index.json b/specification/_json_spec/index.json index 5cce11aec1..f8fd38cd40 100644 --- a/specification/_json_spec/index.json +++ b/specification/_json_spec/index.json @@ -65,7 +65,7 @@ "description": "Explicit operation timeout" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { @@ -74,11 +74,11 @@ "description": "Specific version type" }, "if_seq_no": { - "type": "number", + "type": "long", "description": "only perform the index operation if the last operation that has changed the document has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only perform the index operation if the last operation that has changed the document has the specified primary term" }, "pipeline": { diff --git a/specification/_json_spec/indices.analyze.json b/specification/_json_spec/indices.analyze.json index 0bb0a9e0fb..7f4d7b6818 100644 --- a/specification/_json_spec/indices.analyze.json +++ b/specification/_json_spec/indices.analyze.json @@ -35,7 +35,8 @@ } }, "body": { - "description": "Define analyzer/tokenizer parameters and the text on which the analysis should be performed" + "description": "Define analyzer/tokenizer parameters and the text on which the analysis should be performed", + "required": true } } } diff --git a/specification/_json_spec/indices.clone.json b/specification/_json_spec/indices.clone.json index 8c7ee1b8aa..85e90bd633 100644 --- a/specification/_json_spec/indices.clone.json +++ b/specification/_json_spec/indices.clone.json @@ -46,7 +46,8 @@ } }, "body": { - "description": "The configuration for the target index (`settings` and `aliases`)" + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": false } } } diff --git a/specification/_json_spec/indices.create.json b/specification/_json_spec/indices.create.json index c584c3e650..ca213e498c 100644 --- a/specification/_json_spec/indices.create.json +++ b/specification/_json_spec/indices.create.json @@ -42,7 +42,8 @@ } }, "body": { - "description": "The configuration for the index (`settings` and `mappings`)" + "description": "The configuration for the index (`settings` and `mappings`)", + "required": false } } } diff --git a/specification/_json_spec/indices.forcemerge.json b/specification/_json_spec/indices.forcemerge.json index befcda41a4..fb5bc29308 100644 --- a/specification/_json_spec/indices.forcemerge.json +++ b/specification/_json_spec/indices.forcemerge.json @@ -47,7 +47,7 @@ "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." }, "max_num_segments": { - "type": "number", + "type": "long", "description": "The number of segments the index should be merged into (default: dynamic)" }, "only_expunge_deletes": { diff --git a/specification/_json_spec/indices.put_data_lifecycle.json b/specification/_json_spec/indices.put_data_lifecycle.json index bd973f3845..362fa41a71 100644 --- a/specification/_json_spec/indices.put_data_lifecycle.json +++ b/specification/_json_spec/indices.put_data_lifecycle.json @@ -43,7 +43,8 @@ } }, "body": { - "description": "The data stream lifecycle configuration that consist of the data retention" + "description": "The data stream lifecycle configuration that consist of the data retention", + "required": true } } } diff --git a/specification/_json_spec/indices.put_data_stream_options.json b/specification/_json_spec/indices.put_data_stream_options.json index 5ba8532135..5f087ca80b 100644 --- a/specification/_json_spec/indices.put_data_stream_options.json +++ b/specification/_json_spec/indices.put_data_stream_options.json @@ -43,7 +43,8 @@ } }, "body": { - "description": "The data stream options configuration that consist of the failure store configuration" + "description": "The data stream options configuration that consist of the failure store configuration", + "required": true } } } diff --git a/specification/_json_spec/indices.put_sample_configuration.json b/specification/_json_spec/indices.put_sample_configuration.json new file mode 100644 index 0000000000..143156c5a9 --- /dev/null +++ b/specification/_json_spec/indices.put_sample_configuration.json @@ -0,0 +1,42 @@ +{ + "indices.put_sample_configuration": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-sample-configuration", + "description": "Configure sampling for an index or data stream" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/{index}/_sample/config", + "methods": ["PUT"], + "parts": { + "index": { + "type": "string", + "description": "The name of a data stream or index" + } + } + } + ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Timeout for the request" + } + }, + "body": { + "description": "The sampling configuration", + "required": true + } + } +} diff --git a/specification/_json_spec/indices.put_template.json b/specification/_json_spec/indices.put_template.json index 8caf083184..9d7f96094d 100644 --- a/specification/_json_spec/indices.put_template.json +++ b/specification/_json_spec/indices.put_template.json @@ -26,7 +26,7 @@ }, "params": { "order": { - "type": "number", + "type": "int", "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)" }, "create": { diff --git a/specification/_json_spec/indices.rollover.json b/specification/_json_spec/indices.rollover.json index d3669ef462..079cc26a17 100644 --- a/specification/_json_spec/indices.rollover.json +++ b/specification/_json_spec/indices.rollover.json @@ -66,7 +66,8 @@ } }, "body": { - "description": "The conditions that needs to be met for executing rollover" + "description": "The conditions that needs to be met for executing rollover", + "required": false } } } diff --git a/specification/_json_spec/indices.shrink.json b/specification/_json_spec/indices.shrink.json index c7204ceed7..e1a7a39dee 100644 --- a/specification/_json_spec/indices.shrink.json +++ b/specification/_json_spec/indices.shrink.json @@ -46,7 +46,8 @@ } }, "body": { - "description": "The configuration for the target index (`settings` and `aliases`)" + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": true } } } diff --git a/specification/_json_spec/indices.split.json b/specification/_json_spec/indices.split.json index 014829248d..c14e5ce38b 100644 --- a/specification/_json_spec/indices.split.json +++ b/specification/_json_spec/indices.split.json @@ -46,7 +46,8 @@ } }, "body": { - "description": "The configuration for the target index (`settings` and `aliases`)" + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": true } } } diff --git a/specification/_json_spec/indices.validate_query.json b/specification/_json_spec/indices.validate_query.json index 4e5248b76c..9c19336704 100644 --- a/specification/_json_spec/indices.validate_query.json +++ b/specification/_json_spec/indices.validate_query.json @@ -90,7 +90,8 @@ } }, "body": { - "description": "The query definition specified with the Query DSL" + "description": "The query definition specified with the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/inference.chat_completion_unified.json b/specification/_json_spec/inference.chat_completion_unified.json index 6caf2db748..d3971b4bab 100644 --- a/specification/_json_spec/inference.chat_completion_unified.json +++ b/specification/_json_spec/inference.chat_completion_unified.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.completion.json b/specification/_json_spec/inference.completion.json index cb4f1f98a6..d561dcbb41 100644 --- a/specification/_json_spec/inference.completion.json +++ b/specification/_json_spec/inference.completion.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.inference.json b/specification/_json_spec/inference.inference.json index 1ada118f0e..c3091a90c5 100644 --- a/specification/_json_spec/inference.inference.json +++ b/specification/_json_spec/inference.inference.json @@ -39,7 +39,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.put.json b/specification/_json_spec/inference.put.json index 4416edabfe..0c7b0c8180 100644 --- a/specification/_json_spec/inference.put.json +++ b/specification/_json_spec/inference.put.json @@ -39,7 +39,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_ai21.json b/specification/_json_spec/inference.put_ai21.json index 7e7f757975..eb3bdcc85b 100644 --- a/specification/_json_spec/inference.put_ai21.json +++ b/specification/_json_spec/inference.put_ai21.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_alibabacloud.json b/specification/_json_spec/inference.put_alibabacloud.json index 2640f47b3c..9bcd55823a 100644 --- a/specification/_json_spec/inference.put_alibabacloud.json +++ b/specification/_json_spec/inference.put_alibabacloud.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_amazonbedrock.json b/specification/_json_spec/inference.put_amazonbedrock.json index c313ccba1e..4bfe9c25d1 100644 --- a/specification/_json_spec/inference.put_amazonbedrock.json +++ b/specification/_json_spec/inference.put_amazonbedrock.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_amazonsagemaker.json b/specification/_json_spec/inference.put_amazonsagemaker.json index 415c230f3e..c310b2733c 100644 --- a/specification/_json_spec/inference.put_amazonsagemaker.json +++ b/specification/_json_spec/inference.put_amazonsagemaker.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_anthropic.json b/specification/_json_spec/inference.put_anthropic.json index 6f022c9489..36b1e7155d 100644 --- a/specification/_json_spec/inference.put_anthropic.json +++ b/specification/_json_spec/inference.put_anthropic.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_azureaistudio.json b/specification/_json_spec/inference.put_azureaistudio.json index e0b2ebb496..0ea47bedf6 100644 --- a/specification/_json_spec/inference.put_azureaistudio.json +++ b/specification/_json_spec/inference.put_azureaistudio.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_azureopenai.json b/specification/_json_spec/inference.put_azureopenai.json index c2d02e513c..6ad290a351 100644 --- a/specification/_json_spec/inference.put_azureopenai.json +++ b/specification/_json_spec/inference.put_azureopenai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_cohere.json b/specification/_json_spec/inference.put_cohere.json index 153bf2b787..4165723a84 100644 --- a/specification/_json_spec/inference.put_cohere.json +++ b/specification/_json_spec/inference.put_cohere.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_contextualai.json b/specification/_json_spec/inference.put_contextualai.json index 983ce42738..fe58b762db 100644 --- a/specification/_json_spec/inference.put_contextualai.json +++ b/specification/_json_spec/inference.put_contextualai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_custom.json b/specification/_json_spec/inference.put_custom.json index d14089cf12..e39884796a 100644 --- a/specification/_json_spec/inference.put_custom.json +++ b/specification/_json_spec/inference.put_custom.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_deepseek.json b/specification/_json_spec/inference.put_deepseek.json index 96da2c9312..675dff0cca 100644 --- a/specification/_json_spec/inference.put_deepseek.json +++ b/specification/_json_spec/inference.put_deepseek.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_elasticsearch.json b/specification/_json_spec/inference.put_elasticsearch.json index adae4e6883..5c9e37858c 100644 --- a/specification/_json_spec/inference.put_elasticsearch.json +++ b/specification/_json_spec/inference.put_elasticsearch.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_elser.json b/specification/_json_spec/inference.put_elser.json index 6697278a44..d4c912f2ba 100644 --- a/specification/_json_spec/inference.put_elser.json +++ b/specification/_json_spec/inference.put_elser.json @@ -33,7 +33,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_googleaistudio.json b/specification/_json_spec/inference.put_googleaistudio.json index dce5d98c16..279ff013b5 100644 --- a/specification/_json_spec/inference.put_googleaistudio.json +++ b/specification/_json_spec/inference.put_googleaistudio.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_googlevertexai.json b/specification/_json_spec/inference.put_googlevertexai.json index 6dd400f4d1..264e8d89a8 100644 --- a/specification/_json_spec/inference.put_googlevertexai.json +++ b/specification/_json_spec/inference.put_googlevertexai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_hugging_face.json b/specification/_json_spec/inference.put_hugging_face.json index c0fa9aa65a..b22c98b329 100644 --- a/specification/_json_spec/inference.put_hugging_face.json +++ b/specification/_json_spec/inference.put_hugging_face.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_jinaai.json b/specification/_json_spec/inference.put_jinaai.json index 5d4e8e2719..5b54c3d5ba 100644 --- a/specification/_json_spec/inference.put_jinaai.json +++ b/specification/_json_spec/inference.put_jinaai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_llama.json b/specification/_json_spec/inference.put_llama.json index b03aabed90..690df60098 100644 --- a/specification/_json_spec/inference.put_llama.json +++ b/specification/_json_spec/inference.put_llama.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_mistral.json b/specification/_json_spec/inference.put_mistral.json index 2738bf4a90..0596d6bc03 100644 --- a/specification/_json_spec/inference.put_mistral.json +++ b/specification/_json_spec/inference.put_mistral.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_openai.json b/specification/_json_spec/inference.put_openai.json index 85f14dd206..3861f82710 100644 --- a/specification/_json_spec/inference.put_openai.json +++ b/specification/_json_spec/inference.put_openai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_voyageai.json b/specification/_json_spec/inference.put_voyageai.json index 5abef56d73..d556fa8d7d 100644 --- a/specification/_json_spec/inference.put_voyageai.json +++ b/specification/_json_spec/inference.put_voyageai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_watsonx.json b/specification/_json_spec/inference.put_watsonx.json index 80f9a01ae8..9e70688706 100644 --- a/specification/_json_spec/inference.put_watsonx.json +++ b/specification/_json_spec/inference.put_watsonx.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.rerank.json b/specification/_json_spec/inference.rerank.json index d8b4473538..b5d09ca773 100644 --- a/specification/_json_spec/inference.rerank.json +++ b/specification/_json_spec/inference.rerank.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.sparse_embedding.json b/specification/_json_spec/inference.sparse_embedding.json index 379fa34706..c7e1d526df 100644 --- a/specification/_json_spec/inference.sparse_embedding.json +++ b/specification/_json_spec/inference.sparse_embedding.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.stream_completion.json b/specification/_json_spec/inference.stream_completion.json index 2e0e61b89a..5771390829 100644 --- a/specification/_json_spec/inference.stream_completion.json +++ b/specification/_json_spec/inference.stream_completion.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.text_embedding.json b/specification/_json_spec/inference.text_embedding.json index c066e12f58..5f4c4d8e5f 100644 --- a/specification/_json_spec/inference.text_embedding.json +++ b/specification/_json_spec/inference.text_embedding.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.update.json b/specification/_json_spec/inference.update.json index 2772c50e89..be8280491e 100644 --- a/specification/_json_spec/inference.update.json +++ b/specification/_json_spec/inference.update.json @@ -39,7 +39,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/knn_search.json b/specification/_json_spec/knn_search.json index f0278c8907..7c2cb30773 100644 --- a/specification/_json_spec/knn_search.json +++ b/specification/_json_spec/knn_search.json @@ -35,7 +35,8 @@ } }, "body": { - "description": "The search definition" + "description": "The search definition", + "required": true } } } diff --git a/specification/_json_spec/license.post.json b/specification/_json_spec/license.post.json index d048e9e42d..9f98571e92 100644 --- a/specification/_json_spec/license.post.json +++ b/specification/_json_spec/license.post.json @@ -36,7 +36,8 @@ } }, "body": { - "description": "licenses to be installed" + "description": "licenses to be installed", + "required": false } } } diff --git a/specification/_json_spec/ml.delete_expired_data.json b/specification/_json_spec/ml.delete_expired_data.json index a940beccfc..14f9893849 100644 --- a/specification/_json_spec/ml.delete_expired_data.json +++ b/specification/_json_spec/ml.delete_expired_data.json @@ -40,7 +40,8 @@ } }, "body": { - "description": "deleting expired data parameters" + "description": "deleting expired data parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.flush_job.json b/specification/_json_spec/ml.flush_job.json index 60d8c81fa1..61be07dd82 100644 --- a/specification/_json_spec/ml.flush_job.json +++ b/specification/_json_spec/ml.flush_job.json @@ -47,7 +47,8 @@ } }, "body": { - "description": "Flush parameters" + "description": "Flush parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.get_buckets.json b/specification/_json_spec/ml.get_buckets.json index 9658e2b82a..68e4655b41 100644 --- a/specification/_json_spec/ml.get_buckets.json +++ b/specification/_json_spec/ml.get_buckets.json @@ -86,7 +86,8 @@ } }, "body": { - "description": "Bucket selection details if not provided in URI" + "description": "Bucket selection details if not provided in URI", + "required": false } } } diff --git a/specification/_json_spec/ml.get_calendars.json b/specification/_json_spec/ml.get_calendars.json index 90f5de5165..50afc723b0 100644 --- a/specification/_json_spec/ml.get_calendars.json +++ b/specification/_json_spec/ml.get_calendars.json @@ -41,7 +41,8 @@ } }, "body": { - "description": "The from and size parameters optionally sent in the body" + "description": "The from and size parameters optionally sent in the body", + "required": false } } } diff --git a/specification/_json_spec/ml.get_categories.json b/specification/_json_spec/ml.get_categories.json index 5d31f3d99d..169f133a40 100644 --- a/specification/_json_spec/ml.get_categories.json +++ b/specification/_json_spec/ml.get_categories.json @@ -55,7 +55,8 @@ } }, "body": { - "description": "Category selection details if not provided in URI" + "description": "Category selection details if not provided in URI", + "required": false } } } diff --git a/specification/_json_spec/ml.get_influencers.json b/specification/_json_spec/ml.get_influencers.json index 84aab83733..d794aae6d9 100644 --- a/specification/_json_spec/ml.get_influencers.json +++ b/specification/_json_spec/ml.get_influencers.json @@ -66,7 +66,8 @@ } }, "body": { - "description": "Influencer selection criteria" + "description": "Influencer selection criteria", + "required": false } } } diff --git a/specification/_json_spec/ml.get_model_snapshots.json b/specification/_json_spec/ml.get_model_snapshots.json index bb4a781cd6..be83c8ce84 100644 --- a/specification/_json_spec/ml.get_model_snapshots.json +++ b/specification/_json_spec/ml.get_model_snapshots.json @@ -68,7 +68,8 @@ } }, "body": { - "description": "Model snapshot selection criteria" + "description": "Model snapshot selection criteria", + "required": false } } } diff --git a/specification/_json_spec/ml.get_overall_buckets.json b/specification/_json_spec/ml.get_overall_buckets.json index 5c013a1098..79917afa60 100644 --- a/specification/_json_spec/ml.get_overall_buckets.json +++ b/specification/_json_spec/ml.get_overall_buckets.json @@ -58,7 +58,8 @@ } }, "body": { - "description": "Overall bucket selection details if not provided in URI" + "description": "Overall bucket selection details if not provided in URI", + "required": false } } } diff --git a/specification/_json_spec/ml.get_records.json b/specification/_json_spec/ml.get_records.json index e5a5c6ece2..9d4dde88ef 100644 --- a/specification/_json_spec/ml.get_records.json +++ b/specification/_json_spec/ml.get_records.json @@ -67,7 +67,8 @@ } }, "body": { - "description": "Record selection criteria" + "description": "Record selection criteria", + "required": false } } } diff --git a/specification/_json_spec/ml.revert_model_snapshot.json b/specification/_json_spec/ml.revert_model_snapshot.json index ed9fcbcf84..9c3f75d54d 100644 --- a/specification/_json_spec/ml.revert_model_snapshot.json +++ b/specification/_json_spec/ml.revert_model_snapshot.json @@ -36,7 +36,8 @@ } }, "body": { - "description": "Reversion options" + "description": "Reversion options", + "required": false } } } diff --git a/specification/_json_spec/ml.start_data_frame_analytics.json b/specification/_json_spec/ml.start_data_frame_analytics.json index 8be96d53bc..5f9b4a3fcf 100644 --- a/specification/_json_spec/ml.start_data_frame_analytics.json +++ b/specification/_json_spec/ml.start_data_frame_analytics.json @@ -32,7 +32,8 @@ } }, "body": { - "description": "The start data frame analytics parameters" + "description": "The start data frame analytics parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.start_datafeed.json b/specification/_json_spec/ml.start_datafeed.json index e871b3e67b..0dc8a49343 100644 --- a/specification/_json_spec/ml.start_datafeed.json +++ b/specification/_json_spec/ml.start_datafeed.json @@ -40,7 +40,8 @@ } }, "body": { - "description": "The start datafeed parameters" + "description": "The start datafeed parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.stop_data_frame_analytics.json b/specification/_json_spec/ml.stop_data_frame_analytics.json index b80f54df01..4f8a60218e 100644 --- a/specification/_json_spec/ml.stop_data_frame_analytics.json +++ b/specification/_json_spec/ml.stop_data_frame_analytics.json @@ -42,7 +42,8 @@ } }, "body": { - "description": "The stop data frame analytics parameters" + "description": "The stop data frame analytics parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.stop_trained_model_deployment.json b/specification/_json_spec/ml.stop_trained_model_deployment.json index 5ff6b4a3a4..2b0dffcfd1 100644 --- a/specification/_json_spec/ml.stop_trained_model_deployment.json +++ b/specification/_json_spec/ml.stop_trained_model_deployment.json @@ -38,7 +38,8 @@ } }, "body": { - "description": "The stop deployment parameters" + "description": "The stop deployment parameters", + "required": false } } } diff --git a/specification/_json_spec/msearch.json b/specification/_json_spec/msearch.json index 963df14db6..a18360b843 100644 --- a/specification/_json_spec/msearch.json +++ b/specification/_json_spec/msearch.json @@ -35,7 +35,7 @@ "description": "Search operation type" }, "max_concurrent_searches": { - "type": "number", + "type": "int", "description": "Controls the maximum number of concurrent searches the multi search api will execute" }, "typed_keys": { @@ -43,11 +43,11 @@ "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" }, "pre_filter_shard_size": { - "type": "number", + "type": "long", "description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint." }, "max_concurrent_shard_requests": { - "type": "number", + "type": "int", "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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", "default": 5 }, diff --git a/specification/_json_spec/msearch_template.json b/specification/_json_spec/msearch_template.json index 0c50077cc4..18133d29b3 100644 --- a/specification/_json_spec/msearch_template.json +++ b/specification/_json_spec/msearch_template.json @@ -40,7 +40,7 @@ "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" }, "max_concurrent_searches": { - "type": "number", + "type": "long", "description": "Controls the maximum number of concurrent searches the multi search api will execute" }, "rest_total_hits_as_int": { diff --git a/specification/_json_spec/mtermvectors.json b/specification/_json_spec/mtermvectors.json index 10b49beba1..cd0654c3b4 100644 --- a/specification/_json_spec/mtermvectors.json +++ b/specification/_json_spec/mtermvectors.json @@ -76,7 +76,7 @@ "description": "Specifies if requests are real-time as opposed to near-real-time (default: true)." }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/nodes.hot_threads.json b/specification/_json_spec/nodes.hot_threads.json index e6295a5170..f998d43e79 100644 --- a/specification/_json_spec/nodes.hot_threads.json +++ b/specification/_json_spec/nodes.hot_threads.json @@ -34,12 +34,12 @@ "description": "The interval for the second sampling of threads" }, "snapshots": { - "type": "number", + "type": "long", "default": 10, "description": "Number of samples of thread stacktrace (default: 10)" }, "threads": { - "type": "number", + "type": "long", "default": 3, "description": "Specify the number of threads to provide information for (default: 3)" }, diff --git a/specification/_json_spec/open_point_in_time.json b/specification/_json_spec/open_point_in_time.json index aa1e9a9725..a3b93615a9 100644 --- a/specification/_json_spec/open_point_in_time.json +++ b/specification/_json_spec/open_point_in_time.json @@ -55,7 +55,7 @@ "description": "Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false)" }, "max_concurrent_shard_requests": { - "type": "number", + "type": "int", "description": "The number of concurrent shard requests per node executed concurrently when opening this point-in-time. This value should be used to limit the impact of opening the point-in-time on the cluster", "default": 5 }, @@ -65,7 +65,8 @@ } }, "body": { - "description": "An index_filter specified with the Query DSL" + "description": "An index_filter specified with the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/reindex.json b/specification/_json_spec/reindex.json index f24e7d66c9..655002dc37 100644 --- a/specification/_json_spec/reindex.json +++ b/specification/_json_spec/reindex.json @@ -55,7 +55,7 @@ "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`." }, "max_docs": { - "type": "number", + "type": "int", "description": "Maximum number of documents to process (default: all documents)" }, "require_alias": { diff --git a/specification/_json_spec/render_search_template.json b/specification/_json_spec/render_search_template.json index 575727bc04..6db006051e 100644 --- a/specification/_json_spec/render_search_template.json +++ b/specification/_json_spec/render_search_template.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The search definition template and its params" + "description": "The search definition template and its params", + "required": true } } } diff --git a/specification/_json_spec/scripts_painless_execute.json b/specification/_json_spec/scripts_painless_execute.json index e5afbbea00..f096b50fb1 100644 --- a/specification/_json_spec/scripts_painless_execute.json +++ b/specification/_json_spec/scripts_painless_execute.json @@ -20,7 +20,8 @@ }, "params": {}, "body": { - "description": "The script to execute" + "description": "The script to execute", + "required": true } } } diff --git a/specification/_json_spec/scroll.json b/specification/_json_spec/scroll.json index 02bfd54055..177901e371 100644 --- a/specification/_json_spec/scroll.json +++ b/specification/_json_spec/scroll.json @@ -50,7 +50,8 @@ } }, "body": { - "description": "The scroll ID if not passed by URL or query parameter." + "description": "The scroll ID if not passed by URL or query parameter.", + "required": false } } } diff --git a/specification/_json_spec/search.json b/specification/_json_spec/search.json index 6a1e58cd6d..d4212c7030 100644 --- a/specification/_json_spec/search.json +++ b/specification/_json_spec/search.json @@ -67,7 +67,7 @@ "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit" }, "from": { - "type": "number", + "type": "int", "default": 0, "description": "Starting offset (default: 0)" }, @@ -129,7 +129,7 @@ "description": "Search operation type" }, "size": { - "type": "number", + "type": "int", "default": 10, "description": "Number of hits to return (default: 10)" }, @@ -156,7 +156,7 @@ "description": "Whether vectors should be excluded from _source" }, "terminate_after": { - "type": "number", + "type": "long", "default": 0, "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." }, @@ -175,7 +175,7 @@ "description": "Specify suggest mode" }, "suggest_size": { - "type": "number", + "type": "long", "description": "How many suggestions to return in response" }, "suggest_text": { @@ -220,17 +220,17 @@ "description": "Specify if request cache should be used for this request or not, defaults to index level setting" }, "batched_reduce_size": { - "type": "number", + "type": "long", "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", "default": 512 }, "max_concurrent_shard_requests": { - "type": "number", + "type": "int", "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", "default": 5 }, "pre_filter_shard_size": { - "type": "number", + "type": "long", "description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint." }, "rest_total_hits_as_int": { @@ -245,7 +245,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/security.update_user_profile_data.json b/specification/_json_spec/security.update_user_profile_data.json index 1d28f2dfb6..398c9c6605 100644 --- a/specification/_json_spec/security.update_user_profile_data.json +++ b/specification/_json_spec/security.update_user_profile_data.json @@ -26,11 +26,11 @@ }, "params": { "if_seq_no": { - "type": "number", + "type": "long", "description": "only perform the update operation if the last operation that has changed the document has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only perform the update operation if the last operation that has changed the document has the specified primary term" }, "refresh": { diff --git a/specification/_json_spec/slm.put_lifecycle.json b/specification/_json_spec/slm.put_lifecycle.json index a3972719de..5c6d6e5d18 100644 --- a/specification/_json_spec/slm.put_lifecycle.json +++ b/specification/_json_spec/slm.put_lifecycle.json @@ -37,7 +37,8 @@ } }, "body": { - "description": "The snapshot lifecycle policy definition to register" + "description": "The snapshot lifecycle policy definition to register", + "required": true } } } diff --git a/specification/_json_spec/snapshot.get.json b/specification/_json_spec/snapshot.get.json index 5c05a31e92..b14bc9afff 100644 --- a/specification/_json_spec/snapshot.get.json +++ b/specification/_json_spec/snapshot.get.json @@ -68,7 +68,7 @@ "description": "Allows setting a sort order for the result. Defaults to start_time" }, "size": { - "type": "integer", + "type": "int", "default": 0, "description": "Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit." }, @@ -87,7 +87,7 @@ "description": "Offset identifier to start pagination from as returned by the 'next' field in the response body." }, "offset": { - "type": "integer", + "type": "int", "default": 0, "description": "Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0" }, diff --git a/specification/_json_spec/snapshot.repository_analyze.json b/specification/_json_spec/snapshot.repository_analyze.json index 5325d4ff6f..da1758cf91 100644 --- a/specification/_json_spec/snapshot.repository_analyze.json +++ b/specification/_json_spec/snapshot.repository_analyze.json @@ -25,36 +25,36 @@ }, "params": { "blob_count": { - "type": "number", + "type": "int", "default": 100, "description": "Number of blobs to create during the test. Defaults to 100." }, "concurrency": { - "type": "number", + "type": "int", "default": 10, "description": "Number of operations to run concurrently during the test. Defaults to 10." }, "register_operation_count": { - "type": "number", + "type": "int", "default": 10, "description": "The minimum number of linearizable register operations to perform in total. Defaults to 10." }, "read_node_count": { - "type": "number", + "type": "int", "default": 10, "description": "Number of nodes on which to read a blob after writing. Defaults to 10." }, "early_read_node_count": { - "type": "number", + "type": "int", "default": 2, "description": "Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2." }, "seed": { - "type": "number", + "type": "int", "description": "Seed for the random number generator used to create the test workload. Defaults to a random value." }, "rare_action_probability": { - "type": "number", + "type": "double", "default": 0, "description": "Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02." }, diff --git a/specification/_json_spec/snapshot.repository_verify_integrity.json b/specification/_json_spec/snapshot.repository_verify_integrity.json index c8719a108c..b3eae64af0 100644 --- a/specification/_json_spec/snapshot.repository_verify_integrity.json +++ b/specification/_json_spec/snapshot.repository_verify_integrity.json @@ -25,32 +25,32 @@ }, "params": { "meta_thread_pool_concurrency": { - "type": "number", + "type": "int", "default": 0, "description": "Number of threads to use for reading metadata" }, "blob_thread_pool_concurrency": { - "type": "number", + "type": "int", "default": 1, "description": "Number of threads to use for reading blob contents" }, "snapshot_verification_concurrency": { - "type": "number", + "type": "int", "default": 0, "description": "Number of snapshots to verify concurrently" }, "index_verification_concurrency": { - "type": "number", + "type": "int", "default": 0, "description": "Number of indices to verify concurrently" }, "index_snapshot_verification_concurrency": { - "type": "number", + "type": "int", "default": 1, "description": "Number of snapshots to verify concurrently within each index" }, "max_failed_shard_snapshots": { - "type": "number", + "type": "int", "default": 10000, "description": "Maximum permitted number of failed shard snapshots" }, diff --git a/specification/_json_spec/terms_enum.json b/specification/_json_spec/terms_enum.json index 97be2472db..a405909af2 100644 --- a/specification/_json_spec/terms_enum.json +++ b/specification/_json_spec/terms_enum.json @@ -26,7 +26,8 @@ }, "params": {}, "body": { - "description": "field name, string which is the prefix expected in matching terms, timeout and size for max number of results" + "description": "field name, string which is the prefix expected in matching terms, timeout and size for max number of results", + "required": true } } } diff --git a/specification/_json_spec/termvectors.json b/specification/_json_spec/termvectors.json index 1d7f82d5b7..8037e04099 100644 --- a/specification/_json_spec/termvectors.json +++ b/specification/_json_spec/termvectors.json @@ -82,7 +82,7 @@ "description": "Specifies if request is real-time as opposed to near-real-time (default: true)." }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/transform.get_transform_stats.json b/specification/_json_spec/transform.get_transform_stats.json index 539639e89e..8985eecfef 100644 --- a/specification/_json_spec/transform.get_transform_stats.json +++ b/specification/_json_spec/transform.get_transform_stats.json @@ -25,12 +25,12 @@ }, "params": { "from": { - "type": "number", + "type": "long", "default": 0, "description": "skips a number of transform stats, defaults to 0" }, "size": { - "type": "number", + "type": "long", "default": 100, "description": "specifies a max number of transform stats to get, defaults to 100" }, diff --git a/specification/_json_spec/update.json b/specification/_json_spec/update.json index 1b532cc0aa..7fd6785106 100644 --- a/specification/_json_spec/update.json +++ b/specification/_json_spec/update.json @@ -59,7 +59,7 @@ "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes." }, "retry_on_conflict": { - "type": "number", + "type": "int", "default": 0, "description": "Specify how many times should the operation be retried when a conflict occurs (default: 0)" }, @@ -73,11 +73,11 @@ "description": "Explicit operation timeout" }, "if_seq_no": { - "type": "number", + "type": "long", "description": "only perform the update operation if the last operation that has changed the document has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only perform the update operation if the last operation that has changed the document has the specified primary term" }, "require_alias": { diff --git a/specification/_json_spec/update_by_query.json b/specification/_json_spec/update_by_query.json index 89a943ee11..d490a39a89 100644 --- a/specification/_json_spec/update_by_query.json +++ b/specification/_json_spec/update_by_query.json @@ -45,7 +45,7 @@ "description": "The field to use as default where no field prefix is given in the query string" }, "from": { - "type": "number", + "type": "long", "default": 0, "description": "Starting offset (default: 0)" }, @@ -107,7 +107,7 @@ "description": "Explicit timeout for each search request. Defaults to no timeout." }, "max_docs": { - "type": "number", + "type": "long", "description": "Maximum number of documents to process (default: all documents)" }, "sort": { @@ -115,7 +115,7 @@ "description": "A comma-separated list of : pairs" }, "terminate_after": { - "type": "number", + "type": "long", "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." }, "stats": { @@ -150,7 +150,7 @@ "description": "Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)" }, "scroll_size": { - "type": "number", + "type": "long", "default": 1000, "description": "Size on the scroll request powering the update by query" }, @@ -171,7 +171,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/watcher.put_watch.json b/specification/_json_spec/watcher.put_watch.json index bed2703dba..aab3cebcbf 100644 --- a/specification/_json_spec/watcher.put_watch.json +++ b/specification/_json_spec/watcher.put_watch.json @@ -31,15 +31,15 @@ "description": "Specify whether the watch is in/active by default" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "if_seq_no": { - "type": "number", + "type": "long", "description": "only update the watch if the last operation that has changed the watch has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only update the watch if the last operation that has changed the watch has the specified primary term" } },