Skip to content

Update rest-api-spec 8.19 #5285

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

Merged
merged 1 commit into from
Sep 15, 2025
Merged

Update rest-api-spec 8.19 #5285

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
3 changes: 2 additions & 1 deletion output/openapi/elasticsearch-openapi.json
View file
Open in desktop

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

2 changes: 1 addition & 1 deletion output/schema/schema.json
View file
Open in desktop

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

1 change: 1 addition & 0 deletions specification/_json_spec/cat.aliases.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"local": {
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/cat.allocation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,13 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]
"options": ["b", "kb", "mb", "gb", "tb", "pb"]
},
"local": {
"type": "boolean",
Expand Down
1 change: 1 addition & 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 @@ -30,6 +30,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"local": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.count.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"h": {
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/cat.fielddata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,13 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]
"options": ["b", "kb", "mb", "gb", "tb", "pb"]
},
"h": {
"type": "list",
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.health.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"h": {
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/cat.indices.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,13 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]
"options": ["b", "kb", "mb", "gb", "tb", "pb"]
},
"master_timeout": {
"type": "time",
Expand Down
1 change: 1 addition & 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 @@ -20,6 +20,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"local": {
Expand Down
3 changes: 2 additions & 1 deletion 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 @@ -36,10 +36,11 @@
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]
"options": ["b", "kb", "mb", "gb", "tb", "pb"]
},
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"h": {
Expand Down
1 change: 1 addition & 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 @@ -35,6 +35,7 @@
},
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"h": {
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/cat.ml_jobs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,11 @@
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]
"options": ["b", "kb", "mb", "gb", "tb", "pb"]
},
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"h": {
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/cat.ml_trained_models.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,11 @@
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]
"options": ["b", "kb", "mb", "gb", "tb", "pb"]
},
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"h": {
Expand Down
1 change: 1 addition & 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 @@ -20,6 +20,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"local": {
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/cat.nodes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]
"options": ["b", "kb", "mb", "gb", "tb", "pb"]
},
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"full_id": {
Expand Down
1 change: 1 addition & 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 @@ -20,6 +20,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"local": {
Expand Down
1 change: 1 addition & 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 @@ -20,6 +20,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"local": {
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/cat.recovery.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"active_only": {
Expand All @@ -40,7 +41,7 @@
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]
"options": ["b", "kb", "mb", "gb", "tb", "pb"]
},
"detailed": {
"type": "boolean",
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 @@ -20,6 +20,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"local": {
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/cat.segments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"local": {
Expand All @@ -43,7 +44,7 @@
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]
"options": ["b", "kb", "mb", "gb", "tb", "pb"]
},
"h": {
"type": "list",
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/cat.shards.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,13 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"]
"options": ["b", "kb", "mb", "gb", "tb", "pb"]
},
"master_timeout": {
"type": "time",
Expand Down
1 change: 1 addition & 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 @@ -30,6 +30,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"ignore_unavailable": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.tasks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"nodes": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.templates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"local": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.thread_pool.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"params": {
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"time": {
Expand Down
1 change: 1 addition & 0 deletions specification/_json_spec/cat.transforms.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
},
"format": {
"type": "string",
"default": "text",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"h": {
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/msearch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
},
"pre_filter_shard_size": {
"type": "number",
"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."
"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",
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/search.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@
},
"pre_filter_shard_size": {
"type": "number",
"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."
"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": {
"type": "boolean",
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/watcher.put_watch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
},
"body": {
"description": "The watch",
"required": false
"required": true
}
}
}