Skip to content

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 3 commits into from
May 28, 2025
Merged

generate OpenAPI docs #138

merged 3 commits into from
May 28, 2025

Conversation

miparnisari
Copy link
Contributor

@miparnisari miparnisari commented May 26, 2025

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) $ 

Copy link

github-actions bot commented May 26, 2025

The latest Buf updates on your PR. Results from workflow Lint / lint (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedMay 28, 2025, 5:29 PM

@miparnisari miparnisari force-pushed the generate-openapi branch 4 times, most recently from e3aed51 to 73d3ccb Compare May 27, 2025 00:04
@miparnisari miparnisari requested a review from tstirrat15 May 27, 2025 00:04
@miparnisari miparnisari marked this pull request as ready for review May 27, 2025 00:05
vroldanbet
vroldanbet previously approved these changes May 28, 2025
squat
squat previously approved these changes May 28, 2025
Copy link
Contributor

@squat squat left a 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

@miparnisari miparnisari dismissed stale reviews from squat and vroldanbet via ad825cf May 28, 2025 17:05
vroldanbet
vroldanbet previously approved these changes May 28, 2025
squat
squat previously approved these changes May 28, 2025
Co-authored-by: Lucas Servén Marín <lserven@gmail.com>
@miparnisari miparnisari dismissed stale reviews from squat and vroldanbet via 0211a4a May 28, 2025 17:28
@miparnisari miparnisari merged commit a4a0d28 into main May 28, 2025
3 checks passed
@miparnisari miparnisari deleted the generate-openapi branch May 28, 2025 17:36
@github-actions github-actions bot locked and limited conversation to collaborators May 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants