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 %}
| Request bodies |
{% for item in operation.request_bodies %}{{ item }}{% if not loop.last %}, {% end %}{% end %} |
{% end %}
{% if operation.responses %}
| Responses |
{% for item in operation.responses %}{{ item }}{% if not loop.last %}, {% end %}{% end %} |
{% end %}
{% if operation.schemas %}
| Schemas |
{% for item in operation.schemas %}{{ item }}{% if not loop.last %}, {% end %}{% end %} |
{% end %}
{% if operation.examples %}
| Examples |
{% for item in operation.examples %}{{ item }}{% if not loop.last %}, {% end %}{% end %} |
{% end %}
{% end %}
{% if operation.auth or operation.environments %}
Runtime
{% if operation.auth %}
| Auth |
{% for item in operation.auth %}{{ item }}{% if not loop.last %}, {% end %}{% end %} |
{% end %}
{% if operation.environments %}
| Environments |
{% for item in operation.environments %}{{ item }}{% if not loop.last %}, {% end %}{% 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 }}
| Mode |
State |
Behavior |
{% for mode in try_it.modes %}
| {{ mode.id }} |
{{ 'available' if mode.available else 'unavailable' }} |
{{ mode.request_behavior }}{% if mode.disabled_reason | default('') %}: {{ mode.disabled_reason }}{% end %} |
{% 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 %}