-
Notifications
You must be signed in to change notification settings - Fork 46
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
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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)>> | ||
==== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`. | ||
==== |
9 changes: 9 additions & 0 deletions
9
core/requirements/validation/REQ_process-validate-request.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
12
core/requirements/validation/REQ_process-validate-success.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
-- | ||
==== | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>>). | ||
|
||
|
||
|
||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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