From 715e0cd3c9d9b134f1039e45193c1d9175296cc9 Mon Sep 17 00:00:00 2001 From: Thomas Farr Date: Fri, 27 Dec 2024 07:52:40 +1300 Subject: [PATCH] Fix vale Signed-off-by: Thomas Farr --- spec/namespaces/cluster.yaml | 2 +- spec/schemas/cluster.reroute.yaml | 28 ++++++++++++++-------------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/spec/namespaces/cluster.yaml b/spec/namespaces/cluster.yaml index f55eda8d..566cf317 100644 --- a/spec/namespaces/cluster.yaml +++ b/spec/namespaces/cluster.yaml @@ -808,7 +808,7 @@ components: description: Unique identifier for the cluster. $ref: '../schemas/_common.yaml#/components/schemas/Uuid' indices: - description: Contains statistics about indices with shards assigned to selected nodes. + description: Contains statistics about indexes with shards assigned to selected nodes. $ref: '../schemas/cluster.stats.yaml#/components/schemas/ClusterIndices' nodes: description: Contains statistics about nodes selected by the request's node filters. diff --git a/spec/schemas/cluster.reroute.yaml b/spec/schemas/cluster.reroute.yaml index e4c344ec..98de24c4 100644 --- a/spec/schemas/cluster.reroute.yaml +++ b/spec/schemas/cluster.reroute.yaml @@ -11,47 +11,47 @@ components: properties: cancel: description: |- - Cancel allocation of a shard (or recovery). Accepts index and shard for index - name and shard number, and node for the node to cancel the shard allocation + Cancel allocation of a shard (or recovery). Accepts `index` and `shard` for index + name and shard number, and `node` for the node to cancel the shard allocation on. This can be used to force resynchronization of existing replicas from the primary shard by cancelling them and allowing them to be reinitialized through the standard recovery process. By default only replica shard allocations can be cancelled. If it is necessary to cancel the allocation of - a primary shard then the allow_primary flag must also be included in the + a primary shard then the `allow_primary` flag must also be included in the request. $ref: '#/components/schemas/CommandCancelAction' move: description: |- - Move a started shard from one node to another node. Accepts index and shard - for index name and shard number, from_node for the node to move the shard - from, and to_node for the node to move the shard to. + Move a started shard from one node to another node. Accepts `index` and `shard` + for index name and shard number, `from_node` for the node to move the shard + from, and `to_node` for the node to move the shard to. $ref: '#/components/schemas/CommandMoveAction' allocate_replica: description: |- - Allocate an unassigned replica shard to a node. Accepts index and shard for - index name and shard number, and node to allocate the shard to. Takes + Allocate an unassigned replica shard to a node. Accepts `index` and `shard` for + index name and shard number, and `node` to allocate the shard to. Takes allocation deciders into account. $ref: '#/components/schemas/CommandAllocateReplicaAction' allocate_stale_primary: description: |- - Allocate a primary shard to a node that holds a stale copy. Accepts the index - and shard for index name and shard number, and node to allocate the shard to. + Allocate a primary shard to a node that holds a stale copy. Accepts `index` + and `shard` for index name and shard number, and `node` to allocate the shard to. Using this command may lead to data loss for the provided shard id. If a node which has the good copy of the data rejoins the cluster later on, that data will be deleted or overwritten with the data of the stale copy that was forcefully allocated with this command. To ensure that these implications are - well-understood, this command requires the flag accept_data_loss to be + well-understood, this command requires the flag `accept_data_loss` to be explicitly set to true. $ref: '#/components/schemas/CommandAllocatePrimaryAction' allocate_empty_primary: description: |- - Allocate an empty primary shard to a node. Accepts the index and shard for - index name and shard number, and node to allocate the shard to. Using this + Allocate an empty primary shard to a node. Accepts `index` and `shard` for + index name and shard number, and `node` to allocate the shard to. Using this command leads to a complete loss of all data that was indexed into this shard, if it was previously started. If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag - accept_data_loss to be explicitly set to true. + `accept_data_loss` to be explicitly set to true. $ref: '#/components/schemas/CommandAllocatePrimaryAction' CommandCancelAction: type: object