Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 12 additions & 1 deletion output/schema/validation-errors.json
Original file line number Diff line number Diff line change
@@ -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'",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"description": "the history id"
},
"version": {
"type": "integer",
"type": "int",
"description": "the version number"
}
}
Expand Down
15 changes: 8 additions & 7 deletions specification/_json_spec/async_search.submit.json
Original file line number Diff line number Diff line change
Expand Up @@ -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
},
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -142,7 +142,7 @@
"description": "Search operation type"
},
"size": {
"type": "number",
"type": "int",
"description": "Number of hits to return (default: 10)"
},
"sort": {
Expand All @@ -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": {
Expand All @@ -180,7 +180,7 @@
"description": "Specify suggest mode"
},
"suggest_size": {
"type": "number",
"type": "long",
"description": "How many suggestions to return in response"
},
"suggest_text": {
Expand Down Expand Up @@ -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
}
}
}
23 changes: 23 additions & 0 deletions specification/_json_spec/cat.segments.json
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
}
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/clear_scroll.json
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
}
3 changes: 2 additions & 1 deletion specification/_json_spec/close_point_in_time.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
},
"params": {},
"body": {
"description": "a point-in-time id to close"
"description": "a point-in-time id to close",
"required": true
}
}
}
5 changes: 3 additions & 2 deletions specification/_json_spec/cluster.allocation_explain.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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
}
}
}
3 changes: 2 additions & 1 deletion specification/_json_spec/cluster.reroute.json
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
}
2 changes: 1 addition & 1 deletion specification/_json_spec/cluster.state.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
7 changes: 4 additions & 3 deletions specification/_json_spec/count.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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
}
}
}
2 changes: 1 addition & 1 deletion specification/_json_spec/create.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"description": "Explicit operation timeout"
},
"version": {
"type": "number",
"type": "long",
"description": "Explicit version number for concurrency control"
},
"version_type": {
Expand Down
6 changes: 3 additions & 3 deletions specification/_json_spec/delete.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
8 changes: 4 additions & 4 deletions specification/_json_spec/delete_by_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -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)"
},
Expand Down Expand Up @@ -102,15 +102,15 @@
"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": {
"type": "list",
"description": "A comma-separated list of <field>:<direction> 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": {
Expand Down Expand Up @@ -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"
},
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/exists.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/exists_source.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/explain.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@
}
},
"body": {
"description": "The query definition using the Query DSL"
"description": "The query definition using the Query DSL",
"required": false
}
}
}
3 changes: 2 additions & 1 deletion specification/_json_spec/field_caps.json
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
}
3 changes: 2 additions & 1 deletion specification/_json_spec/fleet.search.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
}
},
"body": {
"description": "The search definition using the Query DSL"
"description": "The search definition using the Query DSL",
"required": true
}
}
}
2 changes: 1 addition & 1 deletion specification/_json_spec/get.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/get_source.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/graph.explore.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@
}
},
"body": {
"description": "Graph Query DSL"
"description": "Graph Query DSL",
"required": true
}
}
}
3 changes: 2 additions & 1 deletion specification/_json_spec/ilm.move_to_step.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
},
"params": {},
"body": {
"description": "The new lifecycle step to move to"
"description": "The new lifecycle step to move to",
"required": true
}
}
}
Loading