diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 5d448233b1..e3c3f834c8 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -16968,7 +16968,13 @@ } } }, - "x-state": "Generally available" + "x-state": "Generally available; Added in 9.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_data_stream/my-data-stream/_settings\n" + } + ] }, "put": { "tags": [ @@ -17077,7 +17083,13 @@ } } }, - "x-state": "Generally available" + "x-state": "Generally available; Added in 9.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT /_data_stream/my-data-stream/_settings\n{\n \"index.lifecycle.name\" : \"new-test-policy\",\n \"index.number_of_shards\": 11\n}" + } + ] } }, "/_mapping/field/{fields}": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index b4d771eb84..8d4e4aca76 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -9120,7 +9120,13 @@ } } }, - "x-state": "Generally available" + "x-state": "Generally available", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_data_stream/my-data-stream/_settings\n" + } + ] }, "put": { "tags": [ @@ -9229,7 +9235,13 @@ } } }, - "x-state": "Generally available" + "x-state": "Generally available", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT /_data_stream/my-data-stream/_settings\n{\n \"index.lifecycle.name\" : \"new-test-policy\",\n \"index.number_of_shards\": 11\n}" + } + ] } }, "/_index_template": { diff --git a/output/schema/schema.json b/output/schema/schema.json index 00f9daab15..0356a7cab9 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -2520,7 +2520,7 @@ "stability": "stable" } }, - "description": "Get cluster-wide settings.\nBy default, it returns only settings that have been explicitly defined.", + "description": "Get cluster-wide settings.\n\nBy default, it returns only settings that have been explicitly defined.", "docId": "cluster-get-settings", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings", "extDocId": "stack-settings", @@ -7790,6 +7790,7 @@ "visibility": "public" }, "stack": { + "since": "9.1.0", "stability": "stable", "visibility": "public" } @@ -8429,6 +8430,7 @@ "visibility": "public" }, "stack": { + "since": "9.1.0", "stability": "stable", "visibility": "public" } @@ -115457,7 +115459,7 @@ "body": { "kind": "no_body" }, - "description": "Get cluster-wide settings.\nBy default, it returns only settings that have been explicitly defined.", + "description": "Get cluster-wide settings.\n\nBy default, it returns only settings that have been explicitly defined.", "examples": { "ClusterGetSettingsExample1": { "method_request": "GET /_cluster/settings?filter_path=persistent.cluster.remote" @@ -115528,7 +115530,7 @@ } } ], - "specLocation": "cluster/get_settings/ClusterGetSettingsRequest.ts#L23-L64" + "specLocation": "cluster/get_settings/ClusterGetSettingsRequest.ts#L23-L65" }, { "kind": "response", @@ -145280,6 +145282,11 @@ "kind": "no_body" }, "description": "Get data stream settings.\n\nGet setting information for one or more data streams.", + "examples": { + "IndicesGetDataStreamSettingsRequestExample1": { + "method_request": "GET /_data_stream/my-data-stream/_settings" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -147534,6 +147541,7 @@ "examples": { "IndicesPutDataStreamSettingsRequestExample1": { "description": "This is a request to change two settings on a data stream.\n", + "method_request": "PUT /_data_stream/my-data-stream/_settings", "summary": "Change a data stream setting", "value": "{\n \"index.lifecycle.name\" : \"new-test-policy\",\n \"index.number_of_shards\": 11\n}" } diff --git a/specification/cluster/get_settings/ClusterGetSettingsRequest.ts b/specification/cluster/get_settings/ClusterGetSettingsRequest.ts index cb1c176f44..3412b4675c 100644 --- a/specification/cluster/get_settings/ClusterGetSettingsRequest.ts +++ b/specification/cluster/get_settings/ClusterGetSettingsRequest.ts @@ -22,6 +22,7 @@ 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 diff --git a/specification/indices/get_data_stream_settings/IndicesGetDataStreamSettingsRequest.ts b/specification/indices/get_data_stream_settings/IndicesGetDataStreamSettingsRequest.ts index ed09b3bd04..db07d90880 100644 --- a/specification/indices/get_data_stream_settings/IndicesGetDataStreamSettingsRequest.ts +++ b/specification/indices/get_data_stream_settings/IndicesGetDataStreamSettingsRequest.ts @@ -26,7 +26,7 @@ import { Duration } from '@_types/Time' * * Get setting information for one or more data streams. * @rest_spec_name indices.get_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 view_index_metadata * @doc_id indices-get-data-stream-settings diff --git a/specification/indices/get_data_stream_settings/examples/request/IndicesGetDataStreamSettingsRequestExample1.yaml b/specification/indices/get_data_stream_settings/examples/request/IndicesGetDataStreamSettingsRequestExample1.yaml new file mode 100644 index 0000000000..851227fe07 --- /dev/null +++ b/specification/indices/get_data_stream_settings/examples/request/IndicesGetDataStreamSettingsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_data_stream/my-data-stream/_settings diff --git a/specification/indices/put_data_stream_settings/IndicesPutDataStreamSettingsRequest.ts b/specification/indices/put_data_stream_settings/IndicesPutDataStreamSettingsRequest.ts index 3eb1e02b06..c09dcda447 100644 --- a/specification/indices/put_data_stream_settings/IndicesPutDataStreamSettingsRequest.ts +++ b/specification/indices/put_data_stream_settings/IndicesPutDataStreamSettingsRequest.ts @@ -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 diff --git a/specification/indices/put_data_stream_settings/examples/request/IndicesPutDataStreamSettingsRequestExample1.yaml b/specification/indices/put_data_stream_settings/examples/request/IndicesPutDataStreamSettingsRequestExample1.yaml index 15331dc534..cb15d12db5 100644 --- a/specification/indices/put_data_stream_settings/examples/request/IndicesPutDataStreamSettingsRequestExample1.yaml +++ b/specification/indices/put_data_stream_settings/examples/request/IndicesPutDataStreamSettingsRequestExample1.yaml @@ -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