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.

Sign up for GitHub

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

Jump to bottom

Improvements to Swagger documentation #243

Open
stefaniatadama opened this issue Aug 2, 2021 · 0 comments
Open

Improvements to Swagger documentation #243

stefaniatadama opened this issue Aug 2, 2021 · 0 comments
Assignees
@YBAAC
Labels
enhancement New feature or request small change Minor changes that won't take much time

Comments

@stefaniatadama
Copy link
Collaborator

stefaniatadama commented Aug 2, 2021 •
edited
Loading

Currently:

  • Swagger docs for Cosmos SDK gRPC endpoints can be viewed under the /swagger/ route of the blockchain's REST API (port 1317), and (from what we can tell) are generated on the fly
  • Swagger docs for ixo modules gRPC endpoints can be found in ixo-blockchain/client/docs/swagger-ui/swagger.yaml, and can be generated using make proto-swagger-gen (if more ixo modules are added, this should be reflected in ixo-blockchain/client/docs/config.json before using this command)

Ideally, Cosmos SDK endpoints and ixo-specific endpoints are documented in a single Swagger file available at a single endpoint. This should be investigated and implemented.
@stefaniatadama stefaniatadama added enhancement New feature or request small change Minor changes that won't take much time labels Aug 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@YBAAC YBAAC

Labels
enhancement New feature or request small change Minor changes that won't take much time
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@stefaniatadama @YBAAC