Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • have openEHR REST Api specs formally expressed in a popular, consumer friendly and machine processable format, hence we need to migrate from api-blueprint to OpenAPI

  • the resulted openEHR OpenAPI specs should be easily used to (order matters):

    • generate HTML docs

    • validate data (API payload)

    • generate client code or server stubs

    • (in the future) generate mock-servers (for generic testing)

  • address not only schema for the json payload, but also xml

...

Tools can be used (via docker) from https://github.com/openEHR/sanbox-openapi/tree/master/dev . Tetst files are located in https://github.com/openEHR/sanbox-openapi/tree/master/docs . Generated code is in https://github.com/openEHR/sanbox-openapi/tree/master/gen .

Beside the DvText/DvCodedText examples, we also converted all of https://specifications.openehr.org/releases/ITS-REST/Release-1.0.2 in OpenAPI v3.0.3 yaml format and rendered as HTML. The goal is to Release 1.0.3 open openEHR REST API specs.

The other line of work was done by Pablo Pazos to look at the rest of the RM from an OpenAPI modelling perspective. (Pablo, feel free to fill this part in with a proper definition of the work you’ve done, I failed to do that (smile) )

...