Support rendering externalDocs objects in the OpenAPI schema

https://swagger.io/specification/#external-documentation-object can be attached to: the whole specification; operations; schema. For example on the PDS FHIR API "Update Patient details" operation we have one that points out to the json-patch RFC: https://github.com/NHSDigital/personal-demographics-service-api/blob/345da64ea0c042fc40c309ba955858e18228593f/specification/personal-demographics.yaml#L1420

Suggest we support rendering these into the published API documentation as a way to reference relevant external documentation

Under consideration Suggested by: Alex Hawdon Upvoted: 11 Jan Comments: 0

Add a comment

0 / 1,000

* Your name will be publicly visible

* Your email will be visible only to moderators