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.

Sign up for GitHub

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

Jump to bottom

[OpenAPI] Edit search API summaries #3080

Merged
merged 10 commits into from
Nov 5, 2024
Merged

[OpenAPI] Edit search API summaries #3080

merged 10 commits into from
Nov 5, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Oct 25, 2024 •
edited
Loading

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.

@lcawl lcawl requested a review from esdocs October 25, 2024 01:27
@github-actions GitHub Actions
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
@lcawl lcawl mentioned this pull request Oct 25, 2024
Closed
@github-actions GitHub Actions
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.

@github-actions GitHub Actions
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.

@github-actions GitHub Actions
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.

leemthompo
leemthompo approved these changes Nov 5, 2024
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

Rubber stamp :)

specification/_global/close_point_in_time/ClosePointInTimeRequest.ts Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 5, 2024

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 🔴 2216/2286 2267/2268
termvectors 🟢 8/8 8/8

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 5, 2024

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 🔴 2216/2286 2267/2268
termvectors 🟢 8/8 8/8

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

@lcawl lcawl enabled auto-merge (squash) November 5, 2024 16:48
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 5, 2024

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 🔴 2216/2286 2267/2268
termvectors 🟢 8/8 8/8

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

1 similar comment
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 5, 2024

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 🔴 2216/2286 2267/2268
termvectors 🟢 8/8 8/8

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

@lcawl lcawl merged commit 5def4b4 into main Nov 5, 2024
6 checks passed
@lcawl lcawl deleted the lcawl/search-edits branch November 5, 2024 16:49
github-actions bot pushed a commit that referenced this pull request Nov 5, 2024
@lcawl @github-actions
[OpenAPI] Edit search API summaries (#3080)
eba8066 
Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 5def4b4)
@github-actions github-actions bot mentioned this pull request Nov 5, 2024
Merged
github-actions bot pushed a commit that referenced this pull request Nov 5, 2024
@lcawl @github-actions
[OpenAPI] Edit search API summaries (#3080)
985c3f6 
Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 5def4b4)
@github-actions github-actions bot mentioned this pull request Nov 5, 2024
Merged
lcawl added a commit that referenced this pull request Nov 5, 2024
@github-actions @lcawl
[OpenAPI] Edit search API summaries (#3080) (#3099)
fc63029 
Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 5def4b4)

Co-authored-by: Lisa Cawley <[email protected]>
lcawl added a commit that referenced this pull request Nov 5, 2024
@github-actions @lcawl
[OpenAPI] Edit search API summaries (#3080) (#3100)
ae37821 
Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 5def4b4)

Co-authored-by: Lisa Cawley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leemthompo leemthompo leemthompo approved these changes

@esdocs esdocs Awaiting requested review from esdocs

Assignees
No one assigned
Labels
backport 8.x backport 8.16 OpenAPI specification
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lcawl @leemthompo