Skip to content

Update rest-api-spec 9.1 #4930

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 3 commits into from
Jul 15, 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
297 changes: 242 additions & 55 deletions output/openapi/elasticsearch-openapi.json

Large diffs are not rendered by default.

287 changes: 232 additions & 55 deletions output/openapi/elasticsearch-serverless-openapi.json

Large diffs are not rendered by default.

482 changes: 392 additions & 90 deletions output/schema/schema.json

Large diffs are not rendered by default.

24 changes: 0 additions & 24 deletions output/schema/validation-errors.json
Original file line number Diff line number Diff line change
@@ -1,23 +1,5 @@
{
"endpointErrors": {
"create": {
"request": [
"Request: query parameter 'if_primary_term' does not exist in the json spec",
"Request: query parameter 'if_seq_no' does not exist in the json spec",
"Request: query parameter 'op_type' does not exist in the json spec",
"Request: query parameter 'require_alias' does not exist in the json spec",
"Request: query parameter 'require_data_stream' does not exist in the json spec"
],
"response": []
},
"eql.search": {
"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"
],
"response": []
},
"esql.async_query_get": {
"request": [
"Request: query parameter 'format' does not exist in the json spec"
Expand Down Expand Up @@ -47,12 +29,6 @@
],
"response": []
},
"snapshot.repository_analyze": {
"request": [
"Request: query parameter 'register_operation_count' does not exist in the json spec"
],
"response": []
},
"xpack.info": {
"request": [
"request definition xpack.info:Request / query - Property 'human' is already defined in an ancestor class"
Expand Down
27 changes: 24 additions & 3 deletions output/typescript/types.ts

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

22 changes: 0 additions & 22 deletions specification/_global/create/CreateRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,12 @@ import { RequestBase } from '@_types/Base'
import {
Id,
IndexName,
OpType,
Refresh,
Routing,
SequenceNumber,
VersionNumber,
VersionType,
WaitForActiveShards
} from '@_types/common'
import { long } from '@_types/Numeric'
import { Duration } from '@_types/Time'

/**
Expand Down Expand Up @@ -134,30 +131,11 @@ export interface Request<TDocument> extends RequestBase {
index: IndexName
}
query_parameters: {
/**
* Only perform the operation if the document has this primary term.
* @ext_doc_id optimistic-concurrency
*/
if_primary_term?: long
/**
* Only perform the operation if the document has this sequence number.
* @ext_doc_id optimistic-concurrency
*/
if_seq_no?: SequenceNumber
/**
* True or false if to include the document source in the error message in case of parsing errors.
* @server_default true
*/
include_source_on_error?: boolean
/**
* Set to `create` to only index the document if it does not already exist (put if absent).
* If a document with the specified `_id` already exists, the indexing operation will fail.
* The behavior is the same as using the `<index>/_create` endpoint.
* If a document ID is specified, this paramater defaults to `index`.
* Otherwise, it defaults to `create`.
* If the request targets a data stream, an `op_type` of `create` is required.
*/
op_type?: OpType
/**
* The ID of the pipeline to use to preprocess incoming documents.
* If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.
Expand Down
8 changes: 8 additions & 0 deletions specification/_json_spec/create.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,14 @@
"include_source_on_error": {
"type": "boolean",
"description": "True or false if to include the document source in the error message in case of parsing errors. Defaults to true."
},
"require_alias": {
"type": "boolean",
"description": "When true, requires destination to be an alias. Default is false"
},
"require_data_stream": {
"type": "boolean",
"description": "When true, requires destination to be a data stream (existing or to be created). Default is false"
}
},
"body": {
Expand Down
19 changes: 19 additions & 0 deletions specification/_json_spec/eql.search.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,25 @@
"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
},
"ccs_minimize_roundtrips": {
"type": "boolean",
"description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution",
"default": true
},
"ignore_unavailable": {
"type": "boolean",
"description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
},
"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)"
},
"expand_wildcards": {
"type": "enum",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
}
},
"body": {
Expand Down
4 changes: 4 additions & 0 deletions specification/_json_spec/snapshot.repository_analyze.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@
"type": "number",
"description": "Number of operations to run concurrently during the test. Defaults to 10."
},
"register_operation_count": {
"type": "number",
"description": "The minimum number of linearizable register operations to perform in total. Defaults to 10."
},
"read_node_count": {
"type": "number",
"description": "Number of nodes on which to read a blob after writing. Defaults to 10."
Expand Down
5 changes: 5 additions & 0 deletions specification/eql/search/EqlSearchRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,11 @@ export interface Request extends RequestBase {
* @server_default open
*/
expand_wildcards?: ExpandWildcards
/**
* Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
* @server_default true
*/
ccs_minimize_roundtrips?: boolean
/**
* If true, missing or closed indices are not included in the response.
* @server_default true
Expand Down