Перейти к содержимому
Разделы

Гостевой кабинет

Войти в нативное управление с точным свежим целевым proof

POST/guest-portal/native-entry/{targetKind}/{targetId}/commands

Атомарно использует один целевой proof и выдаёт нативный grant управления. Core сохраняет только неизменное подтверждение без секретов. Повтор восстанавливает исходное подтверждение и отдельно оценивает текущее продолжение существующего grant; он никогда не выдаёт другой grant и не возрождает истёкшие или отозванные права. Обязательный Idempotency-Key обеспечивает возврат сохранённых статуса и тела при повторе с теми же данными; другие данные с тем же ключом возвращают 409.

Авторизация

x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>

Гостевой токен сессии своего кабинета.

Руководство по подключению

Параметры

originЗаголовок · Обязательно

Фактический browser Origin. Нативный владелец проверяет исходную аудиторию источника и текущее представление. Сессия Portal никогда не расширяет нативные CORS или права представления.

string
Полное определение
{
  "type": "string",
  "maxLength": 2048,
  "example": "example"
}
idempotency-keyЗаголовок · Обязательно

Обязательный ключ идемпотентности длиной до 128 символов.

string
Полное определение
{
  "type": "string",
  "minLength": 1,
  "maxLength": 128,
  "example": "example"
}
targetKindПуть · Обязательно

Точный вид нативного владельца.

string
Полное определение
{
  "enum": [
    "RESERVATION",
    "WAITLIST",
    "PREORDER"
  ],
  "type": "string",
  "example": "RESERVATION"
}
targetIdПуть · Обязательно

Точный UUID нативной цели.

string · uuid
Полное определение
{
  "format": "uuid",
  "type": "string",
  "example": "9b6163a8-afea-4877-818b-8e2ae28a2845"
}

Тело запроса

Обязательно

UUID проверенного одноразового proof, связанного с текущими субъектом, сессией, целью и нативной аудиторией.

application/json

IssueGuestPortalNativeEntryDto
Полное определение
{
  "$ref": "#/components/schemas/IssueGuestPortalNativeEntryDto"
}

Ответы

200Исходная квитанция выдачи и отдельно оценённое текущее нативное продолжение.
GuestPortalNativeEntryResultDto
Полное определение
{
  "$ref": "#/components/schemas/GuestPortalNativeEntryResultDto"
}
Пример ответа · 200 · application/json
{
  "receipt": {
    "schema": "hallify.guest-portal.native-entry-receipt",
    "version": 1,
    "targetKind": "RESERVATION",
    "targetId": "c42be69f-6a23-422e-82b8-22abbf035588",
    "proofId": "6eeca0df-6b25-4279-8845-acecc5a1976c",
    "grantId": "ad6e6218-440a-4616-898d-8f092e74f534",
    "issuedAt": "2026-01-15T10:00:00.000Z",
    "expiresAt": "2026-12-31T18:00:00.000Z"
  },
  "current": {
    "state": "AVAILABLE",
    "manageToken": null,
    "effectiveExpiresAt": null
  }
}
400Цель, входные данные, фактический Origin, сохранённый proof или OTP недействительны либо просрочены.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 400 · application/json
{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}
401Текущая Portal capability недействительна либо её субъект/сессия недоступны.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 401 · application/json
{
  "statusCode": 401,
  "error": "errors:http.unauthorized",
  "code": "HTTP_UNAUTHORIZED",
  "message": "errors:http.unauthorized",
  "translationKey": "errors:http.unauthorized"
}
403Текущий нативный источник или необходимый proof контакта недоступны.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 403 · application/json
{
  "statusCode": 403,
  "error": "errors:http.forbidden",
  "code": "HTTP_FORBIDDEN",
  "message": "errors:http.forbidden",
  "translationKey": "errors:http.forbidden"
}
404В области, принадлежащей capability, нет точного нативного источника с текущим допуском.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 404 · application/json
{
  "statusCode": 404,
  "error": "errors:http.notFound",
  "code": "HTTP_NOT_FOUND",
  "message": "errors:http.notFound",
  "translationKey": "errors:http.notFound"
}
409Ключ идемпотентности уже обрабатывается или повторно использован с другим телом.
IdempotencyConflictError
Полное определение
{
  "$ref": "#/components/schemas/IdempotencyConflictError"
}
Пример ответа · 409 · application/json
{
  "statusCode": 409,
  "error": "errors:http.conflict",
  "code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
  "message": "errors:idempotency.inProgress",
  "translationKey": "errors:idempotency.inProgress"
}
503Защищённые подтверждающие данные, исходная квитанция или необходимая политика ключей недоступны.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 503 · application/json
{
  "statusCode": 503,
  "error": "errors:http.serviceUnavailable",
  "code": "HTTP_SERVICE_UNAVAILABLE",
  "message": "errors:http.serviceUnavailable",
  "translationKey": "errors:http.serviceUnavailable"
}

Схемы

IssueGuestPortalNativeEntryDto

