Edit Snapshot namespace descriptions by Naarcha-AWS · Pull Request #830 · opensearch-project/opensearch-api-specification

Naarcha-AWS · 2025-03-12T14:10:48Z

This change edits the Snapshot path and query parameter descriptions.

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 <naarcha@amazon.com>

github-actions · 2025-03-12T14:15:11Z

Changes Analysis

Commit SHA: 223336c
Comparing To SHA: 74d9e56

API Changes

Summary

├─┬Paths
│ ├─┬/_cluster/state/{metric}/{index}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18693:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18663:20)
│ ├─┬/_snapshot/{repository}/{snapshot}
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26739:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26750:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26775:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26731:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (26757:20)
│ │ ├─┬PUT
│ │ │ ├──[🔀] description (10350:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26600:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26592:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26608:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26625:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       ├──[🔀] description (29863:26)
│ │ │       ├─┬ignore_unavailable
│ │ │       │ └──[🔀] description (29834:30)
│ │ │       ├─┬include_global_state
│ │ │       │ ├──[🔀] description (29839:30)
│ │ │       │ └──[➕] default (29844:26)❌ 
│ │ │       ├─┬feature_states
│ │ │       │ └──[🔀] description (29848:30)
│ │ │       └─┬partial
│ │ │         ├──[🔀] description (29857:30)
│ │ │         └──[➕] default (29862:26)❌ 
│ │ ├─┬POST
│ │ │ ├──[🔀] description (10327:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26592:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26625:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26600:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26608:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       ├──[🔀] description (29863:26)
│ │ │       ├─┬partial
│ │ │       │ ├──[🔀] description (29857:30)
│ │ │       │ └──[➕] default (29862:26)❌ 
│ │ │       ├─┬feature_states
│ │ │       │ └──[🔀] description (29848:30)
│ │ │       ├─┬ignore_unavailable
│ │ │       │ └──[🔀] description (29834:30)
│ │ │       └─┬include_global_state
│ │ │         ├──[🔀] description (29839:30)
│ │ │         └──[➕] default (29844:26)❌ 
│ │ └─┬DELETE
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26673:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26681:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (26665:20)
│ ├─┬/_cluster/stats
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (18768:20)
│ ├─┬/_snapshot/_status
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26839:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (26846:20)
│ ├─┬/_snapshot/{repository}/{snapshot}/_status
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26823:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26831:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26839:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (26846:20)
│ ├─┬/_cluster/state
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (18693:20)
│ ├─┬/_cluster/voting_config_exclusions
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18475:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18484:20)
│ ├─┬/_cluster/stats/{metric}/{index_metric}/nodes/{node_id}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18768:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18741:20)
│ ├─┬/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}
│ │ └─┬PUT
│ │   ├──[🔀] description (10374:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26520:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26528:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26536:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26512:20)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[🔀] description (29825:26)
│ ├─┬/_snapshot
│ │ └─┬GET
│ │   ├──[🔀] description (10095:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26706:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (26713:20)
│ ├─┬/_snapshot/{repository}/_status
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26839:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26823:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (26846:20)
│ ├─┬/_component_template/{name}
│ │ ├─┬PUT
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (18504:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (18504:20)
│ ├─┬/_snapshot/{repository}/_verify
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26864:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26872:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (26889:20)
│ ├─┬/_snapshot/{repository}/_cleanup
│ │ └─┬POST
│ │   ├──[🔀] description (10222:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26505:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (26488:20)
│ ├─┬/_cluster/stats/{metric}/nodes/{node_id}
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (18768:20)
│ ├─┬/_cluster/settings
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (18304:20)
│ │ └─┬PUT
│ │   └─┬Parameters
│ │     └──[🔀] description (18569:20)
│ ├─┬/_cluster/state/{metric}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18663:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18693:20)
│ ├─┬/_snapshot/{repository}
│ │ ├─┬GET
│ │ │ ├──[🔀] description (10155:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26713:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26698:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (26706:20)
│ │ ├─┬PUT
│ │ │ ├──[🔀] description (10198:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26561:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26578:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26553:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26585:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └──[🔀] description (29879:26)
│ │ ├─┬POST
│ │ │ ├──[🔀] description (10175:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26553:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26561:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26578:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (26585:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └──[🔀] description (29879:26)
│ │ └─┬DELETE
│ │   ├──[🔀] description (10135:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26633:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26641:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (26658:20)
│ ├─┬/_snapshot/{repository}/{snapshot}/_restore
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26782:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26790:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26815:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (26798:20)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         ├──[🔀] description (29962:26)
│ │         ├─┬partial
│ │         │ ├──[🔀] description (29923:30)
│ │         │ └──[➕] default (29922:26)❌ 
│ │         ├─┬storage_type
│ │         │ ├──[🔀] description (29958:30)
│ │         │ └──[➕] default (29957:26)❌ 
│ │         ├─┬ignore_index_settings
│ │         │ └──[🔀] description (29888:30)
│ │         ├─┬include_aliases
│ │         │ ├──[🔀] description (29902:30)
│ │         │ └──[➕] default (29901:26)❌ 
│ │         ├─┬ignore_unavailable
│ │         │ ├──[🔀] description (29895:30)
│ │         │ └──[➕] default (29894:26)❌ 
│ │         └─┬include_global_state
│ │           ├──[🔀] description (29909:30)
│ │           └──[➕] default (29908:26)❌ 
│ └─┬/_cluster/stats/nodes/{node_id}
│   └─┬GET
│     └─┬Parameters
│       └──[🔀] description (18768:20)
└─┬Components
  ├─┬snapshot._common___Repository
  │ └──[➕] description (63075:20)
  ├─┬snapshot._common___RepositorySettings
  │ └──[➕] description (63088:20)
  └─┬snapshot._common___SnapshotShardsStatsStage
    ├─┬ONEOF
    │ └──[🔀] description (63220:24)
    ├─┬ONEOF
    │ └──[🔀] description (63223:24)
    ├─┬ONEOF
    │ └──[🔀] description (63226:24)
    ├─┬ONEOF
    │ └──[🔀] description (63229:24)
    └─┬ONEOF
      └──[🔀] description (63232:24)

Document Element	Total Changes	Breaking Changes
paths	108	9
components	7	0

❌ BREAKING Changes: 9 out of 115
Modifications: 104
Additions: 11
Breaking Additions: 9

Report

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

API Coverage

	Before	After	Δ
Covered (%)	663 (64.94 %)	663 (64.94 %)	0 (0 %)
Uncovered (%)	358 (35.06 %)	358 (35.06 %)	0 (0 %)
Unknown	49	49	0

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

github-actions · 2025-03-12T14:19:13Z

Spec Test Coverage Analysis

Total	Tested
599	597 (99.67 %)

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

Naarcha-AWS · 2025-03-13T19:52:07Z

This is ready for review.

Naarcha-AWS added 2 commits March 12, 2025 08:48

Edit Snapshot namespace descriptions

b0c7e58

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

Additional feedback on cluster API descriptions

339e31f

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

Naarcha-AWS requested review from Tokesh, VachaShah, Xtansia, aabeshov, dblock, harshavamsi, nhtruong and sachetalva as code owners March 12, 2025 14:10

Remove extra schema. Fix typo

357b91c

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

Naarcha-AWS added 2 commits March 12, 2025 09:15

Fix linting error

fa19dad

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

Add changelog

de2da81

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

Merge branch 'main' into snapshot-namespace

223336c

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

nhtruong approved these changes Mar 17, 2025

View reviewed changes

nhtruong added the skip-changelog No need to update CHANGELOG. label Mar 17, 2025

nhtruong merged commit 5b837e6 into opensearch-project:main Mar 17, 2025
33 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Edit Snapshot namespace descriptions#830

Edit Snapshot namespace descriptions#830
nhtruong merged 6 commits intoopensearch-project:mainfrom
Naarcha-AWS:snapshot-namespace

Naarcha-AWS commented Mar 12, 2025

Uh oh!

github-actions bot commented Mar 12, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Mar 12, 2025 •

edited

Loading

Uh oh!

Naarcha-AWS commented Mar 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Naarcha-AWS commented Mar 12, 2025

Uh oh!

github-actions bot commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes Analysis

API Changes

Summary

Report

API Coverage

Uh oh!

github-actions bot commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Spec Test Coverage Analysis

Uh oh!

Naarcha-AWS commented Mar 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions bot commented Mar 12, 2025 •

edited

Loading

github-actions bot commented Mar 12, 2025 •

edited

Loading