Add markers for cluster APIs. #9110

Naarcha-AWS · 2025-01-24T22:31:52Z

Part of issue #9050

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Archer <naarcha@amazon.com>

github-actions · 2025-01-24T22:32:04Z

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Signed-off-by: Archer <naarcha@amazon.com>

_api-reference/cluster-api/cluster-reroute.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Signed-off-by: Archer <naarcha@amazon.com>

Naarcha-AWS · 2025-02-14T17:30:05Z

Sent two fixes for cluster parameter descriptions:

These must be merged before this PR can move forward.

Signed-off-by: Archer <naarcha@amazon.com>

kolchfa-aws

Some changes to be made in the documentation and in the spec. Thank you.

_api-reference/cluster-api/cluster-allocation.md

kolchfa-aws · 2025-02-20T18:50:38Z

_api-reference/cluster-api/cluster-allocation.md

+| Parameter | Data type | Description | Default |
+| :--- | :--- | :--- | :--- |
+| `include_disk_info` | Boolean | When `true`, returns information about disk usage and shard sizes. | `false` |
+| `include_yes_decisions` | Boolean | When `true`, returns any `YES` decisions in the allocation explanation. | `false` |


Could we clarify this description? What's meant by YES decisions?

Can do. Will open a adjustment PR in the opensearch-api-specification for this one.

kolchfa-aws · 2025-02-20T18:52:01Z

_api-reference/cluster-api/cluster-allocation.md

-index | String | The name of the shard's index.
-primary | Boolean | Whether to provide an explanation for the primary shard (true) or its first replica (false), which share the same shard ID.
-shard | Integer | The shard ID that you want an explanation for.
+`current_node` | String | If you only want an explanation if the shard happens to be on a particular node, specify that node name here.


Suggested change

`current_node` | String | If you only want an explanation if the shard happens to be on a particular node, specify that node name here.

`current_node` | String | Specifies a node name to return an explanation only if the shard is on that node.

kolchfa-aws · 2025-02-20T18:53:40Z

_api-reference/cluster-api/cluster-allocation.md

-shard | Integer | The shard ID that you want an explanation for.
+`current_node` | String | If you only want an explanation if the shard happens to be on a particular node, specify that node name here.
+`index` | String | The name of the shard's index.
+`primary` | Boolean | Whether to provide an explanation for the primary shard (true) or its first replica (false), which share the same shard ID.


Suggested change

`primary` | Boolean | Whether to provide an explanation for the primary shard (true) or its first replica (false), which share the same shard ID.

`primary` | Boolean | Whether to provide an explanation for the primary shard (`true`) or its first replica (`false`), both of which share the same shard ID.

_api-reference/cluster-api/cluster-component-template.md

kolchfa-aws · 2025-02-20T20:13:21Z

_api-reference/cluster-api/cluster-voting-configuration.md

+| :--- | :--- | :--- |
+| `node_ids` | List or String | A comma-separated list of node IDs to exclude from the voting configuration. When using this setting, you cannot also specify `node_names`. |
+| `node_names` | List or String | A comma-separated list of node names to exclude from the voting configuration. When using this setting, you cannot also specify `node_ids`. |
+| `timeout` | String | When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning a response. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error. |


Default is 30 seconds. Please update the spec.

@kolchfa-aws: How are you getting these defaults? Is there somewhere else in the code besides the spec where defaults are set?

kolchfa-aws · 2025-02-20T20:15:19Z

_api-reference/cluster-api/cluster-voting-configuration.md

+| `node_ids` | List or String | A comma-separated list of node IDs to exclude from the voting configuration. When using this setting, you cannot also specify `node_names`. |
+| `node_names` | List or String | A comma-separated list of node names to exclude from the voting configuration. When using this setting, you cannot also specify `node_ids`. |
+| `timeout` | String | When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning a response. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error. |
+


Does this API support wait_for_removal?

It does not.

_api-reference/cluster-api/cluster-weighted-routing.md

kolchfa-aws · 2025-02-20T20:17:43Z

_api-reference/cluster-api/cluster-weighted-routing.md

+## Example request
+
+```json
+{


Add an endpoint

kolchfa-aws · 2025-02-20T20:17:51Z

_api-reference/cluster-api/cluster-weighted-routing.md

+    "zone-3": 1
+  }
+}
+```


Add a copy button

kkhatua · 2025-02-20T20:33:45Z

@Naarcha-AWS would it be possible to have the validation capture this? This almost feels like a checklist is needed... the diffs show the "the default value is ..." translated to "N/A" .
I'm guessing the APISpec should have had this, right? If not, following the process, we'll need to add it as discussed. And for later-planned namespaces, push the onus of this on the Dev teams/

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Add markers for cluster APIs.

