jmap-kit
    Preparing search index...

    Interface ProblemDetails<T>

    Structure of a Problem Details object used for JMAP request-level error responses.

    This follows RFC 7807 "Problem Details for HTTP APIs" format.

    interface ProblemDetails<T extends string = string> {
        detail?: string;
        instance?: string;
        status?: number;
        title?: string;
        type: HintedString<T>;
        [key: string]: JSONValue | undefined;
    }

    Type Parameters

    • T extends string = string

    Indexable

    • [key: string]: JSONValue | undefined

      Additional properties specific to the problem type.

    Index

    Properties

    detail? instance? status? title? type

    Properties

    detail?: string

    A human-readable explanation specific to this occurrence of the problem.

    instance?: string

    A URI reference that identifies the specific occurrence of the problem.

    status?: number

    The HTTP status code for this occurrence of the problem.

    title?: string

    A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

    type: HintedString<T>

    A URI reference that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type. This MUST be a string in URI format.

    Settings

    Member Visibility

    On This Page

    Properties