Skip to content

Commit 216f0f5

Browse files
committed
chore(protocol): switch default to /api/v1/dsp
1 parent cb80327 commit 216f0f5

File tree

5 files changed

+72
-6
lines changed

5 files changed

+72
-6
lines changed

charts/tractusx-connector-azure-vault/values.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ controlplane:
110110
# -- port for incoming api calls
111111
port: 8084
112112
# -- path for incoming api calls
113-
path: /api/v1/ids
113+
path: /api/v1/dsp
114114
# -- metrics api, used for application metrics, must not be internet facing
115115
metrics:
116116
# -- port for incoming api calls

charts/tractusx-connector-memory/values.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ runtime:
112112
# -- port for incoming api calls
113113
port: 8084
114114
# -- path for incoming api calls
115-
path: /api/v1/ids
115+
path: /api/v1/dsp
116116
# -- observability api with unsecured access, must not be internet facing
117117
observability:
118118
# -- port for incoming API calls

charts/tractusx-connector/values.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ controlplane:
110110
# -- port for incoming api calls
111111
port: 8084
112112
# -- path for incoming api calls
113-
path: /api/v1/ids
113+
path: /api/v1/dsp
114114
# -- metrics api, used for application metrics, must not be internet facing
115115
metrics:
116116
# -- port for incoming api calls

docs/migration/Version_0.3.4_0.4.0.md

+67-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Migration from 0.3.3 to 0.3.4
1+
# Migration from 0.3.3 to 0.4.0
22

33
## Switching to DSP
44

@@ -10,9 +10,16 @@ From the Tractus-X EDC perspective this causes breaking changes in the following
1010
The old Management API is now deprecated and is **not** tested for compliance. Please upgrade using the `/v2/` path
1111
for every endpoint, e.g. `<PATH>/management/v2/assets`. Please also refer to
1212
the [EDC OpenAPI spec](https://app.swaggerhub.com/apis/eclipse-edc-bot/management-api/0.0.1-SNAPSHOT#/).
13+
An updated postman collection with the `v2` flow is available [here](../development/postman/collection.json)
14+
1315
- modules: all `*ids*` modules are deprecated and cannot be used anymore. Please migrate over
1416
to `org.eclipse.edc:dsp:0.0.1-milestone-9`.
1517

18+
- path: the default protocol path is now `/api/v1/dsp` instead of `/api/v1/ids`
19+
20+
- `edc.participant.id`: new mandatory configuration for the participant id in the dataspace. (BPN number).
21+
It's configured via mandatory property in the charts with object ```yaml participant: id: "id"```.
22+
1623
**Please note that this is not a complete documentation of the DSP Protocol, please refer to
1724
the [official documentation](https://docs.internationaldataspaces.org/dataspace-protocol/overview/readme)**
1825

@@ -27,3 +34,62 @@ The Business tests were brittle, consumed a lot of resources and were quite cumb
2734

2835
Since the old Control-Plane-Adapter is incompatible with DSP, a new iteration was created.
2936
**Due to time constraints with this release documentation for this feature will to be published subsequently**
37+
38+
39+
## Other changes
40+
41+
- When using the EDR [HttpDynamicReceiverExtension](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/transfer/transfer-pull-http-dynamic-receiver) in the transfer process initiation
42+
the properties for configuring the receiver on single transfer process has been changed to:
43+
44+
```json
45+
"privateProperties": {
46+
"receiverHttpEndpoint": "{{BACKEND_SERVICE}}"
47+
}
48+
```
49+
instead of:
50+
51+
```json
52+
"properties": {
53+
"receiver.http.endpoint": "{{BACKEND_SERVICE}}"
54+
}
55+
```
56+
57+
58+
## New Catalog
59+
60+
The DSP catalog is expressed as [DCat Catalog](https://www.w3.org/TR/vocab-dcat-3/), when querying the catalog a response like this will return:
61+
62+
```json
63+
{
64+
"@id": "5a3207ae-bd0d-4a3b-bc8a-05adfbe75d95",
65+
"@type": "dcat:Catalog",
66+
"dcat:dataset": {
67+
"@id": "e6279569-17a9-4ba3-9401-a8ae4100e4eb",
68+
"@type": "dcat:Dataset",
69+
"odrl:hasPolicy": {
70+
"@id": "2:1:535def6e-8321-4c0e-a595-aabdd9c18eed",
71+
"@type": "odrl:Set",
72+
"odrl:permission": [],
73+
"odrl:prohibition": [],
74+
"odrl:obligation": [],
75+
"odrl:target": "1"
76+
},
77+
"dcat:distribution": [
78+
...
79+
],
80+
"edc:description": "Product EDC Demo Asset",
81+
"edc:id": "1"
82+
},
83+
"dcat:service": {
84+
...
85+
},
86+
"edc:participantId": "participantId",
87+
"@context": {
88+
}
89+
}
90+
```
91+
92+
When starting a new contract negotiation for an asset:
93+
94+
- the `@id` of `odrl:hasPolicy` object should be passed in the `offerId` field
95+
- the `edc:participantId` should be passed in the `providerId` and `connectorId` fields. `connectorId` it's still needed for backward compatibility and it will probably be removed in the next versions.

edc-extensions/postgresql-migration/src/main/resources/org/eclipse/tractusx/edc/postgresql/migration/contractdefinition/V0_0_6__Alter_ContractDefinition_Rename_selector_expression.sql

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
--
2-
-- Copyright (c) 2022 Mercedes-Benz Tech Innovation GmbH
2+
-- Copyright (c) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
33
--
44
-- This program and the accompanying materials are made available under the
55
-- terms of the Apache License, Version 2.0 which is available at
@@ -8,7 +8,7 @@
88
-- SPDX-License-Identifier: Apache-2.0
99
--
1010
-- Contributors:
11-
-- Mercedes-Benz Tech Innovation GmbH - EDC Snapshot 20221201 Update
11+
-- Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - initial API and implementation
1212
--
1313

1414
-- add columns

0 commit comments

Comments
 (0)