Removal of `UserInputRequired.error` field scheduled

What is changing?

The error field used by UserInputRequired has been marked as deprecated and is scheduled to be removed on 29 March July 2027.

What do I need to do?

Use errors (note the naming is plural) instead, which contains a list of type OnboardingError.

Example usage

Before (using error):

Request fragment

... on UserInputRequired {
    error {
        message
    }
}

Response:

"error": {
    "message": "Validation failed for: serial_number, odometer_reading",
},

After (using errors):

Request fragment:

... on UserInputRequired {
    errors {
        code
        description
    }
}

Response:

"errors": [
    {
        "code": "INVALID_USER_INPUT_SERIAL_NUMBER",
        "description": "The submitted serial number was invalid.",
    },
    {
        "code": "INVALID_USER_INPUT_ODOMETER_READING",
        "description": "The submitted odometer reading was invalid.",
    },
],