{% include "header.html" %}

API description

Info

Description
{{ info.description }}
Title
{{ info.title }}
Contact email
{{ info.contact.email }}
Contact name
{{ info.contact.name }}

Paths

{% for path, path_info in paths %} {% for method, method_data in path_info %}
{{ method }} {{ method_data.summary }}
OperationId
{{ method_data.operationId }}
Tags
{{ method_data.tags }}
Description
{{ method_data.description }}
{% if existsIn(method_data, "parameters") %}
Parameters
{% for param in method_data.parameters %} {% if existsIn(param, "name") %} {% else %} {% endif %} {% endfor %}
Name Description Type
{{ param.name }} {{ param.description }} {{ param.schema.type }}
{{ param }}
{% endif %}
Responses
{{ method_data.responses}}
{% endfor %} {% endfor %}

Models

{% for schema_name, schema_model in components.schemas %}
Type
{{ schema_model.type }}
Properties
{% for property_name, property_data in schema_model.properties %} {% if existsIn(property_data, "example") and existsIn(property_data, "description") %} {% else %} {% endif %} {% endfor %}
Name Description Type Example
{{ property_name }} {{ property_data.description }} {{ property_data.type }} {% if isArray(property_data.example) %}
    {% for example in property_data.example %}
  • {{ example }}
    • {% endfor %}
{% else %} {{ property_data.example }} {% endif %}
{{ property_name }} {{ property_data }}
Required
    {% for req in schema_model.required %}
  • {{ req }}
    • {% endfor %}
{% endfor %}
{% include "footer.html" %}