Skip to main content
Version: Latest (0.60.x)

[F] getOpenAPI3

function getOpenAPI3(program, options): Promise<OpenAPI3ServiceRecord[]>

Get the OpenAPI 3 document records from the given program. The documents are returned as a JS object.

Parameters

ParameterTypeDescription
programProgramThe program to emit to OpenAPI 3
optionsOmit<OpenAPI3EmitterOptions, IrrelevantOpenAPI3EmitterOptionsForObject>OpenAPI 3 emit options

Returns

Promise<OpenAPI3ServiceRecord[]>

An array of OpenAPI 3 document records.