-
Notifications
You must be signed in to change notification settings - Fork 83
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Problem Statement
We currently document two sets of interfaces on the API documentation site (https://akash.network/docs/api-documentation/getting-started/) - one is the go SDK (at https://akash.network/docs/api-documentation/sdk/) and another is the Managed wallets API aka Credit Card users API (https://akash.network/docs/api-documentation/console-api/). We have another set of public APIs available at partially documented at https://console-api.akash.network/v1/swagger but there is no mention of it on the docs site. Furthermore, we link to just the swagger docs from within Console. We need to consolidate all docs into one place so that they are more easily discoverable by both humans and by AI tools and agents.
Solution
Part 1
- Rename "Akash SDK" on this page (https://akash.network/docs/api-documentation/getting-started/) to say "Akash Blockchain SDK"
- Rename the "Console API" tile on this page (https://akash.network/docs/api-documentation/getting-started/) to "Akash Deployment REST API"
- Add a third tile called "Akash REST API" that will point to pages that document some (not all) of the endpoints from https://console-api.akash.network/v1/swagger that are not already covered by the first 2.
Part2:
- Write documentation to cover a subset of the APIs from https://console-api.akash.network/v1/swagger under the new "Akash REST API" tile. Specifically for now this will include:
-
GET /v1/providers/ -
GET /v1/gpu
-
Part3:
- Update the Console API doc link to point to https://akash.network/docs/api-documentation/getting-started/ instead of https://console-api.akash.network/v1/swagger?
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
