UI Pages

Render the OpenAPI spec, or (dev only) its supporting jinja context

get/openapi.yaml

Request

  • Base URL
    {{ base_url }}
  • URL
    {{ base_url }}/openapi.yaml
  • Auth
    none declared

Headers

x-hail-return-jinja-contextboolean
Example:true

Do not render, and instead return the jinja context json.

Response

Successfully retrieved the OpenAPI spec.

object required

Changes

    • breaking

      removed the media type text/yaml for the response with the status

    • info

      api tag UI Pages added

    • info

      api tag Documentation removed

    • info

      added the new optional header request parameter x-hail-return-jinja-context

    • info

      added the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • warning

      deleted the header request parameter x-hail-return-jinja-context

    • info

      api tag Documentation added

    • info

      api tag UI Pages removed

    • info

      added the media type text/yaml for the response with the status