Skip to content

Update rest-api-spec main #5030

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.

Sign up for GitHub

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 2 commits into from
Aug 19, 2025
Merged

Update rest-api-spec main #5030

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d46b4db
Update rest-api-spec
pquentin Aug 19, 2025
cc1098b
Use new merge_type wording
pquentin Aug 19, 2025
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
2 changes: 1 addition & 1 deletion output/openapi/elasticsearch-openapi.json
View file
Open in desktop

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

31 changes: 28 additions & 3 deletions output/schema/schema.json
View file
Open in desktop

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

3 changes: 1 addition & 2 deletions specification/_json_spec/indices.get_data_stream_mappings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
"description": "Gets a data stream's mappings"
},
"stability": "stable",
"visibility": "feature_flag",
"feature_flag": "logs_stream",
"visibility": "public",
"headers": {
"accept": ["application/json"]
},
Expand Down
3 changes: 1 addition & 2 deletions specification/_json_spec/indices.put_data_stream_mappings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
"description": "Updates a data stream's mappings"
},
"stability": "stable",
"visibility": "feature_flag",
"feature_flag": "logs_stream",
"visibility": "public",
"headers": {
"accept": ["application/json"]
},
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/simulate.ingest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@
},
"merge_type": {
"type": "string",
"description": "The method to be used when merging mapping_additions existing mappings"
"description": "The mapping merge type if mapping overrides are being provided in mapping_addition. The allowed values are one of index or template. The index option merges mappings the way they would be merged into an existing index. The template option merges mappings the way they would be merged into a template.",
"default": "index"
}
},
"body": {
Expand Down
31 changes: 31 additions & 0 deletions specification/_json_spec/transform.set_upgrade_mode.json
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was added in elastic/elasticsearch#132652 by @prwhelan, who plans to add a proper API specification but was waiting for the rest-api-spec change. Merging!

Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"transform.set_upgrade_mode": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/transform-set-upgrade-mode.html",
"description": "Sets a cluster wide upgrade_mode setting that prepares transform indices for an upgrade."
},
"stability": "stable",
"visibility": "public",
"headers": {
"accept": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_transform/set_upgrade_mode",
"methods": ["POST"]
}
]
},
"params": {
"enabled": {
"type": "boolean",
"description": "Whether to enable upgrade_mode Transform setting or not. Defaults to false."
},
"timeout": {
"type": "time",
"description": "Controls the time to wait before action times out. Defaults to 30 seconds"
}
}
}
}
7 changes: 4 additions & 3 deletions specification/simulate/ingest/SimulateIngestRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,10 @@ export interface Request extends RequestBase {
*/
pipeline?: PipelineName
/**
* The method to be used when merging mapping_additions existing mappings. Mappings can be merged in the way mapping changes are merged into an existing index, or in
* the way mapping changes are merged into existing templates. Some changes are allowed to templates that are not allowed to indices. For example,
* a field cannot be changed to an incompatible type in an index, but can in a template.
* The mapping merge type if mapping overrides are being provided in mapping_addition.
* The allowed values are one of index or template.
* The index option merges mappings the way they would be merged into an existing index.
* The template option merges mappings the way they would be merged into a template.
* @server_default index
*/
merge_type?: MergeType
Expand Down