Skip to content

Add since and method_request to data stream settings #4492

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 17 additions & 3 deletions output/openapi/elasticsearch-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 15 additions & 2 deletions output/openapi/elasticsearch-serverless-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 10 additions & 3 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@ import { Duration } from '@_types/Time'

/**
* Get cluster-wide settings.
*
* By default, it returns only settings that have been explicitly defined.
* @rest_spec_name cluster.get_settings
* @availability stack stability=stable
* @availability stack since=9.1.0 stability=stable
* @availability serverless stability=stable visibility=private
* @cluster_privileges monitor
* @doc_id cluster-get-settings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: >
`effective_settings` field shows additional settings that are pulled from its template.
# type: response
# response_code: 200
method_request: GET /_data_stream/my-data-stream/_settings
value: |-
{
"data_streams": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import { IndexSettings } from '@indices/_types/IndexSettings'
* only certain settings are allowed. If possible, the setting change is applied to all
* backing indices. Otherwise, it will be applied when the data stream is next rolled over.
* @rest_spec_name indices.put_data_stream_settings
* @availability stack stability=stable visibility=public
* @availability stack since=9.1.0 stability=stable visibility=public
* @availability serverless stability=stable visibility=public
* @index_privileges manage
* @doc_id indices-put-data-stream-settings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: >
the write index on rollover. The setting `index.lifecycle.name` is applied to the data stream and all backing indices.
# type: response
# response_code: 200
method_request: PUT /_data_stream/my-data-stream/_settings
value: |-
{
"data_streams": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: >
reports that the setting was not successfully applied to that index.
# type: response
# response_code: 200
method_request: PUT /_data_stream/my-data-stream/_settings
value: |-
{
"data_streams": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: >
not allowed on a data stream. As a result, no change was applied to the data stream.
# type: response
# response_code: 200
method_request: PUT /_data_stream/my-data-stream/_settings
value: |-
{
"data_streams": [
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
summary: Change a data stream setting
# method_request: PUT /_data_stream/my-data-stream/_settings
method_request: PUT /_data_stream/my-data-stream/_settings
description: >
This is a request to change two settings on a data stream.
# type: request
Expand Down