diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index aa3bc92229..0f231a85a7 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -62,26 +62,139 @@ actions: - basicAuth: [] - bearerAuth: [] # Examples that apply only to the Elasticsearch OpenAPI document - - target: "$.paths['/_features']['get']" - description: "Add examples for get features operation" +## Examples for autoscaling + - target: "$.paths['/_autoscaling/policy/{name}']['delete']" + description: "Add examples for delete autoscaling policy response" update: responses: 200: content: application/json: examples: - getFeaturesResponseExample1: - $ref: "../../specification/features/get_features/examples/response/GetFeaturesResponseExample1.yaml" - - target: "$.paths['/_features/_reset']['post']" - description: "Add examples for reset features operation" + deleteAutoscalingPolicyResponseExample1: + $ref: "../../specification/autoscaling/delete_autoscaling_policy/examples/response/DeleteAutoscalingPolicyResponseExample1.yaml" + - target: "$.paths['/_autoscaling/capacity']['get']" + description: "Add examples for get autoscaling capacity response" update: responses: 200: content: application/json: examples: - resetFeaturesResponseExample1: - $ref: "../../specification/features/reset_features/examples/response/ResetFeaturesResponseExample1.yaml" + getAutoscalingCapacityResponseExample1: + $ref: "../../specification/autoscaling/get_autoscaling_capacity/examples/200_response/GetAutoscalingCapacityResponseExample1.yaml" + - target: "$.paths['/_autoscaling/policy/{name}']['get']" + description: "Add examples for get autoscaling policy response" + update: + responses: + 200: + content: + application/json: + examples: + getAutoscalingPolicyResponseExample1: + $ref: "../../specification/autoscaling/get_autoscaling_policy/examples/200_response/GetAutoscalingPolicyResponseExample1.yaml" + - target: "$.paths['/_autoscaling/policy/{name}']['put']" + description: "Add examples for create autoscaling policy operation" + update: + requestBody: + content: + application/json: + examples: + createAutoscalingPolicyRequestExample1: + $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample1.yaml" + createAutoscalingPolicyRequestExample2: + $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample2.yaml" + responses: + 200: + content: + application/json: + examples: + createAutoscalingPolicyResponseExample1: + $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/200_response/PutAutoscalingPolicyResponseExample1.yaml" +## Examples for behavioral analytics + - target: "$.paths['/_application/analytics/{collection_name}/event/{event_type}']['post']" + description: "Add examples for post analytics collection event operation" + update: + requestBody: + content: + application/json: + examples: + postBehavioralAnalyticsEventRequestExample1: + $ref: "../../specification/search_application/post_behavioral_analytics_event/examples/request/BehavioralAnalyticsEventPostRequestExample1.yaml" +## Examples for ccr + - target: "$.paths['/{index}/_ccr/follow']['put']" + description: "Add examples for create follower operation" + update: + requestBody: + content: + application/json: + examples: + createFollowIndexRequestExample1: + $ref: "../../specification/ccr/follow/examples/request/CreateFollowIndexRequestExample1.yaml" + responses: + 200: + content: + application/json: + examples: + createFollowIndexResponseExample1: + $ref: "../../specification/ccr/follow/examples/response/CreateFollowIndexResponseExample1.yaml" + - target: "$.paths['/{index}/_ccr/forget_follower']['post']" + description: "Add examples for forget follower operation" + update: + requestBody: + content: + application/json: + examples: + createFollowIndexRequestExample1: + $ref: "../../specification/ccr/forget_follower/examples/request/ForgetFollowerIndexRequestExample1.yaml" + responses: + 200: + content: + application/json: + examples: + createFollowIndexResponseExample1: + $ref: "../../specification/ccr/forget_follower/examples/response/ForgetFollowerIndexResponseExample1.yaml" + - target: "$.paths['/_ccr/auto_follow/{name}']['put']" + description: "Add examples for create auto-follow pattern operation" + update: + requestBody: + content: + application/json: + examples: + putAutoFollowPatternRequestExample1: + $ref: "../../specification/ccr/put_auto_follow_pattern/examples/request/PutAutoFollowPatternRequestExample1.yaml" + responses: + 200: + content: + application/json: + examples: + putAutoFollowPatternResponseExample1: + $ref: "../../specification/ccr/put_auto_follow_pattern/examples/response/PutAutoFollowPatternResponseExample1.yaml" + - target: "$.paths['/{index}/_ccr/resume_follow']['post']" + description: "Add examples for resume a follower operation" + update: + requestBody: + content: + application/json: + examples: + resumeFollowIndexRequestExample1: + $ref: "../../specification/ccr/resume_follow/examples/request/ResumeFollowIndexRequestExample1.yaml" + responses: + 200: + content: + application/json: + 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: "$.components['requestBodies']['cluster.allocation_explain']" description: "Add examples for cluster allocation explain operation" update: @@ -107,6 +220,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: @@ -132,16 +247,6 @@ actions: examples: clusterNodesReloadSecureSettingsResponseExample1: $ref: "../../specification/nodes/reload_secure_settings/examples/response/ReloadSecureSettingsResponseExample1.yaml" - - target: "$.paths['/_tasks']['get']" - description: "Add examples for task management operation" - update: - responses: - 200: - content: - application/json: - examples: - getTasksResponseExample1: - $ref: "../../specification/tasks/get/examples/200_response/GetTaskResponseExample1.yaml" - target: "$.components['responses']['nodes.info#200']" description: "Add response examples for nodes info" update: @@ -150,6 +255,38 @@ actions: examples: nodesInfoResponseExample1: $ref: "../../specification/nodes/info/examples/200_response/nodesInfoResponseExample1.yaml" +## Examples for esql + - target: "$.paths['/_query/async']['post']" + description: "Add examples for async esql query operation" + update: + requestBody: + content: + application/json: + examples: + esqlAsyncQueryRequestExample1: + $ref: "../../specification/esql/async_query/examples/request/AsyncQueryRequestExample1.yaml" +## Examples for features + - target: "$.paths['/_features']['get']" + description: "Add examples for get features operation" + update: + responses: + 200: + content: + application/json: + examples: + getFeaturesResponseExample1: + $ref: "../../specification/features/get_features/examples/response/GetFeaturesResponseExample1.yaml" + - target: "$.paths['/_features/_reset']['post']" + description: "Add examples for reset features operation" + update: + responses: + 200: + content: + application/json: + examples: + resetFeaturesResponseExample1: + $ref: "../../specification/features/reset_features/examples/response/ResetFeaturesResponseExample1.yaml" +## Examples for ilm - target: "$.paths['/_ilm/policy/{policy}']['delete']" description: "Add examples for delete lifecycle policy operation" update: @@ -268,6 +405,17 @@ actions: examples: removePolicyResponseExample1: $ref: "../../specification/ilm/remove_policy/examples/response/RemovePolicyResponseExample1.yaml" +## Examples for indices + - target: "$.paths['/_lifecycle/stats']['get']" + description: "Add examples for get lifecycle stats operation" + update: + responses: + 200: + content: + application/json: + examples: + dataStreamLifecycleStatsResponseExample1: + $ref: "../../specification/indices/get_data_lifecycle_stats/examples/response/IndicesGetDataLifecycleStatsResponseExample1.yaml" - target: "$.components['requestBodies']['indices.clone']" description: "Add examples for clone index request" update: @@ -304,54 +452,6 @@ actions: examples: indicesOpenResponseExample1: $ref: "../../specification/indices/open/examples/200_response/indicesOpenResponseExample1.yaml" - - target: "$.paths['/_autoscaling/policy/{name}']['delete']" - description: "Add examples for delete autoscaling policy response" - update: - responses: - 200: - content: - application/json: - examples: - deleteAutoscalingPolicyResponseExample1: - $ref: "../../specification/autoscaling/delete_autoscaling_policy/examples/response/DeleteAutoscalingPolicyResponseExample1.yaml" - - target: "$.paths['/_autoscaling/capacity']['get']" - description: "Add examples for get autoscaling capacity response" - update: - responses: - 200: - content: - application/json: - examples: - getAutoscalingCapacityResponseExample1: - $ref: "../../specification/autoscaling/get_autoscaling_capacity/examples/200_response/GetAutoscalingCapacityResponseExample1.yaml" - - target: "$.paths['/_autoscaling/policy/{name}']['get']" - description: "Add examples for get autoscaling policy response" - update: - responses: - 200: - content: - application/json: - examples: - getAutoscalingPolicyResponseExample1: - $ref: "../../specification/autoscaling/get_autoscaling_policy/examples/200_response/GetAutoscalingPolicyResponseExample1.yaml" - - target: "$.paths['/_autoscaling/policy/{name}']['put']" - description: "Add examples for create autoscaling policy operation" - update: - requestBody: - content: - application/json: - examples: - createAutoscalingPolicyRequestExample1: - $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample1.yaml" - createAutoscalingPolicyRequestExample2: - $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample2.yaml" - responses: - 200: - content: - application/json: - examples: - createAutoscalingPolicyResponseExample1: - $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/200_response/PutAutoscalingPolicyResponseExample1.yaml" - target: "$.components['responses']['indices.recovery#200']" description: "Add example for get index recovery response" update: @@ -394,37 +494,15 @@ actions: examples: indicesLegacyPutTemplateRequestExample1: $ref: "../../specification/indices/put_template/examples/request/indicesPutTemplateRequestExample1.yaml" -## Examples for behavioral analytics - - target: "$.paths['/_application/analytics/{collection_name}/event/{event_type}']['post']" - description: "Add examples for post analytics collection event operation" - update: - requestBody: - content: - application/json: - examples: - postBehavioralAnalyticsEventRequestExample1: - $ref: "../../specification/search_application/post_behavioral_analytics_event/examples/request/BehavioralAnalyticsEventPostRequestExample1.yaml" -## Examples for esql - - target: "$.paths['/_query/async']['post']" - description: "Add examples for async esql query operation" - update: - requestBody: - content: - application/json: - examples: - esqlAsyncQueryRequestExample1: - $ref: "../../specification/esql/async_query/examples/request/AsyncQueryRequestExample1.yaml" -## Examples for indices - - target: "$.paths['/_lifecycle/stats']['get']" - description: "Add examples for get lifecycle stats operation" +## Examples for inference + - target: "$.components['requestBodies']['inference.stream_inference']" + description: "Add example for inference stream request" update: - responses: - 200: - content: - application/json: - examples: - dataStreamLifecycleStatsResponseExample1: - $ref: "../../specification/indices/get_data_lifecycle_stats/examples/response/IndicesGetDataLifecycleStatsResponseExample1.yaml" + content: + application/json: + examples: + streamInferenceRequestExample1: + $ref: "../../specification/inference/stream_inference/examples/request/StreamInferenceRequestExample1.yaml" ## Examples for ingest - target: "$.components['requestBodies']['simulate.ingest']" description: "Add example for simulate ingest request" @@ -519,7 +597,7 @@ actions: examples: renderSearchApplicationQueryRequestExample1: $ref: "../../specification/search_application/render_query/examples/request/SearchApplicationsRenderQueryRequestExample1.yaml" -# Examples for security +## Examples for security - target: "$.paths['/_security/api_key/_bulk_update']['post']" description: "Add examples for bulk update API keys operation" update: @@ -554,6 +632,17 @@ actions: examples: delegatePkiResponseExample1: $ref: "../../specification/security/delegate_pki/examples/200_response/SecurityDelegatePkiResponseExample1.yaml" +## Examples for tasks + - target: "$.paths['/_tasks']['get']" + description: "Add examples for task management operation" + update: + responses: + 200: + content: + application/json: + examples: + getTasksResponseExample1: + $ref: "../../specification/tasks/get/examples/200_response/GetTaskResponseExample1.yaml" ## Examples for watcher - target: "$.paths['/_watcher/settings']['put']" description: "Add request example for update watcher settings" @@ -574,12 +663,4 @@ actions: examples: updateWatcherSettingsRequestExample1: $ref: "../../specification/watcher/get_settings/examples/200_response/WatcherGetSettingsResponseExample1.yaml" -## Examples for inference - - target: "$.components['requestBodies']['inference.stream_inference']" - description: "Add example for inference stream request" - update: - content: - application/json: - examples: - streamInferenceRequestExample1: - $ref: "../../specification/inference/stream_inference/examples/request/StreamInferenceRequestExample1.yaml" + diff --git a/output/schema/schema.json b/output/schema/schema.json index aa61c998a5..9d17106ef2 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -2271,6 +2271,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": { @@ -2510,7 +2511,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", @@ -2714,7 +2715,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", @@ -108837,7 +108838,7 @@ } } ], - "specLocation": "cluster/allocation_explain/ClusterAllocationExplainRequest.ts#L25-L78" + "specLocation": "cluster/allocation_explain/ClusterAllocationExplainRequest.ts#L25-L79" }, { "kind": "interface", @@ -110235,7 +110236,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", @@ -110413,7 +110414,7 @@ } } ], - "specLocation": "cluster/health/ClusterHealthRequest.ts#L32-L117" + "specLocation": "cluster/health/ClusterHealthRequest.ts#L32-L118" }, { "kind": "response", @@ -111082,7 +111083,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", @@ -111134,7 +111135,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`. *