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
2 changes: 1 addition & 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
1 change: 1 addition & 0 deletions specification/_json_spec/async_search.status.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"params": {
"keep_alive": {
"type": "time",
"default": "5d",
"description": "Specify the time interval in which the results (partial or final) for this search will be available"
}
}
Expand Down
20 changes: 11 additions & 9 deletions specification/_json_spec/async_search.submit.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,13 @@
"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
},
"request_cache": {
"type": "boolean",
"default": true,
"description": "Specify if request cache should be used for this request or not, defaults to true"
},
"analyzer": {
Expand All @@ -68,8 +69,8 @@
},
"default_operator": {
"type": "enum",
"options": ["AND", "OR"],
"default": "OR",
"options": ["and", "or"],
"default": "or",
"description": "The default operator for query string query (AND or OR)"
},
"df": {
Expand All @@ -89,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 @@ -141,7 +142,7 @@
"description": "Search operation type"
},
"size": {
"type": "number",
"type": "int",
"description": "Number of hits to return (default: 10)"
},
"sort": {
Expand All @@ -161,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 @@ -179,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 @@ -216,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
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
},
"timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for acknowledgement of update from all nodes in cluster"
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
},
"timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for acknowledgement of update from all nodes in cluster"
}
},
Expand Down
7 changes: 7 additions & 0 deletions specification/_json_spec/bulk.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,13 @@
"params": {
"wait_for_active_shards": {
"type": "string",
"default": "1",
"description": "Sets the number of shard copies that must be active before proceeding with the bulk 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)"
},
"refresh": {
"type": "enum",
"options": ["true", "false", "wait_for"],
"default": "false",
"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."
},
"routing": {
Expand All @@ -44,6 +46,7 @@
},
"timeout": {
"type": "time",
"default": "1m",
"description": "Explicit operation timeout"
},
"_source": {
Expand All @@ -64,18 +67,22 @@
},
"require_alias": {
"type": "boolean",
"default": false,
"description": "If true, the request's actions must target an index alias. Defaults to false."
},
"require_data_stream": {
"type": "boolean",
"default": false,
"description": "If true, the request's actions must target a data stream (existing or to-be-created). Default to false"
},
"list_executed_pipelines": {
"type": "boolean",
"default": false,
"description": "Sets list_executed_pipelines for all incoming documents. Defaults to unset (false)"
},
"include_source_on_error": {
"type": "boolean",
"default": true,
"description": "True or false if to include the document source in the error message in case of parsing errors. Defaults to true."
}
},
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.allocation.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.component_templates.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.master.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
2 changes: 2 additions & 0 deletions specification/_json_spec/cat.ml_data_frame_analytics.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"params": {
"allow_no_match": {
"type": "boolean",
"default": false,
"description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)"
},
"bytes": {
Expand All @@ -44,6 +45,7 @@
},
"h": {
"type": "list",
"default": "create_time,id,state,type",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
2 changes: 2 additions & 0 deletions specification/_json_spec/cat.ml_datafeeds.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"params": {
"allow_no_match": {
"type": "boolean",
"default": true,
"description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)"
},
"format": {
Expand All @@ -39,6 +40,7 @@
},
"h": {
"type": "list",
"default": "['bc', 'id', 'sc', 's']",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
2 changes: 2 additions & 0 deletions specification/_json_spec/cat.ml_jobs.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"params": {
"allow_no_match": {
"type": "boolean",
"default": true,
"description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"
},
"bytes": {
Expand All @@ -44,6 +45,7 @@
},
"h": {
"type": "list",
"default": "buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.nodeattrs.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
2 changes: 2 additions & 0 deletions specification/_json_spec/cat.nodes.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
},
"full_id": {
"type": "boolean",
"default": false,
"description": "Return the full node ID instead of the shortened version (default: false)"
},
"master_timeout": {
Expand All @@ -39,6 +40,7 @@
},
"h": {
"type": "list",
"default": "ip,hp,rp,r,m,n,cpu,l",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.pending_tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.plugins.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.recovery.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
},
"h": {
"type": "list",
"default": "ip,hp,rp,r,m,n,cpu,l",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
25 changes: 25 additions & 0 deletions specification/_json_spec/cat.segments.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand All @@ -49,6 +50,7 @@
},
"h": {
"type": "list",
"default": "ip,hp,rp,r,m,n,cpu,l",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand All @@ -69,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
1 change: 1 addition & 0 deletions specification/_json_spec/cat.snapshots.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
},
"h": {
"type": "list",
"default": "ip,hp,rp,r,m,n,cpu,l",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
},
"detailed": {
"type": "boolean",
"default": false,
"description": "Return detailed task information (default: false)"
},
"parent_task_id": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.templates.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.thread_pool.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
Loading