Documentation
    Preparing search index...

    Interface IParameter

    Operation parameter.

    interface IParameter {
        description?: string;
        example?: any;
        examples?: Record<
            string,
            | OpenApiV3.IExample
            | OpenApiV3.IJsonSchema.IReference<`#/components/examples/${string}`>,
        >;
        in: "query" | "path" | "header" | "cookie";
        name?: string;
        required?: boolean;
        schema: OpenApiV3.IJsonSchema;
    }
    Index

    Properties

    description? example? examples? in name? required? schema

    Properties

    description?: string

    Parameter description.

    example?: any

    Example value.

    examples?: Record<
        string,
        | OpenApiV3.IExample
        | OpenApiV3.IJsonSchema.IReference<`#/components/examples/${string}`>,
    >

    Named examples.

    in: "query" | "path" | "header" | "cookie"

    Parameter location.

    name?: string

    Parameter name.

    required?: boolean

    Whether required.

    schema: OpenApiV3.IJsonSchema

    Parameter schema.

    Settings

    Member Visibility

    On This Page

    Properties