Add markers for cluster APIs. #9110
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| --- | ||
| layout: default | ||
| title: Cluster component template | ||
| nav_order: 25 | ||
| parent: Cluster APIs | ||
| --- | ||
|
|
||
| # Cluster component template | ||
| **Introduced 1.0** | ||
| {: .label .label-purple } | ||
|
|
||
| The Cluster component template APIs creates and updates the cluster's component templates | ||
Naarcha-AWS marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| # Endpoints | ||
|
|
||
| The `GET` method returns one or more component templates. | ||
Naarcha-AWS marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <!-- spec_insert_start | ||
| api: cluster.get_component_template | ||
| component: endpoints | ||
| omit_header: true | ||
| --> | ||
| ```json | ||
| GET /_component_template | ||
| GET /_component_template/{name} | ||
| ``` | ||
| <!-- spec_insert_end --> | ||
|
|
||
| The `EXISTS` method returns information about whether a particular component template exist. | ||
Naarcha-AWS marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <!-- spec_insert_start | ||
| api: cluster.exists_component_template | ||
| component: endpoints | ||
| omit_header: true | ||
| --> | ||
| ```json | ||
| HEAD /_component_template/{name} | ||
| ``` | ||
| <!-- spec_insert_end --> | ||
|
|
||
| The `PUT` method creates or updates a component template. | ||
Naarcha-AWS marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <!-- spec_insert_start | ||
| api: cluster.put_component_template | ||
| component: endpoints | ||
| omit_header: true | ||
| --> | ||
| ```json | ||
| POST /_component_template/{name} | ||
| PUT /_component_template/{name} | ||
| ``` | ||
| <!-- spec_insert_end --> | ||
|
|
||
| The `DELETE` method deletes a component template. | ||
Naarcha-AWS marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <!-- spec_insert_start | ||
| api: cluster.delete_component_template | ||
| component: endpoints | ||
| omit_header: true | ||
| --> | ||
| ```json | ||
| DELETE /_component_template/{name} | ||
| ``` | ||
| <!-- spec_insert_end --> | ||
|
|
||
| <!-- spec_insert_start | ||
| api: cluster.put_component_template | ||
| component: path_parameters | ||
| --> | ||
| ## Path parameters | ||
|
|
||
| The following table lists the available path parameters. | ||
|
|
||
| | Parameter | Required | Data type | Description | | ||
| | :--- | :--- | :--- | :--- | | ||
| | `name` | **Required** | String | The name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`; `synthetics-mapping`; `synthetics-settings`. OpenSearch uses these templates to configure backing indexes for its data streams. If you want to overwrite one of these templates, set the replacement template `version` to a higher value than the current version. If you want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the Cluster Update Settings API. | | ||
Naarcha-AWS marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <!-- spec_insert_end --> | ||
|
|
||
| <!-- spec_insert_start | ||
| api: cluster.put_component_template | ||
| columns: Parameter, Data type, Description, Default | ||
| include_deprecated: false | ||
| component: query_parameters | ||
| --> | ||
| ## Query parameters | ||
|
|
||
| The following table lists the available query parameters. All query parameters are optional. | ||
|
|
||
| | Parameter | Data type | Description | Default | | ||
| | :--- | :--- | :--- | :--- | | ||
| | `cluster_manager_timeout` | String | A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. | N/A | | ||
|
There was a problem hiding this comment. Several comments on
There was a problem hiding this comment. "Time unit" is not a supported data type, according to the list of supported Data Types for OpenAPI. https://swagger.io/docs/specification/v3_0/data-models/data-types/ Not sure if there's a way to change the Data type manually beyond editing the table directly. That being said, I wouldn't advise it, since "String" matches what's in the API spec. There was a problem hiding this comment. We can keep it as "string" but still change the description and link to the valid units. As is, it's not apparent how one would form a string consisting of a value and units. The valid units link contains examples. |
||
| | `create` | Boolean | When `true`, this request cannot replace or update existing component templates. | `false` | | ||
| | `timeout` | String | A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. | N/A | | ||
|
There was a problem hiding this comment. Same comment as
Naarcha-AWS marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <!-- spec_insert_end --> | ||
|
|
||
| ## Example request | ||
|
|
||
| ```json | ||
| POST /_component_template/logs_template | ||
| { | ||
| "template": { | ||
| "settings": { | ||
| "number_of_shards": 1, | ||
| "number_of_replicas": 1 | ||
| }, | ||
| "mappings": { | ||
| "properties": { | ||
| "timestamp": { | ||
| "type": "date" | ||
| }, | ||
| "message": { | ||
| "type": "text" | ||
| }, | ||
| "level": { | ||
| "type": "keyword" | ||
| }, | ||
| "service": { | ||
| "type": "keyword" | ||
| } | ||
| } | ||
| }, | ||
| "aliases": { | ||
| "logs_alias": {} | ||
| } | ||
| }, | ||
| "version": 1, | ||
| "meta": { | ||
| "description": "Component template for log data" | ||
| } | ||
| } | ||
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| ## Example response | ||
|
|
||
| ```json | ||
| { | ||
| "acknowledged": true | ||
| } | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.