Interface IOpenApiService

Service for generating and retrieving OpenAPI 3.1 specifications.

Since

0.1.0

interface IOpenApiService {
addSchema(name: string, schema: unknown): void;
getSpec(): Readonly<Record<string, unknown>>;
}

Implemented by

OpenApiService

Index

Methods

addSchema getSpec

Methods

addSchema

addSchema(name: string, schema: unknown): void
Registers a named schema for deduplication.
Parameters
- name: string
  Schema name
- schema: unknown
  The schema to register
Returns void
- Defined in packages/openapi-plugin/src/interfaces/openapi-service.ts:27

getSpec

getSpec(): Readonly<Record<string, unknown>>
Returns the generated OpenAPI 3.1 document.

Builds the spec lazily on first call and caches it for subsequent calls.

Returns Readonly<Record<string, unknown>>
The complete OpenAPI document as a readonly record
- Defined in packages/openapi-plugin/src/interfaces/openapi-service.ts:20