Wiki Public API

version: 1.0.0

Формат ошибок

В общем виде сообщение об ошибке представляет собой следующую структуру:

{
    "debug_message": "",
    "details": {},
    "error_code": ""
}

Например:

{
    "debug_message": "Validation failed",
    "details": {
        "body": {
            "data": [
                {
                    "debug_message": "field required",
                    "error_code": "value_error.missing"
                }
            ]
        }
    },
    "error_code": "VALIDATION_ERROR"
}

В первую очередь нужно ориентироваться на error_code. В debug_message представлено текстовое описание ошибки. В detail, при необходимости, будет дополнительная информация (или null, если такой необходимости нет).

Формат сообщения в случае ошибки валидации

{
    "debug_message": "Validation failed",
    "details": {
        "<source>": {
            "<field>": [
                {
                    "debug_message": "<validation debug message>",
                    "error_code": "<validation error code>"
                }
            ]
        }
    },
    "error_code": "VALIDATION_ERROR"
}

<source> — источник данных в котором произошла ошибка валидации, возможные значения [body, query]

<field> — имя поля, не прошедшее валидацию, значением является список, в котором хранятся локальные debug_message и error_code с деталями об ошибке.

Sections

Was the article helpful?

API usage examples

Overview