docs(control-plane-adapter): improve documentation on how to use the …

…control-plane adapter extension (#210)
eclipse-tractusx · Apr 17, 2023 · fd241d0 · fd241d0
1 parent 945ef0c
commit fd241d0
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/edc-extensions/control-plane-adapter/README.md b/edc-extensions/control-plane-adapter/README.md
@@ -39,9 +39,17 @@ To run CP-Adapter in "PERSISTENT" mode, You need to create a proper tables with
 1. Client sends a GET request with two parameters: assetId and the url of the provider controlplane:
 
    ```plain
-   /adapter/asset/sync/{assetId}?providerUrl={providerUrl}
+   {controlplaneUrl}:{web.http.management.port}/{web.http.management.path}/adapter/asset/sync/{assetId}?providerUrl={providerUrl}
    ```
 
+   | Name                       | Description                                                                      |
+   |----------------------------|----------------------------------------------------------------------------------|
+   | `controlplaneUrl`          | The URL where the control plane of the consumer connector is available           |
+   | `web.http.management.port` | Port of the management API provided by the control plane                         |
+   | `web.http.management.path` | Path of the management API provided by the control plane                         |
+   | `assetId`                  | ID of the wanted asset                                                           |
+   | `providerUrl`              | URL pointing to the `data` endpoint of the IDS context of the provider connector |
+
    The example ULR could be:
 
    ```plain