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

docs: add detailed descriptions and examples to swagger specification #165

Merged
merged 8 commits into from
Oct 15, 2021

Conversation

jaybxyz
Copy link
Contributor

@jaybxyz jaybxyz commented Oct 13, 2021

Description

closes: #39 #125

Tasks

  • Write detailed descriptions and examples for query.proto
  • Add third party proto files protoc-gen-openapiv2/options/...
  • Add swagger bundle files such as index.html, swagger-ui-bundle.js, and etc...
  • Update buf.yaml to ignore protoc-gen-openapiv2 (proto lint issue)
  • Make proto-all ( format, swagger-gen, statik, etc. )
  • Update published swagger on swaggerHub

References


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Appropriate labels applied
  • Targeted PR against correct branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@jaybxyz jaybxyz self-assigned this Oct 13, 2021
@jaybxyz jaybxyz marked this pull request as ready for review October 14, 2021 08:01
proto/tendermint/farming/v1beta1/query.proto Outdated Show resolved Hide resolved
proto/tendermint/farming/v1beta1/query.proto Outdated Show resolved Hide resolved
Copy link
Contributor

@dongsam dongsam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but It seems like proto-format, proto-swagger-gen was not executed well.
descriptions and examples was updated on proto, but swagger.yaml not updated that.
This can happen if the proto docker container for another module collides even if the make is executed. Please pay attention to it next time :)
Let me commit that now.

@jaybxyz jaybxyz merged commit f5ff949 into tendermint:master Oct 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Add detailed descriptions and examples to Swagger specification
3 participants