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

Akash API documentation (swagger) #159

Closed
anilmurty opened this issue Dec 7, 2023 · 1 comment
Closed

Akash API documentation (swagger) #159

anilmurty opened this issue Dec 7, 2023 · 1 comment
Assignees
Labels
P1 repo/akash-api repo/node Akash node repo issues

Comments

@anilmurty
Copy link

https://docs.akash.network/akash-nodes/api-endpoints currently only includes Cosmos SDK APIs and this isn't very helpful for anyone trying to build on or integrate with Akash.

We should enable https://github.com/akash-network/akash-api/blob/main/docs/swagger-ui/swagger.yaml and any other APIs to be viewable in swagger instead and run a hosted instance of the UI (maybe on the colo provider?)

@troian
Copy link
Member

troian commented Feb 26, 2024

swagger documentation is off by default.
it can be enabled on each node by either in app.toml

[api]
enable = true
swagger = true

or with environment variables:
AKASH_API_ENABLE=true AKASH_API_SWAGGER=true.

API by default is available on port 1317

@troian troian closed this as completed Feb 26, 2024
@github-project-automation github-project-automation bot moved this from Up Next (prioritized) to Released (in Prod) in Core Product and Engineering Roadmap Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 repo/akash-api repo/node Akash node repo issues
Projects
Status: Released (in Prod)
Development

No branches or pull requests

3 participants