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: Update openapi.yml #295

Merged
merged 2 commits into from
Oct 12, 2022
Merged

Conversation

spoo-bar
Copy link
Contributor

The swagger docs for the REST endpoints have not been updated in a long while, with multiple endpoints missing.
This PR updates the openapi.yml to the latest queries available

@the-frey
Copy link
Collaborator

Thanks! Can't say it's something I regularly use so probably why it wasn't spotted 🤔

@giansalex
Copy link
Member

In this page https://v1.cosmos.network/rpc/v0.45.1, we can set a custom API URL
image

so it is not necessary to have it in this repo

@spoo-bar
Copy link
Contributor Author

spoo-bar commented Oct 2, 2022

@giansalex Currently multiple Juno node providers do have a swagger page for their REST endpoints.

  1. LavenderFive https://juno-api.lavenderfive.com/
  2. Notional https://api-juno-ia.cosmosia.notional.ventures/
  3. Silknodes https://api.juno.silknodes.io/

They seem to be taking the openapi spec from the repo. This results in them showing old endpoints.

Additionally, the https://v1.cosmos.network/rpc/v0.45.1 link does not seem to support the endpoints exposed by x/wasmd under /cosmwasm/wasm/v1/

I think it might still be useful to have the updated spec in the repo to ensure up-to-date documentation by node providers.

@giansalex
Copy link
Member

REST endpoint is from the juno node, if we delete file here, it will not be shown there.

@the-frey the-frey requested a review from faddat October 3, 2022 13:13
Copy link
Contributor

@faddat faddat left a comment

Choose a reason for hiding this comment

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

Thank you Spoorthi!

This is great

@the-frey the-frey self-requested a review October 11, 2022 09:56
Copy link
Collaborator

@the-frey the-frey left a comment

Choose a reason for hiding this comment

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

As far as I can tell the swagger on live nodes does match the repo, so needs updating? On that basis LGTM

@the-frey the-frey merged commit 070316e into CosmosContracts:main Oct 12, 2022
@spoo-bar spoo-bar deleted the updating-openapi branch October 12, 2022 08:40
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.

4 participants