-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Auto Swagger Doc Generation #5038
Closed
Closed
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 Report
@@ Coverage Diff @@
## master #5038 +/- ##
==========================================
+ Coverage 55.04% 55.06% +0.01%
==========================================
Files 291 291
Lines 17835 17835
==========================================
+ Hits 9818 9820 +2
+ Misses 7310 7308 -2
Partials 707 707 |
tnachen
reviewed
Sep 16, 2019
alexanderbez
added
the
T: API Breaking
Breaking changes that impact APIs and the SDK only (not state machine).
label
Sep 17, 2019
alexanderbez
requested review from
alessio,
fedekunze,
jackzampolin and
rigelrozanski
as code owners
September 17, 2019 18:54
@marbar3778 only in auth :) |
Looks to be an issue somewhere in the annotations as upgrading the docs yields different results each time. |
This was referenced Oct 18, 2019
Merged
Punting this from 0.38 to 0.39 |
@alexanderbez should we close this since we will be doing client work with grpc and can generate the swagger docs from there? |
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
T: API Breaking
Breaking changes that impact APIs and the SDK only (not state machine).
T:Docs
Changes and features related to documentation.
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.
This PR starts the groundwork for the automatic generation of REST (Swagger) docs using https://github.com/swaggo/swag.
So far the PR adds annotated documentation to a single handler
BroadcastTxRequest
and mounts the docs at/swager/
.To Do:
closes: #2179
/cc @jackzampolin @tnachen @faboweb @marbar3778
Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to github-issue with discussion and accepted design OR link to spec that describes this work.
Wrote tests
Updated relevant documentation (
docs/
)Added a relevant changelog entry to the
Unreleased
section inCHANGELOG.md
Re-reviewed
Files changed
in the github PR explorerFor Admin Use: