From 3359aac74c1d0b8bcd92bc3fe1f7217a4526e4f0 Mon Sep 17 00:00:00 2001 From: Sascha Isele Date: Wed, 12 Apr 2023 17:33:39 +0200 Subject: [PATCH 1/3] docs(control-plane-adapter): update documentation on how to request an asset Signed-off-by: Sascha Isele --- edc-extensions/control-plane-adapter/README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/edc-extensions/control-plane-adapter/README.md b/edc-extensions/control-plane-adapter/README.md index fe9d4787c..19fdee2e2 100644 --- a/edc-extensions/control-plane-adapter/README.md +++ b/edc-extensions/control-plane-adapter/README.md @@ -39,8 +39,15 @@ 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 hosted | + | `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 leading to the provider connector | The example ULR could be: From cffdbff3849e2cdc78f4ce250d165822d572342c Mon Sep 17 00:00:00 2001 From: Sascha Isele Date: Fri, 14 Apr 2023 10:47:30 +0200 Subject: [PATCH 2/3] docs(control-plane-adapter): incorporate review suggestions Signed-off-by: Sascha Isele --- edc-extensions/control-plane-adapter/README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/edc-extensions/control-plane-adapter/README.md b/edc-extensions/control-plane-adapter/README.md index 19fdee2e2..d59dcd9d4 100644 --- a/edc-extensions/control-plane-adapter/README.md +++ b/edc-extensions/control-plane-adapter/README.md @@ -41,13 +41,14 @@ To run CP-Adapter in "PERSISTENT" mode, You need to create a proper tables with ```plain {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 hosted | - | `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 leading to the provider connector | + + | 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: From 786f88eb089dad397fc671db21f5bc193473c525 Mon Sep 17 00:00:00 2001 From: Sascha Isele Date: Fri, 14 Apr 2023 15:13:37 +0200 Subject: [PATCH 3/3] docs(control-plane-adapter): edit for markdown-lint Signed-off-by: Sascha Isele --- edc-extensions/control-plane-adapter/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/edc-extensions/control-plane-adapter/README.md b/edc-extensions/control-plane-adapter/README.md index d59dcd9d4..5f2d0d890 100644 --- a/edc-extensions/control-plane-adapter/README.md +++ b/edc-extensions/control-plane-adapter/README.md @@ -41,7 +41,7 @@ To run CP-Adapter in "PERSISTENT" mode, You need to create a proper tables with ```plain {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 |