Skip to content

Add descriptions for component templates #2155

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
Jun 28, 2023
Merged

Add descriptions for component templates #2155

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
da7580f
Add descriptions for component templates
lcawl Jun 26, 2023
fa38fd4
Generate output
lcawl Jun 26, 2023
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
116 changes: 62 additions & 54 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.

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

16 changes: 13 additions & 3 deletions specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,13 @@ import { Names } from '@_types/common'
import { Duration } from '@_types/Time'

/**
* Deletes component templates.
* Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
* @rest_spec_name cluster.delete_component_template
* @availability stack since=7.8.0 stability=stable
* @availability serverless stability=stable visibility=public
* @doc_id indices-component-template
* @cluster_privileges manage_index_templates,manage
* @cluster_privileges manage_index_templates
*/
export interface Request extends RequestBase {
path_parts: {
Expand All @@ -36,9 +38,17 @@ export interface Request extends RequestBase {
name: Names
}
query_parameters: {
/** @server_default 30s */
/**
* Period to wait for a connection to the master node.
* If no response is received before the timeout expires, the request fails and returns an error.
* @server_default 30s
*/
master_timeout?: Duration
/** @server_default 30s */
/**
* Period to wait for a response.
* If no response is received before the timeout expires, the request fails and returns an error.
* @server_default 30s
*/
timeout?: Duration
}
}
27 changes: 22 additions & 5 deletions specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,27 +22,44 @@ import { Name } from '@_types/common'
import { Duration } from '@_types/Time'

/**
* Retrieves information about component templates.
* @rest_spec_name cluster.get_component_template
* @availability stack since=7.8.0 stability=stable
* @availability serverless stability=stable visibility=public
* @cluster_privileges manage_index_templates
* @doc_id indices-component-template
*/
export interface Request extends RequestBase {
path_parts: {
/**
* Comma-separated list of component template names used to limit the request.
* Wildcard (`*`) expressions are supported.
*/
name?: Name
}
query_parameters: {
/** @server_default false */
/**
* If `true`, returns settings in flat format.
* @server_default false
*/
flat_settings?: boolean
/** @server_default false */
local?: boolean
/** @server_default 30s */
master_timeout?: Duration
/**
* @server_default false
* @availability stack since=8.8.0 stability=experimental
* @availability serverless stability=experimental
*/
include_defaults?: boolean
/**
* If `true`, the request retrieves information from the local node only.
* If `false`, information is retrieved from the master node.
* @server_default false
*/
local?: boolean
/**
* Period to wait for a connection to the master node.
* If no response is received before the timeout expires, the request fails and returns an error.
* @server_default 30s
*/
master_timeout?: Duration
}
}
Loading