Skip to content
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

Update rest-api-spec 8.x #3593

Open
wants to merge 1 commit into
base: 8.x
Choose a base branch
from
Open
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
18 changes: 15 additions & 3 deletions output/openapi/elasticsearch-openapi.json

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

12 changes: 12 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.

178 changes: 110 additions & 68 deletions output/schema/schema-serverless.json

Large diffs are not rendered by default.

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.

16 changes: 16 additions & 0 deletions output/schema/validation-errors.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
"async_search.submit": {
"request": [
"Request: query parameter 'min_compatible_shard_node' does not exist in the json spec",
"Request: missing json spec query parameter 'keep_alive'",
"interface definition _types:QueryVectorBuilder - Property text_embedding is a single-variant and must be required"
],
"response": []
Expand Down Expand Up @@ -394,6 +395,14 @@
],
"response": []
},
"indices.resolve_cluster": {
"request": [
"Request: different number of urls in the json spec",
"Request: path parameter 'name' is required in the json spec",
"Request: query parameter 'timeout' does not exist in the json spec"
],
"response": []
},
"indices.rollover": {
"request": [
"Request: missing json spec query parameter 'lazy'"
Expand All @@ -413,6 +422,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
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
18 changes: 5 additions & 13 deletions specification/_json_spec/indices.resolve_cluster.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"indices.resolve_cluster": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html",
"description": "Resolves the specified index expressions to return information about each cluster. If no index expression is provided, this endpoint will return information about all the remote clusters that are configured on the local cluster."
"description": "Resolves the specified index expressions to return information about each cluster, including the local cluster, if included."
},
"stability": "stable",
"visibility": "public",
Expand All @@ -11,10 +11,6 @@
},
"url": {
"paths": [
{
"path": "/_resolve/cluster",
"methods": ["GET"]
},
{
"path": "/_resolve/cluster/{name}",
"methods": ["GET"],
Expand All @@ -30,25 +26,21 @@
"params": {
"ignore_unavailable": {
"type": "boolean",
"description": "Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression."
"description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
},
"ignore_throttled": {
"type": "boolean",
"description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression."
"description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled"
},
"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."
"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)"
},
"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). Only allowed when providing an index expression."
},
"timeout": {
"type": "time",
"description": "The maximum time to wait for remote clusters to respond"
"description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/inference.update.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"paths": [
{
"path": "/_inference/{inference_id}/_update",
"methods": ["POST"],
"methods": ["PUT"],
"parts": {
"inference_id": {
"type": "string",
Expand All @@ -24,7 +24,7 @@
},
{
"path": "/_inference/{task_type}/{inference_id}/_update",
"methods": ["POST"],
"methods": ["PUT"],
"parts": {
"task_type": {
"type": "string",
Expand Down