Skip to content

Commit 616939d

Browse files
authored
docs:correction of hyperlinks in "Tractus-X EDC Extensions for DataPlane Signaling Token Refresh" documentation (#1757)
* docs:correction of hyperlinks and dependencies * docs:correction of dependencies * docs:correction of dependencies
1 parent d305343 commit 616939d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/development/dataplane-signaling/tx-signaling.extensions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ that extends the DataPlane Signaling framework.
66
## Overview
77

88
The provider DataPlane exposes a new public facing API called the "Refresh API". Its purpose is to accept a refresh
9-
token and an authentication token (see documentation [here]()), perform validity checks and then respond with a new
9+
token and an authentication token (see documentation [here](https://github.com/eclipse-tractusx/tractusx-profiles/blob/main/tx/refresh/refresh.token.grant.profile.md#3-the-refresh-request)), perform validity checks and then respond with a new
1010
refresh token similar to this:
1111

1212
```json
@@ -23,7 +23,7 @@ A complete sequence including `TransferRequestMessage` is shown here:
2323
- `(1)`Consumer send `TransferRequestMessage`
2424
- `(2)` Provider sends `DataFlowStartMessage` to its own DataPlane via the Signaling API
2525
- `(3)` Provider's DataPlane creates an `EndPointDataReference` (
26-
see [here](https://github.com/eclipse-edc/Connector/blob/main/docs/developer/data-plane-signaling/data-plane-signaling-token-handling.md#2-updates-to-thedataaddress-format)
26+
see [here](https://eclipse-edc.github.io/documentation/for-contributors/data-plane/data-plane-signaling/#323-access-token-generation)
2727
for an example)
2828
- `(4)` Provider's ControlPlane receives `EndpointDataReference` (= EDR)
2929
- `(5)` Provider sends `TransferStartMessage` that contains the `EndpointDataReference` to the Consumer via DSP.
@@ -34,7 +34,7 @@ A complete sequence including `TransferRequestMessage` is shown here:
3434

3535
_TOKEN EXPIRES_
3636

37-
- `(8)` The `TokenRefreshHandler` module creates the `authentication_token` (see [documentation]())
37+
- `(8)` The `TokenRefreshHandler` module creates the `authentication_token`
3838
- `(9)` The `TokenRefreshHandler` module sends token refresh request to provider's public Refresh API
3939
- `(10)` Provider performs authentication checks, creates a new `access_token` and a new `refresh_token`, updates
4040
internal records and sends the response back.
@@ -57,13 +57,13 @@ This is called "lazy refresh".
5757
![](./AutomaticRefresh.drawio.png)
5858

5959
- `(1)`: Consumer data plane receives HTTP 401 indicating an auth failure
60-
- `(2)`: The `TokenRefreshHandler` module creates the `authentication_token` (see [documentation]())
60+
- `(2)`: The `TokenRefreshHandler` module creates the `authentication_token`
6161
- `(3)`: The `TokenRefreshHandler` module sends token refresh request to provider's public Refresh API.
6262

6363
Note that if the token-refresh call also fails with an HTTP 4xx error code, the token must be regarded as invalid and
6464
not authorized. An expired contract agreement or an unsatisfied policy could be reasons for that (
6565
see [decision record](https://github.com/eclipse-edc/Connector/tree/main/docs/developer/decision-records/2023-09-07-policy-monitor)
66-
and [documentation](https://github.com/eclipse-edc/Connector/blob/main/docs/developer/policy-monitor.md)).
66+
and [documentation](https://eclipse-edc.github.io/documentation/for-contributors/control-plane/policy-monitor/)).
6767

6868
Alternatively, implementations of the `TokenRefreshHandler` could choose to proactively refresh the token if nearing
6969
expiry instead of "letting it fail" first. _This is transparent to the client application._

0 commit comments

Comments
 (0)