Skip to content

[I] ResolvedOpenAPI3EmitterOptions

Normalized emitter settings returned by resolveOptions, before document-specific path interpolation.

PropertyTypeDescription
enumStrategyEnumStrategyEnum schema representation; defaults to "default". Annotated output requires OpenAPI 3.1 or later.
fileTypesFileType[]Formats requested for each document; inferred from the output extension or defaulted to YAML when absent.
includeXTypeSpecName"inline-only" | "never"Debug-only TypeSpec name annotations for inline schemas, or "never" by default.
newLineNewLineLine ending convention for serialized files; defaults to "lf".
omitUnreachableTypesbooleanWhen true, excludes service types not reachable from operations; defaults to false.
openapiVersionsOpenAPIVersion[]Specification versions generated in order; defaults to ["3.0.0"], independently of service API versions.
operationIdStrategyobjectGeneration policy for operations lacking @operationId, with a concrete segment separator.
operationIdStrategy.kindOperationIdStrategyName-selection policy; defaults to "parent-container".
operationIdStrategy.separatorstringSegment separator; defaults to "_" for parent-container, "." for fqn, or "" for explicit-only.
outputFilestringResolved output path template; includes an OpenAPI-version directory when multiple specification versions are requested.
parameterExamplesStrategy?"data" | "serialized"Experimental parameter example representation; absent means operation examples do not supply parameter examples.
safeintStrategy"double-int" | "int64"Format used for the TypeSpec safeint scalar; defaults to "int64".
sealObjectSchemasbooleanWhen true, seals object schemas using version-appropriate additional/unevaluated-property constraints; defaults to false.