{% extends 'api/doc/base.html' %} {% load markup prettycode %} {% block extra_head %} {{ block.super }} {% endblock extra_head %} {% block form_content %}

{{ name }}

{{ doc|restructuredtext }} {% include 'api/doc/endpoints.inc.html' %}

Examples

Request

GET {{ urls.list.example.url }}
Host: {{ SITE.domain }}

Response

{{ urls.list.example.response|prettyjson }}

Request

GET {{ urls.object.example.url }}
Host: {{ SITE.domain }}

Response

{{ urls.object.example.response|prettyjson }}
{% for inline in inlines %} {% if forloop.first %}
{% endif %}

{{ inline.name }}

{{ inline.doc|restructuredtext }} {% include 'api/doc/endpoints.inc.html' with urls=inline.urls verbose_name=inline.verbose_name verbose_name_plural=inline.verbose_name_plural formats=inline.formats %}

Examples

Request

GET {{ inline.urls.list.example.url }}
Host: {{ SITE.domain }}

Response

{{ inline.urls.list.example.response|prettyjson }}

Request

GET {{ inline.urls.object.example.url }}
Host: {{ SITE.domain }}

Response

{{ inline.urls.object.example.response|prettyjson }}
{% endfor %} {% endblock form_content %} {% block javascript %} {{ block.super }} {% endblock javascript %}