{% load staticfiles %} API Documentation

API Documentation

Getting Started

Generated date: {% now 'c' %}

Resources

{% for resource_name, resource in resources %}

{{ resource_name|capfirst }}

{% if resource.Meta.description %}
{{ resource.Meta.description }}
{% endif %}
Location {{ resource.Meta.api.api_url }}/{{ resource_name }}
Document Location {{ resource.Meta.api.api_url }}/{{ resource_name }}/{id}
Allowed methods {{ resource.Meta.allowed_methods }}
Authenticators {{ resource.Meta.authenticators }}

Fields

{% for field in resource.Meta.model_info.fields_own %} {% if field.django_field.has_default %} {% else %} {% endif %} {% endfor %}
Name Type Default Description
{{ field.name }} {{ field.django_field.description }}{{ field.django_field.default }}{{ field.django_field.help_text }}

Form Fields

{% for field_name, field in resource.Meta.default_form.base_fields.items %} {% endfor %}
Name Required Description
{{ field_name }} {{ field.required }} {{ field.help_text }}
{% endfor %}