Wiki Public API

version: 1.0.0

Error format

In general, an error message has the following structure:

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

For example:

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

Use error_code as the primary reference. The debug_message field contains a human-readable description of the error. The details field provides additional information when available, or null if not applicable.

Validation error message format

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

<source> — the data source where the validation error occurred; possible values: [body, query]

<field> — the name of the field that failed validation. The value is a list containing the local debug_message and error_code with details about the error.

Sections

Was the article helpful?

API usage examples

Overview