fluid-oas
    Preparing search index...

    Interface OpenApiOperation

    interface OpenApiOperation {
        addCallback(
            mappings: Partial<
                { [K in string]: OpenApiPathItem
                | OpenApiReferenceObject },
            >,
        ): this;
        addDeprecated(deprecated: boolean): this;
        addDescription(description: string): this;
        addExtensions(mappings: { [key: `x-${string}`]: OpenApiSchema }): this;
        addExternalDocs(externalDocs: OpenApiDocumentation): this;
        addOperationId(operationId: string): this;
        addParameters(
            parameters: (OpenApiReferenceObject | OpenApiParameter)[],
        ): this;
        addRequestBody(body: OpenApiReferenceObject | OpenApiRequestBody): this;
        addResponses(responses: OpenApiResponses): this;
        addSecurity(security: OpenApiSecurityRequirement[]): this;
        addServers(servers: OpenApiServer[]): this;
        addSummary(summary: string): this;
        addTags(tags: string[]): this;
        override(overrideVal: unknown): this;
        toJSON(): unknown;
    }

    Hierarchy

    • BaseInterface
      • OpenApiOperation
    Index

    Methods

    addCallback addDeprecated addDescription addExtensions addExternalDocs addOperationId addParameters addRequestBody addResponses addSecurity addServers addSummary addTags 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