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

fix: swagger docs & swagger generation #2233 #2271

Merged
merged 1 commit into from
Aug 3, 2022
Merged

fix: swagger docs & swagger generation #2233 #2271

merged 1 commit into from
Aug 3, 2022

Conversation

ctrl-Felix
Copy link
Contributor

Closes: #2233

What is the purpose of the change

Fix the swagger API documentation

Brief Changelog

  • Fix docs/config.json and add all missing protobuf files/dirs
  • Add phony tag to the Makefile for make docs to not interfere with /docs
  • generate new documentation

Testing and Verifying

Run make docs

Documentation and Release Note

I am not sure about that

@ctrl-Felix ctrl-Felix requested a review from a team August 2, 2022 14:32
Copy link
Member

@ValarDragon ValarDragon left a comment

Choose a reason for hiding this comment

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

LGTM - though I have no idea what all this client docs are / are they even helpful

@ctrl-Felix
Copy link
Contributor Author

what all this client docs are / are they even helpful

The current doc is absolutely outdated. A lot of missing queries paired with not working queries:

https://api.osmosis.interbloc.org/swagger/#/

@czarcas7ic
Copy link
Member

Thanks for doing this @ctrl-Felix! It was for sure needed for those using swagger endpoint 😄

@ValarDragon
Copy link
Member

Thanks for fixing this! Let me make an issue to revisit if theres a better flow we can have as well

This makes sense to backport to v11 right?

@p0mvn
Copy link
Member

p0mvn commented Aug 3, 2022

Thanks for fixing this! Let me make an issue to revisit if theres a better flow we can have as well

This makes sense to backport to v11 right?

I think that makes sense

@p0mvn p0mvn added the A:backport/v11.x backport patches to v11.x branch label Aug 3, 2022
@p0mvn p0mvn merged commit 1592bb8 into osmosis-labs:main Aug 3, 2022
mergify bot pushed a commit that referenced this pull request Aug 3, 2022
p0mvn pushed a commit that referenced this pull request Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:backport/v11.x backport patches to v11.x branch C:CLI T:build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Swagger
4 participants