OpenAPI Schemas

Схема ответа при коде отличном от 2xx всегда одна: %failure

В описании схем используются следующие модификаторы для атрибутов:

{
    *"required": обязательный атрибут
    :"readonly": автогенерируемый атрибут, игнорируется в POST запросах, всегда заполнен в get запросах
    ~"semiauto": если не заполнен в POST запросе, то сгенерируется автоматически.
    +"expanded": атрибут заполняется со связанных сущностей, если в GET запрос передан expanded=true
}

В %patch схемах null значения допустимы для _необязательных параметров. В таком случае значение параметра будет выставлено в null.

Если в %_patch схеме параметр не передается, то он не будет изменен.

---