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

Mismatch between actual API endpoints and the ones in OpenAPI (Swagger) #1449

Closed
fadeev opened this issue Dec 20, 2023 · 3 comments
Closed
Labels

Comments

@fadeev
Copy link
Member

fadeev commented Dec 20, 2023

For example, OpenAPI says there should be an endpoint /zeta-chain/emissions/params:

https://github.com/zeta-chain/node/blob/26a4abe19ea4d70534fb5113d00c77b901a6b682/docs/openapi/openapi.swagger.yaml#L27234

In reality, this endpoint doesn't exist and we have /zeta-chain/zetacore/emissions/params, instead:

https://zetachain-athens.blockpi.network/lcd/v1/public/zeta-chain/zetacore/emissions/params

This is because we still have zetacore in proto and there is a mismatch between directories and proto package names:

package zetachain.zetacore.emissions;

Right now all ZetaChain's custom endpoints are not accessible from the OpenAPI browser.

@fadeev
Copy link
Member Author

fadeev commented Dec 20, 2023

I propose we refactor this to:

package zetachain.emissions; 

To keep things simple.

@fadeev
Copy link
Member Author

fadeev commented Dec 20, 2023

Ideally, instead of /zeta-chain/zetacore/emissions/... we have /zeta-chain/emissions/....

@fadeev
Copy link
Member Author

fadeev commented Dec 21, 2023

No longer relevant: #1282

@fadeev fadeev closed this as completed Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant