Skip to content

Commit f406956

Browse files
Update rest-api-spec main (#3992)
* Update rest-api-spec * Add allow_partial_results parameters --------- Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
1 parent 8616217 commit f406956

12 files changed

+96
-8
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 20 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: 10 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: 14 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

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

output/typescript/types.ts

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

specification/_json_spec/esql.async_query.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@
3232
"type": "boolean",
3333
"description": "Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.",
3434
"default": false
35+
},
36+
"allow_partial_results": {
37+
"type": "boolean",
38+
"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.",
39+
"default": false
3540
}
3641
},
3742
"body": {

specification/_json_spec/esql.query.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@
3232
"type": "boolean",
3333
"description": "Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.",
3434
"default": false
35+
},
36+
"allow_partial_results": {
37+
"type": "boolean",
38+
"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.",
39+
"default": false
3540
}
3641
},
3742
"body": {

specification/_json_spec/indices.get_mapping.json

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,12 @@
4444
},
4545
"master_timeout": {
4646
"type": "time",
47-
"description": "Specify timeout for connection to master"
47+
"description": "Timeout for waiting for new cluster state in case it is blocked"
4848
},
4949
"local": {
5050
"type": "boolean",
5151
"description": "Return local information, do not retrieve the state from master node (default: false)",
52-
"deprecated": {
53-
"version": "7.8.0",
54-
"description": "This parameter is a no-op and field mappings are always retrieved locally."
55-
}
52+
"deprecated": true
5653
}
5754
}
5855
}

specification/esql/async_query/AsyncQueryRequest.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ import { Duration } from '@_types/Time'
3838
*/
3939
export interface Request extends RequestBase {
4040
query_parameters: {
41+
/**
42+
* If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
43+
* @server_default false
44+
*/
45+
allow_partial_results?: boolean
4146
/**
4247
* The character to use between values within a CSV row.
4348
* It is valid only for the CSV format.

specification/esql/query/QueryRequest.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,11 @@ export interface Request extends RequestBase {
5555
* @server_default false
5656
*/
5757
drop_null_columns?: boolean
58+
/**
59+
* If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
60+
* @server_default false
61+
*/
62+
allow_partial_results?: boolean
5863
}
5964
/**
6065
* Use the `query` element to start a query. Use `time_zone` to specify an execution time zone and `columnar` to format the answer.

0 commit comments

Comments
 (0)