Beignet API reference
    Preparing search index...

    Interface ParameterObject

    OpenAPI parameter object.

    interface ParameterObject {
        deprecated?: boolean;
        description?: string;
        in: "path" | "query" | "cookie" | "header";
        name: string;
        required?: boolean;
        schema?: SchemaObject | ReferenceObject;
    }
    Index

    Properties

    deprecated? description? in name required? schema?

    Properties

    deprecated?: boolean

    Whether the parameter is deprecated.

    description?: string

    Parameter description.

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

    Parameter location.

    name: string

    Parameter name.

    required?: boolean

    Whether the parameter is required.

    schema?: SchemaObject | ReferenceObject

    Parameter schema.

    Settings

    Member Visibility

    On This Page

    Properties