Merge branch 'pvretano-issue-286'

pvretano · Jul 17, 2023 · f564ec7 · f564ec7
2 parents 364dd81 + a341528
commit f564ec7
Show file tree

Hide file tree

Showing 112 changed files with 446 additions and 290 deletions.
diff --git a/core/abstract_tests/ATS_class_callback.adoc b/core/abstract_tests/ATS_class_callback.adoc
@@ -1,10 +1,9 @@
-[[ats_callback]]
-[conformance_class]
+[[ats_callback]][conformance_class]
 ====
 [%metadata]
 label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback
 subject:: <<rc_core,Requirements Class "Core">>
 classification:: Target Type:Web API
 ====
 
-include::callback/ATS_job-creation-callback.adoc[]
+include::callback/ATS_process-execute-callback.adoc[]
diff --git a/core/abstract_tests/ATS_class_core.adoc b/core/abstract_tests/ATS_class_core.adoc
@@ -1,49 +1,46 @@
-[[ats_core]]
-[conformance_class]
+[[ats_core]][conformance_class]
 ====
 [%metadata]
 label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core
 subject:: <<rc_core,Requirements Class "Core">>
 classification:: Target Type:Web API
 ====
 
-==== Landing Page /
+=== Retrieve the API landing page
 
 include::core/ATS_landingpage-op.adoc[]
 
 include::core/ATS_landingpage-success.adoc[]
 
-==== API Definition /api
+=== Retrieve an API definition
 
 include::core/ATS_api-definition-op.adoc[]
 
 include::core/ATS_api-definition-success.adoc[]
 
-==== Conformance Path /conformance
+=== Declaration of conformance classes
 
 include::core/ATS_conformance-op.adoc[]
 
 include::core/ATS_conformance-success.adoc[]
 
-==== HTTP 1.1
+=== Use of HTTP 1.1
 
 include::core/ATS_http.adoc[]
 
-==== Processes /processes
-
-===== Process list
+=== Retrieve a process list
 
 include::core/ATS_process-list-op.adoc[]
 
 include::core/ATS_process-list-limit-def.adoc[]
 
+include::core/ATS_process-list-limit-response.adoc[]
+
 include::core/ATS_process-list-success.adoc[]
 
 include::core/ATS_process-list-links.adoc[]
 
-include::core/ATS_process-list-limit-response.adoc[]
-
-===== Process description /processes/{processID}
+=== Retrieve a process description
 
 include::core/ATS_process-description-op.adoc[]
 
@@ -105,23 +102,23 @@ include::core/ATS_job-success.adoc[]
 
 include::core/ATS_job-exception-no-such-job.adoc[]
 
-===== Job results /jobs/{jobID}/results
+=== Retrieve job results
 
-include::core/ATS_job-results-op.adoc[]
+include::core/ATS_job-result-op.adoc[]
 
-include::core/ATS_job-results-success.adoc[]
+include::core/ATS_job-results-op.adoc[]
 
-include::core/ATS_job-results-success-sync.adoc[]
+include::core/ATS_job-results-param-outputs.adoc[]
 
-include::core/ATS_job-results-success-async-raw-value-one.adoc[]
+include::core/ATS_job-results-param-outputs-response.adoc[]
 
-include::core/ATS_job-results-success-async-raw-value-multi.adoc[]
+include::core/ATS_job-results-param-outputs-omit.adoc[]
 
-include::core/ATS_job-results-success-async-raw-ref.adoc[]
+include::core/ATS_job-results-param-outputs-empty.adoc[]
 
-include::core/ATS_job-results-success-async-raw-mixed-multi.adoc[]
+include::core/ATS_job-results-success-async-one.adoc[]
 
-include::core/ATS_job-results-success-async-document.adoc[]
+include::core/ATS_job-results-success-async-many.adoc[]
 
 include::core/ATS_job-results-exception-no-such-job.adoc[]
 

diff --git a/core/abstract_tests/ATS_class_dismiss.adoc b/core/abstract_tests/ATS_class_dismiss.adoc
@@ -1,5 +1,4 @@
-[[ats_dismiss]]
-[conformance_class]
+[[ats_dismiss]][conformance_class]
 ====
 [%metadata]
 label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss
