Update according to review, also add to Collection result type

Open-EO · Jan 28, 2025 · 5f7ca8e · 5f7ca8e
1 parent 80cd197
commit 5f7ca8e
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,7 +11,8 @@ 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)
 - Added `version` property to `GET /processes` [#517](https://github.com/Open-EO/openeo-api/issues/517)
-- Added `queued`, `started` and `expires` to the batch job metadata and the corresponding STAC results. [#542](https://github.com/Open-EO/openeo-api/issues/542)
+- 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
 
@@ -22,6 +23,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
@@ -3294,6 +3294,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:
@@ -4016,6 +4028,8 @@ components:
               $ref: '#/components/schemas/started'
             expires:
               $ref: '#/components/schemas/expires'
+            unpublished:
+              $ref: '#/components/schemas/unpublished'
             'openeo:status':
               $ref: '#/components/schemas/result_status'
         assets:
@@ -5314,6 +5328,7 @@ components:
         parameters:
           type: array
           nullable: true
+          items: {}
         returns:
           type: object
           nullable: true
@@ -5338,6 +5353,7 @@ components:
         parameters:
           type: array
           nullable: true
+          items: {}
         returns:
           type: object
           nullable: true
@@ -5601,8 +5617,8 @@ components:
           $ref: '#/components/schemas/queued'
         started:
           $ref: '#/components/schemas/started'
-        expires:
-          $ref: '#/components/schemas/expires'
+        unpublished:
+          $ref: '#/components/schemas/unpublished'
         plan:
           $ref: '#/components/schemas/billing_plan'
         costs:
@@ -5676,7 +5692,7 @@ components:
         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:36:18Z'
+      example: '2017-01-01T09:54:18Z'
     queued:
       type: string
       format: date-time
@@ -5695,9 +5711,19 @@ components:
       type: string
       format: date-time
       description: >-
-        Time until which the assets are accessible, in UTC. Formatted as
-        an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
-      example: '2020-11-01T00:00:00Z'
+        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