fluid-oas
    Preparing search index...

    Interface SchemaParameter

    interface SchemaParameter {
        addAllowReserved(allowReserved: boolean): this;
        addDeprecated(deprecated: boolean): this;
        addDescription(description: string): this;
        addExample(example: any): this;
        addExamples(
            mappings: { [key: string]: OpenApiExample | OpenApiReferenceObject },
        ): this;
        addExplode(explode: boolean): this;
        addExtensions(mappings: { [key: `x-${string}`]: OpenApiSchema }): this;
        addIn(inParameter: "query" | "header" | "cookie" | "path"): this;
        addName(name: string): this;
        addRequired(required: boolean): this;
        addSchema(schema: OpenApiReferenceObject | OpenApiSchema): this;
        addStyle(style: "simple" | "form"): this;
        override(overrideVal: unknown): this;
        toJSON(): unknown;
    }

    Hierarchy

    • ParameterBase
      • SchemaParameter
    Index

    Methods

    addAllowReserved addDeprecated addDescription addExample addExamples addExplode addExtensions addIn addName addRequired addSchema addStyle override toJSON

    Methods

    • Extend the specification with an extension object schema.

      Parameters

      • mappings: { [key: `x-${string}`]: OpenApiSchema }

        key value mappings with names MUST beginning with "x-"

      Returns this

    • Parameters

      • inParameter: "query" | "header" | "cookie" | "path"

      Returns this

    • Overrides the toJSON method for a custom serialization.

      WARNING: overrideVal must be serializable and future changes are subject to breaking.

      Parameters

      • overrideVal: unknown

        Overrides the serialization of this object into this value.

      Returns this

    • Serializes the object into its equivalent OpenApi JSON value.

      Returns unknown

    Settings

    Member Visibility

    On This Page

    Methods