-
Notifications
You must be signed in to change notification settings - Fork 20
generate OpenAPI docs #138
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
d915bd8
to
8e327fc
Compare
The latest Buf updates on your PR. Results from workflow Lint / lint (pull_request).
|
e3aed51
to
73d3ccb
Compare
73d3ccb
to
b64e865
Compare
miparnisari
commented
May 27, 2025
vroldanbet
reviewed
May 27, 2025
b64e865
to
8a4deaf
Compare
8a4deaf
to
6e47fcf
Compare
vroldanbet
previously approved these changes
May 28, 2025
squat
reviewed
May 28, 2025
squat
previously approved these changes
May 28, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, I just have a request to document a manual action for the generation process to make the workflow more developer-friendly
ad825cf
to
ccd370e
Compare
vroldanbet
previously approved these changes
May 28, 2025
squat
reviewed
May 28, 2025
squat
previously approved these changes
May 28, 2025
Co-authored-by: Lucas Servén Marín <lserven@gmail.com>
squat
approved these changes
May 28, 2025
vroldanbet
approved these changes
May 28, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Testing
Make a change to one of the protos, then commit. You should see something like this, and the swagger file should be automatically updated.
$ git commit ... buf generate.........................................(no files to check)Skipped buf lint.............................................(no files to check)Skipped buf format...........................................(no files to check)Skipped yamllint.............................................(no files to check)Skipped [generate-openapi 4f93a2e] generate OpenAPI docs Date: Mon May 26 16:42:39 2025 -0700 7 files changed, 3407 insertions(+), 28 deletions(-) create mode 100644 Makefile create mode 100755 buf.gen.yaml create mode 100644 docs/apidocs.swagger.json [17:02:22] ~/Documents/GitHub/api (generate-openapi) $