{% extends "docca/base.html" %} {% load docca_tags %} {% block title %}{% if ep.title %}{{ ep.title }} — {% endif %}{{ ep.method }} {{ ep.path|clean_path }}{% endblock %} {% if ep.title or ep.description %} {% block meta_description %}{% endblock %} {% block og_tags %} {% endblock %} {% endif %} {% block content %}
← Back to docs
endpoints {% if prev_ep %} {% else %} {% endif %} {% if next_ep %} {% else %} {% endif %}
{# Header #}
{% with method=ep.method|lower %} {% if method == 'get' %} GET {% elif method == 'post' %} POST {% elif method == 'put' %} PUT {% elif method == 'patch' %} PATCH {% elif method == 'delete' %} DELETE {% else %} {{ ep.method }} {% endif %} {% endwith %} {{ ep.path|clean_path }}
{% if ep.subtitle %}

{{ ep.subtitle }}

{% elif ep.description %}

{{ ep.description|first_sentence }}

{% elif ep.title %}

{{ ep.title }}

{% endif %}
{{ ep.app_label|title }} {% if ep.tag %} {{ ep.tag.name }} {% endif %}
{# Section anchor nav #}
{% if ep.description %} Overview {% endif %} Parameters {% if ep.response_fields.exists %} Response {% endif %}
{% if ep.description %}

Overview

{{ ep.description|codify_params }}

{% endif %} {# Parameters #}

Request parameters

{% if ep.parameters.exists %} {% for param in ep.parameters.select_related %} {% endfor %}
Name Type In Required Description Example
{{ param.name }} {{ param.param_def.get_param_type_display }} {{ param.get_location_display }} {% if param.required %} Yes {% else %} Optional {% endif %} {{ param.effective_description|codify_params }} {% if param.example %}{{ param.example }}{% endif %}
{% else %}

This endpoint does not require any request parameters.

{% endif %} {# Response fields #} {% if ep.response_fields.exists %}

Response fields

{% for field in ep.response_fields.all %} {% endfor %}
Name Type Nullable Description Example
{{ field.name }} {{ field.get_data_type_display }} {% if field.nullable %} Yes {% else %} {% endif %} {{ field.description|codify_params }} {% if field.example %}{{ field.example }}{% endif %}
{% endif %}
{% endblock %}