Merge remote-tracking branch 'origin/jwt-support' into jwt-support

Author: m-mohr

CHANGELOG.md

@@ -11,9 +11,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **New extensions:**
   - [Remote Process Definition Extension](./extensions/remote-process-definition/README.md)
   - [Processing Parameters Extension](./extensions/processing-parameters/README.md)
+- `GET /credentials/oidc`: Added `authorization_parameters` property to enforce specific parameters for the authorization endpoint [#534](https://github.com/Open-EO/openeo-api/issues/534)
 - `POST /result`: Added response header "OpenEO-Identifier" to expose an identifier associated with a synchronous processing request.
+- Added `stacktrace` to log entries (e.g. for `GET /jobs/{job_id}/logs`) [#512](https://github.com/Open-EO/openeo-api/issues/512)
 - Added `version` property to `GET /processes` [#517](https://github.com/Open-EO/openeo-api/issues/517)
 - Added `queued`, `started` and `unpublished` to the batch job metadata and the corresponding STAC results [#542](https://github.com/Open-EO/openeo-api/issues/542)
+- Added a status diagram that explains the status changes of batch jobs [#436](https://github.com/Open-EO/openeo-api/issues/436)
 - Added all the batch job timestamps (including the new timestamps above) to the Collection type of batch job results
 - Support for standard JSON Web Tokens (JWT) being used as Bearer tokens [#558](https://github.com/Open-EO/openeo-api/issues/558)
 
@@ -47,6 +50,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Clarified the behaviour of `federation:backends` for `POST /validation`
 - Clarified the meaning of `expires` in batch job results
 - Clarified that `last_successful_check` (from Federation Extension) can be null.
+- Clarified the relation between result and end nodes, the usage of the result flag, and the relation between the outermost ("root") and child process graphs [#547](https://github.com/Open-EO/openeo-api/issues/547)
 - Fixed various OpenAPI issues reported by redocly lint
 
 ## [1.2.0] - 2021-05-25

assets/status-diagram.png

@@ -323,10 +323,14 @@ info:
     ```
     A process node MUST always contain key-value-pairs named `process_id` and `arguments`. It MAY contain a `description`.
 
-    One of the nodes in a map of processes (the final one) MUST have the `result` flag set to `true`, all the other nodes can omit it as the default value is `false`. Having such a node is important as multiple end nodes are possible, but in most use cases it is important to exactly specify the return value to be used by other processes. Each child process graph must also specify a result node similar to the "main" process graph.
-
     `process_id` MUST be a valid process ID in the `namespace` given. Clients SHOULD warn the user if a user-defined process is added with the same identifier as one of the predefined process.
 
+    In the following, "end node" (also known as "leaf node") defines a node that is not referenced by any other node in the same process graph. The "root process graph" is the outermost process graph, which is not part of any other process graph.
+
+    A "result node" is a node (often an end node, but that's not required) that defines the return value of the process graph and has the `result` flag set to `true`. Exactly one of the nodes in a map of processes MUST have the `result` flag set to `true`, all the other nodes can omit it as the default value is `false`. Each child process graph MUST specify its own result node. The root process graph MUST also specify a result node although not strictly needed in all use cases.
+    
+    Having a result node is important as multiple end nodes are possible and in many use cases it is important to identify a specific return value for the process graph that is passed to other processes. The result node is not necessarily an end node.
+
     ### Arguments
 
     A process can have an arbitrary number of arguments. Their name and value are specified 
@@ -437,7 +441,7 @@ info:
 
     ### Full example for an EVI computation
 
-    Deriving minimum EVI (Enhanced Vegetation Index) measurements over pixel time series of Sentinel-2 imagery. The main process graph in blue, child process graphs in yellow:
+    Deriving minimum EVI (Enhanced Vegetation Index) measurements over pixel time series of Sentinel-2 imagery. The root process graph in blue, child process graphs in yellow:
 
     ![Graph with processing instructions](assets/pg-evi-example.png)
 
@@ -2046,6 +2050,15 @@ paths:
                                 items:
                                   type: string
                                   format: uri
+                        authorization_parameters:
+                          type: object
+                          description: |-
+                            Additional parameters that an openEO client MUST include when requesting the authorization endpoint.
+                            This can be used to enforce specific
+                            [request parameters such as `prompt`](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).
+                          example:
+                            prompt: consent
+                            access_type: offline
                         links:
                           type: array
                           description: |-
@@ -2084,6 +2097,8 @@ paths:
                       - profile
                       - email
                       - earthengine
+                    authorization_parameters:
+                      access_type: offline
                   - id: ms
                     issuer: 'https://login.microsoftonline.com/example-tenant/v2.0'
                     title: Microsoft
@@ -5578,6 +5593,7 @@ components:
             The current status of a batch job.
 
             The following status changes can occur:
+            
             * `POST /jobs`: The status is initialized as `created`.
             * `POST /jobs/{job_id}/results`: The status is set to `queued`, if
             processing does not start instantly.
@@ -5587,7 +5603,11 @@ components:
             * `DELETE /jobs/{job_id}/results`: The status is set to `canceled` if
             the status was `running` beforehand and partial or preliminary results
             are available to be downloaded. Otherwise the status is set to
-            `created`. 
+            `created`.
+
+            The following state diagram shows the possible status changes:
+
+            ![State diagram](assets/status-diagram.png)
           example: running
           default: created
         progress:
@@ -6456,6 +6476,10 @@ components:
                 example: udf
         usage:
           $ref: '#/components/schemas/usage'
+        stacktrace:
+          type: string
+          description: >-
+            A stacktrace or similar, may include whitespaces for formatting.
         links:
           $ref: '#/components/schemas/log_links'
     usage: