docs: management api walkthrough

[arnoweiss]

WHAT

As outlined in #951 - this PR contributes up-to-date documentation for the EDC Management API.

WHY

The Management API is what applications develop against. Currently, there's no parameter-level-documentation for all endpoints thus this PR should help the community integrate tractusx-edcs into their products and infrastructure.

FURTHER NOTES

This was initially written as a contribution to the connector kit. tractusx-edc contributors have voiced their willingness to host the content here. Thus, all non-technical conventions were carved out and will be added to the kit after this PR is merged. The overall structure of this repos documentation remains unchanged.

Closes #951

[github-actions]

This pull request is stale because it has been open for 7 days with no activity.

[ndr-brt]

given that the kit documentation will be statically put in the eclipse-tractusx.github.io repository, I guess we should put the documentation out of the kit folder, that it would get removed soon, am I correct?

[arnoweiss]

It might make sense to keep it in here as long as the eclipse-tractusx/eclipse-tractusx.github.io#558 isn't merged yet. I'll remove duplicate content in a separate PR afterwards but wanna make sure that there's a new home for the Mgmt-API-Walkthrough first.

(edit: corrected PR link)

[arnoweiss]

The build error stems from this exception:

RenewalEdrInMemoryTest > Verify that the EDR is renewed FAILED
    java.lang.RuntimeException: java.lang.RuntimeException: Timeout exceeded waiting for events
        at org.eclipse.tractusx.edc.tests.edr.TestFunctions.waitForEvent(TestFunctions.java:55)
        at org.eclipse.tractusx.edc.tests.edr.AbstractRenewalEdrTest.lambda$negotiateEdr_shouldRenewTheEdr$1(AbstractRenewalEdrTest.java:105)
        at java.base/java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:197)
        at java.base/java.util.AbstractList$RandomAccessSpliterator.forEachRemaining(AbstractList.java:720)
        at java.base/java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:509)
        at java.base/java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:499)
        at java.base/java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:921)
        at java.base/java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234)
        at java.base/java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:682)
        at org.eclipse.tractusx.edc.tests.edr.AbstractRenewalEdrTest.negotiateEdr_shouldRenewTheEdr(AbstractRenewalEdrTest.java:106)
        at java.base/java.lang.reflect.Method.invoke(Method.java:568)
        at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)
        at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)

        Caused by:
        java.lang.RuntimeException: Timeout exceeded waiting for events
            at org.eclipse.tractusx.edc.tests.edr.TestFunctions.waitForEvent(TestFunctions.java:52)
            ... 12 more

Locally, the same command ./gradlew test -DincludeTags="EndToEndTest" -PverboseTest=true builds without error. This PR changes nothing in the relevant domain (EDR in memory), so I'm not sure how to fix this.

[ndr-brt]

looks like a flaky test indeed. LGTM

[sonarcloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

[arnoweiss]

I'll proceed to ensure that the old kit-"folder" is transferred to tractusx.github.io and then remove it from here.