Авторизация
Authorization: Bearer <HALLIFY_RESERVATION_MANAGE_TOKEN>Гостевой токен управления своим бронированием или записью листа ожидания.
Параметры
originЗаголовок · НеобязательноФактический Origin браузерного запроса для проверки текущих прав представления. Обязателен для новых заявок и продолжения через Storefront. Канонические браузерные запросы Hallify используют Origin, настроенный в HALLIFY_PUBLIC_APP_URL. Заголовок передаёт контекст запроса, не авторизует вызывающего и не заменяет соответствующий гостевой ключ.
string · uriПолное определение
{ "type": "string", "format": "uri", "maxLength": 2048, "example": "https://example.test/resource" }idempotency-keyЗаголовок · ОбязательноОбязательный ключ идемпотентности длиной до 128 символов.
stringПолное определение
{ "type": "string", "minLength": 1, "maxLength": 128, "example": "example" }
Тело запроса
Обязательно
Подтверждает бронирование по токену управления и ожидаемой ревизии, если текущее состояние допускает подтверждение гостем.
application/json
Полное определение
{
"$ref": "#/components/schemas/PublicManageActionDto"
}Ответы
200Возвращает данные подтверждённого бронирования: идентификатор, код, ревизию, статус, идентификаторы записей активности и новый токен управления взамен прежнего.
Полное определение
{
"$ref": "#/components/schemas/PublicReservationCommandResultDto"
}{
"id": "710ff6cd-0f24-41c2-8472-54b09612b596",
"referenceCode": "EXAMPLE",
"revision": 1,
"status": "REQUESTED",
"eventIds": [
"6825b43e-93d6-4f3b-8171-c1661099fae8"
],
"manageToken": null,
"manageAccessState": "CURRENT"
}401Отклоняет отсутствующий, некорректный, истёкший, отозванный или недействительный ключ reservationManageToken на границе владеющего домена.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}402Для новых операций требуется покрытие подписки. Отказ также возможен, если у операции нет исходного подтверждения коммерческого допуска. Разрешённое чтение и финансовое восстановление остаются доступны.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 402,
"error": "errors:http.failure",
"code": "HTTP_402",
"message": "errors:http.failure",
"translationKey": "errors:http.failure"
}409Ключ идемпотентности уже обрабатывается или повторно использован с другим телом.
Полное определение
{
"$ref": "#/components/schemas/IdempotencyConflictError"
}{
"statusCode": 409,
"error": "errors:http.conflict",
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "errors:idempotency.inProgress",
"translationKey": "errors:idempotency.inProgress"
}503Не удалось получить достоверное состояние подписки в пределах установленных ограничений. Повторите исходную операцию после восстановления.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 503,
"error": "errors:http.serviceUnavailable",
"code": "HTTP_SERVICE_UNAVAILABLE",
"message": "errors:http.serviceUnavailable",
"translationKey": "errors:http.serviceUnavailable"
}Схемы
PublicManageActionDto
Ревизия бронирования, разрешённого токеном, и необязательные изменения расписания, периода обслуживания и количества гостей для гостевых команд подтверждения, изменения и отмены.
guaranteeTermsHashНеобязательноТочный digest серверного предложения, принятый при финансовом изменении слота или числа гостей; null только для NONE.
string · nullПолное определение
{ "type": "string", "pattern": "^[0-9a-f]{64}$", "nullable": true, "description": "Точный digest серверного предложения, принятый при финансовом изменении слота или числа гостей; null только для NONE.", "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef" }expectedRevisionОбязательноТекущая целочисленная ревизия
expectedRevision, прочитанная вызывающей стороной; устаревшее значение приводит к отклонению изменения. Ограничения: минимум 1.integerПолное определение
{ "type": "integer", "minimum": 1, "description": "Текущая целочисленная ревизия `expectedRevision`, прочитанная вызывающей стороной; устаревшее значение приводит к отклонению изменения. Ограничения: минимум 1.", "example": 1 }scheduledAtНеобязательноВремя
scheduledAtв формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.string · date-timeПолное определение
{ "type": "string", "format": "date-time", "description": "Время `scheduledAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.", "example": "2026-01-15T12:00:00.000Z" }servicePeriodIdНеобязательноUUID Hallify для
servicePeriodId.string · uuidПолное определение
{ "type": "string", "format": "uuid", "description": "UUID Hallify для `servicePeriodId`.", "example": "4846c409-f4df-40f6-81cc-1d7157a5c646" }partySizeНеобязательноЦелочисленное значение
partySize. Ограничения: минимум 1; максимум 99.integerПолное определение
{ "type": "integer", "minimum": 1, "maximum": 99, "description": "Целочисленное значение `partySize`. Ограничения: минимум 1; максимум 99.", "example": 1 }
Полное определение
{
"type": "object",
"properties": {
"guaranteeTermsHash": {
"type": "string",
"pattern": "^[0-9a-f]{64}$",
"nullable": true,
"description": "Точный digest серверного предложения, принятый при финансовом изменении слота или числа гостей; null только для NONE.",
"example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "Текущая целочисленная ревизия `expectedRevision`, прочитанная вызывающей стороной; устаревшее значение приводит к отклонению изменения. Ограничения: минимум 1.",
"example": 1
},
"scheduledAt": {
"type": "string",
"format": "date-time",
"description": "Время `scheduledAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
"example": "2026-01-15T12:00:00.000Z"
},
"servicePeriodId": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `servicePeriodId`.",
"example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
},
"partySize": {
"type": "integer",
"minimum": 1,
"maximum": 99,
"description": "Целочисленное значение `partySize`. Ограничения: минимум 1; максимум 99.",
"example": 1
}
},
"required": [
"expectedRevision"
],
"description": "Ревизия бронирования, разрешённого токеном, и необязательные изменения расписания, периода обслуживания и количества гостей для гостевых команд подтверждения, изменения и отмены.",
"example": {
"expectedRevision": 1
}
}PublicReservationCommandResultDto
Результат выполненной гостевой команды управления бронированием: итоговая ревизия, статус жизненного цикла, идентификаторы записей активности и токен управления, который может быть null.
agreementChangeНеобязательноИсходный неизменяемый результат предложения или принятия соглашения; бронь сохраняет фактическое нативное состояние до активации.
objectПолное определение
{ "type": "object", "description": "Исходный неизменяемый результат предложения или принятия соглашения; бронь сохраняет фактическое нативное состояние до активации.", "additionalProperties": false, "required": [ "id", "state", "planHash", "expiresAt" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID нативного изменения соглашения.", "example": "940006a2-9bbf-40d0-86a4-891c3d173dcc" }, "state": { "type": "string", "enum": [ "PENDING", "ACCEPTED" ], "description": "Исходное состояние предложения или принятого продолжения.", "example": "PENDING" }, "planHash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Digest точных замороженных слота и условий.", "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef" }, "expiresAt": { "type": "string", "format": "date-time", "description": "Исходный срок активации; повтор не продлевает его.", "example": "2026-12-31T18:00:00.000Z" } }, "example": { "id": "940006a2-9bbf-40d0-86a4-891c3d173dcc", "state": "PENDING", "planHash": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef", "expiresAt": "2026-12-31T18:00:00.000Z" } }idОбязательноИдентификатор бронирования, которым управляет гость.
string · uuidПолное определение
{ "type": "string", "description": "Идентификатор бронирования, которым управляет гость.", "format": "uuid", "example": "710ff6cd-0f24-41c2-8472-54b09612b596" }referenceCodeОбязательноКод бронирования, отображаемый гостю.
stringПолное определение
{ "type": "string", "description": "Код бронирования, отображаемый гостю.", "example": "EXAMPLE" }revisionОбязательноРевизия бронирования после выполнения гостевой команды.
integerПолное определение
{ "type": "integer", "description": "Ревизия бронирования после выполнения гостевой команды.", "minimum": 1, "example": 1 }statusОбязательноСтатус жизненного цикла бронирования после выполнения гостевой команды.
stringПолное определение
{ "type": "string", "description": "Статус жизненного цикла бронирования после выполнения гостевой команды.", "enum": [ "REQUESTED", "BOOKED", "CONFIRMED", "ARRIVED", "SEATED", "CANCELED", "NO_SHOW", "DECLINED", "EXPIRED" ], "example": "REQUESTED" }eventIdsОбязательноИдентификаторы записей активности и уведомлений, связанных с выполненной командой управления бронированием.
arrayПолное определение
{ "type": "array", "description": "Идентификаторы записей активности и уведомлений, связанных с выполненной командой управления бронированием.", "minItems": 1, "maxItems": 2, "items": { "type": "string", "description": "Идентификатор записи активности или уведомления по бронированию.", "format": "uuid", "example": "6825b43e-93d6-4f3b-8171-c1661099fae8" }, "example": [ "6825b43e-93d6-4f3b-8171-c1661099fae8" ] }manageTokenОбязательноПриватный исходный ключ-преемник для последующих запросов управления либо null, если продолжение недоступно.
string · nullПолное определение
{ "type": "string", "description": "Приватный исходный ключ-преемник для последующих запросов управления либо null, если продолжение недоступно.", "nullable": true, "example": "synthetic-example-credential" }manageAccessStateОбязательноТекущая доступность исходного ключа управления. Исторические бизнес-поля сохраняют исходную ревизию.
stringПолное определение
{ "type": "string", "description": "Текущая доступность исходного ключа управления. Исторические бизнес-поля сохраняют исходную ревизию.", "enum": [ "CURRENT", "SUPERSEDED", "EXPIRED", "REPROOF_REQUIRED", "NONE" ], "example": "CURRENT" }
Полное определение
{
"type": "object",
"description": "Результат выполненной гостевой команды управления бронированием: итоговая ревизия, статус жизненного цикла, идентификаторы записей активности и токен управления, который может быть null.",
"additionalProperties": false,
"required": [
"id",
"referenceCode",
"revision",
"status",
"eventIds",
"manageToken",
"manageAccessState"
],
"properties": {
"agreementChange": {
"type": "object",
"description": "Исходный неизменяемый результат предложения или принятия соглашения; бронь сохраняет фактическое нативное состояние до активации.",
"additionalProperties": false,
"required": [
"id",
"state",
"planHash",
"expiresAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID нативного изменения соглашения.",
"example": "940006a2-9bbf-40d0-86a4-891c3d173dcc"
},
"state": {
"type": "string",
"enum": [
"PENDING",
"ACCEPTED"
],
"description": "Исходное состояние предложения или принятого продолжения.",
"example": "PENDING"
},
"planHash": {
"type": "string",
"pattern": "^[0-9a-f]{64}$",
"description": "Digest точных замороженных слота и условий.",
"example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Исходный срок активации; повтор не продлевает его.",
"example": "2026-12-31T18:00:00.000Z"
}
},
"example": {
"id": "940006a2-9bbf-40d0-86a4-891c3d173dcc",
"state": "PENDING",
"planHash": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
"expiresAt": "2026-12-31T18:00:00.000Z"
}
},
"id": {
"type": "string",
"description": "Идентификатор бронирования, которым управляет гость.",
"format": "uuid",
"example": "710ff6cd-0f24-41c2-8472-54b09612b596"
},
"referenceCode": {
"type": "string",
"description": "Код бронирования, отображаемый гостю.",
"example": "EXAMPLE"
},
"revision": {
"type": "integer",
"description": "Ревизия бронирования после выполнения гостевой команды.",
"minimum": 1,
"example": 1
},
"status": {
"type": "string",
"description": "Статус жизненного цикла бронирования после выполнения гостевой команды.",
"enum": [
"REQUESTED",
"BOOKED",
"CONFIRMED",
"ARRIVED",
"SEATED",
"CANCELED",
"NO_SHOW",
"DECLINED",
"EXPIRED"
],
"example": "REQUESTED"
},
"eventIds": {
"type": "array",
"description": "Идентификаторы записей активности и уведомлений, связанных с выполненной командой управления бронированием.",
"minItems": 1,
"maxItems": 2,
"items": {
"type": "string",
"description": "Идентификатор записи активности или уведомления по бронированию.",
"format": "uuid",
"example": "6825b43e-93d6-4f3b-8171-c1661099fae8"
},
"example": [
"6825b43e-93d6-4f3b-8171-c1661099fae8"
]
},
"manageToken": {
"type": "string",
"description": "Приватный исходный ключ-преемник для последующих запросов управления либо null, если продолжение недоступно.",
"nullable": true,
"example": "synthetic-example-credential"
},
"manageAccessState": {
"type": "string",
"description": "Текущая доступность исходного ключа управления. Исторические бизнес-поля сохраняют исходную ревизию.",
"enum": [
"CURRENT",
"SUPERSEDED",
"EXPIRED",
"REPROOF_REQUIRED",
"NONE"
],
"example": "CURRENT"
}
},
"example": {
"id": "710ff6cd-0f24-41c2-8472-54b09612b596",
"referenceCode": "EXAMPLE",
"revision": 1,
"status": "REQUESTED",
"eventIds": [
"6825b43e-93d6-4f3b-8171-c1661099fae8"
],
"manageToken": null,
"manageAccessState": "CURRENT"
}
}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"
}IdempotencyConflictError
Ключ идемпотентности уже обрабатывается или использован повторно с другим телом.
Полное определение
{
"example": {
"statusCode": 409,
"error": "errors:http.conflict",
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "errors:idempotency.inProgress",
"translationKey": "errors:idempotency.inProgress"
},
"allOf": [
{
"$ref": "#/components/schemas/TranslatedErrorDto"
},
{
"type": "object",
"required": [
"code"
],
"properties": {
"statusCode": {
"type": "integer",
"enum": [
409
],
"description": "Статус конфликта HTTP 409.",
"example": 409
},
"code": {
"type": "string",
"enum": [
"IDEMPOTENCY_REQUEST_NOT_READY",
"IDEMPOTENCY_KEY_PAYLOAD_MISMATCH",
"IDEMPOTENCY_REQUEST_IN_PROGRESS",
"IDEMPOTENCY_SCOPE_INCOMPLETE"
],
"description": "Допустимые значения `code`: IDEMPOTENCY_REQUEST_NOT_READY, IDEMPOTENCY_KEY_PAYLOAD_MISMATCH, IDEMPOTENCY_REQUEST_IN_PROGRESS, IDEMPOTENCY_SCOPE_INCOMPLETE.",
"example": "IDEMPOTENCY_REQUEST_NOT_READY"
}
},
"example": {
"code": "IDEMPOTENCY_REQUEST_NOT_READY"
}
}
],
"description": "Ключ идемпотентности уже обрабатывается или использован повторно с другим телом."
}