{% extends "admin.html" %} {% block content %}

API

{% if endpoint %} {% if token %}
Access Token
{% endif %}
{{ endpoint.name }}

Method

{{ endpoint.method }}

URL

{{ endpoint.url }}

Input

{% if endpoint.query_params or endpoint.input_params %} {% for param in endpoint.query_params %} {% endfor %} {% for param in endpoint.input_params %} {% endfor %}
Verbose Name Name Type Required Detail
{{ param.verbose_name }} {{ param.name }} {{ param.type }} {{ param.required|format }} {{ param.help_text|format }}
{{ param.verbose_name }} {{ param.name }} {{ param.type }} {{ param.required|format }} {{ param.help_text|format }}
{% endif %} {% if token %} {{ form }} {% endif %} {% if result %}
Command
{{ cmd }}
Output
{{ result|safe }} {% endif %}
{% else %}
About

This page contains the documentation necessery to use the applicaton API. It also alows the execution of the endpoints inplace and displays the curl comand that can be used to reproduce the execution in the terminal.

In oder to list the available endpoints for a specific model, click on the model in the panel beside. Click on the endpoint to views its documentation or execute it.

Your token will be displayed on the top of the page and will be used in the executions. To execute with another user's token, execute the endpoint "get_token" from the model "User".

{% endif %}
{{ documentation.title }} {% if documentation.model %} {% endif %}
{% for verbose_name, url in documentation.index %}

{{ verbose_name }}

{{ url }} {% endfor %} {% for endpoint in documentation.endpoints %}

{{ endpoint.name }}

{{ endpoint.url }} {% endfor %}
{% endblock %}