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 url of the Create or Update alias API in rest-api-spec #14935

Merged
merged 2 commits into from
Jul 24, 2024

Conversation

gaobinlong
Copy link
Collaborator

@gaobinlong gaobinlong commented Jul 24, 2024

Description

This is a follow-up PR of #14719, I created a documentation PR for the Create or Update alias API and now the PR is merged, so we need to correct the documentation URL in rest-api-spec.

Related Issues

#14384

Check List

- [ ] Functionality includes testing.
- [ ] API changes companion pull request created, if applicable.
- [ ] Public documentation issue/PR created, if applicable.

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.

@gaobinlong gaobinlong added backport 2.x Backport to 2.x branch skip-changelog documentation Improvements or additions to documentation :test Adding or fixing a test and removed documentation Improvements or additions to documentation labels Jul 24, 2024
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Please do review/fix the related specs in https://github.com/opensearch-project/opensearch-api-specification.

Copy link
Contributor

❌ Gradle check result for 7974120:

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

Copy link
Contributor

✅ Gradle check result for 8270b8d: SUCCESS

Copy link

codecov bot commented Jul 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.83%. Comparing base (7673a77) to head (8270b8d).

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #14935      +/-   ##
============================================
- Coverage     71.89%   71.83%   -0.07%     
- Complexity    62701    62710       +9     
============================================
  Files          5159     5159              
  Lines        294157   294157              
  Branches      42547    42547              
============================================
- Hits         211492   211300     -192     
- Misses        65200    65460     +260     
+ Partials      17465    17397      -68     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dblock dblock merged commit 1fe58b5 into opensearch-project:main Jul 24, 2024
30 of 31 checks passed
@dblock
Copy link
Member

dblock commented Jul 24, 2024

I wonder where this API spec is still used. We should be replacing it with the one from https://github.com/opensearch-project/opensearch-api-specification.

opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 24, 2024
…pi-spec (#14935)

Signed-off-by: Gao Binlong <[email protected]>
(cherry picked from commit 1fe58b5)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
dbwiddis pushed a commit that referenced this pull request Jul 24, 2024
…pi-spec (#14935) (#14955)

(cherry picked from commit 1fe58b5)

Signed-off-by: Gao Binlong <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@gaobinlong
Copy link
Collaborator Author

I wonder where this API spec is still used. We should be replacing it with the one from https://github.com/opensearch-project/opensearch-api-specification.

Do you mean the rest-api-spec in core will be deprecated in the future? I think it's a very solid end-to-end test framework which is helpful during the development, but moving the yaml test cases outside the core repo can helps until the PR is merged and new version is built.

@dblock
Copy link
Member

dblock commented Jul 25, 2024

I wonder where this API spec is still used. We should be replacing it with the one from https://github.com/opensearch-project/opensearch-api-specification.

Do you mean the rest-api-spec in core will be deprecated in the future? I think it's a very solid end-to-end test framework which is helpful during the development, but moving the yaml test cases outside the core repo can helps until the PR is merged and new version is built.

Yes, just the spec. It's incomplete, has bugs, doesn't have plugins, etc. I'd like it replaced with a release rom https://github.com/opensearch-project/opensearch-api-specification/releases/tag/main-latest. The YAML test framework though is perfectly fine.

We have #4027 and #3090 that are related. Ideally we'd do the latter and delete tons of code from core, and make authoring new APIs much easier and less error-prone.

harshavamsi pushed a commit to harshavamsi/OpenSearch that referenced this pull request Aug 20, 2024
wdongyu pushed a commit to wdongyu/OpenSearch that referenced this pull request Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x Backport to 2.x branch skip-changelog :test Adding or fixing a test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants