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

Add x-codeSamples to check document API #3594

Merged
merged 2 commits into from
Jan 28, 2025
Merged

Add x-codeSamples to check document API #3594

merged 2 commits into from
Jan 28, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 24, 2025

This PR tests the addition of some x-codeSamples per https://docs.bump.sh/help/specification-support/doc-code-samples/ via an overlay for https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-exists

The examples are copied from https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html

Preview

The examples show up in a Bump.sh preview like this:

image

image

image

Copy link
Contributor

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

API Status Request Response
exists 🟢 19/19 19/19

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

Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

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

Thanks for experimenting with this!

@pquentin pquentin added the skip-backport This pull request should not be backported label Jan 24, 2025
Copy link
Contributor

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

API Status Request Response
exists 🟢 19/19 19/19

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

1 similar comment
Copy link
Contributor

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

API Status Request Response
exists 🟢 19/19 19/19

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
exists 🟢 19/19 19/19

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

@lcawl lcawl marked this pull request as ready for review January 28, 2025 23:54
@lcawl lcawl merged commit fcd7150 into main Jan 28, 2025
8 checks passed
@lcawl lcawl deleted the x-codesamples branch January 28, 2025 23:54
@lcawl lcawl added backport 8.x and removed skip-backport This pull request should not be backported labels Jan 30, 2025
lcawl added a commit that referenced this pull request Jan 30, 2025
@lcawl
Copy link
Contributor Author

lcawl commented Jan 30, 2025

💚 All backports created successfully

Status Branch Result
8.x

Questions ?

Please refer to the Backport tool documentation

github-actions bot pushed a commit that referenced this pull request Jan 30, 2025
lcawl added a commit that referenced this pull request Jan 30, 2025
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