Применить проверенный одноразовый целевой proof через его нативного владельца управления.

proofIdОбязательно

Точный UUID проверенного proof для этого субъекта, цели и нативной аудитории; сам по себе он не предоставляет прав.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "Точный UUID проверенного proof для этого субъекта, цели и нативной аудитории; сам по себе он не предоставляет прав.",
  "example": "6eeca0df-6b25-4279-8845-acecc5a1976c"
}
Полное определение
{
  "type": "object",
  "properties": {
    "proofId": {
      "type": "string",
      "format": "uuid",
      "description": "Точный UUID проверенного proof для этого субъекта, цели и нативной аудитории; сам по себе он не предоставляет прав.",
      "example": "6eeca0df-6b25-4279-8845-acecc5a1976c"
    }
  },
  "required": [
    "proofId"
  ],
  "description": "Применить проверенный одноразовый целевой proof через его нативного владельца управления.",
  "example": {
    "proofId": "6eeca0df-6b25-4279-8845-acecc5a1976c"
  }
}
GuestPortalNativeEntryResultDto

Неизменное подтверждение нативной выдачи и отдельно оценённое текущее продолжение.

receiptОбязательно

Исходное долговечное нативное подтверждение без секретов. Не предоставляет прав и сохраняется после последующего нативного отзыва или истечения срока.

object
Полное определение
{
  "type": "object",
  "description": "Исходное долговечное нативное подтверждение без секретов. Не предоставляет прав и сохраняется после последующего нативного отзыва или истечения срока.",
  "required": [
    "schema",
    "version",
    "targetKind",
    "targetId",
    "proofId",
    "grantId",
    "issuedAt",
    "expiresAt"
  ],
  "properties": {
    "schema": {
      "type": "string",
      "enum": [
        "hallify.guest-portal.native-entry-receipt"
      ],
      "description": "Схема подтверждения нативного входа.",
      "example": "hallify.guest-portal.native-entry-receipt"
    },
    "version": {
      "type": "integer",
      "enum": [
        1
      ],
      "description": "Версия подтверждения нативного входа.",
      "example": 1
    },
    "targetKind": {
      "type": "string",
      "enum": [
        "RESERVATION",
        "WAITLIST",
        "PREORDER"
      ],
      "description": "Исходный вид нативного владельца.",
      "example": "RESERVATION"
    },
    "targetId": {
      "type": "string",
      "format": "uuid",
      "description": "Исходная нативная цель.",
      "example": "c42be69f-6a23-422e-82b8-22abbf035588"
    },
    "proofId": {
      "type": "string",
      "format": "uuid",
      "description": "Сохранённая сервером ссылка на proof; никогда не является токеном доступа.",
      "example": "6eeca0df-6b25-4279-8845-acecc5a1976c"
    },
    "grantId": {
      "type": "string",
      "format": "uuid",
      "description": "Ссылка на исходный нативный grant; никогда не является bearer.",
      "example": "ad6e6218-440a-4616-898d-8f092e74f534"
    },
    "issuedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Исходное сохранённое время proof или нативной команды.",
      "example": "2026-01-15T10:00:00.000Z"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Исходное сохранённое время proof или нативной команды.",
      "example": "2026-12-31T18:00:00.000Z"
    }
  },
  "example": {
    "schema": "hallify.guest-portal.native-entry-receipt",
    "version": 1,
    "targetKind": "RESERVATION",
    "targetId": "c42be69f-6a23-422e-82b8-22abbf035588",
    "proofId": "6eeca0df-6b25-4279-8845-acecc5a1976c",
    "grantId": "ad6e6218-440a-4616-898d-8f092e74f534",
    "issuedAt": "2026-01-15T10:00:00.000Z",
    "expiresAt": "2026-12-31T18:00:00.000Z"
  }
}
currentОбязательно

Текущее решение нативного владельца, оценённое независимо от исходной квитанции.

