Iskra API Reference
    Preparing search index...

    Interface RoutesDocumentOptions

    interface RoutesDocumentOptions {
        contract?: ResponseContract;
        include?: "described" | "all";
        skip?: (method: string, openApiPath: string) => boolean;
    }
    Index
    contract? include? skip?
    contract?: ResponseContract

    Where the error and success bodies' schemas come from.

    include?: "described" | "all"

    'described' (the default): the routes with a describeRoute(), on them or on their group. 'all': every route with a method OpenAPI knows and a path without wildcards.

    skip?: (method: string, openApiPath: string) => boolean

    Operations already in the spec (GET /users/{id}), left as they are.

    Settings
    Member Visibility

    On This Page
    Properties