Skip to content

StartDocJobDto

reference
1 min readUpdated

Kind: Class

Source: atloria-monorepo/apps/api/src/documentation/dto/doc-automation.dto.ts

Properties

PropertyType
projectIdstring
skipCloneIfExistsboolean
skipScreenshotsboolean
screenshotsOnlyboolean
includeVideoboolean
scenarioIdstring
maxPagesnumber
useV4dStructureboolean
skipUploadboolean
useAgentWriterboolean
enableAgentVerificationboolean
includePathsstring[]
excludePathsstring[]
targetAudience`'beginner'
audienceScopestring
tone`'formal'
docKind'api'
apiStyle`'reference-dense'
maxDocumentsnumber
commitHashstring
branchstring
gitTagstring
versionLabelstring
versionDescriptionstring
triggeredBy`'manual'
useExternalOutputboolean
externalOutputPathstring
updateAssetsOnlyboolean
onlySlugsstring[]
deltaMergeboolean
removedSlugsstring[]
captureOnlySlugsstring[]

Was this page helpful?

Download as PDF