Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(control-plane-adapter): improve documentation on how to use the control-plane adapter extension #210

Merged
merged 3 commits into from
Apr 17, 2023
Merged

docs(control-plane-adapter): improve documentation on how to use the control-plane adapter extension #210

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3359aac
docs(control-plane-adapter): update documentation on how to request a…
saschaisele-zf Apr 12, 2023
cffdbff
docs(control-plane-adapter): incorporate review suggestions
saschaisele-zf Apr 14, 2023
786f88e
docs(control-plane-adapter): edit for markdown-lint
saschaisele-zf Apr 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion edc-extensions/control-plane-adapter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
saschaisele-zf marked this conversation as resolved.
Show resolved Hide resolved
|----------------------------|---------------------------------------------------------------------|
| `controlplaneUrl` | The URL where the control plane of the consumer connector is hosted |
saschaisele-zf marked this conversation as resolved.
Show resolved Hide resolved
| `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 |
saschaisele-zf marked this conversation as resolved.
Show resolved Hide resolved

The example ULR could be:

Expand Down