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

Wire in our own swagger docs #317

Merged
merged 14 commits into from
May 20, 2021
Merged

Conversation

dwedul-figure
Copy link
Contributor

@dwedul-figure dwedul-figure commented May 19, 2021

Description

  • Make the swagger-ui load information about our own endpoints rather than just the Cosmos SDK endpoints.
  • Update the Dockerfiles to copy the client directory now too (since app.go imports a file from there).
  • Update the Makefile to remove the proto-swagger-gen command and put that functionality completely under update-swagger-docs.
  • Update the Makefile to clean up the proto-all command by removing some unavailable commands and reordering the list so that proto-format and proto-lint come before proto-gen.
  • Update the Makefile to output a reminder after proto-gen to also run make update-swagger-docs once done making proto changes (if there are any).
  • Added a README about the Swagger UI stuff.
  • Updated the linkify script to allow easy linking of changelog entries to PRs too.

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.

  • 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 unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

…registered with statik so that when the swagger-ui is activated, it finds our own swagger stuff rather than the Cosmos SDK swagger stuff.
…t call into the update-swagger-docs command. In order to correctly update the docs, both need to be run anyway and this will hopefully prevent confusion.
…ctually available, and also swap the order around a bit so that we're formatting and linting before generating.
@dwedul-figure dwedul-figure enabled auto-merge (squash) May 19, 2021 23:38
@dwedul-figure dwedul-figure enabled auto-merge (squash) May 19, 2021 23:48
@dwedul-figure dwedul-figure merged commit 510a59f into main May 20, 2021
@dwedul-figure dwedul-figure deleted the dwedul/further-swagger-fixes branch May 20, 2021 01:09
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.

2 participants