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

Fix the documentation urls of alias related APIs #448

Merged
merged 1 commit into from
Jul 24, 2024

Conversation

gaobinlong
Copy link
Contributor

Description

After this documentation PR is merged, we now have the official documentation for the Create or Update alias API, we need to correct the documentation url in this repo.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

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: 225f87e
Comparing To SHA: 592b9b6

API Changes

Summary

└─┬Paths
  ├─┬/_aliases
  │ └─┬POST
  │   └─┬External Docs
  │     └──[🔀] url (176:14)
  ├─┬/_aliases/{name}
  │ ├─┬PUT
  │ │ └─┬External Docs
  │ │   └──[🔀] url (220:14)
  │ └─┬POST
  │   └─┬External Docs
  │     └──[🔀] url (198:14)
  ├─┬/_alias/{name}
  │ ├─┬PUT
  │ │ └─┬External Docs
  │ │   └──[🔀] url (153:14)
  │ └─┬POST
  │   └─┬External Docs
  │     └──[🔀] url (131:14)
  ├─┬/{index}/_aliases
  │ └─┬PUT
  │   └─┬External Docs
  │     └──[🔀] url (7934:14)
  ├─┬/{index}/_alias/{name}
  │ ├─┬PUT
  │ │ └─┬External Docs
  │ │   └──[🔀] url (7910:14)
  │ └─┬POST
  │   └─┬External Docs
  │     └──[🔀] url (7887:14)
  ├─┬/{index}/_aliases/{name}
  │ ├─┬PUT
  │ │ └─┬External Docs
  │ │   └──[🔀] url (8001:14)
  │ └─┬POST
  │   └─┬External Docs
  │     └──[🔀] url (7978:14)
  ├─┬/_alias
  │ └─┬PUT
  │   └─┬External Docs
  │     └──[🔀] url (67:14)
  └─┬/{index}/_alias
    └─┬PUT
      └─┬External Docs
        └──[🔀] url (7799:14)

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

Report

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

API Coverage

Before After Δ
Covered (%) 490 (47.99 %) 490 (47.99 %) 0 (0 %)
Uncovered (%) 531 (52.01 %) 531 (52.01 %) 0 (0 %)
Unknown 24 24 0

Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
514 114 (22.18 %)

@dblock dblock added the skip-changelog No need to update CHANGELOG. label Jul 24, 2024
@dblock
Copy link
Member

dblock commented Jul 24, 2024

We can skip CHANGELOG but feel free to update that even for small fixes.

@dblock dblock merged commit b9bdac2 into opensearch-project:main Jul 24, 2024
12 of 21 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.

2 participants