Skip to content

Commit

Permalink
Update rest-api-spec
Browse files Browse the repository at this point in the history
  • Loading branch information
pquentin authored and github-actions[bot] committed Dec 18, 2024
1 parent 2737b43 commit b866a01
Show file tree
Hide file tree
Showing 8 changed files with 307 additions and 55 deletions.
150 changes: 98 additions & 52 deletions output/schema/schema-serverless.json

Large diffs are not rendered by default.

84 changes: 84 additions & 0 deletions output/schema/schema.json

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

28 changes: 27 additions & 1 deletion output/schema/validation-errors.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@
],
"response": []
},
"bulk": {
"request": [
"Request: missing json spec query parameter 'type'"
],
"response": []
},
"capabilities": {
"request": [
"Missing request & response"
Expand Down Expand Up @@ -455,7 +461,9 @@
"request": [
"Request: query parameter 'allow_no_indices' does not exist in the json spec",
"Request: query parameter 'expand_wildcards' does not exist in the json spec",
"Request: query parameter 'ignore_unavailable' does not exist in the json spec"
"Request: query parameter 'ignore_unavailable' does not exist in the json spec",
"Request: missing json spec query parameter 'allow_partial_search_results'",
"Request: missing json spec query parameter 'allow_partial_sequence_results'"
],
"response": []
},
Expand Down Expand Up @@ -694,6 +702,24 @@
],
"response": []
},
"migrate.cancel_reindex": {
"request": [
"Missing request & response"
],
"response": []
},
"migrate.get_reindex_status": {
"request": [
"Missing request & response"
],
"response": []
},
"migrate.reindex": {
"request": [
"Missing request & response"
],
"response": []
},
"ml.delete_trained_model": {
"request": [
"Request: missing json spec query parameter 'timeout'"
Expand Down
8 changes: 6 additions & 2 deletions specification/_json_spec/bulk.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@
"type": "time",
"description": "Explicit operation timeout"
},
"type": {
"type": "string",
"description": "Default document type for items which don't provide one"
},
"_source": {
"type": "list",
"description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request"
Expand All @@ -64,11 +68,11 @@
},
"require_alias": {
"type": "boolean",
"description": "If true, the request’s actions must target an index alias. Defaults to false."
"description": "Sets require_alias for all incoming documents. Defaults to unset (false)"
},
"require_data_stream": {
"type": "boolean",
"description": "If true, the request's actions must target a data stream (existing or to-be-created). Default to false"
"description": "When true, requires the destination to be a data stream (existing or to-be-created). Default is false"
},
"list_executed_pipelines": {
"type": "boolean",
Expand Down
10 changes: 10 additions & 0 deletions specification/_json_spec/eql.search.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,16 @@
"type": "time",
"description": "Update the time interval in which the results (partial or final) for this search will be available",
"default": "5d"
},
"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
},
"allow_partial_sequence_results": {
"type": "boolean",
"description": "Control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true.",
"default": false
}
},
"body": {
Expand Down
28 changes: 28 additions & 0 deletions specification/_json_spec/migrate.cancel_reindex.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"migrate.cancel_reindex": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html",
"description": "This API returns the status of a migration reindex attempt for a data stream or index"
},
"stability": "experimental",
"visibility": "private",
"headers": {
"accept": ["application/json"],
"content_type": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_migration/reindex/{index}/_cancel",
"methods": ["POST"],
"parts": {
"index": {
"type": "string",
"description": "The index or data stream name"
}
}
}
]
}
}
}
28 changes: 28 additions & 0 deletions specification/_json_spec/migrate.get_reindex_status.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"migrate.get_reindex_status": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html",
"description": "This API returns the status of a migration reindex attempt for a data stream or index"
},
"stability": "experimental",
"visibility": "private",
"headers": {
"accept": ["application/json"],
"content_type": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_migration/reindex/{index}/_status",
"methods": ["GET"],
"parts": {
"index": {
"type": "string",
"description": "The index or data stream name"
}
}
}
]
}
}
}
26 changes: 26 additions & 0 deletions specification/_json_spec/migrate.reindex.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"migrate.reindex": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.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",
"visibility": "private",
"headers": {
"accept": ["application/json"],
"content_type": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_migration/reindex",
"methods": ["POST"]
}
]
},
"body": {
"description": "The body contains the fields `mode` and `source.index, where the only mode currently supported is `upgrade`, and the `source.index` must be a data stream name",
"required": true
}
}
}

0 comments on commit b866a01

Please sign in to comment.