Skip to content

Commit

Permalink
Editorial changes to fix metanorma errors.
Browse files Browse the repository at this point in the history
  • Loading branch information
pvretano committed Jul 18, 2023
1 parent 4e0a92a commit b7018b4
Show file tree
Hide file tree
Showing 83 changed files with 755 additions and 1,305 deletions.
9 changes: 5 additions & 4 deletions core/abstract_tests/ATS_class_job-list.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,12 @@ include::job-list/ATS_duration-def.adoc[]

include::job-list/ATS_duration-response.adoc[]

include::job-list/ATS_jl-limit-def.adoc[]
include::job-list/ATS_limit-def.adoc[]

include::job-list/ATS_jl-limit-response.adoc[]
include::job-list/ATS_limit-response.adoc[]

include::job-list/ATS_links.adoc[]

include::job-list/ATS_success.adoc[]

NOTE: A job list may be retrieved in a number of different formats. The following table identifies the applicable schema document for each format and the test to be used to validate the against that schema. All supported formats should be exercised.

Expand All @@ -47,4 +48,4 @@ NOTE: A job list may be retrieved in a number of different formats. The followin
|JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/jobList.yaml[jobList.yaml] |<<ats_json_content,/conf/json/content>>
|===

include::job-list/ATS_jl-links.adoc[]
include::job-list/ATS_success.adoc[]
32 changes: 11 additions & 21 deletions core/abstract_tests/callback/ATS_process-execute-callback.adoc
Original file line number Diff line number Diff line change
@@ -1,30 +1,20 @@
[[ats_callback_job-callback]][abstract_test]
[[ats_callback_job-callback]]

