EDC API Wrapper Initiative (Ongoing)

[richardtreier]

Participating Epics

- [ ] https://github.com/sovity/edc-extensions/issues/680
- [ ] https://github.com/sovity/PMO-Software/issues/404
- [ ] https://github.com/sovity/edc-extensions/issues/797
- [ ] https://github.com/sovity/PMO-Software/issues/696
- [ ] https://github.com/sovity/PMO-Software/issues/403
- [ ] https://github.com/sovity/edc-ee/issues/540
- [ ] sovity/edc-extensions#182
- [ ] https://github.com/sovity/edc-extensions/issues/910
- [ ] https://github.com/sovity/edc-extensions/issues/702
- [ ] https://github.com/sovity/PMO-Software/issues/1102
- [ ] https://github.com/sovity/PMO-Software/issues/376
- [ ] https://github.com/sovity/edc-extensions/issues/679
- [x] sovity/edc-extensions#181
- [x] sovity/edc-extensions#183
- [x] sovity/edc-extensions#191
- [ ] https://github.com/sovity/PMO-Software/issues/1046

Preface

Description

Use Cases use the the EDC API and thus to use the APIs. The JSON-LD Management API is poorly validated, hard to use and a risk for any project when using the EDC due to the intransparency and weakness of JSON-LD.

Having a unified openapi-generator-friendly list of API Client Libaries allows for better enablement of customers to start developing / automating EDCs quickly.

With these new models and endpoints tailored for auto generation we could do multiple things:

• Have API clients in both TypeScript, Java and potentially other languages that are mostly automatically generated, allowing us to ship changes faster and thus confidently change things.
• We could work around API changes that might come from changes between milestones.
• We could offer a simpler and more opinionated workflow for working with the EDC.

Why Is the Feature Desired?

• Pain: Currently no adoption of API Wrapper
• Goal: Higher usage, better usability, easier onboarding.
• Benefit: Make sovity EDC more attractive as underlying tech such as in the context of ConCat

Personas who benefit

• anybody who wants to interact with our EDCs programatically

Hypothesis

• Using auto generated API clients saves time and effort.
• Adjusting to milestone changes once in this extension takes less time and effort than adjusting consumers of our EDC APIs.
• Not having to handle JSON-LD semantics on the API user side by using the API Wrapper REST APIs over JSON-LD APIs saves time, nerves and entire projects, due to JSON-LD API difficulties being hard to plan or expect.

Stakeholders

• MDS EDC API users
• internal Catena-X Use Case Application developers
• external Catena-X Use Case Application developers
• sovity EDC Use Case Application developers

[richardtreier]

[SebastianOpriel]

• [ ] sovity/edc-ui#98