{% import "static_api/docs/macros/common.html" as common with context %}
{% block content %}

{{ resource.name|capitalize }}


{{ common.section_name('Description') }}{% block description %}{% endblock %}
{{ common.section_name('Resource access') }} {% block resource_access %} {{ common.idm_url(resource) }} {% endblock %}
{{ common.section_name('Url Structure') }}{% block urlstructure %}{% include "static_api/docs/include/url-structure.html" %}{% endblock %}
{{ common.section_name('Method') }}{% block method %}GET (or POST for query string larger than 1300 characters){% endblock %}
{{ common.section_name('Authorization') }} {% block authorization %} Requires valid Passport Session_id cookie or OAuth token through HTTP header: Authorization: OAuth {{ ''|escape }}. {% endblock %}
{{ common.section_name('Parameters') }}{% block parameters %}{% include "static_api/docs/include/url-params.html" %}{% endblock %}
{{ common.section_name('Returns') }}{% block returns %}{% endblock %}
{{ common.section_name('JSON Schema') }} {% block json_schema %} {{ common.schema_link(resource.name) }} {% endblock %}
{{ common.section_name('Fields') }} {% block fields %} {{ common.render_schema(resource.name) }} {{ common.render_schema_flatten(resource.name) }} {% endblock %}
{{ common.section_name('Examples') }} {% block examples %} Coming soon. {% endblock %}
{{ common.section_name('Errors') }} {% block errors %} {{ common.errors_start() }} {{ common.error(400, "Invalid request parameters.") }} {{ common.error(401, "Unauthorized. Invalid OAuth token or session cookie.") }} {{ common.error(403, "Fields access forbidden.") }} {{ common.error(404, "Entity with given filters doesn't exist.") }} {{ common.errors_end() }} {% endblock %}
{{ common.section_name('Notes') }} {% block notes %} No notes. {% endblock %}
{{ common.section_name('Stability Policy')}} {% block stability %} JSON schema can be updated by adding new fields but not changing existing ones. {% endblock %}
{% endblock %}