Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add additional batch job timestamps #556

Open
wants to merge 8 commits into
base: draft
Choose a base branch
from
Open

Add additional batch job timestamps #556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1023a30
Added `queued`, `started` and `expires` to the batch job metadata and…
m-mohr Jan 12, 2025
3286739
Apply suggestions from code review
m-mohr Jan 25, 2025
80cd197
Apply suggestions from code review
m-mohr Jan 25, 2025
5f7ca8e
Update according to review, also add to Collection result type
m-mohr Jan 28, 2025
113b1fc
Merge branch 'draft' into job-timestamps
m-mohr Jan 28, 2025
9fe0267
Apply suggestions from code review
m-mohr Jan 28, 2025
2c3815e
Typo
m-mohr Jan 28, 2025
292a23d
Merge branch 'draft' into job-timestamps
m-mohr Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
76 changes: 65 additions & 11 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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'
Expand All @@ -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:
Expand Down Expand Up @@ -5321,6 +5334,7 @@ components:
parameters:
type: array
nullable: true
items: {}
returns:
type: object
nullable: true
Expand All @@ -5345,6 +5359,7 @@ components:
parameters:
type: array
nullable: true
items: {}
returns:
type: object
nullable: true
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit hesitant about "unpublished". That word could suggest that the results still should be published, or can be recovered/republished. I think this should sound more irrevocable, like "removed", "erased" or "purged"

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
Expand Down