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

Adds async search API request and response examples #2780

Merged
merged 5 commits into from
Aug 13, 2024
Merged

Adds async search API request and response examples #2780

merged 5 commits into from
Aug 13, 2024

Conversation

szabosteve
Copy link
Contributor

Overview

Related to #2482.
This PR adds request and response examples to the async search API.

@szabosteve szabosteve requested a review from lcawl August 9, 2024 12:28
@szabosteve szabosteve mentioned this pull request Aug 9, 2024
Open
58 tasks
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 9, 2024

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

API Status Request Response
async_search.get 🟢 6/6 6/6
async_search.status 🟢 3/3 3/3
async_search.submit 🟢 7/7 7/7

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 9, 2024

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

API Status Request Response
async_search.get 🟢 6/6 6/6
async_search.status 🟢 3/3 3/3
async_search.submit 🟢 7/7 7/7

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 9, 2024

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

API Status Request Response
async_search.get 🟢 6/6 6/6
async_search.status 🟢 3/3 3/3
async_search.submit 🟢 7/7 7/7

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

@lcawl
Copy link
Contributor

lcawl commented Aug 9, 2024

I added a commit that appends overlays for the async_search.submit operation. I ran make overlay-docs then linted the output and it has the following warnings:

62541:27 warning oas3-schema Property "method_request" is not expected to be here. components.examples.AsyncSearchSubmitRequestExample1.method_request
62543:17 warning oas3-schema Property "type" is not expected to be here. components.examples.AsyncSearchSubmitRequestExample1.type
62549:17 warning oas3-schema Property "type" is not expected to be here. components.examples.AsyncSearchSubmitResponseExample1.type
62550:26 warning oas3-schema Property "response_code" is not expected to be here. components.examples.AsyncSearchSubmitResponseExample1.response_code

However when I preview the output in Bump.sh, the example showed up fine.

@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.get 🟢 6/6 6/6
async_search.status 🟢 3/3 3/3
async_search.submit 🟢 7/7 7/7

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

@szabosteve szabosteve requested a review from lcawl August 12, 2024 11:25
lcawl
lcawl approved these changes Aug 12, 2024
View reviewed changes
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

lgtm

@szabosteve szabosteve merged commit 73602db into main Aug 13, 2024
6 checks passed
@szabosteve szabosteve deleted the szabosteve/api-examples-p1 branch August 13, 2024 07:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lcawl lcawl lcawl approved these changes

Assignees
No one assigned
Labels
specification
Projects
None yet
Milestone
No milestone
Development

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