Update Cluster namespace descriptions #806

Naarcha-AWS · 2025-01-22T21:58:56Z

Part of issue #780. Must be reviewed by @natebower first.

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

Signed-off-by: Archer <[email protected]>

github-actions · 2025-01-22T22:01:09Z

Changes Analysis

Commit SHA: 12687dd
Comparing To SHA: 799d046

API Changes

Summary

├─┬Paths
│ ├─┬/{index}/_open
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cluster/stats/{metric}/{index_metric}/nodes/{node_id}
│ │ └─┬GET
│ │   ├──[🔀] description (1851:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18629:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18696:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18664:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18656:20)
│ ├─┬/_cluster/routing/awareness/{attribute}/weights
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   ├──[🔀] description (18239:20)
│ │ │   └─┬Schema
│ │ │     └──[🔀] description (18242:22)
│ │ └─┬PUT
│ │   └─┬Parameters
│ │     ├──[🔀] description (18486:20)
│ │     └─┬Schema
│ │       └──[🔀] description (18489:22)
│ ├─┬/{alias}/_rollover/{new_index}
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cluster/reroute
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18500:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18507:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18555:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18534:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18534:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18583:20)
│ │   ├─┬Responses
│ │   │ └─┬200
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └─┬ALLOF
│ │   │         └─┬state
│ │   │           └──[🔀] description (30463:34)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬commands
│ │           └──[🔀] description (27713:30)
│ ├─┬/_cluster/state/{metric}
│ │ └─┬GET
│ │   ├──[🔀] description (1777:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18591:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18598:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18564:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18615:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18554:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18622:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18583:20)
│ │   └─┬Parameters
│ │     └──[➖] description (18652:20)
│ ├─┬/_cluster/health
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18330:20)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (18315:20)
│ │   │ └─┬Schema
│ │   │   └──[➕] default (18318:18)❌ 
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18339:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18284:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18291:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18323:20)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (18254:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (18257:22)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18298:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18330:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18337:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18323:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18280:20)
│ │   └─┬Parameters
│ │     └──[➖] description (18313:20)
│ ├─┬/{index}/_update_by_query
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_nodes/{node_id}/{metric}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_cluster/decommission/awareness
│ │ └─┬DELETE
│ │   └──[🔀] description (1433:20)
│ ├─┬/{index}/_doc/{id}
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ ├─┬POST
│ │ │ └──Parameters
│ │ └─┬DELETE
│ │   └──Parameters
│ ├─┬/_cluster/settings
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[➖] description (18240:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[➖] description (18252:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[➖] description (18217:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18208:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (18216:20)
│ │ └─┬PUT
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18509:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18494:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18519:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18463:20)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[🔀] description (27699:26)
│ ├─┬/_component_template
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18175:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18197:20)
│ │   └─┬Parameters
│ │     └──[➖] description (18172:20)
│ ├─┬/{index}/_clone/{target}
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cluster/stats/nodes/{node_id}
│ │ └─┬GET
│ │   ├──[🔀] description (1894:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18664:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18696:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18656:20)
│ ├─┬/{index}/_bulk
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cluster/pending_tasks
│ │ └─┬GET
│ │   ├──[🔀] description (1603:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18374:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18352:20)
│ │   └─┬Parameters
│ │     └──[➖] description (18391:20)
│ ├─┬/_bulk
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_bulk/stream
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cat/allocation/{node_id}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}
│ │ └─┬PUT
│ │   └──Parameters
│ ├─┬/_nodes/{node_id}/usage
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_split/{target}
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cluster/health/{index}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18313:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18323:20)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (18315:20)
│ │   │ └─┬Schema
│ │   │   └──[➕] default (18318:18)❌ 
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18323:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18339:20)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (18254:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (18257:22)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18284:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18280:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18269:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18291:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18298:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18330:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18337:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18330:20)
│ ├─┬/_nodes/{node_id}/usage/{metric}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_nodes/{node_id}/stats
│ │ └─┬GET
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_nodes/{node_id}/stats/{metric}
│ │ └─┬GET
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_nodes/{node_id}/stats/{metric}/{index_metric}
│ │ └─┬GET
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/{index}/_update/{id}
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}
│ │ └─┬PUT
│ │   ├──[🔀] description (1468:20)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (18441:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (18444:22)
│ │   └─┬Parameters
│ │     ├──[🔀] description (18449:20)
│ │     └─┬Schema
│ │       └──[🔀] description (18452:22)
│ ├─┬/{index}/_close
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{alias}/_rollover
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_bulk/stream
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_reindex
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_stats/{metric}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_nodes/stats/{metric}/{index_metric}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_stats/{metric}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_shrink/{target}
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cluster/allocation/explain
│ │ ├─┬GET
│ │ │ ├──[🔀] description (1392:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18054:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18062:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       ├──[🔀] description (27659:26)
│ │ │       └─┬primary
│ │ │         └──[🔀] description (27653:30)
│ │ └─┬POST
│ │   ├──[🔀] description (1412:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18054:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18062:20)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         ├──[🔀] description (27659:26)
│ │         └─┬primary
│ │           └──[🔀] description (27653:30)
│ ├─┬/_cluster/stats/{metric}/nodes/{node_id}
│ │ └─┬GET
│ │   ├──[🔀] description (1873:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18664:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18696:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18656:20)
│ ├─┬/{index}/_doc
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_stats
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_cluster/voting_config_exclusions
│ │ ├─┬POST
│ │ │ ├──[🔀] description (1931:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18371:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18380:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (18389:20)
│ │ └─┬DELETE
│ │   ├──[🔀] description (1914:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18102:20)
│ ├─┬/_cluster/decommission/awareness/{awareness_attribute_name}/_status
│ │ └─┬GET
│ │   ├──[🔀] description (1450:20)
│ │   └─┬Parameters
│ │     ├──[🔀] description (18194:20)
│ │     └─┬Schema
│ │       └──[🔀] description (18197:22)
│ ├─┬/_stats
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_nodes/stats
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_component_template/{name}
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[➖] description (18172:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[➖] description (18197:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18151:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (18175:20)
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18419:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[➖] description (18460:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[➖] description (18472:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18400:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[➖] description (18445:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       ├──[🔀] description (27685:26)
│ │ │       └─┬allow_auto_create
│ │ │         └──[🔀] description (27672:30)
│ │ ├─┬POST
│ │ │ ├─┬Parameters
│ │ │ │ └──[➖] description (18445:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18419:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[➖] description (18460:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[➖] description (18472:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18400:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       ├──[🔀] description (27685:26)
│ │ │       └─┬allow_auto_create
│ │ │         └──[🔀] description (27672:30)
│ │ ├─┬DELETE
│ │ │ ├─┬Parameters
│ │ │ │ └──[➖] description (18099:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18070:20)
│ │ │ └─┬Parameters
│ │ │   └──[➖] description (18087:20)
│ │ └─┬HEAD
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18132:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18149:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18116:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18132:20)
│ ├─┬/_cluster/stats
│ │ └─┬GET
│ │   ├──[🔀] description (1832:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18656:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18664:20)
│ ├─┬/{index}/_delete_by_query
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cluster/state/{metric}/{index}
│ │ └─┬GET
│ │   ├──[🔀] description (1804:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18583:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18590:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18554:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18564:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18591:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18652:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18615:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18622:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18598:20)
│ ├─┬/_nodes/{node_id}/reload_secure_settings
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cluster/state
│ │ └─┬GET
│ │   ├──[🔀] description (1751:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18615:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18591:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18622:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18583:20)
│ │   ├─┬Parameters
│ │   │ └──[➖] description (18652:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18564:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18598:20)
│ ├─┬/{index}/_create/{id}
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ └─┬/_nodes/stats/{metric}
│   └─┬GET
│     └──Parameters
└─┬Components
  ├─┬_common___NodeIds
  │ └──[➕] description (35318:20)
  ├─┬_common___WaitForEvents
  │ └──[➕] description (36654:20)
  ├─┬_common___WaitForActiveShards
  │ └──[➕] description (36647:20)
  └─┬_common___Level
    └──[➕] description (35190:20)

Document Element	Total Changes	Breaking Changes
paths	153	2
components	4	0

❌ BREAKING Changes: 2 out of 157
Modifications: 98
Removals: 53
Additions: 6
Breaking Additions: 2

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/12933109864/artifacts/2475558236

API Coverage

	Before	After	Δ
Covered (%)	662 (64.84 %)	662 (64.84 %)	0 (0 %)
Uncovered (%)	359 (35.16 %)	359 (35.16 %)	0 (0 %)
Unknown	45	45	0

github-actions · 2025-01-22T22:06:48Z

Spec Test Coverage Analysis

Total	Tested
594	593 (99.83 %)

natebower

@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Approval pending reread of lines 535, 1329, and 1339. Thanks!

spec/namespaces/cluster.yaml

spec/schemas/_common.yaml

spec/namespaces/cluster.yaml

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

natebower

LGTM

Tokesh · 2025-01-23T18:49:08Z

Hello! Great job!
We need to resolve the last two conversations to merge this PR.

Naarcha-AWS · 2025-01-23T19:18:37Z

@Tokesh: They should be resolved now.

Cluser namespace descriptions.

f4c8475

Signed-off-by: Archer <[email protected]>

Naarcha-AWS requested review from dblock, harshavamsi, sachetalva, nhtruong, Xtansia, VachaShah, Tokesh and aabeshov as code owners January 22, 2025 21:58

Fix linter

6e3d707

Signed-off-by: Archer <[email protected]>

Naarcha-AWS mentioned this pull request Jan 22, 2025

Update query parameter descriptions #780

Open

27 tasks

natebower suggested changes Jan 23, 2025

View reviewed changes

Naarcha-AWS commented Jan 23, 2025

View reviewed changes

spec/namespaces/cluster.yaml Outdated Show resolved Hide resolved

Naarcha-AWS commented Jan 23, 2025

View reviewed changes

spec/namespaces/cluster.yaml Outdated Show resolved Hide resolved

Naarcha-AWS commented Jan 23, 2025

View reviewed changes

spec/namespaces/cluster.yaml Outdated Show resolved Hide resolved

Naarcha-AWS and others added 2 commits January 23, 2025 10:00

Apply suggestions from code review

646e07c

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

Update spec/namespaces/cluster.yaml

12687dd

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

natebower approved these changes Jan 23, 2025

View reviewed changes

Tokesh added the skip-changelog No need to update CHANGELOG. label Jan 23, 2025

Tokesh approved these changes Jan 23, 2025

View reviewed changes

Tokesh merged commit 592336a into opensearch-project:main Jan 23, 2025
30 of 31 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Cluster namespace descriptions #806

Update Cluster namespace descriptions #806

Naarcha-AWS commented Jan 22, 2025

github-actions bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025

natebower left a comment

natebower left a comment

Tokesh commented Jan 23, 2025

Naarcha-AWS commented Jan 23, 2025

Update Cluster namespace descriptions #806

Update Cluster namespace descriptions #806

Conversation

Naarcha-AWS commented Jan 22, 2025

github-actions bot commented Jan 22, 2025 • edited Loading

Changes Analysis

API Changes

Summary

Report

API Coverage

github-actions bot commented Jan 22, 2025

Spec Test Coverage Analysis

natebower left a comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

Tokesh commented Jan 23, 2025

Naarcha-AWS commented Jan 23, 2025

github-actions bot commented Jan 22, 2025 •

edited

Loading