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

use request converter to generate python examples #2643

Merged

Conversation

miguelgrinberg
Copy link
Contributor

@miguelgrinberg miguelgrinberg commented Aug 22, 2024

This PR replaces the generate-examples.py script with a new version written in JavaScript (heavily based on the JS client's example generator) that uses the request converter library.

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@miguelgrinberg miguelgrinberg force-pushed the generate-examples-with-converter branch 6 times, most recently from 76a498b to f993de2 Compare August 23, 2024 11:10
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! LGTM.

utils/generate-docs-examples/README.md Outdated Show resolved Hide resolved
utils/generate-docs-examples/package.json Outdated Show resolved Hide resolved
@miguelgrinberg miguelgrinberg merged commit 4ee4650 into elastic:main Aug 23, 2024
9 of 10 checks passed
@miguelgrinberg miguelgrinberg deleted the generate-examples-with-converter branch August 23, 2024 14:12
github-actions bot pushed a commit that referenced this pull request Aug 26, 2024
* use request converter to generate examples

* updated examples

* use correct license

(cherry picked from commit 4ee4650)
pquentin pushed a commit that referenced this pull request Aug 26, 2024
)

* use request converter to generate python examples (#2643)

* use request converter to generate examples

* updated examples

* use correct license

(cherry picked from commit 4ee4650)

* update connector API documentation examples

---------

Co-authored-by: Miguel Grinberg <[email protected]>
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