Безопасность и ошибки

Аутентификация, переиспользуемые ответы ошибок и покрытие error statuses для API v2.

Security Schemes

{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "Sanctum token",
    "description": "Laravel Sanctum bearer token returned by the authentication endpoint."
  }
}

Переиспользуемые ответы

AcceptanceCreateBadRequest
AcceptanceCreateConflict
AcceptanceCreateValidationError
BadRequest
Conflict
CrossDockBadRequest
CrossDockConflict
CrossDockForbidden
CrossDockInternalServerError
CrossDockNotFound
CrossDockTooManyRequests
CrossDockUnauthorized
CrossDockValidationError
Forbidden
InternalServerError
NotFound
SendDocumentConflict
TooManyRequests
Unauthorized
ValidationError

Покрытие ошибок

StatusЗначениеОперации
400Некорректный запрос84
401Требуется аутентификация136
403Доступ запрещен136
404Не найдено105
409Конфликт84
422Ошибка валидации84
429Превышен лимит запросов135
500Внутренняя ошибка сервера135

Схема ошибки

Поле Обязательное Тип Флаги Ограничения Описание Пример
message да string "The request could not be processed."
error да string "BAD_REQUEST"