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.

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 validation requirements class. #423

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions 18-062.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
12 changes: 12 additions & 0 deletions core/requirements/requirements_class_validation.adoc
Original file line number Diff line number Diff line change
@@ -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:: <<rfc2616,RFC 2616 (HTTP/1.1)>>
inherit:: <<rfc2818,RFC 2818 (HTTP over TLS)>>
inherit:: <<rfc8288,RFC 8288 (Web Linking)>>
====
8 changes: 8 additions & 0 deletions core/requirements/validation/REQ_process-validate-op.adoc
Original file line number Diff line number Diff line change
@@ -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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be /process/{processID}/validation

====
Original file line number Diff line number Diff line change
@@ -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].
====
12 changes: 12 additions & 0 deletions core/requirements/validation/REQ_process-validate-success.adoc
Original file line number Diff line number Diff line change
@@ -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.
--
====

34 changes: 34 additions & 0 deletions core/sections/clause_7a_validation.adoc
Original file line number Diff line number Diff line change
@@ -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 <<http_status_codes>> 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 <<req_core_process-exception-no-such-process,/req/core/process-exception/no-such-process>>).

If the job with the specified identifier does not exist, the status code of the
response SHALL be `404` (see <<req_core_job-exception-no-such-job,/req/core/job-results-exception/no-such-job>>).




Loading