From 1023a300ce297f4ae0f59bc2cc619c934a0d9658 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Sun, 12 Jan 2025 23:36:30 +0100 Subject: [PATCH] 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