Skip to content

Commit c370c5d

Browse files
joshua-adams-1lcawll-trotta
authored
Apply suggestions from code review
Apply suggested improvements from code review Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: Laura Trotta <[email protected]>
1 parent c1a4840 commit c370c5d

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import { Duration } from '@_types/Time'
2525
/**
2626
* Explain the shard allocations.
2727
* Get explanations for shard allocations in the cluster.
28-
* This API accepts the current_node, index, primary and shard parameters via the request body, or via query parameters, but not via both at the same time.
28+
* This API accepts the current_node, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time.
2929
* For unassigned shards, it provides an explanation for why the shard is unassigned.
3030
* 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.
3131
* 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.

specification/cluster/allocation_explain/examples/request/ClusterAllocationExplainRequestExample2.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
summary: Query Parameters
2-
method_request: GET _cluster/allocation/explain
2+
method_request: GET _cluster/allocation/explain?index=my-index-000001&shard=0&primary=false&current_node=my-node
33
description: >
44
Run `GET _cluster/allocation/explain?index="my-index-000001"&shard=0&primary=false&current_node="my-node` to get an explanation for a shard's current allocation. No parameters are required in the request body
55
# type: request

0 commit comments

Comments
 (0)