Skip to content

Commit 30c43f9

Browse files
Update rest-api-spec 9.1 (#4930)
* Update rest-api-spec * Add ccs_minimize_roundtrips * Remove invalid query parameters from CreateRequest --------- Co-authored-by: pquentin <[email protected]> Co-authored-by: Quentin Pradet <[email protected]>
1 parent a165149 commit 30c43f9

File tree

10 files changed

+926
-249
lines changed

10 files changed

+926
-249
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 242 additions & 55 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: 232 additions & 55 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 392 additions & 90 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: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,5 @@
11
{
22
"endpointErrors": {
3-
"create": {
4-
"request": [
5-
"Request: query parameter 'if_primary_term' does not exist in the json spec",
6-
"Request: query parameter 'if_seq_no' does not exist in the json spec",
7-
"Request: query parameter 'op_type' does not exist in the json spec",
8-
"Request: query parameter 'require_alias' does not exist in the json spec",
9-
"Request: query parameter 'require_data_stream' does not exist in the json spec"
10-
],
11-
"response": []
12-
},
13-
"eql.search": {
14-
"request": [
15-
"Request: query parameter 'allow_no_indices' does not exist in the json spec",
16-
"Request: query parameter 'expand_wildcards' does not exist in the json spec",
17-
"Request: query parameter 'ignore_unavailable' does not exist in the json spec"
18-
],
19-
"response": []
20-
},
213
"esql.async_query_get": {
224
"request": [
235
"Request: query parameter 'format' does not exist in the json spec"
@@ -47,12 +29,6 @@
4729
],
4830
"response": []
4931
},
50-
"snapshot.repository_analyze": {
51-
"request": [
52-
"Request: query parameter 'register_operation_count' does not exist in the json spec"
53-
],
54-
"response": []
55-
},
5632
"xpack.info": {
5733
"request": [
5834
"request definition xpack.info:Request / query - Property 'human' is already defined in an ancestor class"

output/typescript/types.ts

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

specification/_global/create/CreateRequest.ts

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,12 @@ import { RequestBase } from '@_types/Base'
2121
import {
2222
Id,
2323
IndexName,
24-
OpType,
2524
Refresh,
2625
Routing,
27-
SequenceNumber,
2826
VersionNumber,
2927
VersionType,
3028
WaitForActiveShards
3129
} from '@_types/common'
32-
import { long } from '@_types/Numeric'
3330
import { Duration } from '@_types/Time'
3431

3532
/**
@@ -134,30 +131,11 @@ export interface Request<TDocument> extends RequestBase {
134131
index: IndexName
135132
}
136133
query_parameters: {
137-
/**
138-
* Only perform the operation if the document has this primary term.
139-
* @ext_doc_id optimistic-concurrency
140-
*/
141-
if_primary_term?: long
142-
/**
143-
* Only perform the operation if the document has this sequence number.
144-
* @ext_doc_id optimistic-concurrency
145-
*/
146-
if_seq_no?: SequenceNumber
147134
/**
148135
* True or false if to include the document source in the error message in case of parsing errors.
149136
* @server_default true
150137
*/
151138
include_source_on_error?: boolean
152-
/**
153-
* Set to `create` to only index the document if it does not already exist (put if absent).
154-
* If a document with the specified `_id` already exists, the indexing operation will fail.
155-
* The behavior is the same as using the `<index>/_create` endpoint.
156-
* If a document ID is specified, this paramater defaults to `index`.
157-
* Otherwise, it defaults to `create`.
158-
* If the request targets a data stream, an `op_type` of `create` is required.
159-
*/
160-
op_type?: OpType
161139
/**
162140
* The ID of the pipeline to use to preprocess incoming documents.
163141
* If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.

specification/_json_spec/create.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,14 @@
6262
"include_source_on_error": {
6363
"type": "boolean",
6464
"description": "True or false if to include the document source in the error message in case of parsing errors. Defaults to true."
65+
},
66+
"require_alias": {
67+
"type": "boolean",
68+
"description": "When true, requires destination to be an alias. Default is false"
69+
},
70+
"require_data_stream": {
71+
"type": "boolean",
72+
"description": "When true, requires destination to be a data stream (existing or to be created). Default is false"
6573
}
6674
},
6775
"body": {

specification/_json_spec/eql.search.json

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,25 @@
4848
"type": "boolean",
4949
"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.",
5050
"default": false
51+
},
52+
"ccs_minimize_roundtrips": {
53+
"type": "boolean",
54+
"description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution",
55+
"default": true
56+
},
57+
"ignore_unavailable": {
58+
"type": "boolean",
59+
"description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
60+
},
61+
"allow_no_indices": {
62+
"type": "boolean",
63+
"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)"
64+
},
65+
"expand_wildcards": {
66+
"type": "enum",
67+
"options": ["open", "closed", "hidden", "none", "all"],
68+
"default": "open",
69+
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
5170
}
5271
},
5372
"body": {

specification/_json_spec/snapshot.repository_analyze.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@
3232
"type": "number",
3333
"description": "Number of operations to run concurrently during the test. Defaults to 10."
3434
},
35+
"register_operation_count": {
36+
"type": "number",
37+
"description": "The minimum number of linearizable register operations to perform in total. Defaults to 10."
38+
},
3539
"read_node_count": {
3640
"type": "number",
3741
"description": "Number of nodes on which to read a blob after writing. Defaults to 10."

specification/eql/search/EqlSearchRequest.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@ export interface Request extends RequestBase {
6565
* @server_default open
6666
*/
6767
expand_wildcards?: ExpandWildcards
68+
/**
69+
* Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
70+
* @server_default true
71+
*/
72+
ccs_minimize_roundtrips?: boolean
6873
/**
6974
* If true, missing or closed indices are not included in the response.
7075
* @server_default true

0 commit comments

Comments
 (0)