{{ method.description }}

Метод

{{ method.type }} {{ method.url }}

Параметры

{% if (method.requestHeaders is empty) and (method.requestQueryParams is empty) and (method.requestFields is empty)%}

Параметры отсутствуют

{% else %} {% if method.requestHeaders is not empty %}

Заголовки:

Название заголовка
Тип
Описание
Обязательность
{% for field in method.requestHeaders -%} {%- include 'field-row.html.twig' with { field: field, objectsLinks: objectsLinks, useAnchors: useAnchors } %} {%- endfor %}
{% endif %} {% if method.requestQueryParams is not empty %}

Query-параметры:

Название параметра
Тип
Описание
Обязательность
{% for field in method.requestQueryParams -%} {%- include 'field-row.html.twig' with { field: field, objectsLinks: objectsLinks, useAnchors: useAnchors } %} {%- endfor %}
{% endif %} {% if method.requestFields is not empty %}

Тело запроса, объект следующей структуры:

Название поля
Тип
Описание
Обязательность
{% for field in method.requestFields -%} {%- include 'field-row.html.twig' with { field: field, objectsLinks: objectsLinks, useAnchors: useAnchors } %} {%- endfor %}
{% if default(showSandbox, true) %}
Пример запроса
{% for field in method.requestFields -%} {% endfor %}
{% endif %}
{% endif %} {% endif %}

Возможные ошибки

{% if (method.errorsEnumeration is empty) or (method.errorsEnumeration.allowedValues is empty) %}

Описание ошибок отсутствует

{% else %} {% for value in method.errorsEnumeration.values -%} {%- if value.value in method.errorsEnumeration.allowedValues %}

#Код {{ value.value }} — {{ value.description }}

{%- endif -%} {%- endfor %} {% endif %}

Результат

{% if (method.responseFields is empty) and (method.responseHeaders is empty) %}

Результат отсутствует

{% else %} {% if method.booleanResponseDescription is not empty %}

{{ method.booleanResponseDescription }}. Тип Boolean.

{% elseif method.responseFields is not empty %}

Объект следующей структуры:

Название поля
Тип
Описание
Обязательность
{% for field in method.responseFields -%} {%- include 'field-row.html.twig' with { field: field, objectsLinks: objectsLinks, useAnchors: useAnchors } %} {%- endfor %}
{% endif %} {% if method.responseHeaders is not empty %}

Заголовки:

Название заголовка
Тип
Описание
Обязательность
{% for field in method.responseHeaders -%} {%- include 'field-row.html.twig' with { field: field, objectsLinks: objectsLinks, useAnchors: useAnchors } %} {%- endfor %}
{% endif %} {% endif %} {%- include 'comment.html.twig' with { comment: method.comment } %}