Add additional batch job timestamps (#556)

* Added `queued`, `started` and `expires` to the batch job metadata and the corresponding STAC results. #542 * Apply suggestions from code review Co-authored-by: Serge Croisé <[email protected]> * Apply suggestions from code review Co-authored-by: Serge Croisé <[email protected]> * Update according to review, also add to Collection result type * Apply suggestions from code review Co-authored-by: Serge Croisé <[email protected]> * Typo --------- Co-authored-by: Serge Croisé <[email protected]>
Open-EO · Feb 14, 2025 · 5d356f7 · 5d356f7
1 parent e4f607a
commit 5d356f7
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,8 +11,10 @@ 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)
-- Added `version` property to `GET /processes` [#517](https://github.com/Open-EO/openeo-api/issues/517)
 - `POST /result`: Added response header "OpenEO-Identifier" to expose an identifier associated with a synchronous processing request.
+- 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 all the batch job timestamps (including the new timestamps above) to the Collection type of batch job results
 
 ### Fixed
 
@@ -23,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Clarified for log levels which default values apply
 - Clarified how the relation types `license`, `version-history` and `author` can be used to enrich the process metadata. [#531](https://github.com/Open-EO/openeo-api/issues/531)
 - Clarified the behaviour of `federation:backends` for `POST /validation`
+- Clarified the meaning of `expires` in batch job results
 
 ## [1.2.0] - 2021-05-25
 

diff --git a/openapi.yaml b/openapi.yaml
@@ -3300,6 +3300,18 @@ paths:
                     required:
                       - assets
                     properties:
+                      created:
+                        $ref: '#/components/schemas/created'
+                      updated:
+                        $ref: '#/components/schemas/updated'
+                      queued: 
+                        $ref: '#/components/schemas/queued'
+                      started:
+                        $ref: '#/components/schemas/started'
+                      expires:
+                        $ref: '#/components/schemas/expires'
+                      unpublished:
+                        $ref: '#/components/schemas/unpublished'
                       'openeo:status':
                         $ref: '#/components/schemas/result_status'
                     allOf:
@@ -4002,7 +4014,7 @@ components:
               format: date-time
               description: >-
                 For time series: The last or end date and time for the data, in
-                UTC. Formatted as a [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)
+                UTC. Formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)
                 date-time.
             title:
               $ref: '#/components/schemas/eo_title'
@@ -4016,13 +4028,14 @@ components:
               $ref: '#/components/schemas/created'
             updated:
               $ref: '#/components/schemas/updated'
+            queued: 
+              $ref: '#/components/schemas/queued'
+            started:
+              $ref: '#/components/schemas/started'
             expires:
-              type: string
-              format: date-time
-              description: >-
-                Time until which the assets are accessible, in UTC. Formatted as
-                a [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
-              example: '2020-11-01T00:00:00Z'
+              $ref: '#/components/schemas/expires'
+            unpublished:
+              $ref: '#/components/schemas/unpublished'
             'openeo:status':
               $ref: '#/components/schemas/result_status'
         assets:
@@ -5321,6 +5334,7 @@ components:
         parameters:
           type: array
           nullable: true
+          items: {}
         returns:
           type: object
           nullable: true
@@ -5345,6 +5359,7 @@ components:
         parameters:
           type: array
           nullable: true
+          items: {}
         returns:
           type: object
           nullable: true
@@ -5604,6 +5619,12 @@ components:
           $ref: '#/components/schemas/created'
         updated:
           $ref: '#/components/schemas/updated'
+        queued: 
+          $ref: '#/components/schemas/queued'
+        started:
+          $ref: '#/components/schemas/started'
+        unpublished:
+          $ref: '#/components/schemas/unpublished'
         plan:
           $ref: '#/components/schemas/billing_plan'
         costs:
@@ -5666,16 +5687,49 @@ components:
       type: string
       format: date-time
       description: >-
-        Date and time of creation, formatted as a [RFC
-        3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
+        Date and time of creation (for batch jobs: the status 'created' was set),
+        formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
       example: '2017-01-01T09:32:12Z'
     updated:
       type: string
       format: date-time
       description: >-
-        Date and time of the last status change, formatted as a [RFC
-        3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
+        Date and time of the last status change,
+        formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
+        If the status is `error`, `canceled` or `finished`,
+        this is the time when the job has ended.
+      example: '2017-01-01T09:54:18Z'
+    queued:
+      type: string
+      format: date-time
+      description: >-
+        Date and time of queueing the batch job (i.e., when the status 'queued' was set),
+        formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
+      example: '2017-01-01T09:34:00Z'
+    started:
+      type: string
+      format: date-time
+      description: >-
+        Date and time when the batch job started processing (i.e., when the status 'running' was set),
+        formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
       example: '2017-01-01T09:36:18Z'
+    expires:
+      type: string
+      format: date-time
+      description: >-
+        Time in UTC until which the assets and this document are accessible via the signed URL
+        that is provided with the relation type `canonical` in the links.
+        Formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
+        After expiration, a document with new signed URLs can be retrieved through an authenticated
+        request to this endpoint.
+      example: '2017-02-01T09:54:18Z'
+    unpublished:
+      type: string
+      format: date-time
+      description: >-
+        Time until which the batch job results are stored on the back-end, in UTC.
+        Formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
+      example: '2018-01-01T09:54:18Z'
     description:
       type: string
       format: commonmark