You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: extensions/remote-udp/README.md
+16-14Lines changed: 16 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -22,23 +22,25 @@ This makes it possible for this extension to add additional allowed values to th
22
22
23
23
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:
24
24
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}`.
26
26
In this case, the `id` property of the process graph node MUST be equal to the `id` of the process,
27
27
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`.
29
29
In this case, the `id` property of the process graph node is used to identify the process from the list.
30
30
If not found a `ProcessNamespaceInvalid` error is thrown
31
31
32
-
### Compatibility
32
+
\* Compatible means in this context that the requests and responses must comply to the openEO API specification with the following exceptions:
33
33
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.
38
40
39
41
### Client Considerations
40
42
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.
42
44
43
45
The protocol `http` is discouraged for URLs as web-based clients may not be able to retrieve HTTP URLs from a HTTPS context.
44
46
For the same reason it is also RECOMMENDED to enable CORS for all URLs.
@@ -57,11 +59,11 @@ An exemplary process graph node:
0 commit comments