@karmaniverous/jeeves
    Preparing search index...

    Interface CatalogEntry

    One endpoint in a service's catalog.

    interface CatalogEntry {
        auth: AuthSpec;
        body?: ZodObject<$ZodLooseShape, $ZodObjectConfig>;
        contentType?: string;
        description: string;
        kind: EntryKind;
        method: "POST" | "GET" | "PUT" | "DELETE";
        name: string;
        params?: ZodObject<$ZodLooseShape, $ZodObjectConfig>;
        path: string;
        query?: ZodObject<$ZodLooseShape, $ZodObjectConfig>;
        response: ZodType;
    }
    Index
    auth body? contentType? description kind method name params? path query? response
    auth: AuthSpec

    Who may call it.

    Optional Readonlybody

    body?: ZodObject<$ZodLooseShape, $ZodObjectConfig>

    JSON request body.

    contentType?: string

    Response content type; default application/json.

    description: string

    What the endpoint does; used for OpenAPI and tool descriptions.

    kind: EntryKind

    What it does to service state.

    method: "POST" | "GET" | "PUT" | "DELETE"

    HTTP method.

    name: string

    Unique camelCase name; the OpenAPI operationId.

    params?: ZodObject<$ZodLooseShape, $ZodObjectConfig>

    Path parameters; keys equal the path's :param names.

    path: string

    Route path in Fastify syntax (:param segments, * wildcard).

    query?: ZodObject<$ZodLooseShape, $ZodObjectConfig>

    Query parameters; each field must accept string input (rule 6).

    response: ZodType

    Successful (2xx) response. For non-JSON entries, z.instanceof(Uint8Array) or z.string().

    Settings
    Member Visibility

    On This Page
    Properties