Skip to content

HttpErrorResponse ​

The standardized error body returned by every package in this repository. ErrorDescription is the only optional field, and holds the unresolved message key when no message file defines it.

json
{
    "code": 401,
    "error": "invalid_credentials",
    "errorDescription": "Authentication failed"
}

Fields

Code: int
The HTTP status code returned by the response.

Error: string
Stable machine-readable identifier for the failure, such as invalid_credentials.

ErrorDescription: string?
Human-readable description, resolved for the request's language.
Default: null

Type signature ​

csharp
public record HttpErrorResponse
{
    public required int Code { get; init; }
    public required string Error { get; init; }
    public string? ErrorDescription { get; init; }
}

All packages are released under the MIT License.