{% extends "base.html" %} {# OpenAPI Reference Overview Template Renders the API overview page with information from the OpenAPI info object. Extends base.html to inherit theme navigation, sidebars, and styling. Uses autodoc.css for all styling. This template receives: - element: DocElement for the overview - config: Autodoc configuration - site: Site instance #} {% from 'partials/navigation-components.html' import breadcrumbs, page_navigation, toc %} {% block content %} {# Three-column documentation layout #}
{# Left Sidebar: Navigation #} {# Main Content #}
{# Page Hero: Breadcrumbs + Title + Description + Metadata #} {% include 'partials/page-hero.html' %} {# Article Content - autodoc skeleton #}
{# Header #}
REST API {% if element.metadata.version %} v{{ element.metadata.version }} {% end %}

{{ element.name }}

{% if element.description %}
{{ element.description | safe }}
{% end %}
{# Servers #} {% if element.metadata.servers %}

Base URLs

    {% for server in element.metadata.servers %}
  • {{ server.href or server }} {% if server.description %} — {{ server.description }} {% end %}
  • {% end %}
{% end %} {# Tags / Endpoint Groups #} {% if element.metadata.tags %}

API Groups

{% for tag in element.metadata.tags %}

{{ tag.name or tag }}

{% if tag.description %}

{{ tag.description }}

{% end %}
{% end %}
{% end %} {# Authentication / Security Schemes #} {% if element.metadata.security_schemes %}

Authentication

{% for scheme_name, scheme in element.metadata.security_schemes.items() %} {% end %}
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 ?? '—' }}
{% end %} {# Quick Links to Endpoints and Schemas #}

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 ~ '/' %}
{{ icon("zap", size=24, css_class="icon-success") }} Endpoints
Browse API operations
{{ icon("layers", size=24, css_class="icon-info") }} Schemas
View data models
{# Tags #} {% if page.tags %} {% end %}
{# Page navigation (prev/next) at bottom #} {{ page_navigation(page) }}
{# Right Sidebar: Contextual Graph + TOC + Metadata #} {% include 'partials/docs-toc-sidebar.html' %}
{# Mobile sidebar toggle button #} {# Sidebar overlay for mobile #} {% end %}