Iskra API Reference
    Preparing search index...

    Interface RouteDocFragment

    What a handler tells the spec about the routes it is on.

    interface RouteDocFragment {
        describe?: RouteDescription;
        gate?: { optional: boolean; security?: GateSecurity };
        scopes?: string[];
        validates?: {
            body?: object;
            bodyTypes?: string[];
            params?: object;
            query?: object;
        };
    }
    Index
    describe? gate? scopes? validates?
    describe?: RouteDescription

    From describeRoute(): the route is described.

    gate?: { optional: boolean; security?: GateSecurity }

    From requireActor() (optional: false) or identify() (optional: true).

    scopes?: string[]

    From requireScopes().

    validates?: {
        body?: object;
        bodyTypes?: string[];
        params?: object;
        query?: object;
    }

    From a validation middleware: its schemas, and a 400.

    Settings
    Member Visibility

    On This Page
    Properties