Crypto API
    Preparing search index...

    Interface ItemShape

    Recursive folder/item shape for Postman-style collections.

    const item: ItemShape = { name: "Auth", item: [{ name: "Login" }] };
    interface ItemShape {
        name: string;
        item?: ItemShape[];
        request?: JsonRequest & {
            method?: string;
            description?: string;
            url?: string | UrlWithQuery;
            body?: BodyShape;
            auth?: AuthorizationInfo;
        };
        response?: ResponseType[];
    }
    Index
    name item? request? response?
    name: string

    Display name of the folder or endpoint.

    item?: ItemShape[]

    Nested child items (sub-folders or endpoints).

    request?: JsonRequest & {
        method?: string;
        description?: string;
        url?: string | UrlWithQuery;
        body?: BodyShape;
        auth?: AuthorizationInfo;
    }

    Request details (present when this is an endpoint, not a folder).

    Type Declaration

    • Optionalmethod?: string

      HTTP verb (GET, POST, etc.).

    • Optionaldescription?: string

      Human-readable description of the endpoint.

    • Optionalurl?: string | UrlWithQuery

      Request URL, either a string or an object with query params.

    • Optionalbody?: BodyShape

      Request body definition.

    • Optionalauth?: AuthorizationInfo

      Authorization configuration.

    response?: ResponseType[]

    Example responses (present when this is an endpoint, not a folder).

    Settings
    Member Visibility

    On This Page
    Properties