Skip to content

[I] AutorestDocumentEmitterOptions

Options to configure the behavior of the Autorest document emitter.

PropertyModifierTypeDescription
armResourceFlattening?readonlybooleanreadOnly property ARM resource flattening
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.
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"-