The OpenAPI 3.0 (Swagger) specification of cardano-wallet is located at specifications/api/swagger.yaml.
Viewing online
To view the file online, use:
-
API Documentation for the latest released version.
-
ReDoc viewer for the
masterbranch version.
Validating locally
To validate from your local git working tree, use this command. It is the same as what Buildkite runs.
openapi-spec-validator --schema 3.0.0 specifications/api/swagger.yaml
If you don’t have the validator tool installed, it is available within nix-shell.
It may also be convenient to edit the YAML while validating under the Steel Overseer file watching tool:
sos specifications/api/swagger.yaml -c 'openapi-spec-validator --schema 3.0.0 \0'