Documentation
    Preparing search index...

    Interface IQuery

    Query parameters metadata.

    interface IQuery {
        description: () => string | undefined;
        example: () => any;
        examples: () => Record<string, any> | undefined;
        key: string;
        name: string;
        schema: OpenApi.IJsonSchema;
        title: () => string | undefined;
    }
    Index

    Properties

    description example examples key name schema title

    Properties

    description: () => string | undefined

    Returns description.

    example: () => any

    Returns example value.

    examples: () => Record<string, any> | undefined

    Returns named examples.

    key: string

    Query variable key.

    name: string

    Combined query parameter name.

    schema: OpenApi.IJsonSchema

    Combined query schema.

    title: () => string | undefined

    Returns title.

    Settings

    Member Visibility

    On This Page

    Properties