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

Additonal CAT description updates #778

Merged
merged 1 commit into from
Jan 10, 2025

Conversation

Naarcha-AWS
Copy link
Contributor

Description

Adds a couple of small tweaks to CAT API descriptions based on feedback.

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

github-actions bot commented Jan 9, 2025

Changes Analysis

Commit SHA: dc46acb
Comparing To SHA: c1651ec

API Changes

Summary

└─┬Paths
  ├─┬/_cat/pending_tasks
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16684:20)
  │     └─┬Schema
  │       └──[🔀] description (16688:22)
  ├─┬/_cat/pit_segments
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16758:20)
  │     └─┬Schema
  │       └──[🔀] description (16762:22)
  ├─┬/_cat/pit_segments/_all
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (15941:20)
  │     └─┬Schema
  │       └──[🔀] description (15945:22)
  ├─┬/_cat/templates
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (17570:20)
  │     └─┬Schema
  │       └──[🔀] description (17574:22)
  ├─┬/_cat/indices/{index}
  │ └─┬GET
  │   ├─┬Parameters
  │   │ └──[🔀] description (16329:20)
  │   └─┬Parameters
  │     ├──[🔀] description (16361:20)
  │     └─┬Schema
  │       └──[🔀] description (16365:22)
  ├─┬/_cat/thread_pool
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (17649:20)
  │     └─┬Schema
  │       └──[🔀] description (17653:22)
  ├─┬/_cat/thread_pool/{thread_pool_patterns}
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (17649:20)
  │     └─┬Schema
  │       └──[🔀] description (17653:22)
  ├─┬/_cat/health
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16263:20)
  │     └─┬Schema
  │       └──[🔀] description (16267:22)
  ├─┬/_cat/snapshots
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (17385:20)
  │     └─┬Schema
  │       └──[🔀] description (17389:22)
  ├─┬/_cat/plugins
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16810:20)
  │     └─┬Schema
  │       └──[🔀] description (16814:22)
  ├─┬/_cat/segment_replication
  │ └─┬GET
  │   ├─┬Parameters
  │   │ └──[🔀] description (17073:20)
  │   └─┬Parameters
  │     ├──[🔀] description (17097:20)
  │     └─┬Schema
  │       └──[🔀] description (17101:22)
  ├─┬/_cat/indices
  │ └─┬GET
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16361:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16365:22)
  │   └─┬Parameters
  │     └──[🔀] description (16329:20)
  ├─┬/_cat/snapshots/{repository}
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (17385:20)
  │     └─┬Schema
  │       └──[🔀] description (17389:22)
  ├─┬/_cat/shards/{index}
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (17298:20)
  │     └─┬Schema
  │       └──[🔀] description (17302:22)
  ├─┬/_cat/repositories
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16978:20)
  │     └─┬Schema
  │       └──[🔀] description (16982:22)
  ├─┬/_cat/count
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16149:20)
  │     └─┬Schema
  │       └──[🔀] description (16153:22)
  ├─┬/_cat/cluster_manager
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16077:20)
  │     └─┬Schema
  │       └──[🔀] description (16081:22)
  ├─┬/_cat/tasks
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (17481:20)
  │     └─┬Schema
  │       └──[🔀] description (17485:22)
  ├─┬/_cat/count/{index}
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16149:20)
  │     └─┬Schema
  │       └──[🔀] description (16153:22)
  ├─┬/_cat/shards
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (17298:20)
  │     └─┬Schema
  │       └──[🔀] description (17302:22)
  ├─┬/_cat/nodeattrs
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16522:20)
  │     └─┬Schema
  │       └──[🔀] description (16526:22)
  ├─┬/_cat/fielddata/{fields}
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16218:20)
  │     └─┬Schema
  │       └──[🔀] description (16222:22)
  ├─┬/_cat/master
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16453:20)
  │     └─┬Schema
  │       └──[🔀] description (16457:22)
  ├─┬/_cat/segment_replication/{index}
  │ └─┬GET
  │   ├─┬Parameters
  │   │ └──[🔀] description (17073:20)
  │   └─┬Parameters
  │     ├──[🔀] description (17097:20)
  │     └─┬Schema
  │       └──[🔀] description (17101:22)
  ├─┬/_cat/templates/{name}
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (17570:20)
  │     └─┬Schema
  │       └──[🔀] description (17574:22)
  ├─┬/_cat/recovery/{index}
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16905:20)
  │     └─┬Schema
  │       └──[🔀] description (16909:22)
  ├─┬/_cat/recovery
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16905:20)
  │     └─┬Schema
  │       └──[🔀] description (16909:22)
  ├─┬/_cat/fielddata
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (16218:20)
  │     └─┬Schema
  │       └──[🔀] description (16222:22)
  └─┬/_cat/nodes
    └─┬GET
      └─┬Parameters
        ├──[🔀] description (16606:20)
        └─┬Schema
          └──[🔀] description (16610:22)

Document Element Total Changes Breaking Changes
paths 62 0
  • Total Changes: 62
  • Modifications: 62

Report

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

API Coverage

Before After Δ
Covered (%) 643 (62.98 %) 643 (62.98 %) 0 (0 %)
Uncovered (%) 378 (37.02 %) 378 (37.02 %) 0 (0 %)
Unknown 43 43 0

Copy link
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dblock dblock added the skip-changelog No need to update CHANGELOG. label Jan 10, 2025
@dblock dblock merged commit f021351 into opensearch-project:main Jan 10, 2025
29 of 39 checks passed
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.

3 participants