@tikoci/centrs
    Preparing search index...

    Interface ApiRequestSummary

    interface ApiRequestSummary {
        endpoint: string;
        format: "text" | "json" | "yaml";
        id?: string;
        listen: boolean;
        method: string;
        path: string;
        proplist?: readonly string[];
        query?: readonly string[];
        raw: boolean;
        validate: boolean;
        verb: ApiVerb | null;
        write: boolean;
        yes: boolean;
    }
    Index

    Properties

    endpoint format id? listen method path proplist? query? raw validate verb write yes

    Properties

    endpoint: string
    format: "text" | "json" | "yaml"
    id?: string
    listen: boolean
    method: string

    The method reported back: a valid ApiMethod, or the raw string when an invalid -X could not be parsed (error path).

    path: string
    proplist?: readonly string[]
    query?: readonly string[]
    raw: boolean
    validate: boolean
    verb: ApiVerb | null

    null when the method was invalid and no verb could be mapped (error path).

    write: boolean
    yes: boolean

    Settings

    Member Visibility

    On This Page

    Properties