fluid-oas
    Preparing search index...

    Interface ContentParameter

    interface ContentParameter {
        addContents(
            mappings: Partial<{ [K in OpenApiMediaContentType]: OpenApiMediaType }>,
        ): this;
        addDeprecated(deprecated: boolean): this;
        addDescription(description: string): this;
        addExtensions(mappings: { [key: `x-${string}`]: OpenApiSchema }): this;
        addIn(inParameter: "query" | "header" | "cookie" | "path"): this;
        addName(name: string): this;
        addRequired(required: boolean): this;
        override(overrideVal: unknown): this;
        toJSON(): unknown;
    }

    Hierarchy

    • ParameterBase
      • ContentParameter
    Index

    Methods

    addContents addDeprecated addDescription addExtensions addIn addName addRequired 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