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 Swagger docs #326

Merged
merged 4 commits into from
Aug 19, 2024
Merged

docs: Add Swagger docs #326

merged 4 commits into from
Aug 19, 2024

Conversation

hacheigriega
Copy link
Member

@hacheigriega hacheigriega commented Aug 16, 2024

Motivation

Adding Swagger docs for all query points. To enable it, set swagger = true in app.toml and go to http://localhost:1317/swagger/

To re-generate Swagger docs, run make proto-swagger-gen. Note that client/docs/config.json has to be updated to add or delete query endpoints from the doc.

Closes #159

@Thomasvdam
Copy link
Member

This feels pretty intense, but then again this is often the case with code/docs generation.

Why do we have to manually check out all dependencies and move their proto files? I tried looking at a few other projects (Gaia and Osmosis) but it seems they don't need/do that?

@hacheigriega
Copy link
Member Author

This feels pretty intense, but then again this is often the case with code/docs generation.

Why do we have to manually check out all dependencies and move their proto files? I tried looking at a few other projects (Gaia and Osmosis) but it seems they don't need/do that?

Yeah the number of lines changed is more than my total changes in this repo 🙃
They do! For Osmosis check: https://github.com/osmosis-labs/osmosis/blob/704e95c88f9742b7515f44262657f7081b5107d5/scripts/makefiles/proto.mk#L39

Copy link
Member

@Thomasvdam Thomasvdam left a comment

Choose a reason for hiding this comment

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

Aaaah I didn't check beyond their root makefile, that explains :)

@hacheigriega hacheigriega merged commit 0b5dc48 into main Aug 19, 2024
9 of 10 checks passed
@hacheigriega hacheigriega deleted the hy/swagger branch August 19, 2024 15:35
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.

🐛 Broken REST Routes
2 participants