-
{% if enableSandbox %}
- Documentation
- Sandbox {% endif %}
{% if data.documentation is defined and data.documentation is not empty %}
{% endif %}
{% if data.filters is defined and data.filters is not empty %}
{% endif %}
{% if data.parameters is defined and data.parameters is not empty %}
{% endif %}
{% if data.headers is defined and data.headers is not empty %}
{% endif %}
{% if data.parsedResponseMap is defined and data.parsedResponseMap is not empty %}
{% endif %}
{% if data.statusCodes is defined and data.statusCodes is not empty %}
{% endif %}
{% if data.cache is defined and data.cache is not empty %}
{% if enableSandbox %}
Documentation
{{ data.documentation|extra_markdown }}
{% endif %}
{% if data.link is defined and data.link is not empty %}
Link
{% endif %} {% if data.requirements is defined and data.requirements is not empty %}Requirements
Name | Requirement | Type | Description |
---|---|---|---|
{{ name }} | {{ infos.requirement is defined ? infos.requirement : ''}} | {{ infos.dataType is defined ? infos.dataType : ''}} | {{ infos.description is defined ? infos.description : ''}} |
Filters
Name | Information | ||
---|---|---|---|
{{ name }} |
|
Parameters
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
{{ name }} | {{ infos.dataType is defined ? infos.dataType : '' }} | {{ infos.required ? 'true' : 'false' }} | {{ infos.format }} | {{ infos.description is defined ? infos.description|trans : '' }} |
Headers
Name | Required? | Description |
---|---|---|
{{ name }} | {{ infos.required is defined and infos.required == 'true' ? 'true' : 'false'}} | {{ infos.description is defined ? infos.description|trans : ''}} |
Return
Parameter | Type | Versions | Description |
---|---|---|---|
{{ status_code }} {% if data.statusCodes is defined and data.statusCodes[status_code] is defined %} - {{ data.statusCodes[status_code]|join(', ') }} {% endif %} |
|||
{{ name }} | {{ infos.dataType }} | {% include '@NelmioApiDoc/Components/version.html.twig' with {'sinceVersion': infos.sinceVersion, 'untilVersion': infos.untilVersion} only %} | {{ infos.description }} |
Status Codes
Status Code | Description |
---|---|
{{ status_code }} |
|
Cache
{{ data.cache }}s
{% endif %}
{% if app.request is not null and data.https and app.request.secure != data.https %}
Please reload the documentation using the scheme {% if data.https %}HTTPS{% else %}HTTP{% endif %} if you want to use the sandbox.
{% else %}
{% endif %}
{% endif %}