forked from ScoDoc/ScoDoc
32 lines
795 B
Django/Jinja
32 lines
795 B
Django/Jinja
{# Template pour la doc mardown d'un point d'entrée de l'API #}
|
|
#### **`{{doc.nom}}`**
|
|
|
|
{% if doc.routes %}
|
|
{% if doc.routes|length == 1 %}
|
|
* **Route:** `{{doc.routes[0]|safe}}`
|
|
{% else %}
|
|
* **Routes:**
|
|
{% for route in doc.routes %}
|
|
* `{{route|safe}}`
|
|
{% endfor %}
|
|
{% endif %}
|
|
{% endif %}
|
|
* **Méthode:** `{{doc.method}}`
|
|
* **Permission:** `{{doc.permission}}`
|
|
{% if doc.params %}
|
|
* **Paramètres:**
|
|
{% for param in doc.params %}
|
|
* `{{param.nom|safe}}` : {{param.description|safe}}
|
|
{% endfor %}
|
|
{% endif %}
|
|
{% if doc.description %}
|
|
* **Description:** {{doc.description|safe}}
|
|
{% endif %}
|
|
{% if doc.data %}
|
|
* **Data:** {{doc.data|safe}}
|
|
{% endif %}
|
|
|
|
{% if doc.sample %}
|
|
* **Exemple de résultat:** [{{doc.sample.nom}}](./samples/sample_{{doc.sample.href}})
|
|
{% else %}
|
|
{% endif %} |