diff --git a/18-062.adoc b/18-062.adoc index 666bc33c..81b22df5 100644 --- a/18-062.adoc +++ b/18-062.adoc @@ -50,6 +50,8 @@ include::core/sections/clause_6_overview.adoc[] include::core/sections/clause_7_core.adoc[] +include::core/sections/clause_7a_validation.adoc[] + include::core/sections/clause_8_ogc-process-description.adoc[] include::core/sections/clause_9_security-considerations.adoc[] diff --git a/core/requirements/requirements_class_validation.adoc b/core/requirements/requirements_class_validation.adoc new file mode 100644 index 00000000..bbc17107 --- /dev/null +++ b/core/requirements/requirements_class_validation.adoc @@ -0,0 +1,12 @@ +[[rc_validation]] +[requirements_class] +==== +[%metadata] +identifier:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/req/validation +obligation:: requirement +subject:: Web API +inherit:: http://www.opengis.net/spec/ogcapi_common-1/1.0/req/core[API - Common Core] +inherit:: <> +inherit:: <> +inherit:: <> +==== diff --git a/core/requirements/validation/REQ_process-validate-op.adoc b/core/requirements/validation/REQ_process-validate-op.adoc new file mode 100644 index 00000000..cc9baf74 --- /dev/null +++ b/core/requirements/validation/REQ_process-validate-op.adoc @@ -0,0 +1,8 @@ +[[req_process-validate_op]] +[requirement] +==== +[%metadata] +identifier:: /req/process-validate/op + +The server SHALL support the HTTP POST operation at the path `/process/{processID}/validate`. +==== diff --git a/core/requirements/validation/REQ_process-validate-request.adoc b/core/requirements/validation/REQ_process-validate-request.adoc new file mode 100644 index 00000000..6843f2ed --- /dev/null +++ b/core/requirements/validation/REQ_process-validate-request.adoc @@ -0,0 +1,9 @@ +[[req_process-validate_request]] +[requirement] +==== +[%metadata] +identifier:: /req/process-validate/request + +The content of a request the request body SHALL be based upon the OpenAPI +3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/execute.yaml[execute.yaml]. +==== diff --git a/core/requirements/validation/REQ_process-validate-success.adoc b/core/requirements/validation/REQ_process-validate-success.adoc new file mode 100644 index 00000000..20cb3e30 --- /dev/null +++ b/core/requirements/validation/REQ_process-validate-success.adoc @@ -0,0 +1,12 @@ +[[req_process-validate_success]] +[requirement] +==== +[%metadata] +identifier:: /req/process-validate/success + +[.component,class=part] +-- +A successful execution of the operation SHALL be reported as a response with a HTTP status code 200. +-- +==== + diff --git a/core/sections/clause_7a_validation.adoc b/core/sections/clause_7a_validation.adoc new file mode 100644 index 00000000..8a786e60 --- /dev/null +++ b/core/sections/clause_7a_validation.adoc @@ -0,0 +1,34 @@ + +[[Validation]] +== Requirements Class "Validation" + +=== Overview + +include::../requirements/requirements_class_validation.adoc[] + +The Validation requirements class specifies how to validate an execution request. This requirements class defines the `/process/{processID}/validation` endpoint which behaves in an analogous manner to the `/processes/{processID}/execution` endpoint. It accepts the same content and headers as the execution endpoint. However, rather than actually executing the specified request and consuming resources on the server, the server simply confirms that it would be able to accept and process the specified execution request as presented. + +NOTE: A successful confirmation does not imply that the execution request would ultimately succeed. It simply means that the request is syntactically and semantically correct and the server would be able to accept and begin executing this request. + +=== Operation + +include::../requirements/validation/REQ_process-validate-op.adoc[] + +include::../requirements/validation/REQ_process-validate-request.adoc[] + +=== Response + +include::../requirements/validation/REQ_process-validate-success.adoc[] + +=== Error situations + +See <> for general guidance. + +If the process with the specified identifier does not exist on the server, the status code of the response SHALL be `404` (see <>). + +If the job with the specified identifier does not exist, the status code of the +response SHALL be `404` (see <>). + + + +