{% if introduction_content %}
{{ introduction_content|safe }}
{% endif %}
{% for group, endpoints in grouped_endpoints.items() %}
{{ group }}
{% for endpoint in endpoints %}
{{ endpoint.method }}
{{ endpoint.url|e }}
{{ endpoint.name or endpoint.title }}
{% if endpoint.description %}
{{ endpoint.description|safe }}
{% endif %}
{% if endpoint.params %}
Parameters
| Name |
Type |
Required |
Description |
{% for param in endpoint.params %}
{{ param.name }} |
{{ param.type }} |
{% if param.optional %}Optional{% else %}Required{% endif %} |
{{ param.description }} |
{% endfor %}
{% endif %}
{% if endpoint.query %}
Query Parameters
| Name |
Type |
Required |
Description |
{% for param in endpoint.query %}
{{ param.name }} |
{{ param.type }} |
{% if param.optional %}Optional{% else %}Required{% endif %} |
{{ param.description }} |
{% endfor %}
{% endif %}
{% if endpoint.success %}
Success Responses
{% for success in endpoint.success %}
{{ success.status }}
{{ success.type }}
{{ success.name }}
{{ success.description }}
{% endfor %}
{% endif %}
{% if endpoint.error %}
Error Responses
{% for error in endpoint.error %}
{{ error.status }}
{{ error.type }}
{{ error.description }}
{% endfor %}
{% endif %}
{% if endpoint.example or endpoint.example_request or endpoint.example_response %}
Example
{% if endpoint.example_request %}
Request
{{ endpoint.example_request }}
{% endif %}
{% if endpoint.example_response %}
Response
{{ endpoint.example_response }}
{% endif %}
{% if endpoint.example and not endpoint.example_request and not endpoint.example_response %}
{% endif %}
{% endif %}
{% endfor %}
{% endfor %}