Тема
Конверт ответа
Обязательная часть успешного ответа любого инструмента каталога. Контракт допускает дополнительные поля: выход бизнеса может быть шире (направление совместимости).
| Поле | Обязательно | Тип | Значение |
|---|---|---|---|
freshness | да | Freshness | Свежесть |
page | нет | Page | Страница |
source_refs | да | список SourceRef |
Схема Envelope
json
{
"additionalProperties": true,
"description": "Обязательная часть успешного ответа любого инструмента каталога: откуда данные, насколько свежи, есть ли продолжение.",
"properties": {
"freshness": {
"$ref": "#/$defs/Freshness"
},
"page": {
"$ref": "#/$defs/Page"
},
"source_refs": {
"items": {
"$ref": "#/$defs/SourceRef"
},
"type": "array"
}
},
"required": [
"source_refs",
"freshness"
],
"title": "Конверт ответа",
"type": "object"
}Списковый инструмент (list: true в каталоге) обязан принимать limit и непрозрачный cursor и возвращать page.
| Поле | Обязательно | Тип | Значение |
|---|---|---|---|
cursor | нет | string | |
limit | нет | integer |