Skip to main content
Version: Current

OpenAPIDocument

@rotorsoft/act-root


@rotorsoft/act-root / act-http/src/openapi / OpenAPIDocument

Type Alias: OpenAPIDocument

OpenAPIDocument = object

Defined in: libs/act-http/src/openapi/index.ts:71

Minimal OpenAPI 3.1 document type. The emitter targets the 3.1 spec; the type is intentionally a structural subset rather than the full surface from openapi-types so callers can post-process without fighting the type system. Cast to a fuller type from openapi-types when downstream consumers need it.

Properties​

components​

readonly components: OpenAPIComponents

Defined in: libs/act-http/src/openapi/index.ts:76


info​

readonly info: OpenAPIInfo

Defined in: libs/act-http/src/openapi/index.ts:73


openapi​

readonly openapi: "3.1.0"

Defined in: libs/act-http/src/openapi/index.ts:72


paths​

readonly paths: Record<string, OpenAPIPathItem>

Defined in: libs/act-http/src/openapi/index.ts:75


servers?​

readonly optional servers?: ReadonlyArray<OpenAPIServer>

Defined in: libs/act-http/src/openapi/index.ts:74