Skip to content

Update rest-api-spec 8.x #3593

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.

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
Feb 27, 2025
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
6 changes: 6 additions & 0 deletions output/openapi/elasticsearch-openapi.json

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

6 changes: 6 additions & 0 deletions output/openapi/elasticsearch-serverless-openapi.json

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

18 changes: 16 additions & 2 deletions output/schema/schema-serverless.json

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

19 changes: 7 additions & 12 deletions output/schema/validation-errors.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"endpointErrors": {
"async_search.submit": {
"request": [
"Request: query parameter 'keep_alive' does not exist in the json spec",
"Request: query parameter 'min_compatible_shard_node' does not exist in the json spec",
"interface definition _types:QueryVectorBuilder - Property text_embedding is a single-variant and must be required"
],
Expand Down Expand Up @@ -57,13 +56,6 @@
],
"response": []
},
"cat.help": {
"request": [
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'"
],
"response": []
},
"cat.indices": {
"request": [
"request definition cat.indices:Request / body - A request with inherited properties must have a PropertyBody"
Expand Down Expand Up @@ -138,8 +130,6 @@
},
"cat.segments": {
"request": [
"Request: query parameter 'local' does not exist in the json spec",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"request definition cat.segments:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
Expand All @@ -158,8 +148,6 @@
},
"cat.tasks": {
"request": [
"Request: query parameter 'timeout' does not exist in the json spec",
"Request: query parameter 'wait_for_completion' does not exist in the json spec",
"request definition cat.tasks:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
Expand Down Expand Up @@ -367,6 +355,13 @@
],
"response": []
},
"inference.update": {
"request": [
"/_inference/{inference_id}/_update: different http methods in the json spec",
"/_inference/{task_type}/{inference_id}/_update: different http methods in the json spec"
],
"response": []
},
"ingest.delete_geoip_database": {
"request": [
"Request: query parameter 'master_timeout' does not exist in the json spec",
Expand Down
5 changes: 5 additions & 0 deletions specification/_json_spec/async_search.submit.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@
"description": "Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)",
"default": false
},
"keep_alive": {
"type": "time",
"description": "Update the time interval in which the results (partial or final) for this search will be available",
"default": "5d"
},
"batched_reduce_size": {
"type": "number",
"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.",
Expand Down
11 changes: 0 additions & 11 deletions specification/_json_spec/cat.help.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,6 @@
"methods": ["GET"]
}
]
},
"params": {
"help": {
"type": "boolean",
"description": "Return help information",
"default": false
},
"s": {
"type": "list",
"description": "Comma-separated list of column names or column aliases to sort by"
}
}
}
}
8 changes: 8 additions & 0 deletions specification/_json_spec/cat.segments.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@
"type": "string",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"local": {
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
"type": "time",
"description": "Explicit operation timeout for connection to master node"
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
Expand Down
10 changes: 10 additions & 0 deletions specification/_json_spec/cat.tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,16 @@
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
},
"timeout": {
"type": "time",
"default": "30s",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
},
"wait_for_completion": {
"type": "boolean",
"default": false,
"description": "If `true`, the request blocks until the task has completed."
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/eql.search.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"allow_partial_search_results": {
"type": "boolean",
"description": "Control whether the query should keep running in case of shard failures, and return partial results",
"default": false
"default": true
},
"allow_partial_sequence_results": {
"type": "boolean",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"indices.cancel_migrate_reindex": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html",
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex-cancel-api.html",
"description": "This API returns the status of a migration reindex attempt for a data stream or index"
},
"stability": "experimental",
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.create_from.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"indices.create_from": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html",
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index-from-source.html",
"description": "This API creates a destination from a source index. It copies the mappings and settings from the source index while allowing request settings and mappings to override the source values."
},
"stability": "experimental",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"indices.get_migrate_reindex_status": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html",
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex-status-api.html",
"description": "This API returns the status of a migration reindex attempt for a data stream or index"
},
"stability": "experimental",
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.migrate_reindex.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"indices.migrate_reindex": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html",
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex-api.html",
"description": "This API reindexes all legacy backing indices for a data stream. It does this in a persistent task. The persistent task id is returned immediately, and the reindexing work is completed in that task"
},
"stability": "experimental",
Expand Down