HAhail-is
UI Pages

API Documentation UI

Changed on

Render the swagger UI page, or (dev only) its supporting jinja context

get/swagger

Request

  • Base URL
    {{ base_url }}
  • URL
    {{ base_url }}/swagger
  • 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 Swagger UI

object required

Changes

  • 51788a4b337bRevision changes
    • breaking

      removed the media type text/html 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

  • b936fd02a792Revision changes
    • 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/html for the response with the status