Module api

Module api 

Source
Expand description

Catalyst Gateway API Definition

This defines all endpoints for the Catalyst Gateway API. It however does NOT contain any processing for them, that is defined elsewhere.

Modulesยง

cardano ๐Ÿ”’
Cardano API endpoints
config ๐Ÿ”’
Configuration Endpoints
documents ๐Ÿ”’
Signed Documents API endpoints
health ๐Ÿ”’
Health Endpoints

Constantsยง

API_DESCRIPTION ๐Ÿ”’
A long description of the API. Markdown is supported
API_TITLE ๐Ÿ”’
The name of the API
API_VERSION ๐Ÿ”’
The version of the API
TERMS_OF_SERVICE ๐Ÿ”’
Get the terms of service for the API

Functionsยง

get_api_contact ๐Ÿ”’
Get the contact details for inquiring about the API
get_api_license ๐Ÿ”’
Get the license details for the API
mk_api ๐Ÿ”’
Create the OpenAPI definition
set_localhost_addresses ๐Ÿ”’
Set the localhost addresses descriptions.