Skip to content

Commit

Permalink
Merge pull request #384 from pvretano/issue-377
Browse files Browse the repository at this point in the history
Add link to results in status response.
  • Loading branch information
pvretano authored Mar 4, 2024
2 parents f046c04 + fc665af commit c04b2e2
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 2 deletions.
14 changes: 14 additions & 0 deletions core/recommendations/core/REC_job-links.adoc
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
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
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,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 @@ -40,8 +42,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
Original file line number Diff line number Diff line change
Expand Up @@ -1160,6 +1160,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

0 comments on commit c04b2e2

Please sign in to comment.