@bearnjs/rest
    Preparing search index...

    Interface RouteSchema

    A minimal schema structure for generating OpenAPI documentation. RouteSchema

    interface RouteSchema {
        body?: {
            properties?: Record<string, JsonValue>;
            required?: string[];
            type: string;
        };
        description?: string;
        params?: Record<
            string,
            { description?: string; required?: boolean; type: string },
        >;
        query?: Record<
            string,
            { description?: string; required?: boolean; type: string },
        >;
        responses?: Record<string, { content?: JsonValue; description?: string }>;
        summary?: string;
        tags?: string[];
    }
    Index

    Properties

    body? description? params? query? responses? summary? tags?

    Properties

    Optionalbody

    body?: {
        properties?: Record<string, JsonValue>;
        required?: string[];
        type: string;
    }

    Schema for the request body.

    description?: string

    A detailed description of the route.

    params?: Record<
        string,
        { description?: string; required?: boolean; type: string },
    >

    Schemas for URL parameters.

    query?: Record<
        string,
        { description?: string; required?: boolean; type: string },
    >

    Schemas for query parameters.

    responses?: Record<string, { content?: JsonValue; description?: string }>

    Schemas for responses.

    summary?: string

    A short summary of the route.

    tags?: string[]

    Tags for categorizing the route in OpenAPI documentation.

    Settings

    Member Visibility

    On This Page

    Properties