Skip to content

AuthoredDocs

reference
1 min readUpdated

Kind: Interface

Source: atloria-monorepo/libs/parser-core/src/openapi/doc-annotations.ts

What an author wrote about one operation, in whatever language they wrote it.

Absent means "the source said nothing here" — never "the source said nothing useful". The distinction is what lets mergeAuthoredDocs layer a weak source under a strong one without a blank field from the strong source erasing a real sentence from the weak one.

Properties

PropertyType
summarystring
descriptionstring
paramsAuthoredParamDocs
responsesAuthoredResponseDoc[]
tagsstring[]

Was this page helpful?

Download as PDF