Skip to content

Commit 2ffd5a3

Browse files
lcawlswallez
authored andcommitted
Add descriptions for component templates (#2155)
1 parent 6350fe4 commit 2ffd5a3

File tree

6 files changed

+140
-75
lines changed

6 files changed

+140
-75
lines changed

output/schema/schema.json

Lines changed: 62 additions & 54 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 & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,13 @@ import { Names } from '@_types/common'
2222
import { Duration } from '@_types/Time'
2323

2424
/**
25+
* Deletes component templates.
26+
* Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
2527
* @rest_spec_name cluster.delete_component_template
2628
* @availability stack since=7.8.0 stability=stable
2729
* @availability serverless stability=stable visibility=public
2830
* @doc_id indices-component-template
29-
* @cluster_privileges manage_index_templates,manage
31+
* @cluster_privileges manage_index_templates
3032
*/
3133
export interface Request extends RequestBase {
3234
path_parts: {
@@ -36,9 +38,17 @@ export interface Request extends RequestBase {
3638
name: Names
3739
}
3840
query_parameters: {
39-
/** @server_default 30s */
41+
/**
42+
* Period to wait for a connection to the master node.
43+
* If no response is received before the timeout expires, the request fails and returns an error.
44+
* @server_default 30s
45+
*/
4046
master_timeout?: Duration
41-
/** @server_default 30s */
47+
/**
48+
* Period to wait for a response.
49+
* If no response is received before the timeout expires, the request fails and returns an error.
50+
* @server_default 30s
51+
*/
4252
timeout?: Duration
4353
}
4454
}

specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,27 +22,44 @@ import { Name } from '@_types/common'
2222
import { Duration } from '@_types/Time'
2323

2424
/**
25+
* Retrieves information about component templates.
2526
* @rest_spec_name cluster.get_component_template
2627
* @availability stack since=7.8.0 stability=stable
2728
* @availability serverless stability=stable visibility=public
29+
* @cluster_privileges manage_index_templates
2830
* @doc_id indices-component-template
2931
*/
3032
export interface Request extends RequestBase {
3133
path_parts: {
34+
/**
35+
* Comma-separated list of component template names used to limit the request.
36+
* Wildcard (`*`) expressions are supported.
37+
*/
3238
name?: Name
3339
}
3440
query_parameters: {
35-
/** @server_default false */
41+
/**
42+
* If `true`, returns settings in flat format.
43+
* @server_default false
44+
*/
3645
flat_settings?: boolean
37-
/** @server_default false */
38-
local?: boolean
39-
/** @server_default 30s */
40-
master_timeout?: Duration
4146
/**
4247
* @server_default false
4348
* @availability stack since=8.8.0 stability=experimental
4449
* @availability serverless stability=experimental
4550
*/
4651
include_defaults?: boolean
52+
/**
53+
* If `true`, the request retrieves information from the local node only.
54+
* If `false`, information is retrieved from the master node.
55+
* @server_default false
56+
*/
57+
local?: boolean
58+
/**
59+
* Period to wait for a connection to the master node.
60+
* If no response is received before the timeout expires, the request fails and returns an error.
61+
* @server_default 30s
62+
*/
63+
master_timeout?: Duration
4764
}
4865
}

0 commit comments

Comments
 (0)