International-Data-Spaces-Association / ids-specification

The Dataspace Protocol is a set of specifications designed to facilitate interoperable data sharing between entities governed by usage control and based on Web technologies. These specifications define the schemas and protocols required for entities to publish data, negotiate Agreements, and access data in a data space
https://docs.internationaldataspaces.org/dataspace-protocol/
Apache License 2.0
31 stars 14 forks source link

Provide OpenApi definition of https bindings #13

Closed juliapampus closed 1 year ago

juliapampus commented 1 year ago

catalog.binding.https.md says:

The OpenAPI definitions for this specification can be accessed here.

Would be a nice idea to have an OpenApi definition of the HTTPS bindings.

Same goes for negotiation and transfer.

sebbader-sap commented 1 year ago

Alternative for OpenApi for the asynchronous operations: https://www.asyncapi.com (@juliapampus you were right with the link)

matgnt commented 1 year ago

I've created a first draft version of an openapi spec for the catalog part: https://github.com/boschresearch/py-cx-ids/blob/dev/pycxids/core/http_binding/http_binding_openapi.yaml

Since I didn't find tooling to generate the models from existing context / ttl files, I did this manually. I maninly used this catalog example: https://github.com/International-Data-Spaces-Association/ids-specification/blob/main/catalog/message/catalog.json

I guess this is very error-prone and should be automated to be in sync.


Matthias Binzer