search

belgif / openapi-common

common technical OpenAPI data types
Apache License 2.0
4 stars 2 forks source link

CloudEvents schema #10

Open jpraet opened 6 months ago

jpraet commented 6 months ago

A CloudEvents schema could be added to openapi-common (or new separate module?).

https://www.belgif.be/specification/rest/api-guide/#events

Could be based on this JSON schema: https://github.com/cloudevents/spec/blob/main/cloudevents/formats/cloudevents.json

pvdbosch commented 6 months ago

eHealth has also created its own version of the JSON schema; could be interesting to draw on their experiences. In implementation, ehealth uses the Java SDK from the CloudEvents project instead of generated code.

Probably best a separate belgif-openapi module, to avoid overloading openapi-common. Do we also need to support HTTP Binary Content mode (with HTTP headers instead for all context attributes instead of JSON)?