fluid-oas
    Preparing search index...

    Interface OpenApiComponent

    interface OpenApiComponent {
        addCallbacks(
            mappings: Partial<
                { [K in string]: OpenApiCallback
                | OpenApiReferenceObject },
            >,
        ): this;
        addExamples(
            mappings: Partial<
                { [K in string]: OpenApiExample
                | OpenApiReferenceObject },
            >,
        ): this;
        addExtensions(mappings: { [key: `x-${string}`]: OpenApiSchema }): this;
        addHeaders(
            mappings: Partial<
                { [K in string]: OpenApiHeader
                | OpenApiReferenceObject },
            >,
        ): this;
        addLinks(
            mappings: Partial<
                { [K in string]: OpenApiLink
                | OpenApiReferenceObject },
            >,
        ): this;
        addParameters(
            mappings: Partial<
                { [K in string]: OpenApiParameter
                | OpenApiReferenceObject },
            >,
        ): this;
        addPathItems(
            mappings: Partial<
                { [K in string]: OpenApiPathItem
                | OpenApiReferenceObject },
            >,
        ): this;
        addRequestBodies(
            mappings: Partial<
                { [K in string]: OpenApiRequestBody
                | OpenApiReferenceObject },
            >,
        ): this;
        addResponses(
            mappings: Partial<
                { [K in string]: OpenApiResponses
                | OpenApiReferenceObject },
            >,
        ): this;
        addSchemas(
            mappings: Partial<
                { [K in string]: OpenApiSchema
                | OpenApiReferenceObject },
            >,
        ): this;
        addSecuritySchemes(
            mappings: Partial<
                { [K in string]: OpenApiSecurityScheme
                | OpenApiReferenceObject },
            >,
        ): this;
        createMappings(): Map<ComponentMappings, OpenApiReferenceObject>;
        override(overrideVal: unknown): this;
        toJSON(): unknown;
    }

    Hierarchy

    • BaseInterface
      • OpenApiComponent
    Index

    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