diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index a7cb17184e..c140dbf824 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -199,6 +199,15 @@ actions: examples: resumeFollowIndexResponseExample1: $ref: "../../specification/ccr/resume_follow/examples/response/ResumeFollowIndexResponseExample1.yaml" +## Examples for cluster + - target: "$.components['requestBodies']['cluster.allocation_explain']" + description: "Add example for cluster allocation exaplain request" + update: + content: + application/json: + examples: + clusterAllocationExplainRequestExample1: + $ref: "../../specification/cluster/allocation_explain/examples/request/ClusterAllocationExplainRequestExample1.yaml" - target: "$.paths['/{index}/_ccr/unfollow']['post']" description: "Add examples for unfollow an index" update: @@ -315,6 +324,8 @@ actions: examples: clusterPutSettingsRequestExample1: $ref: "../../specification/cluster/put_settings/examples/request/ClusterPutSettingsRequestExample1.yaml" + clusterPutSettingsRequestExample2: + $ref: "../../specification/cluster/put_settings/examples/request/ClusterPutSettingsRequestExample2.yaml" - target: "$.paths['/_cluster/reroute']['post']" description: "Add examples for cluster reroute operation" update: diff --git a/output/schema/schema.json b/output/schema/schema.json index 6c9d39c2dd..2e3c404085 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -2321,6 +2321,7 @@ }, "description": "Explain the shard allocations.\nGet explanations for shard allocations in the cluster.\nFor unassigned shards, it provides an explanation for why the shard is unassigned.\nFor assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node.\nThis API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.", "docId": "cluster-allocation-explain", + "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-allocation-explain.html", "name": "cluster.allocation_explain", "request": { @@ -2560,7 +2561,7 @@ "stability": "stable" } }, - "description": "Get the cluster health status.\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status.", + "description": "Get the cluster health status.\n\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status.", "docId": "cluster-health", "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-health.html", @@ -2764,7 +2765,7 @@ "stability": "stable" } }, - "description": "Update the cluster settings.\nConfigure and update dynamic settings on a running cluster.\nYou can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.\n\nUpdates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.\nYou can also reset transient or persistent settings by assigning them a null value.\n\nIf you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value.\nFor example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting.\nHowever, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.\n\nTIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster.\nIf you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings.\nOnly use `elasticsearch.yml` for static cluster settings and node settings.\nThe API doesn’t require a restart and ensures a setting’s value is the same on all nodes.\n\nWARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead.\nIf a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.", + "description": "Update the cluster settings.\n\nConfigure and update dynamic settings on a running cluster.\nYou can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.\n\nUpdates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.\nYou can also reset transient or persistent settings by assigning them a null value.\n\nIf you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value.\nFor example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting.\nHowever, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.\n\nTIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster.\nIf you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings.\nOnly use `elasticsearch.yml` for static cluster settings and node settings.\nThe API doesn’t require a restart and ensures a setting’s value is the same on all nodes.\n\nWARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead.\nIf a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.", "docId": "cluster-update-settings", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-update-settings.html", "name": "cluster.put_settings", @@ -109795,7 +109796,7 @@ } } ], - "specLocation": "cluster/allocation_explain/ClusterAllocationExplainRequest.ts#L25-L78" + "specLocation": "cluster/allocation_explain/ClusterAllocationExplainRequest.ts#L25-L79" }, { "kind": "interface", @@ -111193,7 +111194,7 @@ "body": { "kind": "no_body" }, - "description": "Get the cluster health status.\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status.", + "description": "Get the cluster health status.\n\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status.", "inherits": { "type": { "name": "RequestBase", @@ -111371,7 +111372,7 @@ } } ], - "specLocation": "cluster/health/ClusterHealthRequest.ts#L32-L117" + "specLocation": "cluster/health/ClusterHealthRequest.ts#L32-L118" }, { "kind": "response", @@ -112040,7 +112041,7 @@ } ] }, - "description": "Update the cluster settings.\nConfigure and update dynamic settings on a running cluster.\nYou can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.\n\nUpdates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.\nYou can also reset transient or persistent settings by assigning them a null value.\n\nIf you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value.\nFor example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting.\nHowever, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.\n\nTIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster.\nIf you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings.\nOnly use `elasticsearch.yml` for static cluster settings and node settings.\nThe API doesn’t require a restart and ensures a setting’s value is the same on all nodes.\n\nWARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead.\nIf a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.", + "description": "Update the cluster settings.\n\nConfigure and update dynamic settings on a running cluster.\nYou can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.\n\nUpdates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.\nYou can also reset transient or persistent settings by assigning them a null value.\n\nIf you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value.\nFor example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting.\nHowever, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.\n\nTIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster.\nIf you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings.\nOnly use `elasticsearch.yml` for static cluster settings and node settings.\nThe API doesn’t require a restart and ensures a setting’s value is the same on all nodes.\n\nWARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead.\nIf a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.", "inherits": { "type": { "name": "RequestBase", @@ -112092,7 +112093,7 @@ } } ], - "specLocation": "cluster/put_settings/ClusterPutSettingsRequest.ts#L25-L67" + "specLocation": "cluster/put_settings/ClusterPutSettingsRequest.ts#L25-L68" }, { "kind": "response", diff --git a/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts b/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts index aa81c369d8..6e7deb0a83 100644 --- a/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts +++ b/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts @@ -32,6 +32,7 @@ import { Duration } from '@_types/Time' * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=private * @doc_id cluster-allocation-explain + * @doc_tag cluster */ export interface Request extends RequestBase { urls: [ diff --git a/specification/cluster/health/ClusterHealthRequest.ts b/specification/cluster/health/ClusterHealthRequest.ts index 71c465980b..6ca1253684 100644 --- a/specification/cluster/health/ClusterHealthRequest.ts +++ b/specification/cluster/health/ClusterHealthRequest.ts @@ -31,6 +31,7 @@ import { Duration } from '@_types/Time' /** * Get the cluster health status. + * * You can also use the API to get the health status of only specified data streams and indices. * For data streams, the API retrieves the health status of the stream’s backing indices. * diff --git a/specification/cluster/put_settings/ClusterPutSettingsRequest.ts b/specification/cluster/put_settings/ClusterPutSettingsRequest.ts index 8f8e406bb6..24cffee141 100644 --- a/specification/cluster/put_settings/ClusterPutSettingsRequest.ts +++ b/specification/cluster/put_settings/ClusterPutSettingsRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * Update the cluster settings. + * * Configure and update dynamic settings on a running cluster. * You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`. *