REST API
{% if element.metadata.version %}
v{{ element.metadata.version }}
{% endif %}
{{ element.name }}
{% if element.description %}{{ element.description | safe }}
{% endif %}
Base URLs
-
{% for server in element.metadata.servers %}
-
{{ server.href if server.href is defined else server }}{% if server.description is defined %} — {{ server.description }} {% endif %}
{% endfor %}
API Groups
{% for tag in element.metadata.tags %}
{% endfor %}
{{ tag.name if tag.name is defined else tag }}
{% if tag.description is defined %}{{ tag.description }}
{% endif %}Authentication
| Scheme | Type | Description |
|---|---|---|
{{ scheme_name }} |
{% if scheme.type == 'http' %} {{ scheme.scheme | default('bearer') | title }} ({{ scheme.bearerFormat | default('Token') }}) {% elif scheme.type == 'apiKey' %} API Key ({{ scheme.in }}: {{ scheme.name }}) {% elif scheme.type == 'oauth2' %} OAuth 2.0 {% else %} {{ scheme.type }} {% endif %} | {{ scheme.description | default('—') }} |
Explore
{# Use page URL as base - for overview page at /api/, links go to /api/endpoints/ etc. #}
{% set base_url = page.href | default('/api/') %}
{% set base_url = base_url if base_url.endswith('/') else base_url ~ '/' %}
Endpoints
Browse API operations
Schemas
View data models