Skip to content

Update rest-api-spec main #3992

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
Mar 18, 2025
Merged

Update rest-api-spec main #3992

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
0b8a13d
Update rest-api-spec
pquentin Mar 18, 2025
7ddcfd7
Add allow_partial_results parameters
pquentin Mar 18, 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
20 changes: 20 additions & 0 deletions 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.

10 changes: 10 additions & 0 deletions output/openapi/elasticsearch-serverless-openapi.json
View file
Open in desktop

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

15 changes: 14 additions & 1 deletion output/schema/schema-serverless.json
View file
Open in desktop

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

30 changes: 28 additions & 2 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.

2 changes: 2 additions & 0 deletions output/typescript/types.ts
View file
Open in desktop

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

5 changes: 5 additions & 0 deletions specification/_json_spec/esql.async_query.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@
"type": "boolean",
"description": "Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.",
"default": false
},
"allow_partial_results": {
"type": "boolean",
"description": "If `true`, partial results will be returned if there are shard failures, but\nthe query can continue to execute on other clusters and shards.",
"default": false
}
},
"body": {
Expand Down
5 changes: 5 additions & 0 deletions specification/_json_spec/esql.query.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@
"type": "boolean",
"description": "Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.",
"default": false
},
"allow_partial_results": {
"type": "boolean",
"description": "If `true`, partial results will be returned if there are shard failures, but\nthe query can continue to execute on other clusters and shards.",
"default": false
}
},
"body": {
Expand Down
7 changes: 2 additions & 5 deletions specification/_json_spec/indices.get_mapping.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,12 @@
},
"master_timeout": {
"type": "time",
"description": "Specify timeout for connection to master"
"description": "Timeout for waiting for new cluster state in case it is blocked"
},
"local": {
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)",
"deprecated": {
"version": "7.8.0",
"description": "This parameter is a no-op and field mappings are always retrieved locally."
}
"deprecated": true
Copy link
Member

Choose a reason for hiding this comment

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

This change does not seems like a net benefit to me - asked about it in https://github.com/elastic/elasticsearch/pull/122921/files#r2000258419.

}
}
}
Expand Down
0 ...tion/_json_spec/inference.put.openai.json → ...tion/_json_spec/inference.put_openai.json
View file
Open in desktop
File renamed without changes.
0 ...ion/_json_spec/inference.put.watsonx.json → ...ion/_json_spec/inference.put_watsonx.json
View file
Open in desktop
File renamed without changes.
5 changes: 5 additions & 0 deletions specification/esql/async_query/AsyncQueryRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ import { Duration } from '@_types/Time'
*/
export interface Request extends RequestBase {
query_parameters: {
/**
* If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
* @server_default false
*/
allow_partial_results?: boolean
/**
* The character to use between values within a CSV row.
* It is valid only for the CSV format.
Expand Down
5 changes: 5 additions & 0 deletions specification/esql/query/QueryRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ export interface Request extends RequestBase {
* @server_default false
*/
drop_null_columns?: boolean
/**
* If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
* @server_default false
*/
allow_partial_results?: boolean
}
/**
* Use the `query` element to start a query. Use `time_zone` to specify an execution time zone and `columnar` to format the answer.
Expand Down
Loading