fluid-oas
Version:
Build declarative OpenApiv3.* specifications.
18 lines (17 loc) • 801 B
TypeScript
import type { OpenApiHTTPMethod } from "../types";
import { type BaseInterface } from "./base";
import type { OpenApiOperation } from "./OpenApiOperation";
import type { OpenApiParameter } from "./OpenApiParameter";
import type { OpenApiReferenceObject } from "./OpenApiReferenceObject";
import type { OpenApiServer } from "./OpenApiServer";
export interface OpenApiPathItem extends BaseInterface {
addSummary(summary: string): this;
addDescription(description: string): this;
addMethod(mappings: Partial<{
[K in OpenApiHTTPMethod]: OpenApiOperation;
}>): this;
addServers(servers: OpenApiServer[]): this;
addParameters(parameters: (OpenApiParameter | OpenApiReferenceObject)[]): this;
add$Ref($ref: string): this;
}
export declare const PathItem: OpenApiPathItem;