[abstract_test]
====
[%metadata]
label:: /conf/callback/job-callback
subject:: <<req_callback_job-callback,/req/callback/job-callback>>
identifier:: /conf/callback/job-callback
target:: <<req_callback_job-callback,/req/callback/job-callback>>
test-purpose:: Validate the passing of a subscriber-URL in an execute request.
[.component,class=test method]
=====
[.component,class=step]
--
Configure a URL endpoint to accept message body from the server.
test-method::
+
--
1. Configure a URL endpoint to accept message body from the server.
[.component,class=step]
--
Create an asynchronous execute request that includes the optional `subscriber` key (see https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/execute.yaml[execute.yaml].
--
2. Create an asynchronous execute request that includes the optional `subscriber` key (see https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/execute.yaml[execute.yaml].
[.component,class=step]
--
Execute the asynchronous job using test <<ats_core_process-execute-op,/conf/core/process-execute-request>>.
--
3. Execute the asynchronous job using test <<ats_core_process-execute-op,/conf/core/process-execute-request>>.
[.component,class=step]
--
Validate the job results are received by the specified callback URL.
4. Validate the job results are received by the specified callback URL.
--
=====
====
28 changes: 10 additions & 18 deletions core/abstract_tests/core/ATS_api-definition-op.adoc
Original file line number Diff line number Diff line change
@@ -1,25 +1,17 @@
[[ats_core_api-definition-op]][abstract_test]
[[ats_core_api-definition-op]]

[abstract_test]
====
[%metadata]
label:: /conf/core/api-definition-op
subject:: <<req_core_api-definition-op,/req/core/api-definition-op>>
identifier:: /conf/core/api-definition-op
target:: <<req_core_api-definition-op,/req/core/api-definition-op>>
test-purpose:: Validate that the API Definition document can be retrieved from the expected location.
test-method::
+
1. Construct a path for the API Definition document that ends with `/api`.
[.component,class=test method]
=====
[.component,class=step]
--
Construct a path for the API Definition document that ends with `/api`.
--
2. Issue a HTTP GET request on that path
[.component,class=step]
--
Issue a HTTP GET request on that path
--

[.component,class=step]
--
Validate the contents of the returned document using test <<ats_core_api-definition-success,/conf/core/api-definition-success>>.
3. Validate the contents of the returned document using test <<ats_core_api-definition-success,/conf/core/api-definition-success>>.
--
=====
====
22 changes: 9 additions & 13 deletions core/abstract_tests/core/ATS_api-definition-success.adoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
[[ats_core_api-definition-success]][abstract_test]
[[ats_core_api-definition-success]]

[abstract_test]
====
[%metadata]
label:: /conf/core/api-definition-success
subject:: <<req_core_api-definition-success,/req/core/api-definition-success>>
identifier:: /conf/core/api-definition-success
target:: <<req_core_api-definition-success,/req/core/api-definition-success>>
test-purpose:: Validate that the API Definition complies with the required structure and contents.
[.component,class=test method]
=====
[.component,class=step]
--
Validate that a document was returned with a status code 200
test-method::
+
--
1. Validate that a document was returned with a status code 200
[.component,class=step]
--
Validate the API Definition document against an appropriate schema document.
2. Validate the API Definition document against an appropriate schema document.
--
=====
====
27 changes: 10 additions & 17 deletions core/abstract_tests/core/ATS_conformance-op.adoc
Original file line number Diff line number Diff line change
@@ -1,25 +1,18 @@
[[ats_core_conformance-op]][abstract_test]
[[ats_core_conformance-op]]

[abstract_test]
====
[%metadata]
label:: /conf/core/conformance-op
subject:: <<req_core_conformance-op,/req/core/conformance-op>>
identifier:: /conf/core/conformance-op
target:: <<req_core_conformance-op,/req/core/conformance-op>>
test-purpose:: Validate that a Conformance Declaration can be retrieved from the expected location.
[.component,class=test method]
=====
[.component,class=step]
--
Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/conformance" link on the landing page as well as for the {root}/conformance path.
test-method::
+
--
1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/conformance" link on the landing page as well as for the {root}/conformance path.
[.component,class=step]
--
Issue an HTTP GET request on each path
--
2. Issue an HTTP GET request on each path
[.component,class=step]
--
Validate the contents of the returned document using test <<ats_core_conformance-success,/conf/core/conformance-success>>.
3. Validate the contents of the returned document using test <<ats_core_conformance-success,/conf/core/conformance-success>>.
--
=====
====
32 changes: 11 additions & 21 deletions core/abstract_tests/core/ATS_conformance-success.adoc
Original file line number Diff line number Diff line change
@@ -1,30 +1,20 @@
[[ats_core_conformance-success]][abstract_test]
[[ats_core_conformance-success]]

[abstract_test]
====
[%metadata]
label:: /conf/core/conformance-success
subject:: <<req_core_conformance-success,/req/core/conformance-success>>
identifier:: /conf/core/conformance-success
target:: <<req_core_conformance-success,/req/core/conformance-success>>
test-purpose:: Validate that the Conformance Declaration response complies with the required structure and contents.
[.component,class=test method]
=====
[.component,class=step]
--
Validate that a document was returned with an HTTP status code of 200.
test-method::
+
--
1.Validate that a document was returned with an HTTP status code of 200.
[.component,class=step]
--
Validate the response document against OpenAPI 3.0 schema link: http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/confClasses.yaml[confClasses.yaml]
--
2. Validate the response document against OpenAPI 3.0 schema link: http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/confClasses.yaml[confClasses.yaml]
[.component,class=step]
--
Validate that the document includes the conformance class "http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core"
--
3. Validate that the document includes the conformance class "http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core"
[.component,class=step]
--
Validate that the document list all OGC API conformance classes that the API implements.
4. Validate that the document list all OGC API conformance classes that the API implements.
--
=====
====
21 changes: 8 additions & 13 deletions core/abstract_tests/core/ATS_http.adoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,15 @@
[[ats_core_http]][abstract_test]
[[ats_core_http]]
[abstract_test]
====
[%metadata]
label:: /conf/core/http
subject:: <<req_core_http,/req/core/http>>
identifier:: /conf/core/http
target:: <<req_core_http,/req/core/http>>
test-purpose:: Validate that the resource paths advertised through the API conform with HTTP 1.1 and, where appropriate, TLS.
[.component,class=test method]
=====
[.component,class=step]
--
All compliance tests SHALL be configured to use the HTTP 1.1 protocol exclusively.
test-method::
+
--
1. All compliance tests SHALL be configured to use the HTTP 1.1 protocol exclusively.
[.component,class=step]
--
For APIs which support HTTPS, all compliance tests SHALL be configured to use <<rfc2818,HTTP over TLS>> (RFC 2818) with their HTTP 1.1 protocol.
2. For APIs which support HTTPS, all compliance tests SHALL be configured to use <<rfc2818,HTTP over TLS>> (RFC 2818) with their HTTP 1.1 protocol.
--
=====
====
35 changes: 13 additions & 22 deletions core/abstract_tests/core/ATS_job-exception-no-such-job.adoc
Original file line number Diff line number Diff line change
@@ -1,35 +1,26 @@
[[ats_core_job-exception-no-such-job]][abstract_test]
[[ats_core_job-exception-no-such-job]]

[abstract_test]
====
[%metadata]
label:: /conf/core/job-exception-no-such-job
subject:: <<req_core_job-exception-no-such-job,/req/core/job-exception-no-such-job>>
identifier:: /conf/core/job-exception-no-such-job
target:: <<req_core_job-exception-no-such-job,/req/core/job-exception-no-such-job>>
test-purpose:: Validate that an invalid job identifier is handled correctly.
[.component,class=test method]
=====
[.component,class=step]
--
Issue an HTTP GET request to the URL that includes the `{jobID}` as a path element using a non-existent job identifier.
test-method::
+
--
1. Issue an HTTP GET request to the URL that includes the `{jobID}` as a path element using a non-existent job identifier.
[.component,class=step]
--
Validate that the document was returned with a 404.
--
2. Validate that the document was returned with a 404.
[.component,class=step]
--
Validate that the document contains the exception type "http://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/no-such-job".
--
3. Validate that the document contains the exception type "http://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/no-such-job".
[.component,class=step]
4. Validate the document for all supported media types using the resources and tests identified in <<job-exception-no-such-job>>
--
Validate the document for all supported media types using the resources and tests identified in <<job-exception-no-such-job>>
--
=====
An exception response caused by the use of an invalid job identifier may be retrieved in a number of different formats. The following table identifies the applicable schema document for each format and the test to be used to validate the response. All supported formats should be exercised.
====

NOTE: An exception response caused by the use of an invalid job identifier may be retrieved in a number of different formats. The following table identifies the applicable schema document for each format and the test to be used to validate the response. All supported formats should be exercised.

[[job-exception-no-such-job]]
.Schema and Tests for the Job Result for Non-existent Job
[cols="3",options="header"]
Expand Down
27 changes: 10 additions & 17 deletions core/abstract_tests/core/ATS_job-op.adoc
Original file line number Diff line number Diff line change
@@ -1,25 +1,18 @@
[[ats_core_job-op]][abstract_test]
[[ats_core_job-op]]

[abstract_test]
====
[%metadata]
label:: /conf/core/job-op
subject:: <<req_core_job,/req/core/job>>
identifier:: /conf/core/job-op
target:: <<req_core_job,/req/core/job>>
test-purpose:: Validate that the status info of a job can be retrieved.
[.component,class=test method]
=====
[.component,class=step]
--
Create a job as per <<ats_core_process-execute-op,/req/core/process-execute-op>> and note the {jobID} assigned to the job.
test-method::
+
--
1. Create a job as per <<ats_core_process-execute-op,/req/core/process-execute-op>> and note the {jobID} assigned to the job.
[.component,class=step]
--
Issue an HTTP GET request to the URL '/jobs/{jobID}'.
--
2. Issue an HTTP GET request to the URL '/jobs/{jobID}'.
[.component,class=step]
--
Validate the contents of the returned document using the test <<ats_core_job-success,/conf/core/job-success>>.
3. Validate the contents of the returned document using the test <<ats_core_job-success,/conf/core/job-success>>.
--
=====
====
22 changes: 9 additions & 13 deletions core/abstract_tests/core/ATS_job-result-op.adoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
[[ats_core_job-result]][abstract_test]
[[ats_core_job-result]]

[abstract_test]
====
[%metadata]
label:: /conf/core/job-result
subject:: <<req_core_job-result,/req/core/job-result>>
identifier:: /conf/core/job-result
target:: <<req_core_job-result,/req/core/job-result>>
test-purpose:: Validate that each process output with identifier `{outputID}` can be retrived from the `/jobs/{jobID}/results/{outputID}` endpoint.
[.component,class=test method]
=====
[.component,class=step]
--
Negotiate asynchronous process execution as per test <<ats_core_process-execute-auto-execution-mode,/req/core/process-execute-op>>.
test-method::
+
--
1. Negotiate asynchronous process execution as per test <<ats_core_process-execute-auto-execution-mode,/req/core/process-execute-op>>.
[.component,class=step]
--
Validate that each process output can be retrived as per requirement <<req_core_job-result,/req/core/job-result>>.
2. Validate that each process output can be retrived as per requirement <<req_core_job-result,/req/core/job-result>>.
--
=====
====
Loading

0 comments on commit b7018b4

Please sign in to comment.