@@ -10,3 +9,14 @@ classification:: Target Type:Web API
 include::dismiss/ATS_job-dismiss-op.adoc[]
 
 include::dismiss/ATS_job-dismiss-success.adoc[]
+
+NOTE: The response to dismissing a job can be presented 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 against that schema. All supported formats should be exercised.
+
+[[job-dismiss-schema]]
+.Schema and Tests for Dismissing a Job
+[cols="3",options="header"]
+|===
+|Format |Schema Document |Test ID
+|HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/statusInfo.yaml[statusInfo.yaml] |<<ats_html_content,/conf/html/content>>
+|JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/statusInfo.yaml[statusInfo.yaml] |<<ats_json_content,/conf/json/content>>
+|===
diff --git a/core/abstract_tests/ATS_class_html.adoc b/core/abstract_tests/ATS_class_html.adoc
@@ -1,5 +1,4 @@
-[[ats_html]]
-[conformance_class]
+[[ats_html]][conformance_class]
 ====
 [%metadata]
 label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss

diff --git a/core/abstract_tests/ATS_class_job-list.adoc b/core/abstract_tests/ATS_class_job-list.adoc
@@ -1,5 +1,4 @@
-[[ats_job-list]]
-[conformance_class]
+[[ats_job-list]][conformance_class]
 ====
 [%metadata]
 label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/job-list
@@ -11,30 +10,41 @@ include::job-list/ATS_op.adoc[]
 
 include::job-list/ATS_type-def.adoc[]
 
+include::job-list/ATS_type-response.adoc[]
+
+include::job-list/ATS_processid-mandatory.adoc[]
+
 include::job-list/ATS_processid-def.adoc[]
 
-include::job-list/ATS_status-def.adoc[]
+include::job-list/ATS_processid-response.adoc[]
 
-include::job-list/ATS_datetime-def.adoc[]
+include::job-list/ATS_status-def.adoc[]
 
-include::job-list/ATS_duration-def.adoc[]
+include::job-list/ATS_status-response.adoc[]
 
-include::job-list/ATS_jl-limit-def.adoc[]
+include::job-list/ATS_datetime-def.adoc[]
 
-include::job-list/ATS_success.adoc[]
+include::job-list/ATS_datetime-response.adoc[]
 
-include::job-list/ATS_jl-links.adoc[]
+include::job-list/ATS_duration-def.adoc[]
 
-include::job-list/ATS_type-response.adoc[]
+include::job-list/ATS_duration-response.adoc[]
 
-include::job-list/ATS_processid-mandatory.adoc[]
+include::job-list/ATS_jl-limit-def.adoc[]
 
-include::job-list/ATS_processid-response.adoc[]
+include::job-list/ATS_jl-limit-response.adoc[]
 
-include::job-list/ATS_status-response.adoc[]
+include::job-list/ATS_success.adoc[]
 
-include::job-list/ATS_datetime-response.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.
 
-include::job-list/ATS_duration-response.adoc[]
+[[job-list-schema]]
+.Schema and Tests for Job List Content
+[cols="3",options="header"]
+|===
+|Format |Schema Document |Test ID
+|HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/jobList.yaml[jobList.yaml] |<<ats_html_content,/conf/html/content>>
+|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-limit-response.adoc[]
+include::job-list/ATS_jl-links.adoc[]
diff --git a/core/abstract_tests/ATS_class_json.adoc b/core/abstract_tests/ATS_class_json.adoc
@@ -1,4 +1,3 @@
-[[ats_json]]
 [conformance_class]
 ====
 [%metadata]

diff --git a/core/abstract_tests/ATS_class_oas30.adoc b/core/abstract_tests/ATS_class_oas30.adoc
@@ -1,5 +1,4 @@
-[[ats_oas30]]
-[conformance_class]
+[[ats_oas30]][conformance_class]
 ====
 [%metadata]
 label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30

diff --git a/core/abstract_tests/ATS_class_ogc-process-description.adoc b/core/abstract_tests/ATS_class_ogc-process-description.adoc
@@ -1,5 +1,4 @@
-[[ats_ogc-process-description]]
-[conformance_class]
+[[ats_ogc-process-description]][conformance_class]
 ====
 [%metadata]
 label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description

diff --git a/...s/callback/ATS_job-creation-callback.adoc → ...allback/ATS_process-execute-callback.adoc b/...s/callback/ATS_job-creation-callback.adoc → ...allback/ATS_process-execute-callback.adoc
@@ -1,5 +1,4 @@
-[[ats_callback_job-callback]]
-[abstract_test]
+[[ats_callback_job-callback]][abstract_test]
 ====
 [%metadata]
 label:: /conf/callback/job-callback
@@ -28,4 +27,4 @@ Execute the asynchronous job using test <<ats_core_process-execute-op,/conf/core
 Validate the job results are received by the specified callback URL.
 --
 =====
-====
+====
diff --git a/core/abstract_tests/core/ATS_api-definition-op.adoc b/core/abstract_tests/core/ATS_api-definition-op.adoc
@@ -1,5 +1,4 @@
-[[ats_core_api-definition-op]]
-[abstract_test]
+[[ats_core_api-definition-op]][abstract_test]
 ====
 [%metadata]
 label:: /conf/core/api-definition-op
@@ -23,4 +22,4 @@ Issue a HTTP GET request on that path
 Validate the contents of the returned document using test <<ats_core_api-definition-success,/conf/core/api-definition-success>>.
 --
 =====
-====
+====
diff --git a/core/abstract_tests/core/ATS_api-definition-success.adoc b/core/abstract_tests/core/ATS_api-definition-success.adoc
@@ -1,5 +1,4 @@
-[[ats_core_api-definition-success]]
-[abstract_test]
+[[ats_core_api-definition-success]][abstract_test]
 ====
 [%metadata]
 label:: /conf/core/api-definition-success
@@ -18,4 +17,4 @@ Validate that a document was returned with a status code 200
 Validate the API Definition document against an appropriate schema document.
 --
 =====
-====
+====
diff --git a/core/abstract_tests/core/ATS_conformance-op.adoc b/core/abstract_tests/core/ATS_conformance-op.adoc
@@ -1,5 +1,4 @@
-[[ats_core_conformance-op]]
-[abstract_test]
+[[ats_core_conformance-op]][abstract_test]
 ====
 [%metadata]
 label:: /conf/core/conformance-op
@@ -23,4 +22,4 @@ Issue an HTTP GET request on each path
 Validate the contents of the returned document using test <<ats_core_conformance-success,/conf/core/conformance-success>>.
 --
 =====
-====
+====
diff --git a/core/abstract_tests/core/ATS_conformance-success.adoc b/core/abstract_tests/core/ATS_conformance-success.adoc
@@ -1,5 +1,4 @@
-[[ats_core_conformance-success]]
-[abstract_test]
+[[ats_core_conformance-success]][abstract_test]
 ====
 [%metadata]
 label:: /conf/core/conformance-success
@@ -28,4 +27,4 @@ Validate that the document includes the conformance class "http://www.opengis.ne
 Validate that the document list all OGC API conformance classes that the API implements.
 --
 =====
-====
+====
diff --git a/core/abstract_tests/core/ATS_http.adoc b/core/abstract_tests/core/ATS_http.adoc
@@ -1,5 +1,4 @@
-[[ats_core_http]]
-[abstract_test]
+[[ats_core_http]][abstract_test]
 ====
 [%metadata]
 label:: /conf/core/http
@@ -18,4 +17,4 @@ All compliance tests SHALL be configured to use the HTTP 1.1 protocol exclusivel
 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.
 --
 =====
-====
+====
diff --git a/core/abstract_tests/core/ATS_job-exception-no-such-job.adoc b/core/abstract_tests/core/ATS_job-exception-no-such-job.adoc
@@ -1,5 +1,4 @@
-[[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

diff --git a/core/abstract_tests/core/ATS_job-op.adoc b/core/abstract_tests/core/ATS_job-op.adoc
@@ -1,5 +1,4 @@
-[[ats_core_job-op]]
-[abstract_test]
+[[ats_core_job-op]][abstract_test]
 ====
 [%metadata]
 label:: /conf/core/job-op

diff --git a/core/abstract_tests/core/ATS_job-result-op.adoc b/core/abstract_tests/core/ATS_job-result-op.adoc
@@ -0,0 +1,20 @@
+[[ats_core_job-result]][abstract_test]
+====
+[%metadata]
+label:: /conf/core/job-result
+subject:: <<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>>.
+--
+
+[.component,class=step]
+--
+Validate that each process output can be retrived as per requirement <<req_core_job-result,/req/core/job-result>>.
+--
+=====
+====
diff --git a/core/abstract_tests/core/ATS_job-results-exception-no-such-job.adoc b/core/abstract_tests/core/ATS_job-results-exception-no-such-job.adoc
@@ -1,5 +1,4 @@
-[[ats_core_job-results-exception-no-such-job]]
-[abstract_test]
+[[ats_core_job-results-exception-no-such-job]][abstract_test]
 ====
 [%metadata]
 label:: /conf/core/job-results-failed
@@ -31,7 +30,6 @@ Validate the document for all supported media types using the resources and test
 =====
 
 The job results page for a job 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 job results for a non-existent job against that schema.  All supported formats should be exercised.
-====
 
 [[job-results-exception-no-such-job]]
 .Schema and Tests for the Job Result for Non-existent Job
@@ -41,3 +39,5 @@ The job results page for a job may be retrieved in a number of different formats
 |HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/exception.yaml[exception.yaml] |<<ats_html_content,/conf/html/content>>
 |JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/exception.yaml[exception.yaml] |<<ats_json_content,/conf/json/content>>
 |===
+
+====
diff --git a/core/abstract_tests/core/ATS_job-results-exception-results-not-ready.adoc b/core/abstract_tests/core/ATS_job-results-exception-results-not-ready.adoc
@@ -1,5 +1,4 @@
-[[ats_core_job-results-exception-results-not-ready]]
-[abstract_test]
+[[ats_core_job-results-exception-results-not-ready]][abstract_test]
 ====
 [%metadata]
 label:: /conf/core/job-results-exception-results-not-ready
@@ -36,7 +35,6 @@ Validate the document for all supported media types using the resources and test
 =====
 
 The job results page for a job 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 job results for an incomplete job against that schema.  All supported formats should be exercised.
-====
 
 [[job-results-exception-results-not-ready]]
 .Schema and Tests for the Job Result for an Incomplete Job
@@ -46,3 +44,5 @@ The job results page for a job may be retrieved in a number of different formats
 |HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/exception.yaml[exception.yaml] |<<ats_html_content,/conf/html/content>>
 |JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/exception.yaml[exception.yaml] |<<ats_json_content,/conf/json/content>>
 |===
+
+====
diff --git a/core/abstract_tests/core/ATS_job-results-failed.adoc b/core/abstract_tests/core/ATS_job-results-failed.adoc
@@ -1,5 +1,4 @@
-[[ats_core_job-results-failed]]
-[abstract_test]
+[[ats_core_job-results-failed]][abstract_test]
 ====
 [%metadata]
 label:: /conf/core/job-results-failed
@@ -41,7 +40,6 @@ Validate the document for all supported media types using the resources and test
 =====
 
 The job results page for a job 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 job results for a failed job against that schema.  All supported formats should be exercised.
-====
 
 [[job-results-failed-schema]]
 .Schema and Tests for the Job Result for a Failed Job
@@ -50,4 +48,6 @@ The job results page for a job may be retrieved in a number of different formats
 |Format |Schema Document |Test ID
 |HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/exception.yaml[exception.yaml] |<<ats_html_content,/conf/html/content>>
 |JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/exception.yaml[exception.yaml] |<<ats_json_content,/conf/json/content>>
+====
+
 |===