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] Edit search API summaries #3080

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[OpenAPI] Edit search API summaries #3080

wants to merge 6 commits into from

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Oct 25, 2024

Relates to #2635

This PR edits the summaries for a subset of search APIs, such that they more closely align with our style recommendations and the titles from https://www.elastic.co/guide/en/elasticsearch/reference/master/search.html

Reviewer notes

Since the openAPI document is too big for previews and not hooked into buildkite previews yet, if reviewers are wanting to review the strings, they all appear in the output/openapi/elasticsearch-openapi.json file. The serverless file in that folder is the same or smaller subset so it's not necessary to compare both output for the purposes of these text edits.

Copy link
Contributor

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

API Status Request Response
clear_scroll 🟢 17/17 17/17
close_point_in_time 🟢 7/7 7/7
field_caps 🟢 63/63 63/63
msearch_template 🟢 1/1 1/1
open_point_in_time 🟢 7/7 7/7
rank_eval Missing test Missing test
render_search_template 🟢 1/1 1/1
search_template 🟢 2/2 1/1

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

@lcawl lcawl marked this pull request as ready for review October 25, 2024 01:29
Copy link
Contributor

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

API Status Request Response
clear_scroll 🟢 17/17 17/17
close_point_in_time 🟢 7/7 7/7
field_caps 🟢 63/63 63/63
msearch_template 🟢 1/1 1/1
open_point_in_time 🟢 7/7 7/7
rank_eval Missing test Missing test
render_search_template 🟢 1/1 1/1
search_template 🟢 2/2 1/1

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
clear_scroll 🟢 17/17 17/17
close_point_in_time 🟢 7/7 7/7
field_caps 🟢 63/63 63/63
knn_search 🟢 4/4 4/4
msearch_template 🟢 1/1 1/1
open_point_in_time 🟢 7/7 7/7
rank_eval Missing test Missing test
render_search_template 🟢 1/1 1/1
search_mvt 34/34 Missing test
search_shards 🟢 7/7 7/7
search_template 🟢 2/2 1/1
search 🔴 2213/2273 2254/2255
termvectors 🟢 8/8 8/8

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
clear_scroll 🟢 17/17 17/17
close_point_in_time 🟢 7/7 7/7
field_caps 🟢 63/63 63/63
knn_search 🟢 4/4 4/4
msearch_template 🟢 1/1 1/1
open_point_in_time 🟢 7/7 7/7
rank_eval Missing test Missing test
render_search_template 🟢 1/1 1/1
search_mvt 34/34 Missing test
search_shards 🟢 7/7 7/7
search_template 🟢 2/2 1/1
search 🔴 2213/2273 2254/2255
termvectors 🟢 8/8 8/8

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

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.

1 participant