Skip to content

Commit a2369a3

Browse files
committed
Fix and expand deprecation information (#5620)
* Fix and expand deprecation information * Add reasons (cherry picked from commit ca670c5) # Conflicts: # specification/_global/delete_by_query/DeleteByQueryRequest.ts # specification/cluster/state/ClusterStateRequest.ts
1 parent 00a7a36 commit a2369a3

File tree

10 files changed

+19
-2
lines changed

10 files changed

+19
-2
lines changed

specification/_global/delete_by_query/DeleteByQueryRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,7 @@ export interface Request extends RequestBase {
258258
slices?: Slices
259259
/**
260260
* A comma-separated list of `<field>:<direction>` pairs.
261+
* @deprecated 9.0.0 This query parameter is not supported and will be removed in a future version
261262
*/
262263
sort?: string[]
263264
/**

specification/_global/msearch/MultiSearchRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ export interface Request extends RequestBase {
8181
expand_wildcards?: ExpandWildcards
8282
/**
8383
* If true, concrete, expanded or aliased indices are ignored when frozen.
84+
* @deprecated 7.16.0 This parameter is deprecated because frozen indices have been deprecated.
8485
* @server_default false
8586
*/
8687
ignore_throttled?: boolean

specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ export interface Request extends RequestBase {
5555
/**
5656
* If true, the request retrieves information from the local node only.
5757
* Defaults to false, which means information is retrieved from the master node.
58+
* @deprecated 9.0.0 This parameter has no effect, is now deprecated, and will be removed in a future version.
5859
* @server_default false
5960
*/
6061
local?: boolean

specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ export interface Request extends RequestBase {
6868
/**
6969
* If `true`, the request retrieves information from the local node only.
7070
* If `false`, information is retrieved from the master node.
71+
* @deprecated 9.0.0 This parameter has no effect, is now deprecated, and will be removed in a future version.
7172
* @server_default false
7273
*/
7374
local?: boolean

specification/cluster/state/ClusterStateRequest.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,15 @@ export interface Request extends RequestBase {
7979
flat_settings?: boolean
8080
/** @server_default false */
8181
ignore_unavailable?: boolean
82-
/** @server_default false */
82+
/**
83+
* @deprecated 9.0.0 This parameter has no effect, is now deprecated, and will be removed in a future version.
84+
* @server_default false
85+
*/
8386
local?: boolean
84-
/** @server_default 30s */
87+
/**
88+
* Timeout for waiting for new cluster state in case it is blocked
89+
* @server_default 30s
90+
* */
8591
master_timeout?: Duration
8692
wait_for_metadata_version?: VersionNumber
8793
wait_for_timeout?: Duration

specification/indices/exists_template/IndicesExistsTemplateRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ export interface Request extends RequestBase {
5555
flat_settings?: boolean
5656
/**
5757
* Indicates whether to get information from the local node only.
58+
* @deprecated 9.0.0 This parameter has no effect, is now deprecated, and will be removed in a future version.
5859
* @server_default false
5960
*/
6061
local?: boolean

specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ export interface Request extends RequestBase {
4848
query_parameters: {
4949
/**
5050
* If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
51+
* @deprecated 9.0.0 This parameter has no effect, is now deprecated, and will be removed in a future version.
5152
* @server_default false
5253
*/
5354
local?: boolean

specification/indices/get_settings/IndicesGetSettingsRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ export interface Request extends RequestBase {
9797
/**
9898
* If `true`, the request retrieves information from the local node only. If
9999
* `false`, information is retrieved from the master node.
100+
* @deprecated 9.1.0 This parameter is a no-op and settings are always retrieved locally.
100101
* @server_default false
101102
*/
102103
local?: boolean

specification/indices/get_template/IndicesGetTemplateRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ export interface Request extends RequestBase {
6060
flat_settings?: boolean
6161
/**
6262
* If `true`, the request retrieves information from the local node only.
63+
* @deprecated 9.0.0 This parameter is a no-op and templates are always retrieved locally.
6364
* @server_default false
6465
*/
6566
local?: boolean

specification/xpack/info/XPackInfoRequest.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ export interface Request extends RequestBase {
4545
* For example, `build,license,features`.
4646
*/
4747
categories?: XPackCategory[]
48+
/**
49+
* @deprecated 8.0.0 Supported for backwards compatibility with 7.x
50+
*/
4851
accept_enterprise?: boolean
4952
/**
5053
* Defines whether additional human-readable information is included in the response.

0 commit comments

Comments
 (0)