EDC API Wrapper Initiative (Ongoing)

[richardtreier]

Participating Epics

Tasks

Beta Give feedback

1. [Documentation] Document the existence of JSON-LD and what it means #680
   1 of 3
   component/api-wrapper kind/enhancement scope/ce scope/mds +4
   
2. https://github.com/sovity/PMO-Software/issues/404
3. Implement Fix for EDC Crash Triggered by Catalog Request” #797
   0 of 2
   kind/bug scope/ce task/analyze +3
   
4. https://github.com/sovity/PMO-Software/issues/696
5. https://github.com/sovity/PMO-Software/issues/403
6. https://github.com/sovity/PMO-Software/issues/377
7. API Wrapper: Use Case API Initiative (Ongoing) #182
   component/api-wrapper kind/epic status/blocked/needs-product +3
   
8. Backend: Implement filters for contracts definition page #910
   1 of 4
   kind/enhancement scope/ce +2
   
9. [API Wrapper] Add Additional API Client Libraries to support Other Programming Languages #702
   0 of 3
   area/github clean-backlog component/api-wrapper goal/enable-dataspace-app-dev status/blocked/needs-product +5
   
10. https://github.com/sovity/PMO-Software/issues/1102
11. https://github.com/sovity/PMO-Software/issues/376
12. Custom Asset JSON-LD is a trap right now edc-extensions#679
    2 of 2
    kind/enhancement scope/ce scope/ee status/blocked +4
    
13. POC & Architecture for EDC API Wrapper and Clients edc-extensions#181
    area/api-wrapper kind/epic +2
    
14. EDC UI API edc-extensions#183
    area/api-wrapper kind/epic status/duplicate +3
    
15. Additional Functionalities beyond Core EDC edc-extensions#191
    area/api-wrapper kind/epic +2
    
16. 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]

• Additional Transfer Details edc-ui#98