OpenAPI spec and libraries

We provide an OpenAPI file to help generate client libraries.

You can find openapi.yaml in our public github repo here.

Steps to generate client libraries:

  1. Install open-api generator. openapi-generator installation guide
    1. Using homebrew: brew install openapi-generator
    2. Using NPM: npm install @openapitools/openapi-generator-cli -g
  2. Generate openapi-generator usage documentation
    1. Select the programming language to generate with. (supported languages by the generator)
    2. This command will generate go libraries from the openapi.yaml in the generated folder.
    3. openapi-generator generate -i openapi.yaml -g go -o generated.

If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.