Skip to content

Commit 16613a7

Browse files
Update rest-api-spec (#3593)
Co-authored-by: pquentin <[email protected]>
1 parent fdee03c commit 16613a7

13 files changed

+63
-30
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema-serverless.json

Lines changed: 16 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/validation-errors.json

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"endpointErrors": {
33
"async_search.submit": {
44
"request": [
5-
"Request: query parameter 'keep_alive' does not exist in the json spec",
65
"Request: query parameter 'min_compatible_shard_node' does not exist in the json spec",
76
"interface definition _types:QueryVectorBuilder - Property text_embedding is a single-variant and must be required"
87
],
@@ -57,13 +56,6 @@
5756
],
5857
"response": []
5958
},
60-
"cat.help": {
61-
"request": [
62-
"Request: missing json spec query parameter 'help'",
63-
"Request: missing json spec query parameter 's'"
64-
],
65-
"response": []
66-
},
6759
"cat.indices": {
6860
"request": [
6961
"request definition cat.indices:Request / body - A request with inherited properties must have a PropertyBody"
@@ -138,8 +130,6 @@
138130
},
139131
"cat.segments": {
140132
"request": [
141-
"Request: query parameter 'local' does not exist in the json spec",
142-
"Request: query parameter 'master_timeout' does not exist in the json spec",
143133
"request definition cat.segments:Request / body - A request with inherited properties must have a PropertyBody"
144134
],
145135
"response": []
@@ -158,8 +148,6 @@
158148
},
159149
"cat.tasks": {
160150
"request": [
161-
"Request: query parameter 'timeout' does not exist in the json spec",
162-
"Request: query parameter 'wait_for_completion' does not exist in the json spec",
163151
"request definition cat.tasks:Request / body - A request with inherited properties must have a PropertyBody"
164152
],
165153
"response": []
@@ -367,6 +355,13 @@
367355
],
368356
"response": []
369357
},
358+
"inference.update": {
359+
"request": [
360+
"/_inference/{inference_id}/_update: different http methods in the json spec",
361+
"/_inference/{task_type}/{inference_id}/_update: different http methods in the json spec"
362+
],
363+
"response": []
364+
},
370365
"ingest.delete_geoip_database": {
371366
"request": [
372367
"Request: query parameter 'master_timeout' does not exist in the json spec",

specification/_json_spec/async_search.submit.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@
3939
"description": "Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)",
4040
"default": false
4141
},
42+
"keep_alive": {
43+
"type": "time",
44+
"description": "Update the time interval in which the results (partial or final) for this search will be available",
45+
"default": "5d"
46+
},
4247
"batched_reduce_size": {
4348
"type": "number",
4449
"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.",

specification/_json_spec/cat.help.json

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,6 @@
1616
"methods": ["GET"]
1717
}
1818
]
19-
},
20-
"params": {
21-
"help": {
22-
"type": "boolean",
23-
"description": "Return help information",
24-
"default": false
25-
},
26-
"s": {
27-
"type": "list",
28-
"description": "Comma-separated list of column names or column aliases to sort by"
29-
}
3019
}
3120
}
3221
}

specification/_json_spec/cat.segments.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@
3232
"type": "string",
3333
"description": "a short version of the Accept header, e.g. json, yaml"
3434
},
35+
"local": {
36+
"type": "boolean",
37+
"description": "Return local information, do not retrieve the state from master node (default: false)"
38+
},
39+
"master_timeout": {
40+
"type": "time",
41+
"description": "Explicit operation timeout for connection to master node"
42+
},
3543
"bytes": {
3644
"type": "enum",
3745
"description": "The unit in which to display byte values",

specification/_json_spec/cat.tasks.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,16 @@
6060
"type": "boolean",
6161
"description": "Verbose mode. Display column headers",
6262
"default": false
63+
},
64+
"timeout": {
65+
"type": "time",
66+
"default": "30s",
67+
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
68+
},
69+
"wait_for_completion": {
70+
"type": "boolean",
71+
"default": false,
72+
"description": "If `true`, the request blocks until the task has completed."
6373
}
6474
}
6575
}

specification/_json_spec/eql.search.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
"allow_partial_search_results": {
4343
"type": "boolean",
4444
"description": "Control whether the query should keep running in case of shard failures, and return partial results",
45-
"default": false
45+
"default": true
4646
},
4747
"allow_partial_sequence_results": {
4848
"type": "boolean",

specification/_json_spec/indices.cancel_migrate_reindex.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"indices.cancel_migrate_reindex": {
33
"documentation": {
4-
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html",
4+
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex-cancel-api.html",
55
"description": "This API returns the status of a migration reindex attempt for a data stream or index"
66
},
77
"stability": "experimental",

specification/_json_spec/indices.create_from.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"indices.create_from": {
33
"documentation": {
4-
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html",
4+
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index-from-source.html",
55
"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."
66
},
77
"stability": "experimental",

specification/_json_spec/indices.get_migrate_reindex_status.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"indices.get_migrate_reindex_status": {
33
"documentation": {
4-
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html",
4+
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex-status-api.html",
55
"description": "This API returns the status of a migration reindex attempt for a data stream or index"
66
},
77
"stability": "experimental",

specification/_json_spec/indices.migrate_reindex.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"indices.migrate_reindex": {
33
"documentation": {
4-
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html",
4+
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex-api.html",
55
"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"
66
},
77
"stability": "experimental",

0 commit comments

Comments
 (0)