Beignet API reference
    Preparing search index...

    Interface ParameterObject

    OpenAPI parameter object.

    interface ParameterObject {
        deprecated?: boolean;
        description?: string;
        explode?: boolean;
        in: "cookie" | "path" | "query" | "header";
        name: string;
        required?: boolean;
        schema?: SchemaObject | ReferenceObject;
        style?:
            | "label"
            | "deepObject"
            | "form"
            | "simple"
            | "matrix"
            | "spaceDelimited"
            | "pipeDelimited";
    }
    Index
    deprecated? description? explode? in name required? schema? style?
    deprecated?: boolean

    Whether the parameter is deprecated.

    description?: string

    Parameter description.

    explode?: boolean

    Whether arrays and objects are expanded into separate parameter values.

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

    Parameter location.

    name: string

    Parameter name.

    required?: boolean

    Whether the parameter is required.

    schema?: SchemaObject | ReferenceObject

    Parameter schema.

    style?:
        | "label"
        | "deepObject"
        | "form"
        | "simple"
        | "matrix"
        | "spaceDelimited"
        | "pipeDelimited"

    OpenAPI parameter serialization style.

    Settings
    Member Visibility

    On This Page
    Properties