docs: update walkthrough guide #1241
Conversation
wolf4ood
force-pushed
the
docs/1239_walk_guide_update
branch
from
1b029ec to
34365ae
Compare
wolf4ood
force-pushed
the
docs/1239_walk_guide_update
branch
from
34365ae to
1592686
Compare
There was a problem hiding this comment.
Thanks for this PR - clarifies and updates a lot. At some point, a separate PR could update the documentation of the /edrs API as that appears to have changed a lot too. There's some errors in unchanged sections too that don't have to be included for this PR to be merged. Got a couple of questions but nothing blocking.
| @@ -28,38 +28,33 @@ impacting policy definitions. | |||
| Policies can be created in the EDC as follows: | |||
|
|
|||
| ```http | |||
| POST /v3/assets HTTP/1.1 | |||
| POST /v3/policydefinitions HTTP/1.1 | |||
| "@context": { | ||
| "edc": "https://w3id.org/edc/v0.0.1/ns/" | ||
| }, | ||
| "@type": "edc:Criterion", |
There was a problem hiding this comment.
Is this tested? In the past, leftOperands had to be given in expanded format (so it appears this was wrong in the docs before).
There was a problem hiding this comment.
do you mean the edc:someProperty ?
There was a problem hiding this comment.
yep, https://w3id.org/edc/v0.0.1/ns/someProperty I've seen work in the past, edc:someProperty (even with appropriate context present) not.
There was a problem hiding this comment.
Yes, it was already in the form of edc:someProperty but is not correct. Will fix it thanks :)
| @@ -42,6 +38,8 @@ Content-Type: application/json | |||
| The request body is lean. Mandatory properties are: | |||
| - `counterPartyAddress` (formerly `providerUrl`): This property points to the DSP-endpoint of the Data Provider's Control | |||
| Plane. Usually this ends on `/api/v1/dsp`. | |||
| - `counterPartyId`: must be the provider BPN. This in not a mandatory property for EDC but it's required for TractusX-EDC. | |||
| If omitted the catalog request will fail. | |||
There was a problem hiding this comment.
just curious: why does tractusx-edc require this additional bit of info in 0.7.x?
There was a problem hiding this comment.
It's for the IATP protocol, we need BPN -> DID for on every DSP requests
| @@ -148,13 +167,12 @@ Consequently, if there may be more than one offer for the same Asset, requiring | |||
| policies included. | |||
|
|
|||
| - The `@id` corresponds to the id of the Asset that can be negotiated for. | |||
| - `dcat:Distribution` makes statements over which Data Planes an Asset's data can be retrieved. Currently, the EDC always | |||
| returns `HttpProxy` and `AmazonS3` even though not all EDC-deployments have both capabilities. | |||
| - `dcat:Distribution` makes statements over which Data Planes an Asset's data can be retrieved. Currently, the TractusX-EDC supports | |||
There was a problem hiding this comment.
Does this statement hold true only for the general capabilities of the Dataplane OR for also for this particular dcat:Dataset? With 0.6.x, I've witnessed it just returning HttpData-PULL, AmazonS3-PUSH and AzureStorage-PUSH independently of how the Asset was registered.
There was a problem hiding this comment.
That's independent on how the Asset is configured. The asset only says where the is resides and in which protocol, but that is the source of a transfer and the consumer does not see that.
HttpData-PULL, AmazonS3-PUSH and AzureStorage-PUSH are the destination, or how the consumer can receive data.
Those can be mixed, for example if I configure an asset with HttpData that can be consumed:
HttpData-PULL(Consumer pull the data)AmazonS3-PUSH/AzureStorage-PUSH(Provider push the data)
| "odrl": "http://www.w3.org/ns/odrl/2/", | ||
| "dspace": "https://w3id.org/dspace/v0.8/" | ||
| "tx": "https://w3id.org/tractusx/v0.0.1/ns/", | ||
| "tx-auth": "https://w3id.org/tractusx/auth/", |
There was a problem hiding this comment.
I haven't seen this namespace used anywhere - what does it manage?
There was a problem hiding this comment.
This are automatically returned by EDC side in every response when we register custom namespaces. event if not used in this specific response
|
@arnoweiss the EDR api docs has already been modified in this PR. |
|
WHAT
updates the walkthrough mostly by adjusting payloads and adding 0.7.x relevant documentation
WHY
documentation
Closes #1239