fluid-oas
    Preparing search index...

    Interface OpenApiDocumentation

    interface OpenApiDocumentation {
        addDescription(description: string): this;
        addExtensions(mappings: { [key: `x-${string}`]: OpenApiSchema }): this;
        addUrl(url: string): this;
        override(overrideVal: unknown): this;
        toJSON(): unknown;
    }

    Hierarchy

    • BaseInterface
      • OpenApiDocumentation
    Index

    Methods

    addDescription addExtensions addUrl 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

    • 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