Skip to content

Update rest-api-spec 9.1 #5447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 9.1
Choose a base branch
from
Open

Update rest-api-spec 9.1 #5447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion output/schema/validation-errors.json
View file
Open in desktop
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
1 change: 1 addition & 0 deletions specification/_json_spec/_internal.delete_desired_balance.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for connection to master node"
}
}
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/_internal.delete_desired_nodes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for connection to master node"
},
"timeout": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/_internal.get_desired_balance.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for connection to master node"
}
}
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/_internal.prevalidate_node_removal.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"timeout": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/async_search.status.json
View file
Open in desktop
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
1 change: 1 addition & 0 deletions specification/_json_spec/async_search.submit.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
},
"request_cache": {
"type": "boolean",
"default": true,
"description": "Specify if request cache should be used for this request or not, defaults to true"
},
"analyzer": {
Expand Down
2 changes: 2 additions & 0 deletions specification/_json_spec/autoscaling.delete_autoscaling_policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,12 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for processing on master node"
},
"timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for acknowledgement of update from all nodes in cluster"
}
}
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/autoscaling.get_autoscaling_capacity.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for processing on master node"
}
}
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/autoscaling.get_autoscaling_policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for processing on master node"
}
}
Expand Down
2 changes: 2 additions & 0 deletions specification/_json_spec/autoscaling.put_autoscaling_policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,12 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for processing on master node"
},
"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
View file
Open in desktop
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
2 changes: 2 additions & 0 deletions specification/_json_spec/cat.allocation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,12 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"h": {
Expand Down
2 changes: 2 additions & 0 deletions specification/_json_spec/cat.component_templates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"h": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.indices.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"h": {
Expand Down
2 changes: 2 additions & 0 deletions specification/_json_spec/cat.master.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"h": {
Expand Down
2 changes: 2 additions & 0 deletions specification/_json_spec/cat.ml_data_frame_analytics.json
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
2 changes: 2 additions & 0 deletions specification/_json_spec/cat.nodeattrs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"h": {
Expand Down
3 changes: 3 additions & 0 deletions specification/_json_spec/cat.nodes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,17 @@
},
"full_id": {
"type": "boolean",
"default": false,
"description": "Return the full node ID instead of the shortened version (default: false)"
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"h": {
"type": "list",
"default": "ip,hp,rp,r,m,n,cpu,l",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
2 changes: 2 additions & 0 deletions specification/_json_spec/cat.pending_tasks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"h": {
Expand Down
2 changes: 2 additions & 0 deletions specification/_json_spec/cat.plugins.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"h": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.recovery.json
View file
Open in desktop
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
1 change: 1 addition & 0 deletions specification/_json_spec/cat.repositories.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"h": {
Expand Down
26 changes: 26 additions & 0 deletions specification/_json_spec/cat.segments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"bytes": {
Expand All @@ -48,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 @@ -68,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.shards.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"h": {
Expand Down
2 changes: 2 additions & 0 deletions specification/_json_spec/cat.snapshots.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,12 @@
},
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout for connection to master node"
},
"h": {
"type": "list",
"default": "ip,hp,rp,r,m,n,cpu,l",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
Loading