Skip to content

Commit b3c7cef

Browse files
committed
Updates according to code review
1 parent 92a7e56 commit b3c7cef

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

extensions/remote-udp/README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,25 @@ This makes it possible for this extension to add additional allowed values to th
2222

2323
This extension extends the `namespace` property of process graph nodes so that it accepts **absolute** URL with the protocols `https` (**recommended**) and `http` (discouraged). The URLs specified MUST return one of the following two options:
2424

25-
1. A single process, compatible to the endpoint `GET /process_graphs/{process_graph_id}`.
25+
1. A single process, compatible\* to the endpoint `GET /process_graphs/{process_graph_id}`.
2626
In this case, the `id` property of the process graph node MUST be equal to the `id` of the process,
2727
otherwise a `ProcessNamespaceInvalid` error is thrown
28-
2. A list of processes, compatible to the endpoint `GET /process_graphs`.
28+
2. A list of processes, compatible\* to the endpoint `GET /process_graphs`.
2929
In this case, the `id` property of the process graph node is used to identify the process from the list.
3030
If not found a `ProcessNamespaceInvalid` error is thrown
3131

32-
### Compatibility
32+
\* Compatible means in this context that the requests and responses must comply to the openEO API specification with the following exceptions:
3333

34-
Compatible means in this context that the requests and responses must comply to the openEO API specification with the following exceptions:
35-
36-
- The `Authorization` header MUST NOT not be sent.
37-
- Lists of processes MUST NOT paginate and the full process description MUST be provided for each process (i.e., the recommendation to omit large properties such as `process_graph` doesn't apply).
34+
- User credentials / tokens that are obtained through the openEO API MUST NOT not be sent to URIs that are external to the openEO API.
35+
The requirement to provide an `Authorization` header for the respective endpoints doesn't apply.
36+
- For a list of processes, the full process description MUST be provided for the process with the given ID within the first request.
37+
This means that the recommendation to omit large roperties such as `process_graph` doesn't apply.
38+
It also requires that the requester doesn't need to paginate through additional pages to find the process with the given ID.
39+
Ideally, the list of processes is not paginated as otherwise the process with the given ID may move to other pages over time.
3840

3941
### Client Considerations
4042

41-
Clients MUST only offer this functionality to users if the conformance class of this extension is listed in the `conformsTo` property of the `GET /` endpoint.
43+
If a client is conncected to a specific backend, the client MUST only offer this functionality to users if the conformance class of this extension is listed in the `conformsTo` property of the `GET /` endpoint.
4244

4345
The protocol `http` is discouraged for URLs as web-based clients may not be able to retrieve HTTP URLs from a HTTPS context.
4446
For the same reason it is also RECOMMENDED to enable CORS for all URLs.
@@ -57,11 +59,11 @@ An exemplary process graph node:
5759

5860
```json
5961
{
60-
"process_id": "echo",
61-
"namespace": "https://hub.openeo.org/processes/echo",
62-
"arguments": {
63-
"message": "Hello World"
64-
},
65-
"result": true
62+
"process_id": "echo",
63+
"namespace": "https://hub.openeo.org/processes/echo",
64+
"arguments": {
65+
"message": "Hello World"
66+
},
67+
"result": true
6668
}
6769
```

0 commit comments

Comments
 (0)