As an Open Data Hub Software Architect I need technical documentation of the writer API that I can share with contributors

[clezag]

Somewhat bafflingly, I cannot find a programming-language-agnostic documentation of the BDP (writer) API.
The bdp-core README only has basic information specific to Java, using our library.

This is a crucial piece of documentation that we have to give to external collaborators that want to push data (either from a data collector or an elaboration).
Also, for the upcoming OpenDataHub Bootcamp event, since participants will have to use this API.

We should at the very least create a swagger browseable OpenAPI definition and a README detailing the calls on a formal level and some example calls, e.g. with curl