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 link to results in status response. #384

Merged
merged 2 commits into from
Mar 4, 2024
Merged

Add link to results in status response. #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d5af0e
Add link to results in status response.
pvretano Dec 11, 2023
fc665af
Don't use rel="status". Use rel="monitor".
pvretano Mar 4, 2024
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
14 changes: 14 additions & 0 deletions core/recommendations/core/REC_job-links.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[[rec_core_job-links]]
[recommendation,type="general",id="/rec/core/job-links",label="/rec/core/job-links"]
====
[.component,class=part]
--
Servers SHOULD include a link (`rel="monitor"`) pointing to a resource that can be used to monitor the progress of a job.
--

[.component,class=part]
--
Servers SHOULD, when available, include a link (`rel="[ogc-rel:results]"`) pointing to the results generated by the job.
--

====
7 changes: 7 additions & 0 deletions core/requirements/core/REQ_job-success.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,15 @@
[%metadata]
identifier:: /req/core/job-success

[.component,class=part]
---
A successful execution of the operation SHALL be reported as a
response with a HTTP status code 200.
---

[.component,class=part]
---
The content of that response SHALL be based upon the OpenAPI
3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[statusInfo.yaml].
---
====
4 changes: 2 additions & 2 deletions core/sections/clause_5_conventions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ The following https://www.iana.org/assignments/link-relations/link-relations.xht

* **license**: Refers to a license associated with the link's context.

* **monitor**: Identifies a resource that can use used to monitor changes in a resource.

* **service-desc**: Identifies service description for the context that is primarily intended for consumption by machines.

** API definitions are considered service descriptions.
Expand All @@ -31,8 +33,6 @@ The following https://www.iana.org/assignments/link-relations/link-relations.xht

* **self**: Conveys an identifier for the link's context.

* **status**: Identifies a resource that represents the context's status.

* **up**: Refers to a parent document in a hierarchy of documents.

In addition the following link relation types are used for which no applicable registered link relation type could be identified.
Expand Down
2 changes: 2 additions & 0 deletions core/sections/clause_7_core.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1177,6 +1177,8 @@ The job status information includes several optional date-time fields that repre

include::../recommendations/core/REC_job-status.adoc[]

include::../recommendations/core/REC_job-links.adoc[]

NOTE: Once a job has finished execution and is no longer consuming compute resources, the duration of processing can be computed as `finished-started`. The `updated` field, however, may still be revised as the system continues processing outputs, storing results, releasing compute resources, etc.

.A HTTP GET request for retrieving status information about a job encoded as JSON.
Expand Down
Loading