fluid-oas/dist/core/openapiv3/OpenApiV3.d.ts

Build declarative OpenApiv3.* specifications.

import type { OpenApiServer, OpenApiSecurityRequirement, OpenApiTag, OpenApiInfo, OpenApiPath, OpenApiPathItem, OpenApiDocumentation } from "./lib";
import { type BaseInterface } from "./lib/base";
import type { OpenApiComponent } from "./lib/OpenApiComponent";
/**
 * Root OpenAPI Object. Allows for method chaining to build a single
 * API Specification.
 */
export interface OpenApiV3 extends BaseInterface {
    /**
     * Adds the current version of the OpenAPI Specification.
     *
     * @param version - The OpenAPI specification version (e.g., "3.1.0")
     */
    addOpenApiVersion(version: string): this;
    /**
     * Adds metadata about the API.
     *
     * @param info - Object containing API metadata including title, version, description, etc.
     */
    addInfo(info: OpenApiInfo): this;
    /**
     * Adds an array of server objects which provide connectivity information to target servers.
     *
     * @param servers - Array of server objects containing URL and optional description/variables
     */
    addServers(servers: OpenApiServer[]): this;
    /**
     * Adds the available paths and operations for the API.
     *
     * @param path - Object containing path definitions with their operations (GET, POST, etc.)
     */
    addPaths(path: OpenApiPath): this;
    /**
     * Adds security requirements that apply to the entire API.
     *
     * @param security - Array of security requirement objects
     */
    addSecurity(security: OpenApiSecurityRequirement[]): this;
    /**
     * Adds metadata tags for grouping operations.
     *
     * @param tags - Array of tag objects containing name and optional description
     */
    addTags(tags: OpenApiTag[]): this;
    /**
     * Adds external documentation reference.
     *
     * @param docs - External documentation object with URL and optional description
     */
    addExternalDocs(docs: OpenApiDocumentation): this;
    /**
     * Adds reusable components to this OpenApi Specification.
     *
     * @param components - Component object.
     */
    addComponents(components: OpenApiComponent): this;
    /**
     * Writes the OpenAPI specification synchronously to a file or outputs it.
     *
     * @param filePath - Optional file path where the specification should be written
     */
    writeOASSync(filePath?: string): void;
    /**
     * Writes the OpenAPI specification asynchronously to a file or outputs it.
     *
     * @param filePath - Optional file path where the specification should be written
     */
    writeOASASync(filePath?: string): void;
}
export interface OpenApiV3_1 extends OpenApiV3 {
    /**
     * Adds the JSON Schema dialect used for the API specification.
     *
     * @param jsonDialect - URI of the JSON Schema dialect (e.g., "https://json-schema.org/draft/2020-12/schema")
     */
    addJsonSchemaDialect(jsonDialect: string): this;
    /**
     * Adds a webhook to this OpenAPI specification.
     *
     */
    addWebhooks(mappings: {
        [K in string]: OpenApiPathItem;
    }): this;
}
export interface OpenApiV3Version {
    addOpenApiVersion(version: `3.1.${string}`): {
        addInfo(info: OpenApiInfo): OpenApiV3_1;
    };
    addOpenApiVersion(version: `3.0.${string}`): {
        addInfo(info: OpenApiInfo): OpenApiV3;
    };
}
export declare const OpenApiV3: OpenApiV3Version;