Каждый метод, принимающий или отдающий сложные модели данных, имеет полное их описание.
Например, для получения описания модели, передаваемой в запрос, надо кликнуть на ссылку Model в таблице Parameters:
GET /api/v1/request/{id}/propose
Для получения описания модели данных, возвращаемых запросом, надо кликнуть на ссылку Model в разделе Response Class:
Описание модели может содержать:
- Признак optional – необязательное поле:
- Тип данных поля:
Подсказку по возможным значениям поля (если набор значений ограничен):
Если поле не является обязательным (признак optional), то значением по умолчанию автоматически выбирается первое значение из списка.
- Перекрестные ссылки на вложенные типы:
- Признак множества значений в параметре, сформированных в массиве: