Каждый метод, принимающий или отдающий сложные модели данных, имеет полное их описание.

Например, для получения описания модели, передаваемой в запрос, надо кликнуть на ссылку Model в таблице Parameters:

GET /api/v1/request/{id}/propose

Для получения описания модели данных, возвращаемых запросом, надо кликнуть на ссылку Model в разделе Response Class:

Описание модели может содержать:

1. Признак optional – необязательное поле:
   
   
   
   
2. Тип данных поля:
   
   
   
   
3. Подсказку по возможным значениям поля (если набор значений ограничен):
   
   
   
   
4. Перекрестные ссылки на вложенные типы:
   
   
   
   
5. Признак множества значений в параметре, сформированных в массиве: