FHIR Chat · docs / PR #118 Add Open API Specification (Swagger) · cds hooks/committers

Stream: cds hooks/committers

Topic: docs / PR #118 Add Open API Specification (Swagger)

Github Notifications (Nov 19 2017 at 20:31):

kpshek opened PR #118
from issues/117-add-swagger-api to master

Merge the Open API Specification (Swagger) from the cds-hooks/api repository into this repository.

Note that I've made this change on top of the specification versioning change to make it easier once that change gets merged in.

Fixes #117.

Github Notifications (Nov 19 2017 at 20:31):

kpshek review_requested PR #118

Github Notifications (Nov 19 2017 at 20:31):

kpshek review_requested PR #118

Github Notifications (Nov 20 2017 at 14:43):

isaacvetter synchronized PR #118

Github Notifications (Nov 21 2017 at 11:29):

kpshek commented on PR #118

I like the yaml, but it's not clear to me whether/how the documentation would/could be derived from that? By having the yaml, will we need to synchronize that definition whenever things change, or is there a way to drive the specification docs from the yaml?

@brynrhodes - We're always going to have the Markdown + YAML. The YAML allows you to have some documentation as well but mkdocs/Markdown allows a lot more flexibility in the documentation that just isn't possible with the YAML.

The big benefit of moving the api repository that held this YAML here is that now when we make a change to the specification, we can be sure that both the Open API specification and the mkdocs content is updated together.

Github Notifications (Nov 21 2017 at 11:30):

kpshek closed PR #118

Last updated: Apr 12 2022 at 19:14 UTC