OpenAPI Specification

We removed navigation chrome and redundant "On this page" / repeated Table of Contents. Below is the cleaned and GitBook-optimized Markdown version of the page content.

GoDocs

We also have a Godoc available here.

The OpenAPI spec for the Shannon protocol is autogenerated by the Ignite CLI.

The raw file can be found at pocket/blob/main/docs/static/openapi.yml.

Swagger UI

The Swagger UI for the Shannon Beta TestNet OpenAPI Spec may be viewed at https://shannon-testnet-grove-api.beta.poktroll.com/.

Re-generating the OpenAPI Spec

You can re-generate the OpenAPI spec by running the following command:

Makefile

make openapi_ignite_gen_docker

Cosmos REST API vs CometBFT RPC

We are not going to dive into a discussion of REST vs RPC HTTP APIs here, but will provide minimal context.

You can read about the general differences between REST and RPC APIs here.

The CometBFT RPC Specification can be found here.

The Cosmos SDK REST API Specification can be found here.

Cosmos — Example command to check accounts

</div>

### `CometBFT` — Example command to check node status

<div data-gb-custom-block data-tag="code"></div>
curl -X 'GET' 'https://shannon-testnet-grove-rpc.beta.poktroll.com/status' -H 'accept: application/json' | jq