From f1bb1a05a9f991d896d6ac82fee612b88170f1a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 11 Jun 2025 13:10:23 +0200 Subject: [PATCH 1/2] Adds an external link to Cluster allocation explain API spec. --- specification/_doc_ids/table.csv | 1 + .../allocation_explain/ClusterAllocationExplainRequest.ts | 1 + 2 files changed, 2 insertions(+) diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index c5045aff39..4375e62baa 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -87,6 +87,7 @@ clear-repositories-metering-archive-api,https://www.elastic.co/docs/api/doc/elas clear-scroll-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll clear-trained-model,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-clear-trained-model-deployment-cache cluster-allocation-explain,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain +cluster-allocation-explain-examples,https://www.elastic.co/docs/troubleshoot/elasticsearch/cluster-allocation-api-examples cluster-get-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings cluster-health,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health cluster-info,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info diff --git a/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts b/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts index 6e7deb0a83..00340b7979 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 + * @ext_doc_id cluster-allocation-explain-examples * @doc_tag cluster */ export interface Request extends RequestBase { From b6df4658bad7b75daa6c30015322f7b4278c2972 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 11 Jun 2025 15:49:15 +0200 Subject: [PATCH 2/2] Adds clarifying sentence. --- .../allocation_explain/ClusterAllocationExplainRequest.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts b/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts index 00340b7979..58fa55a931 100644 --- a/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts +++ b/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * For unassigned shards, it provides an explanation for why the shard is unassigned. * For 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. * This 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. + * Refer to the linked documentation for examples of how to troubleshoot allocation issues using this API. * @rest_spec_name cluster.allocation_explain * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=private