Proposal OGC API - Processs - Part4: Job Management

extensions/job_management/README.md

@@ -0,0 +1,12 @@
+# Standard template
+
+This folder contains the content for the OGC API - Processes - Part 4: Job Management (JM).
+
+This extension provides the ability to create new jobs without starting its execution. Meaning that you can prepare a job and execute it later. This extension also provides ways to track history associated with the execution, starting with the job definition.
+
+The repo is organized as follows:
+
+* standard - the main standard document content
+  - organized in multiple sections and directories (openapi, requirements, etc.)
+* xml - normative XML/XSD components specified by the standard
+* examples - JSON and XML examples

extensions/job_management/examples/json/README.md

@@ -0,0 +1 @@
+Add JSON examples to this directory. If not used, delete the directory.

extensions/job_management/examples/xml/README.md

@@ -0,0 +1 @@
+Add XML examples to this directory. If not used, delete the directory.

extensions/job_management/standard/24-051.adoc

@@ -0,0 +1,56 @@
+= OGC API - Processes - Part 4: Job Management
+:doctype: standard
+:docsubtype: implementation
+:docnumber: 24-051
+:status: draft
+:copyright-year: 2019
+:edition: 1.0
+:language: en
+:published-date: yyyy-mm-dd
+:received-date: yyyy-mm-dd
+:issued-date: yyyy-mm-dd
+:external-id: http://www.opengis.net/doc/IS/ogcapi-processes-4/1.0
+:keywords: process, collection, instance, spatial, data, openapi, transactions, insert, update, delete, add, remove, deploy, undeploy, REST, PUT, POST, DELETE
+:submitting-organizations: Geolabs; Terradue Srl.; Computer Research Institute of Montréal (CRIM).
+:editor: Gérald Fenoy
+:mn-document-class: ogc
+:mn-output-extensions: xml,html,doc,pdf
+
+////
+Make sure to complete each included document
+////
+include::sections/clause_0_front_material.adoc[]
+
+include::sections/clause_1_scope.adoc[]
+
+include::sections/clause_2_conformance.adoc[]
+
+include::sections/clause_3_references.adoc[]
+
+include::sections/clause_4_terms_and_definitions.adoc[]
+
+include::sections/clause_5_conventions.adoc[]
+
+include::sections/clause_6_job_management.adoc[]
+
+include::sections/clause_7_ogcapi-processes.adoc[]
+
+include::sections/clause_8_openeo.adoc[]
+
+include::sections/clause_9_provenance.adoc[]
+
+include::sections/clause_10_oas.adoc[]
+
+include::sections/clause_11_media_types.adoc[]
+
+include::sections/clause_12_security_considerations.adoc[]
+
+include::sections/annex_ats.adoc[]
+
+////
+Revision History should be the last annex before the Bibliography
+Bibliography should be the last annex
+////
+include::sections/annex_history.adoc[]
+
+include::sections/annex_bibliography.adoc[]

extensions/job_management/standard/README.md

@@ -0,0 +1 @@
+This folder contains the text for part 3 of the OGC API Features standard.

extensions/job_management/standard/abstract_tests/ATS_class_jm.adoc

@@ -0,0 +1,14 @@
+[[ats_jm]]
+[conformance_class]
+.Job Management
+====
+[%metadata]
+identifier:: http://www.opengis.net/spec/ogcapi-processes-4/1.0/conf/job-management
+subject:: <<rc_job-management,http://www.opengis.net/spec/ogcapi-processes-4/1.0/conf/job-management>>
+classification:: Target Type:Web API
+conformance-test:: /conf/dru/deploy/post-op
+====
+
+==== Create operation
+
+include::jm/create/ATS_post-op.adoc[]

extensions/job_management/standard/abstract_tests/README.md

@@ -0,0 +1,27 @@
+This folder contains the Abstract Test Suite.
+
+Each file describes a single test. The naming convention for these files is:
+
+"cc/TESTn.adoc" where "cc" corresponds to the identifier for the requirements class and "n" corresponds to the test number. Numbers should have preceeding zeros appropriate for the total number of tests in the conformance class (e.g., the first test could be TEST001 if less than 1000 tests are anticipated).
+
+The test is expressed according to this pattern:
+
+````
+===== Test case title
+
+(( additional discussion, if needed ))
+
+====== a) Test Purpose:
+(( description ))
+
+====== b) Pre-conditions:
+* (( list all preconditions ))
+
+====== c) Test Method:
+* (( steps to execute and assertions to test ))
+
+====== d) References:
+* <<req_cc_req,Requirement /req/cc/req>>
+````
+
+NOTE: for each test, there must be one or more requirements in the "requirements" folder.

extensions/job_management/standard/abstract_tests/cc/TEST001.adoc

@@ -0,0 +1,15 @@
+===== Test case title
+
+(( additional discussion, if needed ))
+
+====== a) Test Purpose:
+(( description ))
+
+====== b) Pre-conditions:
+* (( list all preconditions ))
+
+====== c) Test Method:
+* (( steps to execute and assertions to test ))
+
+====== d) References:
+* <<req_cc_req,Requirement /req/cc/req>>

extensions/job_management/standard/abstract_tests/jm/create/ATS_post-op.adoc

@@ -0,0 +1,19 @@
+[[ats_jm_deploy_post-op]]
+
+[abstract_test]
+====
+[%metadata]
+identifier:: /conf/jm/create/post-op
+target:: <<req_job-management_create_post-op,/req/job-management/create/post-op>>
+test-purpose:: Validate that the server support HTTP POST operation at the path /jobs/
+test-method::
++
+--
+1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/job-list" link on the landing page as well as for the {root}/jobs path.
+
+2. Issue an HTTP POST request for each path.
+
+3. Validate that the response header does not contain `405 Method not allowed`
+--
+====
+

extensions/job_management/standard/figures/README.md

@@ -0,0 +1,5 @@
+Figures go here.
+
+Each figure is a separate file with the naming convention:
+
+"PTm_FIGn.xxx" where "m" is a number with leading zeroes appropriate for the total number of parts, "n" is a number with leading zeroes appropriate for the total number of figures and "xxx" is the appropriate extension for the file type.

extensions/job_management/standard/images/README.md

@@ -0,0 +1,9 @@
+Image files for graphics go here.
+
+Each graphic is a separate file with the naming convention:
+
+"FIGn.xxx" where "n" is a number with leading zeroes appropriate for the total number of figures and "xxx" is the appropriate extension for the file type.
+
+or, for other graphics not associated with figures:
+
+"GRPn.xxx" where "n" is a sequential number with leading zeroes appropriate for the total number of graphics and "xxx" is the appropriate extension for the file type.

extensions/job_management/standard/recommendations/README.md

@@ -0,0 +1,2 @@
+OGC API - Processes - Part 2: Transactions recommendations.
+

extensions/job_management/standard/recommendations/job-management/PER_additional-status-codes.adoc

@@ -0,0 +1,7 @@
+[[per_deploy-replace-undeploy_additional-status-codes]]
+[permission]
+====
+[%metadata]
+label:: /per/core/additional-status-codes
+part:: Servers MAY support other HTTP protocol capabilities. Therefore, the server may return other status codes than those listed in <<status_codes>>.
+====

extensions/job_management/standard/recommendations/job-management/create/PER_body.adoc

@@ -0,0 +1,7 @@
+[[per_job-management_create_body]]
+[permission]
+====
+[%metadata]
+label:: /per/job-management/create/body
+part:: A server MAY support any encoding in the body of a HTTP POST operation.
+====

extensions/job_management/standard/recommendations/job-management/create/PER_content-schema.adoc

@@ -0,0 +1,7 @@
+[[per_job-management_create_content-schema]]
+[permission]
+====
+[%metadata]
+label:: /per/job-management/create/content-schema
+part:: The `Content-Schema` header MAY be an URI to a JSON or OpenAPI 3.0 Schema document that describes the structure of the request body.
+====

extensions/job_management/standard/recommendations/job-management/create/REC_body-ogcapi-processes.adoc

@@ -0,0 +1,8 @@
+[[rec_job-management_create_body-ogcapi-processes]]
+[recommendation]
+====
+[%metadata]
+label:: /rec/job-management/create/body-ogcapi-processes
+
+part:: If the job can be encoded as an <<rc_ogcapi-processes,OGC API - Processes - Workflow Execute Request>>, implementation SHOULD consider supporting the <<rc_ogcapi-processes,OGC API - Processes - Workflow Execute Request>> encoding.
+====

extensions/job_management/standard/recommendations/job-management/create/REC_body-openeo.adoc

@@ -0,0 +1,8 @@
+[[rec_job-management_create_body-openeo]]
+[recommendation]
+====
+[%metadata]
+label:: /rec/job-management/create/body-openeo
+
+part:: If the job can be encoded as an <<rc_openeo,OpenEO graph>>, implementation SHOULD consider supporting the <<rc_openeo,OpenEO graph>> encoding.
+====

extensions/job_management/standard/recommendations/job-management/definition/REC_response-cwl.adoc

@@ -0,0 +1,9 @@
+[[rec_deploy-replace-undeploy_package_response-cwl]]
+[recommendation]
+====
+[%metadata]
+label:: /rec/deploy-replace-undeploy/package/response-cwl
+
+part:: If a process deployed as a <<rc_cwl,CWL>>, implementations SHOULD consider supporting the <<rc_cwl,CWL>> encoding.
+
+====

extensions/job_management/standard/recommendations/job-management/definition/REC_response-ogcapppkg.adoc

@@ -0,0 +1,8 @@
+[[rec_deploy-replace-undeploy_package_response-ogcapppkg]]
+[recommendation]
+====
+[%metadata]
+label:: /rec/deploy-replace-undeploy/package/response-ogcapppkg
+
+part:: If a process was deployed as an <<rc_ogcapppkg,OGC Application Package>>, implementations SHOULD consider supporting the <<rc_ogcapppkg,OGC Application Package>> encoding.
+====

extensions/job_management/standard/recommendations/job-management/update/PER_body.adoc

@@ -0,0 +1,7 @@
+[[per_job-management_update_body]]
+[permission]
+====
+[%metadata]
+label:: /per/job-management/update/body
+part:: A server MAY support any encoding in the body of a HTTP PUT operation.
+====

extensions/job_management/standard/recommendations/job-management/update/PER_content-schema.adoc

@@ -0,0 +1,7 @@
+[[per_job-management_update_content-schema]]
+[permission]
+====
+[%metadata]
+label:: /per/job-management/update/content-schema
+part:: The `Content-Schema` header MAY be used to indicate the schema of a request body for creating a job.
+====

extensions/job_management/standard/recommendations/job-management/update/REC_body-ogcapi-processes.adoc

@@ -0,0 +1,9 @@
+[[rec_job-management_update-ogcapi-processes]]
+[recommendation]
+====
+[%metadata]
+label:: /rec/job-management/update/body-ogcapi-processes
+
+part:: If a job can be created from an <<rc_ogcapi-processes,OGC API - Processes - Workflow Execute Request>>, implementations SHOULD consider supporting the <<rc_ogcapi-processes,OGC API - Processes - Workflow Execute Request>> encoding.
+
+====

extensions/job_management/standard/recommendations/job-management/update/REC_body-openeo.adoc

@@ -0,0 +1,9 @@
+[[rec_job-management_update-openeo]]
+[recommendation]
+====
+[%metadata]
+label:: /rec/job-management/update/body-openeo
+
+part:: If a job can be created from an <<rc_openeo,OpenEO Process Graph>>, implementations SHOULD consider supporting the <<rc_openeo,OpenEO Process Graph>> encoding.
+
+====

extensions/job_management/standard/recommendations/ogcapi-processes/create/PER_content-schema.adoc

@@ -0,0 +1,7 @@
+[[per_ogcapi-processes_create_content-schema]]
+[permission]
+====
+[%metadata]
+label:: /per/ogcapi-processes/create/content-schema
+part:: The `Content-Schema` header MAY be pointing to the OpenAPI 3.0 schema https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-workflows/execute-workflows.yaml[execute-workflows.yaml].
+====

extensions/job_management/standard/recommendations/ogcapi-processes/update/PER_content-schema.adoc

@@ -0,0 +1,7 @@
+[[per_ogcapi-processes_update_content-schema]]
+[permission]
+====
+[%metadata]
+label:: /per/ogcapi-processes/update/content-schema
+part:: The `Content-Schema` header MAY be pointing to the OpenAPI 3.0 schema https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-workflows/execute-workflows.yaml[execute-workflows.yaml].
+====

extensions/job_management/standard/recommendations/openeo/create/PER_content-schema.adoc

@@ -0,0 +1,7 @@
+[[per_openeo_create_content-schema]]
+[permission]
+====
+[%metadata]
+label:: /per/openeo/create/content-schema
+part:: The `Content-Schema` header MAY be pointing to https://raw.githubusercontent.com/Open-EO/openeo-processes/master/meta/subtype-schemas.json#/definitions/process-graph[OpenEO Process Graph schema].
+====

extensions/job_management/standard/recommendations/openeo/update/PER_content-schema.adoc

@@ -0,0 +1,7 @@
+[[per_openeo_update_content-schema]]
+[permission]
+====
+[%metadata]
+label:: /per/openeo/update/content-schema
+part:: The `Content-Schema` header MAY be pointing to https://raw.githubusercontent.com/Open-EO/openeo-processes/master/meta/subtype-schemas.json#/definitions/process-graph[OpenEO Process Graph schema].
+====

extensions/job_management/standard/requirements/job-management/create/REQ_body.adoc

@@ -0,0 +1,7 @@
+[[req_deploy-replace-undeploy_deploy_body]]
+[requirement]
+====
+[%metadata]
+label:: /req/job-management/create/body
+part:: The body of the POST request SHALL be in JSON format.
+====

extensions/job_management/standard/requirements/job-management/create/REQ_content-type.adoc

@@ -0,0 +1,7 @@
+[[req_job-management_create_content-type]]
+[requirement]
+====
+[%metadata]
+label:: /req/job-management/create/content-type
+part:: The `Content-Type` https://tools.ietf.org/html/rfc2616#section-14.17[header] SHALL be used to declare the media type of the request.
+====

extensions/job_management/standard/requirements/job-management/create/REQ_post-op.adoc

@@ -0,0 +1,7 @@
+[[req_job-management_create_post-op]]
+[requirement]
+====
+[%metadata]
+label:: /req/job-management/create/post-op
+part:: The server SHALL support the HTTP POST operation at the path `/jobs`.
+====

extensions/job_management/standard/requirements/job-management/create/REQ_response-body.adoc

@@ -0,0 +1,8 @@
+[[req_job-management_create_response-body]]
+[requirement]
+====
+[%metadata]
+label:: /req/job-management/create/response-body
+part:: The response SHALL include a body that contains a status information of the created job conforms to the https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/statusInfo.yaml[statusInfo.yaml] schema.
+part:: The response SHALL contains a `created` status code and the `jobId` property that contains the job identifier.
+====

extensions/job_management/standard/requirements/job-management/create/REQ_response-jobid.adoc

@@ -0,0 +1,7 @@
+[[req_job-management_create_response-jobid]]
+[requirement]
+====
+[%metadata]
+label:: /req/job-management/create/response-jobid
+part:: If the operation completes, the server SHALL generate a job identifier (i.e. `{jobId}`) for the created job.
+====

extensions/job_management/standard/requirements/job-management/create/REQ_response-success.adoc

@@ -0,0 +1,8 @@
+[[req_job-management_create_response_success]]
+[requirement]
+====
+[%metadata]
+label:: /req/job-management/create/response-success
+part:: A successful execution of the operation SHALL be reported as a response with a HTTP status code `201`.
+part:: A response with HTTP status code `201` SHALL include a `Location` header with the URI of the deployed processes (path: `/jobs/{jobId}`).
+====

extensions/job_management/standard/requirements/job-management/create/REQ_unsupported-media-type.adoc

@@ -0,0 +1,11 @@
+[[req_job-management_create_unsupported-media-type]]
+[requirement]
+====
+[%metadata]
+label:: /req/job-management/create/unsupported-media-type
+
+part:: If the server does not support the Content-Type header associated with the request body, the code of the response SHALL be `415 Unsupported Media Type`.
+part:: The content of that response SHALL be based upon the OpenAPI
+3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/exception.yaml[exception.yaml].
+part:: The `type` of the exception SHALL be “http://www.opengis.net/def/exceptions/ogcapi-processes-4/1.0/unsupported-media-type”.
+====

extensions/job_management/standard/requirements/job-management/definition/REQ_get-op.adoc

@@ -0,0 +1,9 @@
+[[req_job-management_definition_get-op]]
+[requirement]
+====
+[%metadata]
+label:: /req/job-management/definition/get-op
+part:: For every dynamically added process (using method: POST on path: /processes/{processId}), the server SHALL support the HTTP GET operation at the path `/processes/{processId}/package`.
+part:: The parameter `processId` is each `id` property in the process collection response (JSONPath: `$.processes[*].id`).
+
+====

extensions/job_management/standard/requirements/job-management/definition/REQ_response-body.adoc

@@ -0,0 +1,7 @@
+[[req_job-management_definition_response-body]]
+[requirement]
+====
+[%metadata]
+label:: /req/job-management/definition/response-body
+part:: A response with HTTP status code `200` SHALL include a body that contains the request body used to create or update the job.
+====

extensions/job_management/standard/requirements/job-management/definition/REQ_response-success.adoc

@@ -0,0 +1,7 @@
+[[req_job-management_definition_response-success]]
+[requirement]
+====
+[%metadata]
+label:: /req/job-management/definition/response-success
+part:: A successful access to the resource SHALL be reported as a response with a HTTP status code `200`.
+====