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

Add asynchronous search descriptions. #781

Merged
merged 3 commits into from
Jan 13, 2025

Conversation

Naarcha-AWS
Copy link
Contributor

Updates the query parameter descriptions for asynchronous search API.

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 10, 2025

Changes Analysis

Commit SHA: cd09c98
Comparing To SHA: f021351

API Changes

Summary

└─┬Paths
  ├─┬/_plugins/_asynchronous_search/stats
  │ └─┬GET
  │   └──[🔀] description (3707:20)
  ├─┬/_plugins/_asynchronous_search/{id}
  │ ├─┬GET
  │ │ └──[🔀] description (3689:20)
  │ └─┬DELETE
  │   └──[🔀] description (3672:20)
  ├─┬/_opendistro/_asynchronous_search/{id}
  │ ├─┬GET
  │ │ └──[🔀] description (13174:20)
  │ └─┬DELETE
  │   └──[🔀] description (13193:20)
  ├─┬/_plugins/_asynchronous_search
  │ └─┬POST
  │   ├──[🔀] description (3649:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15644:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15650:20)
  │   └─┬Parameters
  │     └──[🔀] description (15635:20)
  ├─┬/_opendistro/_asynchronous_search
  │ └─┬POST
  │   ├──[🔀] description (13130:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15635:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15644:20)
  │   └─┬Parameters
  │     └──[🔀] description (15650:20)
  └─┬/_opendistro/_asynchronous_search/stats
    └─┬GET
      └──[🔀] description (13155:20)

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

Report

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

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

Spec Test Coverage Analysis

Total Tested
573 570 (99.48 %)

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.

@Naarcha-AWS A couple changes. Thanks!

spec/namespaces/asynchronous_search.yaml Outdated Show resolved Hide resolved
spec/namespaces/asynchronous_search.yaml Outdated Show resolved Hide resolved
Naarcha-AWS and others added 2 commits January 10, 2025 12:39
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Tokesh Tokesh added the skip-changelog No need to update CHANGELOG. label Jan 11, 2025
@Tokesh Tokesh merged commit bf353a7 into opensearch-project:main Jan 13, 2025
30 of 31 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