Skip to content

[I] AutorestDocumentEmitterOptions

Options to configure the behavior of the Autorest document emitter.

PropertyModifierTypeDescription
armTypesDirreadonlystringArm types dir
emitCommonTypesSchema?readonly"never" | "for-visibility-changes"Determines whether and how to emit schema for arm common-types Default "for-visibility-only"
emitLroOptions?readonly"none" | "final-state-only" | "all"Determines whether and how to emit x-ms-long-running-operation-options to describe resolution of asynchronous operations Default "final-state-only"
examplesDirectory?readonlystring-
includeXTypeSpecNamereadonly"inline-only" | "never"If the x-typespec-name extension should be included
omitUnreachableTypes?readonlybooleanOmit unreachable types. By default all types declared under the service namespace will be included. With this flag on only types references in an operation will be emitted.
outputSplitting?readonly"legacy-feature-files"Determines whether output should be split into multiple files. The only supported option for splitting is “legacy-feature-files”,
skipExampleCopying?readonlybooleanWhen enabled, example files will not be copied to the output directory. Instead, the source example files will be referenced using relative file paths. Default false
typeNameStrategy?readonly"namespaced" | "name-only"Strategy for naming the OpenAPI names derived from TypeSpec types (definition/schema names, parameter keys, inline names, x-typespec-name, etc.). - "namespaced": Include the namespace prefix for types outside the service namespace (e.g. LiftrBase.Foo). Default. - "name-only": Use only the type name without any namespace prefix (e.g. Foo). Conflicts are reported as an error. Default "namespaced"
useReadOnlyStatusSchema?readonlybooleanreadOnly property schema behavior
versionEnumStrategy?readonly"omit" | "include"Decide how to deal with the version enum when omitUnreachableTypes is not set. Default "omit"
xmlStrategyreadonly"none" | "xml-service"-