8234ec2

Signed-off-by: Archer <naarcha@amazon.com>

github-actions bot assigned Naarcha-AWS Jan 24, 2025

Naarcha-AWS and others added 4 commits January 24, 2025 17:42

Merge branch 'main' into cluster-apis

9ac0957

Add rest of cluster inserts

7f0f39b

Signed-off-by: Archer <naarcha@amazon.com>

Merge branch 'main' into cluster-apis

44d9145

Adjust tables. Add example requests and responses.

94b4cd1

Signed-off-by: Archer <naarcha@amazon.com>

Naarcha-AWS marked this pull request as ready for review February 4, 2025 20:45

Naarcha-AWS requested review from kolchfa-aws, AMoo-Miki, natebower, dlvenable and epugh as code owners February 4, 2025 20:45

Merge branch 'main' into cluster-apis

eff3c78

Naarcha-AWS added 4 - Doc review PR: Doc review in progress backport 2.18 PR: Backport label for 2.18 labels Feb 4, 2025

Naarcha-AWS commented Feb 4, 2025

View reviewed changes

_api-reference/cluster-api/cluster-reroute.md Outdated Show resolved Hide resolved

Naarcha-AWS commented Feb 4, 2025

View reviewed changes

_api-reference/cluster-api/cluster-reroute.md Outdated Show resolved Hide resolved

Naarcha-AWS added 3 commits February 4, 2025 14:53

Apply suggestions from code review

645f9e1

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Apply suggestions from code review

b713b3b

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Merge branch 'main' into cluster-apis

bab9e3c

Naarcha-AWS added backport 2.19 and removed backport 2.18 PR: Backport label for 2.18 labels Feb 12, 2025

Naarcha-AWS and others added 4 commits February 12, 2025 16:01

Merge branch 'main' into cluster-apis

5607382

Merge branch 'main' into cluster-apis

5f60253

Remove depracated parameters.

7550e90

Signed-off-by: Archer <naarcha@amazon.com>

One last deprecated parameter

5fbb2c4

Signed-off-by: Archer <naarcha@amazon.com>

Description additions.

19b60e4

Signed-off-by: Archer <naarcha@amazon.com>

Naarcha-AWS removed the 4 - Doc review PR: Doc review in progress label Feb 20, 2025

Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress 4 - Doc review PR: Doc review in progress and removed 5 - Editorial review PR: Editorial review in progress labels Feb 20, 2025

Naarcha-AWS and others added 2 commits February 20, 2025 11:31

Merge branch 'main' into cluster-apis

ecdce80

Fix formatting error.

7c8ea81

Signed-off-by: Archer <naarcha@amazon.com>

kolchfa-aws requested changes Feb 20, 2025

View reviewed changes

Naarcha-AWS and others added 2 commits February 21, 2025 14:28

Apply suggestions from code review

662c507

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Apply suggestions from code review

403e330

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add markers for cluster APIs. #9110

Add markers for cluster APIs. #9110

Naarcha-AWS commented Jan 24, 2025

github-actions bot commented Jan 24, 2025

Naarcha-AWS commented Feb 14, 2025

kolchfa-aws left a comment

kolchfa-aws Feb 20, 2025

Naarcha-AWS Feb 21, 2025

kolchfa-aws Feb 20, 2025

kolchfa-aws Feb 20, 2025

kolchfa-aws Feb 20, 2025

Naarcha-AWS Feb 21, 2025

kolchfa-aws Feb 20, 2025

Naarcha-AWS Feb 21, 2025

kolchfa-aws Feb 20, 2025

kolchfa-aws Feb 20, 2025

kkhatua commented Feb 20, 2025

	`current_node` \| String \| If you only want an explanation if the shard happens to be on a particular node, specify that node name here.
	`current_node` \| String \| Specifies a node name to return an explanation only if the shard is on that node.

	`primary` \| Boolean \| Whether to provide an explanation for the primary shard (true) or its first replica (false), which share the same shard ID.
	`primary` \| Boolean \| Whether to provide an explanation for the primary shard (`true`) or its first replica (`false`), both of which share the same shard ID.

Add markers for cluster APIs. #9110

Are you sure you want to change the base?

Add markers for cluster APIs. #9110

Conversation

Naarcha-AWS commented Jan 24, 2025

Checklist

github-actions bot commented Jan 24, 2025

Naarcha-AWS commented Feb 14, 2025

kolchfa-aws left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kkhatua commented Feb 20, 2025