-
-
Notifications
You must be signed in to change notification settings - Fork 147
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 Swagger Serving Command #812
Merged
hackerwins
merged 6 commits into
main
from
804-add-connectrpc-spec-definition-for-api-documentation
Mar 6, 2024
Merged
Add Swagger Serving Command #812
hackerwins
merged 6 commits into
main
from
804-add-connectrpc-spec-definition-for-api-documentation
Mar 6, 2024
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #812 +/- ##
=======================================
Coverage 50.71% 50.71%
=======================================
Files 70 70
Lines 10213 10213
=======================================
Hits 5180 5180
Misses 4512 4512
Partials 521 521 ☔ View full report in Codecov by Sentry. |
hackerwins
approved these changes
Mar 6, 2024
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.
Thanks for your contribution.
hackerwins
reviewed
Mar 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What this PR does / why we need it:
This PR focuses on defining the ConnectRPC API Docs as an OpenAPI Spec and includes adding a Swagger serving command. By converting the API docs to an OpenAPI Spec, it enhances the readability, consistency, and ease of use for developers utilizing the ConnectRPC API.
Which issue(s) this PR fixes:
Fixes #804
Special notes for your reviewer:
To access swagger, run
make docker-swagger
and access tolocalhost:3000
.Does this PR introduce a user-facing change?:
Additional documentation:
Checklist: