diff --git a/core/recommendations/core/REC_job-links.adoc b/core/recommendations/core/REC_job-links.adoc new file mode 100644 index 00000000..033e1080 --- /dev/null +++ b/core/recommendations/core/REC_job-links.adoc @@ -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. +-- + +==== diff --git a/core/requirements/core/REQ_job-success.adoc b/core/requirements/core/REQ_job-success.adoc index 7319ff6d..c152f3f9 100644 --- a/core/requirements/core/REQ_job-success.adoc +++ b/core/requirements/core/REQ_job-success.adoc @@ -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]. +--- ==== diff --git a/core/sections/clause_5_conventions.adoc b/core/sections/clause_5_conventions.adoc index 5a4353e7..a6834c23 100644 --- a/core/sections/clause_5_conventions.adoc +++ b/core/sections/clause_5_conventions.adoc @@ -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. @@ -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. diff --git a/core/sections/clause_7_core.adoc b/core/sections/clause_7_core.adoc index a5eaf264..e5316f6a 100644 --- a/core/sections/clause_7_core.adoc +++ b/core/sections/clause_7_core.adoc @@ -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.