From 1023a300ce297f4ae0f59bc2cc619c934a0d9658 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Sun, 12 Jan 2025 23:36:30 +0100 Subject: [PATCH 1/6] Added `queued`, `started` and `expires` to the batch job metadata and the corresponding STAC results. #542 --- CHANGELOG.md | 1 + openapi.yaml | 48 ++++++++++++++++++++++++++++++++++++++---------- 2 files changed, 39 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d6a55776..90efe48f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ 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) ### Fixed diff --git a/openapi.yaml b/openapi.yaml index 22603a2d..79216ec1 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -4010,13 +4010,12 @@ 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' 'openeo:status': $ref: '#/components/schemas/result_status' assets: @@ -5598,6 +5597,12 @@ components: $ref: '#/components/schemas/created' updated: $ref: '#/components/schemas/updated' + queued: + $ref: '#/components/schemas/queued' + started: + $ref: '#/components/schemas/started' + expires: + $ref: '#/components/schemas/expires' plan: $ref: '#/components/schemas/billing_plan' costs: @@ -5660,16 +5665,39 @@ 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 a [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 a [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' + 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 a [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 a [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 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' description: type: string format: commonmark From 328673917c789e012d5476f6b72db804d87b49ec Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Sat, 25 Jan 2025 01:32:04 +0100 Subject: [PATCH 2/6] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Serge Croisé --- openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 79216ec1..2cdb8806 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -5681,14 +5681,14 @@ components: type: string format: date-time description: >- - Date and time of queueing the batch job (i.e. when the status 'queued' was set), + Date and time of queueing the batch job (i.e., when the status 'queued' was set), formatted as a [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), + Date and time when the batch job started processing (i.e., when the status 'running' was set), formatted as a [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time. example: '2017-01-01T09:36:18Z' expires: From 80cd19762a5aa6ce33bcc5119d401c10564b1c9d Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Sat, 25 Jan 2025 01:33:13 +0100 Subject: [PATCH 3/6] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Serge Croisé --- openapi.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 2cdb8806..a6be9e19 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -5666,14 +5666,14 @@ components: format: date-time description: >- Date and time of creation (for batch jobs: the status 'created' was set), - formatted as a [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time. + 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. + 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' @@ -5696,7 +5696,7 @@ components: 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. + an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time. example: '2020-11-01T00:00:00Z' description: type: string From 5f7ca8eebbaf8dd04aeb63ee30ddd551a058cb5e Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Tue, 28 Jan 2025 18:23:43 +0100 Subject: [PATCH 4/6] Update according to review, also add to Collection result type --- CHANGELOG.md | 4 +++- openapi.yaml | 38 ++++++++++++++++++++++++++++++++------ 2 files changed, 35 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 90efe48f..79128a37 100644 --- 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 index a6be9e19..f003bc08 100644 --- 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 From 9fe0267711b213a721ccbcf46a5be528b3fce213 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Tue, 28 Jan 2025 21:14:45 +0100 Subject: [PATCH 5/6] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Serge Croisé --- openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index b562ccde..2f8cab42 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -5704,14 +5704,14 @@ components: format: date-time description: >- Date and time of queueing the batch job (i.e., when the status 'queued' was set), - formatted as a [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time. + 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 a [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time. + formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time. example: '2017-01-01T09:36:18Z' expires: type: string From 2c3815e6c3873d9082c184b574180b852ca34ae1 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Tue, 28 Jan 2025 21:15:37 +0100 Subject: [PATCH 6/6] Typo --- openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi.yaml b/openapi.yaml index 2f8cab42..88955568 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -4014,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'