GitHub

ProblemDetails

API reference for ProblemDetails.

Renders request decoding and response encoding failures as RFC 9457 problems (Effect's HttpApiMiddleware.ProblemDetails). It declares BadRequestProblem (400) and InternalServerErrorProblem (500), so the OpenAPI document and clients of an API using it know both. Provide it with layer_problem_details.

Attributes

AttributeTypeDescription
error= (BadRequestProblem, InternalServerErrorProblem)

Functions

errors

errors() -> tuple[Top, ...]

The error schemas, as a tuple.

Returns tuple[Top, ...]

@classmethod
def errors(cls) -> tuple[Top, ...]:
    """The error schemas, as a tuple."""
    error = cls.error
    return error if isinstance(error, tuple) else (error,)