{% 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 %}
{{ ep.path|clean_path }}
{{ ep.description|codify_params }}
{% endif %} {# Parameters #}| 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 %} |
This endpoint does not require any request parameters.
{% endif %} {# Response fields #} {% if ep.response_fields.exists %}| 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 %} |