{% extends "layouts/docs_catalog.html" %} {% from "chirpui/breadcrumbs.html" import breadcrumbs %} {% block catalog_hero_eyebrow %} {{ breadcrumbs(breadcrumb_items ?? [{"label": "Home", "href": "/"}]) }} {% end %} {% block catalog_hero_metadata %} {% let operation = node.meta.api_operation ?? none %} {% if operation %} {{ operation.method }} {{ operation.path }} {% if operation.tags %} {% for tag in operation.tags %} {{ tag }} {% end %} {% end %} {% elif child_page_count > 0 %} {{ child_page_count }} operation{{ '' if child_page_count == 1 else 's' }} {% end %} {% end %} {% block catalog_article %} {% let operation = node.meta.api_operation ?? none %} {% let try_it = node.meta.api_try_it ?? none %}
{% if operation %}

Operation

Operation ID
{{ operation.operation_id }}
Method
{{ operation.method }}
Path
{{ operation.path }}
{% if operation.summary %}

{{ operation.summary }}

{% end %}
{% if operation.request_bodies or operation.responses or operation.schemas or operation.examples %}

Contract

{% if operation.request_bodies %} {% end %} {% if operation.responses %} {% end %} {% if operation.schemas %} {% end %} {% if operation.examples %} {% end %}
Request bodies {% for item in operation.request_bodies %}{{ item }}{% if not loop.last %}, {% end %}{% end %}
Responses {% for item in operation.responses %}{{ item }}{% if not loop.last %}, {% end %}{% end %}
Schemas {% for item in operation.schemas %}{{ item }}{% if not loop.last %}, {% end %}{% end %}
Examples {% for item in operation.examples %}{{ item }}{% if not loop.last %}, {% end %}{% end %}
{% end %} {% if operation.auth or operation.environments %}

Runtime

{% if operation.auth %} {% end %} {% if operation.environments %} {% end %}
Auth {% for item in operation.auth %}{{ item }}{% if not loop.last %}, {% end %}{% end %}
Environments {% for item in operation.environments %}{{ item }}{% if not loop.last %}, {% end %}{% end %}
{% end %} {% if try_it %}

Try it

Tenant
{{ try_it.boundaries.tenant }}
Site
{{ try_it.boundaries.site }}
Mount
{{ try_it.boundaries.mount }}
Static export
{{ try_it.static_export.fallback_mode }} {{ try_it.static_export.reason }}
{% for mode in try_it.modes %} {% end %}
Mode State Behavior
{{ mode.id }} {{ 'available' if mode.available else 'unavailable' }} {{ mode.request_behavior }}{% if mode.disabled_reason | default('') %}: {{ mode.disabled_reason }}{% end %}
{% if try_it.base_urls %}

Base URLs

    {% for base in try_it.base_urls %}
  • {{ base.label }}{% if base.url %}: {{ base.url }}{% end %}{% if base.base_url_env %} via {{ base.base_url_env }}{% end %}
  • {% end %}
{% end %} {% if try_it.auth %}

Auth boundaries

    {% for auth in try_it.auth %}
  • {{ auth.scheme }} uses {{ auth.storage }} token storage{% if not auth.configured %}; token reference not configured{% end %}
  • {% end %}
{% end %}
{% end %} {{ node | doc_body | boost_doc_links }} {% if operation.external_docs %}
{% end %}
{% else %}
{{ node | doc_body | boost_doc_links }}
{% end %} {% if backlinks %} {% end %}
{% end %} {% block catalog_doc_nav %} {% include "partials/doc_nav.html" %} {% end %} {% block catalog_toc_aside %} {% if node.toc | length > 0 %} {% end %} {% end %}