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

[OpenAPI] Improve analyze and async search summaries #2924

Merged
merged 5 commits into from
Oct 16, 2024
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Sep 23, 2024

This PR improves the operation summary for the analyze API and async search

Note that it adds a link from the API docs to the Elasticsearch Guide, which relates to #2748. If this is problematic per discussions in #2758, I can omit it for now.

Copy link
Contributor

Following you can find the validation results for the API you have changed.

API Status Request Response
indices.analyze 🔴 240/242 242/242

You can validate this API yourself by using the make validate target.

@lcawl lcawl requested a review from esdocs September 23, 2024 20:09
@lcawl lcawl marked this pull request as ready for review September 23, 2024 20:11
@lcawl lcawl marked this pull request as draft September 26, 2024 22:26
Copy link
Contributor

Following you can find the validation results for the API you have changed.

API Status Request Response
indices.analyze 🔴 240/242 242/242

You can validate this API yourself by using the make validate target.

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
async_search.delete 🟢 4/4 4/4
async_search.get 🟢 6/6 6/6
async_search.status 🟢 3/3 3/3
async_search.submit 🟢 7/7 7/7
indices.analyze 🔴 240/242 242/242

You can validate these APIs yourself by using the make validate target.

@lcawl lcawl changed the title Improve analyze API summary [OpenAPI] Improve analyze and async search summaries Sep 26, 2024
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
async_search.delete 🟢 4/4 4/4
async_search.get 🟢 6/6 6/6
async_search.status 🟢 3/3 3/3
async_search.submit 🟢 7/7 7/7
indices.analyze 🔴 240/242 242/242

You can validate these APIs yourself by using the make validate target.

@lcawl lcawl marked this pull request as ready for review September 27, 2024 00:01
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
async_search.delete 🟢 4/4 4/4
async_search.get 🟢 6/6 6/6
async_search.status 🟢 3/3 3/3
async_search.submit 🟢 7/7 7/7
indices.analyze 🔴 240/242 242/242

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
async_search.delete 🟢 4/4 4/4
async_search.get 🟢 6/6 6/6
async_search.status 🟢 3/3 3/3
async_search.submit 🟢 7/7 7/7
indices.analyze 🟢 242/242 242/242

You can validate these APIs yourself by using the make validate target.

Copy link

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@lcawl lcawl merged commit 9db3982 into main Oct 16, 2024
6 checks passed
@lcawl lcawl deleted the analyze-summaries branch October 16, 2024 21:28
github-actions bot pushed a commit that referenced this pull request Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants