Skip to content

Commit 5d356f7

Browse files
m-mohrSergeCroise
m-mohr
and
SergeCroise
authored
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é <SergeCroise@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Serge Croisé <SergeCroise@users.noreply.github.com> * Update according to review, also add to Collection result type * Apply suggestions from code review Co-authored-by: Serge Croisé <SergeCroise@users.noreply.github.com> * Typo --------- Co-authored-by: Serge Croisé <SergeCroise@users.noreply.github.com>
1 parent e4f607a commit 5d356f7

2 files changed

Lines changed: 69 additions & 12 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111
- **New extensions:**
1212
- [Remote Process Definition Extension](./extensions/remote-process-definition/README.md)
1313
- [Processing Parameters Extension](./extensions/processing-parameters/README.md)
14-
- Added `version` property to `GET /processes` [#517](https://github.com/Open-EO/openeo-api/issues/517)
1514
- `POST /result`: Added response header "OpenEO-Identifier" to expose an identifier associated with a synchronous processing request.
15+
- Added `version` property to `GET /processes` [#517](https://github.com/Open-EO/openeo-api/issues/517)
16+
- 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)
17+
- Added all the batch job timestamps (including the new timestamps above) to the Collection type of batch job results
1618

1719
### Fixed
1820

@@ -23,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2325
- Clarified for log levels which default values apply
2426
- 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)
2527
- Clarified the behaviour of `federation:backends` for `POST /validation`
28+
- Clarified the meaning of `expires` in batch job results
2629

2730
## [1.2.0] - 2021-05-25
2831

‎openapi.yaml‎

Lines changed: 65 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3300,6 +3300,18 @@ paths:
33003300
required:
33013301
- assets
33023302
properties:
3303+
created:
3304+
$ref: '#/components/schemas/created'
3305+
updated:
3306+
$ref: '#/components/schemas/updated'
3307+
queued:
3308+
$ref: '#/components/schemas/queued'
3309+
started:
3310+
$ref: '#/components/schemas/started'
3311+
expires:
3312+
$ref: '#/components/schemas/expires'
3313+
unpublished:
3314+
$ref: '#/components/schemas/unpublished'
33033315
'openeo:status':
33043316
$ref: '#/components/schemas/result_status'
33053317
allOf:
@@ -4002,7 +4014,7 @@ components:
40024014
format: date-time
40034015
description: >-
40044016
For time series: The last or end date and time for the data, in
4005-
UTC. Formatted as a [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)
4017+
UTC. Formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)
40064018
date-time.
40074019
title:
40084020
$ref: '#/components/schemas/eo_title'
@@ -4016,13 +4028,14 @@ components:
40164028
$ref: '#/components/schemas/created'
40174029
updated:
40184030
$ref: '#/components/schemas/updated'
4031+
queued:
4032+
$ref: '#/components/schemas/queued'
4033+
started:
4034+
$ref: '#/components/schemas/started'
40194035
expires:
4020-
type: string
4021-
format: date-time
4022-
description: >-
4023-
Time until which the assets are accessible, in UTC. Formatted as
4024-
a [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
4025-
example: '2020-11-01T00:00:00Z'
4036+
$ref: '#/components/schemas/expires'
4037+
unpublished:
4038+
$ref: '#/components/schemas/unpublished'
40264039
'openeo:status':
40274040
$ref: '#/components/schemas/result_status'
40284041
assets:
@@ -5321,6 +5334,7 @@ components:
53215334
parameters:
53225335
type: array
53235336
nullable: true
5337+
items: {}
53245338
returns:
53255339
type: object
53265340
nullable: true
@@ -5345,6 +5359,7 @@ components:
53455359
parameters:
53465360
type: array
53475361
nullable: true
5362+
items: {}
53485363
returns:
53495364
type: object
53505365
nullable: true
@@ -5604,6 +5619,12 @@ components:
56045619
$ref: '#/components/schemas/created'
56055620
updated:
56065621
$ref: '#/components/schemas/updated'
5622+
queued:
5623+
$ref: '#/components/schemas/queued'
5624+
started:
5625+
$ref: '#/components/schemas/started'
5626+
unpublished:
5627+
$ref: '#/components/schemas/unpublished'
56075628
plan:
56085629
$ref: '#/components/schemas/billing_plan'
56095630
costs:
@@ -5666,16 +5687,49 @@ components:
56665687
type: string
56675688
format: date-time
56685689
description: >-
5669-
Date and time of creation, formatted as a [RFC
5670-
3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
5690+
Date and time of creation (for batch jobs: the status 'created' was set),
5691+
formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
56715692
example: '2017-01-01T09:32:12Z'
56725693
updated:
56735694
type: string
56745695
format: date-time
56755696
description: >-
5676-
Date and time of the last status change, formatted as a [RFC
5677-
3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
5697+
Date and time of the last status change,
5698+
formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
5699+
If the status is `error`, `canceled` or `finished`,
5700+
this is the time when the job has ended.
5701+
example: '2017-01-01T09:54:18Z'
5702+
queued:
5703+
type: string
5704+
format: date-time
5705+
description: >-
5706+
Date and time of queueing the batch job (i.e., when the status 'queued' was set),
5707+
formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
5708+
example: '2017-01-01T09:34:00Z'
5709+
started:
5710+
type: string
5711+
format: date-time
5712+
description: >-
5713+
Date and time when the batch job started processing (i.e., when the status 'running' was set),
5714+
formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
56785715
example: '2017-01-01T09:36:18Z'
5716+
expires:
5717+
type: string
5718+
format: date-time
5719+
description: >-
5720+
Time in UTC until which the assets and this document are accessible via the signed URL
5721+
that is provided with the relation type `canonical` in the links.
5722+
Formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
5723+
After expiration, a document with new signed URLs can be retrieved through an authenticated
5724+
request to this endpoint.
5725+
example: '2017-02-01T09:54:18Z'
5726+
unpublished:
5727+
type: string
5728+
format: date-time
5729+
description: >-
5730+
Time until which the batch job results are stored on the back-end, in UTC.
5731+
Formatted as an [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
5732+
example: '2018-01-01T09:54:18Z'
56795733
description:
56805734
type: string
56815735
format: commonmark

0 commit comments

Comments
 (0)