Kind: Function
Source: atloria-monorepo/libs/parser-core/src/openapi/doc-annotations.ts
Write recovered docs onto an endpoint entity, in the shape the spec builder reads.
entity.description keeps carrying the summary because that is what it has always meant
downstream (summary: entity.description ?? entity.name); metadata.summary and
metadata.description are the new, explicit channel. Existing values are never clobbered —
a parser that already resolved something better keeps it.
Signature
tsfunction applyAuthoredDocs(endpoint: DocumentableEndpoint, docs: AuthoredDocs): void
Parameters
| Name | Type |
|---|---|
endpoint | DocumentableEndpoint |
docs | AuthoredDocs |
Returns: void
Was this page helpful?