Skip to main content

OpenAPI specification

OpenAPI support in Temba is enabled by default, automatically generating both JSON and YAML specifications that accurately reflect your configured resources and settings.

Alongside these specs, Temba serves interactive HTML documentation (i.e. Swagger UI) out of the box.

OpenAPI support is controlled through the openapi setting, which accepts two forms:

  • Boolean

    • true (default) enables OpenAPI support.
    • false disables it completely.

  • Object

    • Supplying an object both enables OpenAPI and lets you customize the spec.
    • The object must adhere to the OpenAPIObject interface (see openapi3-ts model).
    • Temba will deep-merge your custom specification into its default spec, preserving all auto-generated endpoints and schemas while applying your overrides.