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