Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Point CAT API descriptions to shared schema when applicable. #804

Merged

Conversation

Naarcha-AWS
Copy link
Contributor

Description

This PR removes descriptions for CAT APIs when the API can use the description from the shared common schema.

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.

Copy link
Contributor

Changes Analysis

Commit SHA: af7167c
Comparing To SHA: d8e4583

API Changes

Summary

├─┬Paths
│ ├─┬/_cat/nodes
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_cat/snapshots
│ │ └─┬GET
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/{index}/_segments
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_cluster/health/{index}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_cluster/voting_config_exclusions
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_aliases
│ │ └─┬PUT
│ │   └──Parameters
│ ├─┬/_cat/aliases
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[➖] description (16205:20)
│ ├─┬/_cat/aliases/{name}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[➖] description (16197:20)
│ │   └─┬Parameters
│ │     └──[➖] description (16205:20)
│ ├─┬/{index}/_rank_eval
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cat/segment_replication/{index}
│ │ └─┬GET
│ │   ├──Parameters
│ │   └─┬Parameters
│ │     └──[➖] description (17421:20)
│ ├─┬/{index}/_open
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_recovery
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_list/indices/{index}
│ │ └─┬GET
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_cat/segments/{index}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_close
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cat/indices/{index}
│ │ └─┬GET
│ │   ├──Parameters
│ │   ├─┬Parameters
│ │   │ └──[➖] description (16677:20)
│ │   └──Parameters
│ ├─┬/_cat/indices
│ │ └─┬GET
│ │   ├──Parameters
│ │   └─┬Parameters
│ │     └──[➖] description (16677:20)
│ ├─┬/_data_stream/{name}/_stats
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_cat/shards/{index}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[➖] description (17682:20)
│ │   └─┬Parameters
│ │     └──[➖] description (17603:20)
│ ├─┬/{index}/_delete_by_query
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_alias/{name}
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬HEAD
│ │   └──Parameters
│ ├─┬/{index}/_update_by_query
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cat/recovery/{index}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_list/shards
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_cat/shards
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[➖] description (17682:20)
│ ├─┬/{index}/_refresh
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_snapshot/{repository}/{snapshot}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_msearch
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_forcemerge
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_list/shards/{index}
│ │ └─┬GET
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_cat/health
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_msearch/template
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_search
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cat/pending_tasks
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_stats/{metric}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_cat/snapshots/{repository}
│ │ └─┬GET
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_cat/segment_replication
│ │ └─┬GET
│ │   ├──Parameters
│ │   └─┬Parameters
│ │     └──[➖] description (17421:20)
│ ├─┬/{index}/_search/template
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_block/{block}
│ │ └─┬PUT
│ │   └──Parameters
│ ├─┬/_cat/thread_pool/{thread_pool_patterns}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_validate/query
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cat/count/{index}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_field_caps
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ ├─┬DELETE
│ │ │ └──Parameters
│ │ └─┬HEAD
│ │   └──Parameters
│ ├─┬/_cluster/state/{metric}/{index}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_list/indices
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_mapping
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_template/{name}
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬HEAD
│ │   └──Parameters
│ ├─┬/{index}/_alias
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬PUT
│ │   └──Parameters
│ ├─┬/{index}/_shard_stores
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_cache/clear
│ │ └──POST
│ ├─┬/{index}/_settings
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬PUT
│ │   └──Parameters
│ ├─┬/{index}/_settings/{name}
│ │ └─┬GET
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/{index}/_mapping/field/{fields}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_count
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_flush
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_aliases/{name}
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ ├─┬POST
│ │ │ └──Parameters
│ │ └─┬DELETE
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_snapshot/{repository}/{snapshot}/_status
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_snapshot/{repository}
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬DELETE
│ │   └──Parameters
│ ├─┬/_mapping
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/{index}/_search_shards
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_stats
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_cat/recovery
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_resolve/index/{name}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_cat/tasks
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_settings/{name}
│ │ └─┬GET
│ │   └──Parameters
│ └─┬/{index}/_alias/{name}
│   ├─┬GET
│   │ ├──Parameters
│   │ └──Parameters
│   ├─┬PUT
│   │ └──Parameters
│   ├─┬POST
│   │ └──Parameters
│   ├─┬DELETE
│   │ ├──Parameters
│   │ └──Parameters
│   └─┬HEAD
│     ├──Parameters
│     └──Parameters
└─┬Components
  ├─┬_common___Names
  │ └──[➕] description (35312:20)
  ├─┬_common___Indices
  │ └──[➕] description (35141:20)
  └─┬_common___TimeUnit
    └──[➕] description (36559:20)

Document Element Total Changes Breaking Changes
paths 10 0
components 3 0
  • Total Changes: 13
  • Removals: 10
  • Additions: 3

Report

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

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

Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
594 593 (99.83 %)

@Naarcha-AWS
Copy link
Contributor Author

This needs to be merged before we can merge automation markers for opensearch-project/documentation-website#9060

@dblock dblock added the skip-changelog No need to update CHANGELOG. label Jan 21, 2025
@dblock dblock merged commit 38951da into opensearch-project:main Jan 21, 2025
30 of 39 checks passed
@Naarcha-AWS Naarcha-AWS deleted the cat-description-consistency branch January 21, 2025 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No need to update CHANGELOG.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants