-
Notifications
You must be signed in to change notification settings - Fork 53
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.
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: adds documentations for the new management api #441
docs: adds documentations for the new management api #441
Conversation
docs/samples/management-api-v2-walkthrough/1-management-api-oveview.md
Outdated
Show resolved
Hide resolved
docs/samples/management-api-v2-walkthrough/1-management-api-oveview.md
Outdated
Show resolved
Hide resolved
docs/samples/management-api-v2-walkthrough/3-policy-definitions.md
Outdated
Show resolved
Hide resolved
docs/samples/management-api-v2-walkthrough/6-contract-negotiation.md
Outdated
Show resolved
Hide resolved
docs/samples/management-api-v2-walkthrough/6-contract-negotiation.md
Outdated
Show resolved
Hide resolved
docs/samples/management-api-v2-walkthrough/6-contract-negotiation.md
Outdated
Show resolved
Hide resolved
Could you also take a look? @ndr-brt @paullatzelsperger |
docs/samples/management-api-v2-walkthrough/7-transfer-process.md
Outdated
Show resolved
Hide resolved
docs/samples/management-api-v2-walkthrough/1-management-api-oveview.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Sascha Isele <[email protected]>
3699912
to
a444335
Compare
…to docs/new_management_api
@yurimssilva I just approved and run the GitHub checks for this PR. Please have a look at the failed checks :-) |
@stephanbcbauer review needed :) |
docs/samples/management-api-v2-walkthrough/1-management-api-oveview.md
Outdated
Show resolved
Hide resolved
docs/samples/management-api-v2-walkthrough/1-management-api-oveview.md
Outdated
Show resolved
Hide resolved
docs/samples/management-api-v2-walkthrough/3-policy-definitions.md
Outdated
Show resolved
Hide resolved
docs/samples/management-api-v2-walkthrough/7-transfer-process.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but i am still not sure if the documentation should be here or at upstream :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These definitively deserve to stay on upstream
…to docs/new_management_api
{ | ||
"@context": { | ||
"@vocab": "https://w3id.org/edc/v0.0.1/ns/" | ||
}, | ||
"@type": "AssetEntryDto", | ||
"asset": { | ||
"@id": "asset-id", | ||
"properties": { | ||
"name": "asset-name", | ||
"description": "asset-description", | ||
"version": "0.0.1", | ||
"contenttype": "application/json" | ||
}, | ||
"privateProperties": { | ||
"pvt-prop-1": "prt-prov-val-1", | ||
"pvt-prop-2": "prt-prov-val-2" | ||
} | ||
}, | ||
"dataAddress": { | ||
"type": "asset-address-type", | ||
"keyName": "asset-key-name" | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This object doesn't match with the object thats in our Postman collection. Have you tried to put this objects to an real EDC? Could you double check it?
We (ZF) tried to create assets based on your structure and received a 500. Sadly I can't provide the error message any longer :-/
\cc @tuncaytunc-zf
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Object in the postman collections looks like this:
{
"@context": {},
"asset": {
"@type": "Asset",
"@id": "{{ASSET_ID}}",
"properties": {
"description": "Product EDC Demo Asset"
}
},
"dataAddress": {
"@type": "DataAddress",
"type": "HttpData",
"baseUrl": "https://jsonplaceholder.typicode.com/todos"
}
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've tried it, and it works. The only thing "wrong" there is the dataAddress.type, where I put a placeholder that doesn't look like one, and I'll change it.
Kudos, SonarCloud Quality Gate passed! |
This PR should be closed here and moved to the upstream edc repository. |
…lva/tractusx-edc into docs/new_management_api
Kudos, SonarCloud Quality Gate passed! |
PR moved upstream. |
@yurimssilva please let me know when the PR on upstream is ready. Because I also want to update the documentation on tractusx.github.io |
WHAT