object
Полное определение
{
  "type": "object",
  "description": "Текущее решение нативного владельца, оценённое независимо от исходной квитанции.",
  "required": [
    "state",
    "manageToken",
    "effectiveExpiresAt"
  ],
  "properties": {
    "state": {
      "type": "string",
      "enum": [
        "AVAILABLE",
        "SUPERSEDED",
        "EXPIRED",
        "REPROOF_REQUIRED",
        "UNAVAILABLE"
      ],
      "description": "Текущая доступность продолжения.",
      "example": "AVAILABLE"
    },
    "manageToken": {
      "type": "string",
      "nullable": true,
      "description": "Свежевосстановленная нативная capability доступна только пока точные текущие источник, proof и фактический Origin остаются разрешены. Хранится вне Redux и кэшей.",
      "example": "synthetic-example-credential"
    },
    "effectiveExpiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Текущий эффективный нативный срок, отдельно ограниченный текущим допуском, либо null.",
      "nullable": true,
      "example": "2026-12-31T18:00:00.000Z"
    }
  },
  "example": {
    "state": "AVAILABLE",
    "manageToken": null,
    "effectiveExpiresAt": null
  }
}
Полное определение
{
  "type": "object",
  "description": "Неизменное подтверждение нативной выдачи и отдельно оценённое текущее продолжение.",
  "required": [
    "receipt",
    "current"
  ],
  "properties": {
    "receipt": {
      "type": "object",
      "description": "Исходное долговечное нативное подтверждение без секретов. Не предоставляет прав и сохраняется после последующего нативного отзыва или истечения срока.",
      "required": [
        "schema",
        "version",
        "targetKind",
        "targetId",
        "proofId",
        "grantId",
        "issuedAt",
        "expiresAt"
      ],
      "properties": {
        "schema": {
          "type": "string",
          "enum": [
            "hallify.guest-portal.native-entry-receipt"
          ],
          "description": "Схема подтверждения нативного входа.",
          "example": "hallify.guest-portal.native-entry-receipt"
        },
        "version": {
          "type": "integer",
          "enum": [
            1
          ],
          "description": "Версия подтверждения нативного входа.",
          "example": 1
        },
        "targetKind": {
          "type": "string",
          "enum": [
            "RESERVATION",
            "WAITLIST",
            "PREORDER"
          ],
          "description": "Исходный вид нативного владельца.",
          "example": "RESERVATION"
        },
        "targetId": {
          "type": "string",
          "format": "uuid",
          "description": "Исходная нативная цель.",
          "example": "c42be69f-6a23-422e-82b8-22abbf035588"
        },
        "proofId": {
          "type": "string",
          "format": "uuid",
          "description": "Сохранённая сервером ссылка на proof; никогда не является токеном доступа.",
          "example": "6eeca0df-6b25-4279-8845-acecc5a1976c"
        },
        "grantId": {
          "type": "string",
          "format": "uuid",
          "description": "Ссылка на исходный нативный grant; никогда не является bearer.",
          "example": "ad6e6218-440a-4616-898d-8f092e74f534"
        },
        "issuedAt": {
          "type": "string",
          "format": "date-time",
          "description": "Исходное сохранённое время proof или нативной команды.",
          "example": "2026-01-15T10:00:00.000Z"
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time",
          "description": "Исходное сохранённое время proof или нативной команды.",
          "example": "2026-12-31T18:00:00.000Z"
        }
      },
      "example": {
        "schema": "hallify.guest-portal.native-entry-receipt",
        "version": 1,
        "targetKind": "RESERVATION",
        "targetId": "c42be69f-6a23-422e-82b8-22abbf035588",
        "proofId": "6eeca0df-6b25-4279-8845-acecc5a1976c",
        "grantId": "ad6e6218-440a-4616-898d-8f092e74f534",
        "issuedAt": "2026-01-15T10:00:00.000Z",
        "expiresAt": "2026-12-31T18:00:00.000Z"
      }
    },
    "current": {
      "type": "object",
      "description": "Текущее решение нативного владельца, оценённое независимо от исходной квитанции.",
      "required": [
        "state",
        "manageToken",
        "effectiveExpiresAt"
      ],
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "AVAILABLE",
            "SUPERSEDED",
            "EXPIRED",
            "REPROOF_REQUIRED",
            "UNAVAILABLE"
          ],
          "description": "Текущая доступность продолжения.",
          "example": "AVAILABLE"
        },
        "manageToken": {
          "type": "string",
          "nullable": true,
          "description": "Свежевосстановленная нативная capability доступна только пока точные текущие источник, proof и фактический Origin остаются разрешены. Хранится вне Redux и кэшей.",
          "example": "synthetic-example-credential"
        },
        "effectiveExpiresAt": {
          "type": "string",
          "format": "date-time",
          "description": "Текущий эффективный нативный срок, отдельно ограниченный текущим допуском, либо null.",
          "nullable": true,
          "example": "2026-12-31T18:00:00.000Z"
        }
      },
      "example": {
        "state": "AVAILABLE",
        "manageToken": null,
        "effectiveExpiresAt": null
      }
    }
  },
  "example": {
    "receipt": {
      "schema": "hallify.guest-portal.native-entry-receipt",
      "version": 1,
      "targetKind": "RESERVATION",
      "targetId": "c42be69f-6a23-422e-82b8-22abbf035588",
      "proofId": "6eeca0df-6b25-4279-8845-acecc5a1976c",
      "grantId": "ad6e6218-440a-4616-898d-8f092e74f534",
      "issuedAt": "2026-01-15T10:00:00.000Z",
      "expiresAt": "2026-12-31T18:00:00.000Z"
    },
    "current": {
      "state": "AVAILABLE",
      "manageToken": null,
      "effectiveExpiresAt": null
    }
  }
}
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": "Ключ идемпотентности уже обрабатывается или использован повторно с другим телом."
}

Hallify использует обязательные cookies и опциональную аналитику.

Обязательные cookies поддерживают вход, язык и тему. Аналитика выключена, пока вы явно ее не разрешите.