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.

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(edr): Update 07_edrs.md #1646

Merged
merged 3 commits into from
Oct 23, 2024
Merged

Conversation

gerbigf
Copy link
Contributor

@gerbigf gerbigf commented Oct 23, 2024

WHAT

Fixed the section about provider data plane data transfer in the edr chapter of the management walkthrough and added some more detailed explanation about how the request is build.

WHY

Incorrect example

FURTHER NOTES

Copy link
Contributor

@rafaelmag110 rafaelmag110 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some nits...

docs/usage/management-api-walkthrough/07_edrs.md Outdated Show resolved Hide resolved
Provider Data Plane:
Once the right EDR has been identified using the EDR Management API via the correct asset/agreement/transfer-process that
you want to transfer, we can use the `endpoint` and `authorization` information from the EDRto make the request. The `endpoint`
is used as the Host to which the request is sent and the `authorization` is used as the Token in the authorization header.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
is used as the Host to which the request is sent and the `authorization` is used as the Token in the authorization header.
As in the example bellow, the `endpoint` is used as the Host to which the request is sent and the `authorization` replaces TOKEN in the `Authorization` header.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed with a different proposal.

@rafaelmag110 rafaelmag110 requested a review from wolf4ood October 23, 2024 08:07
@rafaelmag110 rafaelmag110 added the documentation Improvements or additions to documentation label Oct 23, 2024
Added Rafaels Suggestions
Copy link

@rafaelmag110
Copy link
Contributor

Even though its not mentioned anywhere in this repo (i thinkg), the name of the pr should adhere to the Eclipse EDC project contributing guidelines: https://github.com/eclipse-edc/docs/blob/main/CONTRIBUTING.md
At least to make it consistent.
Something like: docs(edr): <your description> should do!

@wolf4ood wolf4ood merged commit 6fcfa80 into eclipse-tractusx:main Oct 23, 2024
6 checks passed
@wolf4ood wolf4ood changed the title Update 07_edrs.md docs(edr): Update 07_edrs.md Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

3 participants