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

Update asynchronous_search descriptions #687

Merged
merged 3 commits into from
Nov 26, 2024

Conversation

Naarcha-AWS
Copy link
Contributor

Description

Describe what this change achieves.

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.

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

github-actions bot commented Nov 21, 2024

Changes Analysis

Commit SHA: 4a9244f
Comparing To SHA: 7e4e18e

API Changes

Summary

└─┬Paths
  ├─┬/_opendistro/_asynchronous_search
  │ └─┬POST
  │   ├─┬Parameters
  │   │ └──[🔀] description (14826:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (14832:20)
  │   └─┬Parameters
  │     └──[🔀] description (14844:20)
  └─┬/_plugins/_asynchronous_search
    └─┬POST
      ├─┬Parameters
      │ └──[🔀] description (14832:20)
      ├─┬Parameters
      │ └──[🔀] description (14844:20)
      └─┬Parameters
        └──[🔀] description (14826:20)

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

Report

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

API Coverage

Before After Δ
Covered (%) 599 (58.67 %) 599 (58.67 %) 0 (0 %)
Uncovered (%) 422 (41.33 %) 422 (41.33 %) 0 (0 %)
Unknown 42 42 0

Copy link
Contributor

github-actions bot commented Nov 21, 2024

Spec Test Coverage Analysis

Total Tested
528 385 (72.92 %)

@dblock
Copy link
Member

dblock commented Nov 21, 2024

Looks like Vale is rightfully unhappy.

@Naarcha-AWS
Copy link
Contributor Author

Pulled the descriptions from docs that have been reviewed by editorial. I'll make Vale happy really fast.

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

@dblock: This is ready to merge.

@dblock dblock added the skip-changelog No need to update CHANGELOG. label Nov 26, 2024
@dblock dblock merged commit d7d6520 into opensearch-project:main Nov 26, 2024
27 of 28 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