Авторизация
Authorization: Bearer <HALLIFY_PREORDER_DRAFT_TOKEN>Гостевой токен своего публичного черновика предзаказа.
Параметры
draftReferenceПуть · ОбязательноНепрозрачный ссылочный идентификатор публичного черновика. Для авторизации дополнительно требуется отдельный токен черновика.
stringПолное определение
{ "type": "string", "example": "example" }
Ответы
200Возвращает черновик, доступный по токену, и допустимые следующие действия.
Полное определение
{
"$ref": "#/components/schemas/PreorderPublicGetDraftResultDto"
}{
"draftReference": "example-reference",
"status": "ACTIVE",
"request": {
"serviceMode": "DINE_IN",
"scheduledFor": "2026-01-15T12:00:00.000Z",
"partySize": 1,
"salesChannelId": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc",
"clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05",
"items": [
{
"clientLineId": "example-id",
"menuItemId": null,
"menuVariantId": null,
"quantity": 1,
"modifierOptionIds": [
"d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
],
"serviceFlags": [
"example"
]
}
]
},
"quote": null,
"expiresAt": "2026-12-31T18:00:00.000Z",
"updatedAt": "2026-01-15T13:00:00.000Z"
}401Отклоняет отсутствующий, некорректный, истёкший, отозванный или недействительный ключ preorderDraftToken на границе владеющего домена.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}Схемы
PreorderPublicGetDraftResultDto
Возвращает черновик, доступный по токену, и допустимые следующие действия.
draftReferenceОбязательноСсылочный идентификатор
draftReference, назначенный человеком или провайдером для сверки с исходной записью.stringПолное определение
{ "type": "string", "description": "Ссылочный идентификатор `draftReference`, назначенный человеком или провайдером для сверки с исходной записью.", "example": "example-reference" }statusОбязательноТекущий статус жизненного цикла
status; допустимые значения: ACTIVE, PENDING_VERIFICATION, VERIFIED, QUOTED, CONSUMED, EXPIRED, CANCELED.stringПолное определение
{ "type": "string", "enum": [ "ACTIVE", "PENDING_VERIFICATION", "VERIFIED", "QUOTED", "CONSUMED", "EXPIRED", "CANCELED" ], "description": "Текущий статус жизненного цикла `status`; допустимые значения: ACTIVE, PENDING_VERIFICATION, VERIFIED, QUOTED, CONSUMED, EXPIRED, CANCELED.", "example": "ACTIVE" }requestОбязательноВложенные сведения
request; состав полей указан в схеме.objectПолное определение
{ "type": "object", "properties": { "serviceMode": { "type": "string", "enum": [ "DINE_IN", "PICKUP", "DELIVERY", "CATERING" ], "description": "Допустимые значения `serviceMode`: DINE_IN, PICKUP, DELIVERY, CATERING.", "example": "DINE_IN" }, "scheduledFor": { "type": "string", "format": "date-time", "description": "Время `scheduledFor` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.", "example": "2026-01-15T12:00:00.000Z" }, "partySize": { "type": "integer", "minimum": 1, "maximum": 10000, "description": "Целочисленное значение `partySize`. Ограничения: минимум 1; максимум 10000.", "example": 1 }, "salesChannelId": { "type": "string", "format": "uuid", "description": "UUID Hallify для `salesChannelId`.", "example": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc" }, "clientMenuVersionId": { "type": "string", "format": "uuid", "description": "UUID Hallify для `clientMenuVersionId`.", "example": "cd2f2c2a-ba73-4579-8e32-52da8388fd05" }, "items": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "object", "properties": { "clientLineId": { "type": "string", "description": "Непрозрачный идентификатор `clientLineId`; клиент не должен предполагать формат UUID.", "example": "example-id" }, "menuItemId": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID Hallify для `menuItemId`. Null означает отсутствие записанного значения в этом представлении.", "example": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd" }, "menuVariantId": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID Hallify для `menuVariantId`. Null означает отсутствие записанного значения в этом представлении.", "example": "94389946-e5d8-4fba-8358-e3a9c8a04b11" }, "quantity": { "type": "integer", "minimum": 1, "maximum": 999, "description": "Целое количество `quantity` в единице измерения содержащей его позиции или строки. Ограничения: минимум 1; максимум 999.", "example": 1 }, "modifierOptionIds": { "type": "array", "items": { "type": "string", "format": "uuid", "example": "d251fdb0-274c-4e59-8e7e-b1d90e1433bc" }, "description": "Набор идентификаторов UUID Hallify в `modifierOptionIds`.", "example": [ "d251fdb0-274c-4e59-8e7e-b1d90e1433bc" ] }, "serviceFlags": { "type": "array", "items": { "type": "string", "example": "example" }, "description": "Коллекция `serviceFlags` в составе представления.", "example": [ "example" ] } }, "required": [ "clientLineId", "menuItemId", "menuVariantId", "quantity", "modifierOptionIds", "serviceFlags" ], "example": { "clientLineId": "example-id", "menuItemId": null, "menuVariantId": null, "quantity": 1, "modifierOptionIds": [ "d251fdb0-274c-4e59-8e7e-b1d90e1433bc" ], "serviceFlags": [ "example" ] } }, "description": "Коллекция `items` в составе представления.", "example": [ { "clientLineId": "example-id", "menuItemId": null, "menuVariantId": null, "quantity": 1, "modifierOptionIds": [ "d251fdb0-274c-4e59-8e7e-b1d90e1433bc" ], "serviceFlags": [ "example" ] } ] } }, "required": [ "serviceMode", "scheduledFor", "partySize", "salesChannelId", "clientMenuVersionId", "items" ], "description": "Вложенные сведения `request`; состав полей указан в схеме.", "example": { "serviceMode": "DINE_IN", "scheduledFor": "2026-01-15T12:00:00.000Z", "partySize": 1, "salesChannelId": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc", "clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05", "items": [ { "clientLineId": "example-id", "menuItemId": null, "menuVariantId": null, "quantity": 1, "modifierOptionIds": [ "d251fdb0-274c-4e59-8e7e-b1d90e1433bc" ], "serviceFlags": [ "example" ] } ] } }quoteОбязательноВложенные сведения
quote; состав полей указан в схеме. Null означает отсутствие записанного значения в этом представлении.object · nullПолное определение
{ "type": "object", "nullable": true, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID Hallify для `id`.", "example": "9cf6502c-081b-4f02-8b21-5b6146192a9e" }, "status": { "type": "string", "enum": [ "ISSUED", "ACCEPTED", "DECLINED", "EXPIRED", "SUPERSEDED" ], "description": "Текущий статус жизненного цикла `status`; допустимые значения: ISSUED, ACCEPTED, DECLINED, EXPIRED, SUPERSEDED.", "example": "ISSUED" }, "reference": { "type": "string", "description": "Ссылочный идентификатор `reference`, назначенный человеком или провайдером для сверки с исходной записью.", "example": "example-reference" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Код валюты ISO 4217 в `currency` для денежных значений этого представления.", "example": "GEL" }, "subtotal": { "type": "string", "pattern": "^\\d+\\.\\d{2}$", "description": "Десятичная денежная величина `subtotal`, сериализованная строкой в валюте поля `currency`. Ноль означает записанную сумму, а не отсутствие значения.", "example": "1.00" }, "discount": { "type": "string", "pattern": "^\\d+\\.\\d{2}$", "description": "Десятичная денежная величина `discount`, сериализованная строкой в валюте поля `currency`. Ноль означает записанную сумму, а не отсутствие значения.", "example": "1.00" }, "serviceCharge": { "type": "string", "pattern": "^\\d+\\.\\d{2}$", "description": "Десятичная денежная величина `serviceCharge`, сериализованная строкой в валюте поля `currency`. Ноль означает записанную сумму, а не отсутствие значения.", "example": "1.00" }, "tax": { "type": "string", "pattern": "^\\d+\\.\\d{2}$", "description": "Десятичная денежная величина `tax`, сериализованная строкой в валюте поля `currency`. Ноль означает записанную сумму, а не отсутствие значения.", "example": "1.00" }, "deliveryFee": { "type": "string", "pattern": "^\\d+\\.\\d{2}$", "description": "Десятичная денежная величина `deliveryFee`, сериализованная строкой в валюте поля `currency`. Ноль означает записанную сумму, а не отсутствие значения.", "example": "1.00" }, "total": { "type": "string", "pattern": "^\\d+\\.\\d{2}$", "description": "Десятичная денежная величина `total`, сериализованная строкой в валюте поля `currency`. Ноль означает записанную сумму, а не отсутствие значения.", "example": "1.00" }, "depositRequired": { "type": "string", "pattern": "^\\d+\\.\\d{2}$", "description": "Требуемый депозит `depositRequired`.", "example": "1.00" }, "expiresAt": { "type": "string", "format": "date-time", "description": "Время `expiresAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.", "example": "2026-12-31T18:00:00.000Z" } }, "required": [ "id", "status", "reference", "currency", "subtotal", "discount", "serviceCharge", "tax", "deliveryFee", "total", "depositRequired", "expiresAt" ], "description": "Вложенные сведения `quote`; состав полей указан в схеме. Null означает отсутствие записанного значения в этом представлении.", "example": { "id": "9cf6502c-081b-4f02-8b21-5b6146192a9e", "status": "ISSUED", "reference": "example-reference", "currency": "GEL", "subtotal": "1.00", "discount": "1.00", "serviceCharge": "1.00", "tax": "1.00", "deliveryFee": "1.00", "total": "1.00", "depositRequired": "1.00", "expiresAt": "2026-12-31T18:00:00.000Z" } }expiresAtОбязательноВремя
expiresAtв формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.string · date-timeПолное определение
{ "type": "string", "format": "date-time", "description": "Время `expiresAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.", "example": "2026-12-31T18:00:00.000Z" }updatedAtОбязательноВремя
updatedAtв формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.string · date-timeПолное определение
{ "type": "string", "format": "date-time", "description": "Время `updatedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.", "example": "2026-01-15T13:00:00.000Z" }
Полное определение
{
"type": "object",
"properties": {
"draftReference": {
"type": "string",
"description": "Ссылочный идентификатор `draftReference`, назначенный человеком или провайдером для сверки с исходной записью.",
"example": "example-reference"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"PENDING_VERIFICATION",
"VERIFIED",
"QUOTED",
"CONSUMED",
"EXPIRED",
"CANCELED"
],
"description": "Текущий статус жизненного цикла `status`; допустимые значения: ACTIVE, PENDING_VERIFICATION, VERIFIED, QUOTED, CONSUMED, EXPIRED, CANCELED.",
"example": "ACTIVE"
},
"request": {
"type": "object",
"properties": {
"serviceMode": {
"type": "string",
"enum": [
"DINE_IN",
"PICKUP",
"DELIVERY",
"CATERING"
],
"description": "Допустимые значения `serviceMode`: DINE_IN, PICKUP, DELIVERY, CATERING.",
"example": "DINE_IN"
},
"scheduledFor": {
"type": "string",
"format": "date-time",
"description": "Время `scheduledFor` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
"example": "2026-01-15T12:00:00.000Z"
},
"partySize": {
"type": "integer",
"minimum": 1,
"maximum": 10000,
"description": "Целочисленное значение `partySize`. Ограничения: минимум 1; максимум 10000.",
"example": 1
},
"salesChannelId": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `salesChannelId`.",
"example": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc"
},
"clientMenuVersionId": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `clientMenuVersionId`.",
"example": "cd2f2c2a-ba73-4579-8e32-52da8388fd05"
},
"items": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"clientLineId": {
"type": "string",
"description": "Непрозрачный идентификатор `clientLineId`; клиент не должен предполагать формат UUID.",
"example": "example-id"
},
"menuItemId": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "UUID Hallify для `menuItemId`. Null означает отсутствие записанного значения в этом представлении.",
"example": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd"
},
"menuVariantId": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "UUID Hallify для `menuVariantId`. Null означает отсутствие записанного значения в этом представлении.",
"example": "94389946-e5d8-4fba-8358-e3a9c8a04b11"
},
"quantity": {
"type": "integer",
"minimum": 1,
"maximum": 999,
"description": "Целое количество `quantity` в единице измерения содержащей его позиции или строки. Ограничения: минимум 1; максимум 999.",
"example": 1
},
"modifierOptionIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"example": "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
},
"description": "Набор идентификаторов UUID Hallify в `modifierOptionIds`.",
"example": [
"d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
]
},
"serviceFlags": {
"type": "array",
"items": {
"type": "string",
"example": "example"
},
"description": "Коллекция `serviceFlags` в составе представления.",
"example": [
"example"
]
}
},
"required": [
"clientLineId",
"menuItemId",
"menuVariantId",
"quantity",
"modifierOptionIds",
"serviceFlags"
],
"example": {
"clientLineId": "example-id",
"menuItemId": null,
"menuVariantId": null,
"quantity": 1,
"modifierOptionIds": [
"d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
],
"serviceFlags": [
"example"
]
}
},
"description": "Коллекция `items` в составе представления.",
"example": [
{
"clientLineId": "example-id",
"menuItemId": null,
"menuVariantId": null,
"quantity": 1,
"modifierOptionIds": [
"d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
],
"serviceFlags": [
"example"
]
}
]
}
},
"required": [
"serviceMode",
"scheduledFor",
"partySize",
"salesChannelId",
"clientMenuVersionId",
"items"
],
"description": "Вложенные сведения `request`; состав полей указан в схеме.",
"example": {
"serviceMode": "DINE_IN",
"scheduledFor": "2026-01-15T12:00:00.000Z",
"partySize": 1,
"salesChannelId": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc",
"clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05",
"items": [
{
"clientLineId": "example-id",
"menuItemId": null,
"menuVariantId": null,
"quantity": 1,
"modifierOptionIds": [
"d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
],
"serviceFlags": [
"example"
]
}
]
}
},
"quote": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `id`.",
"example": "9cf6502c-081b-4f02-8b21-5b6146192a9e"
},
"status": {
"type": "string",
"enum": [
"ISSUED",
"ACCEPTED",
"DECLINED",
"EXPIRED",
"SUPERSEDED"
],
"description": "Текущий статус жизненного цикла `status`; допустимые значения: ISSUED, ACCEPTED, DECLINED, EXPIRED, SUPERSEDED.",
"example": "ISSUED"
},
"reference": {
"type": "string",
"description": "Ссылочный идентификатор `reference`, назначенный человеком или провайдером для сверки с исходной записью.",
"example": "example-reference"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"description": "Код валюты ISO 4217 в `currency` для денежных значений этого представления.",
"example": "GEL"
},
"subtotal": {
"type": "string",
"pattern": "^\\d+\\.\\d{2}$",
"description": "Десятичная денежная величина `subtotal`, сериализованная строкой в валюте поля `currency`. Ноль означает записанную сумму, а не отсутствие значения.",
"example": "1.00"
},
"discount": {
"type": "string",
"pattern": "^\\d+\\.\\d{2}$",
"description": "Десятичная денежная величина `discount`, сериализованная строкой в валюте поля `currency`. Ноль означает записанную сумму, а не отсутствие значения.",
"example": "1.00"
},
"serviceCharge": {
"type": "string",
"pattern": "^\\d+\\.\\d{2}$",
"description": "Десятичная денежная величина `serviceCharge`, сериализованная строкой в валюте поля `currency`. Ноль означает записанную сумму, а не отсутствие значения.",
"example": "1.00"
},
"tax": {
"type": "string",
"pattern": "^\\d+\\.\\d{2}$",
"description": "Десятичная денежная величина `tax`, сериализованная строкой в валюте поля `currency`. Ноль означает записанную сумму, а не отсутствие значения.",
"example": "1.00"
},
"deliveryFee": {
"type": "string",
"pattern": "^\\d+\\.\\d{2}$",
"description": "Десятичная денежная величина `deliveryFee`, сериализованная строкой в валюте поля `currency`. Ноль означает записанную сумму, а не отсутствие значения.",
"example": "1.00"
},
"total": {
"type": "string",
"pattern": "^\\d+\\.\\d{2}$",
"description": "Десятичная денежная величина `total`, сериализованная строкой в валюте поля `currency`. Ноль означает записанную сумму, а не отсутствие значения.",
"example": "1.00"
},
"depositRequired": {
"type": "string",
"pattern": "^\\d+\\.\\d{2}$",
"description": "Требуемый депозит `depositRequired`.",
"example": "1.00"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Время `expiresAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
"example": "2026-12-31T18:00:00.000Z"
}
},
"required": [
"id",
"status",
"reference",
"currency",
"subtotal",
"discount",
"serviceCharge",
"tax",
"deliveryFee",
"total",
"depositRequired",
"expiresAt"
],
"description": "Вложенные сведения `quote`; состав полей указан в схеме. Null означает отсутствие записанного значения в этом представлении.",
"example": {
"id": "9cf6502c-081b-4f02-8b21-5b6146192a9e",
"status": "ISSUED",
"reference": "example-reference",
"currency": "GEL",
"subtotal": "1.00",
"discount": "1.00",
"serviceCharge": "1.00",
"tax": "1.00",
"deliveryFee": "1.00",
"total": "1.00",
"depositRequired": "1.00",
"expiresAt": "2026-12-31T18:00:00.000Z"
}
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Время `expiresAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
"example": "2026-12-31T18:00:00.000Z"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Время `updatedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
"example": "2026-01-15T13:00:00.000Z"
}
},
"required": [
"draftReference",
"status",
"request",
"quote",
"expiresAt",
"updatedAt"
],
"description": "Возвращает черновик, доступный по токену, и допустимые следующие действия.",
"example": {
"draftReference": "example-reference",
"status": "ACTIVE",
"request": {
"serviceMode": "DINE_IN",
"scheduledFor": "2026-01-15T12:00:00.000Z",
"partySize": 1,
"salesChannelId": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc",
"clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05",
"items": [
{
"clientLineId": "example-id",
"menuItemId": null,
"menuVariantId": null,
"quantity": 1,
"modifierOptionIds": [
"d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
],
"serviceFlags": [
"example"
]
}
]
},
"quote": null,
"expiresAt": "2026-12-31T18:00:00.000Z",
"updatedAt": "2026-01-15T13:00:00.000Z"
}
}TranslatedErrorDto
Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.
statusCodeОбязательноHTTP-статус, повторённый из ответа.
integerПолное определение
{ "type": "integer", "description": "HTTP-статус, повторённый из ответа.", "example": 400 }errorОбязательноКлюч перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.
stringПолное определение
{ "type": "string", "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.", "example": "errors.request.invalid" }codeОбязательноСтабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями.
stringПолное определение
{ "type": "string", "example": "HTTP_BAD_REQUEST", "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями." }messageОбязательноКлюч перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе.
stringПолное определение
{ "type": "string", "example": "errors:http.badRequest", "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе." }translationKeyОбязательноКанонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте.
stringПолное определение
{ "type": "string", "example": "errors:http.badRequest", "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте." }translationValuesНеобязательноНеобязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.
objectПолное определение
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.", "example": { "exampleKey": "example" } }validationErrorsНеобязательноОшибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.
arrayПолное определение
{ "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.", "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorDto" }, "example": [ { "field": "email", "translationKey": "validation:isEmail", "code": "isEmail", "message": "validation:isEmail" } ] }detailsНеобязательноНеобязательные сведения о доменных препятствиях или ошибках валидации.
oneOfПолное определение
{ "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.", "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JsonValue" }, "example": [ "example" ] }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "example": { "exampleKey": "example" } } ], "example": [ "example" ] }
Полное определение
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP-статус, повторённый из ответа.",
"example": 400
},
"error": {
"type": "string",
"description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.",
"example": "errors.request.invalid"
},
"code": {
"type": "string",
"example": "HTTP_BAD_REQUEST",
"description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями."
},
"message": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе."
},
"translationKey": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
"example": {
"exampleKey": "example"
}
},
"validationErrors": {
"description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorDto"
},
"example": [
{
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
]
},
"details": {
"description": "Необязательные сведения о доменных препятствиях или ошибках валидации.",
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"example": [
"example"
]
}
},
"required": [
"statusCode",
"error",
"code",
"message",
"translationKey"
],
"description": "Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.",
"example": {
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}
}ValidationErrorDto
Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.
fieldОбязательноПубличный путь поля. Вложенные свойства и индексы массива разделены точками.
stringПолное определение
{ "type": "string", "example": "email", "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками." }translationKeyОбязательноКлюч перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers.
stringПолное определение
{ "type": "string", "example": "validation:isEmail", "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers." }codeОбязательноСтабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы.
stringПолное определение
{ "type": "string", "example": "isEmail", "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы." }messageОбязательноКлюч перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются.
stringПолное определение
{ "type": "string", "example": "validation:isEmail", "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются." }translationValuesНеобязательноНеобязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.
objectПолное определение
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.", "example": { "exampleKey": "example" } }
Полное определение
{
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "email",
"description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками."
},
"translationKey": {
"type": "string",
"example": "validation:isEmail",
"description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers."
},
"code": {
"type": "string",
"example": "isEmail",
"description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы."
},
"message": {
"type": "string",
"example": "validation:isEmail",
"description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
"example": {
"exampleKey": "example"
}
}
},
"required": [
"field",
"translationKey",
"code",
"message"
],
"description": "Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.",
"example": {
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
}JsonValue
Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.
Полное определение
{
"oneOf": [
{
"type": "string",
"nullable": true,
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"description": "Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.",
"example": "example"
}