Skip to content

Update rest-api-spec main #4229

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 2 commits into from
Apr 8, 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
109 changes: 81 additions & 28 deletions output/schema/schema.json

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

4 changes: 2 additions & 2 deletions specification/_json_spec/esql.async_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@
},
"allow_partial_results": {
"type": "boolean",
"description": "If `true`, partial results will be returned if there are shard failures, but\nthe query can continue to execute on other clusters and shards.",
"default": false
"description": "If `true`, partial results will be returned if there are shard failures, but\nthe query can continue to execute on other clusters and shards.\nIf `false`, the entire query will fail if there are\nany failures.",
"default": true
}
},
"body": {
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/esql.query.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@
},
"allow_partial_results": {
"type": "boolean",
"description": "If `true`, partial results will be returned if there are shard failures, but\nthe query can continue to execute on other clusters and shards.",
"default": false
"description": "If `true`, partial results will be returned if there are shard failures, but\nthe query can continue to execute on other clusters and shards.\nIf `false`, the entire query will fail if there are\nany failures.",
"default": true
}
},
"body": {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"indices.delete_data_stream_options": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html",
"description": "Deletes the data stream options of the selected data streams."
},
"stability": "experimental",
"visibility": "feature_flag",
"feature_flag": "es.failure_store_feature_flag_enabled",
"headers": {
"accept": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_data_stream/{name}/_options",
"methods": ["DELETE"],
"parts": {
"name": {
"type": "list",
"description": "A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams"
}
}
}
]
},
"params": {
"expand_wildcards": {
"type": "enum",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)"
},
"timeout": {
"type": "time",
"description": "Explicit timestamp for the document"
},
"master_timeout": {
"type": "time",
"description": "Specify timeout for connection to master"
}
}
}
}
44 changes: 44 additions & 0 deletions specification/_json_spec/indices.get_data_stream_options.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"indices.get_data_stream_options": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html",
"description": "Returns the data stream options of the selected data streams."
},
"stability": "experimental",
"visibility": "feature_flag",
"feature_flag": "es.failure_store_feature_flag_enabled",
"headers": {
"accept": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_data_stream/{name}/_options",
"methods": ["GET"],
"parts": {
"name": {
"type": "list",
"description": "A comma-separated list of data streams to get; use `*` to get all data streams"
}
}
}
]
},
"params": {
"expand_wildcards": {
"type": "enum",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)"
},
"include_defaults": {
"type": "boolean",
"description": "Return all relevant default configurations for the data stream (default: false)"
},
"master_timeout": {
"type": "time",
"description": "Specify timeout for connection to master"
}
}
}
}
1 change: 1 addition & 0 deletions specification/_json_spec/indices.get_settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
"description": "Return settings in flat format (default: false)"
},
"local": {
"deprecated": true,
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
Expand Down
48 changes: 48 additions & 0 deletions specification/_json_spec/indices.put_data_stream_options.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"indices.put_data_stream_options": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html",
"description": "Updates the data stream options of the selected data streams."
},
"stability": "experimental",
"visibility": "feature_flag",
"feature_flag": "es.failure_store_feature_flag_enabled",
"headers": {
"accept": ["application/json"],
"content_type": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_data_stream/{name}/_options",
"methods": ["PUT"],
"parts": {
"name": {
"type": "list",
"description": "A comma-separated list of data streams whose options will be updated; use `*` to set the options to all data streams"
}
}
}
]
},
"params": {
"expand_wildcards": {
"type": "enum",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)"
},
"timeout": {
"type": "time",
"description": "Explicit timestamp for the document"
},
"master_timeout": {
"type": "time",
"description": "Specify timeout for connection to master"
}
},
"body": {
"description": "The data stream options configuration that consist of the failure store configuration"
}
}
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"inference.post_eis_chat_completion": {
"inference.put_voyageai": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html",
"description": "Perform a chat completion task via the Elastic Inference Service (EIS)"
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-apis.html",
"description": "Configure an VoyageAI inference endpoint"
},
"stability": "stable",
"visibility": "public",
Expand All @@ -13,10 +13,14 @@
"url": {
"paths": [
{
"path": "/_inference/chat_completion/{eis_inference_id}/_stream",
"methods": ["POST"],
"path": "/_inference/{task_type}/{voyageai_inference_id}",
"methods": ["PUT"],
"parts": {
"eis_inference_id": {
"task_type": {
"type": "string",
"description": "The task type"
},
"voyageai_inference_id": {
"type": "string",
"description": "The inference ID"
}
Expand All @@ -25,7 +29,7 @@
]
},
"body": {
"description": "The inference tasks settings to perform"
"description": "The inference endpoint's task and service settings"
}
}
}