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

Auto Swagger Doc Generation #5038

Closed
wants to merge 44 commits into from
Closed

Conversation

alexanderbez
Copy link
Contributor

@alexanderbez alexanderbez commented Sep 12, 2019

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 in CHANGELOG.md

  • Re-reviewed Files changed in the github PR explorer


For Admin Use:

  • Added appropriate labels to PR (ex. wip, ready-for-review, docs)
  • Reviewers Assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

@alexanderbez alexanderbez added T:Docs Changes and features related to documentation. WIP labels Sep 12, 2019
@codecov
Copy link

codecov bot commented Sep 16, 2019

Codecov Report

Merging #5038 into master will increase coverage by 0.01%.
The diff coverage is n/a.

@@            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

client/rest/root.go Outdated Show resolved Hide resolved
@alexanderbez alexanderbez added the T: API Breaking Breaking changes that impact APIs and the SDK only (not state machine). label Sep 17, 2019
@alexanderbez
Copy link
Contributor Author

@marbar3778 only in auth :)

@alexanderbez
Copy link
Contributor Author

Looks to be an issue somewhere in the annotations as upgrading the docs yields different results each time.

@alexanderbez
Copy link
Contributor Author

Punting this from 0.38 to 0.39

@tac0turtle
Copy link
Member

@alexanderbez should we close this since we will be doing client work with grpc and can generate the swagger docs from there?

@alexanderbez alexanderbez deleted the bez/2179-auto-swagger branch February 25, 2020 19:27
@alexanderbez alexanderbez restored the bez/2179-auto-swagger branch February 25, 2020 19:27
@clevinson clevinson added this to the v0.39 milestone Apr 30, 2020
@tac0turtle tac0turtle deleted the bez/2179-auto-swagger branch June 3, 2020 14:04
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement automatic API documentation for the LCD
7 participants