Skip to content

Commit

Permalink
Merge pull request #337 from pvretano/editorial_fixes_3
Browse files Browse the repository at this point in the history
Changes to patch more metanorma warnings.
  • Loading branch information
pvretano committed Jul 19, 2023
2 parents bcee088 + 8550917 commit 145fbc1
Show file tree
Hide file tree
Showing 257 changed files with 419 additions and 441 deletions.
6 changes: 3 additions & 3 deletions 18-062.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
:status: published
:copyright-year: 2018
:external-id: http://www.opengis.net/doc/IS/ogcapi-processes-1/1.0
:received-date: yyyy-mm-dd
:issued-date: yyyy-mm-dd
:published-date: yyyy-mm-dd
:received-date: 2018-01-01
:issued-date: 2018-01-01
:published-date: 2018-01-01
:fullname: Benjamin Pross
:fullname_2: Panagiotis (Peter) A. Vretanos
:keywords: ogcdoc, OGC document, OGC API, Geospatial API, processes, Web Processing Service, WPS, JSON, HTML, geoprocessing, API, OpenAPI, HTML
Expand Down
5 changes: 3 additions & 2 deletions core/abstract_tests/ATS_class_callback.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
[[ats_callback]][conformance_class]
====
[%metadata]
label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback
subject:: <<rc_core,Requirements Class "Core">>
identifier:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback
subject:: <<rc_core,http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback>>
classification:: Target Type:Web API
conformance-test:: /conf/callback/job-callback
====

include::callback/ATS_process-execute-callback.adoc[]
67 changes: 58 additions & 9 deletions core/abstract_tests/ATS_class_core.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,63 @@
[[ats_core]][conformance_class]
[[ats_core]]
[conformance_class]
.Core
====
[%metadata]
label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core
subject:: <<rc_core,Requirements Class "Core">>
identifier:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core
subject:: <<rc_core,http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core>>
classification:: Target Type:Web API
conformance-test:: /conf/core
conformance-test:: /conf/core/api-definition-op
conformance-test:: /conf/core/api-definition-success
conformance-test:: /conf/core/conformance-op
conformance-test:: /conf/core/conformance-success
conformance-test:: /conf/core/http
conformance-test:: /conf/core/job-exception-no-such-job
conformance-test:: /conf/core/job-op
conformance-test:: /conf/core/job-result
conformance-test:: /conf/core/job-results
conformance-test:: /conf/core/job-results-async-many
conformance-test:: /conf/core/job-results-async-one
conformance-test:: /conf/core/job-results-exception-no-such-job
conformance-test:: /conf/core/job-results-exception-results-not-ready
conformance-test:: /conf/core/job-results-failed
conformance-test:: /conf/core/job-results-param-outputs
conformance-test:: /conf/core/job-results-param-outputs-empty
conformance-test:: /conf/core/job-results-param-outputs-omit
conformance-test:: /conf/core/job-results-param-outputs-response
conformance-test:: /conf/core/job-results-success-sync
conformance-test:: /conf/core/job-success
conformance-test:: /conf/core/landingpage-op
conformance-test:: /conf/core/landingpage-success
conformance-test:: /conf/core/pl-limit-definition
conformance-test:: /conf/core/pl-limit-response
conformance-test:: /conf/core/pl-links
conformance-test:: /conf/core/process-description
conformance-test:: /conf/core/process-description-success
conformance-test:: /conf/core/process-exception-no-such-process
conformance-test:: /conf/core/process-execute-auto-execution-mode
conformance-test:: /conf/core/process-execute-default-execution-mode
conformance-test:: /conf/core/process-execute-default-outputs
conformance-test:: /conf/core/process-execute-input-array
conformance-test:: /conf/core/process-execute-input-inline-bbox
conformance-test:: /conf/core/process-execute-input-inline-binary
conformance-test:: /conf/core/process-execute-input-inline-mixed
conformance-test:: /conf/core/process-execute-input-inline-object
conformance-test:: /conf/core/process-execute-inputs
conformance-test:: /conf/core/process-execute-input-validation
conformance-test:: /conf/core/process-execute-op
conformance-test:: /conf/core/process-execute-request
conformance-test:: /conf/core/process-execute-success-async
conformance-test:: /conf/core/process-execute-sync-many-json
conformance-test:: /conf/core/process-execute-sync-one
conformance-test:: /conf/core/process-execute-sync-one-default-content
conformance-test:: /conf/core/process-list
conformance-test:: /conf/core/process-list-success
====

=== Abstract test suite

// include::core/ATS_test-process.adoc[]
include::core/ATS_test-process.adoc[]

=== Retrieve the API landing page

Expand Down Expand Up @@ -50,11 +99,11 @@ include::core/ATS_process-description-op.adoc[]

include::core/ATS_process-description-success.adoc[]

===== Process exception
=== Process exception

include::core/ATS_process-exception-no-such-process.adoc[]

==== Process execution /processes/{processID}/execution
=== Process execution /processes/{processID}/execution

include::core/ATS_process-execute-op.adoc[]

Expand Down Expand Up @@ -90,17 +139,17 @@ include::core/ATS_job-results-success-sync.adoc[]

include::core/ATS_process-execute-success-async.adoc[]

==== Jobs
=== Jobs

===== Job status /jobs/{jobID}
==== Job status /jobs/{jobID}

include::core/ATS_job-op.adoc[]

include::core/ATS_job-success.adoc[]

include::core/ATS_job-exception-no-such-job.adoc[]

=== Retrieve job results
==== Retrieve job results

include::core/ATS_job-result-op.adoc[]

Expand Down
6 changes: 4 additions & 2 deletions core/abstract_tests/ATS_class_dismiss.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
[[ats_dismiss]][conformance_class]
====
[%metadata]
label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss
subject:: <<rc_core,Requirements Class "Core">>
identifier:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss
subject:: <<rc_core,http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss>>
classification:: Target Type:Web API
conformance-test:: /conf/dismiss/job-dismiss-op
conformance-test:: /conf/dismiss/job-dismiss-success
====

include::dismiss/ATS_job-dismiss-op.adoc[]
Expand Down
6 changes: 4 additions & 2 deletions core/abstract_tests/ATS_class_html.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
[[ats_html]][conformance_class]
====
[%metadata]
label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss
subject:: <<rc_core,Requirements Class "Core">>
identifier:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/html
subject:: <<rc_core,http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/html>>
inherit:: <<ats_core,Conformance Class "Core">>
classification:: Target Type:Web API
conformance-test:: /conf/html/content
conformance-test:: /conf/html/definition
====

include::html/ATS_content.adoc[]
Expand Down
20 changes: 18 additions & 2 deletions core/abstract_tests/ATS_class_job-list.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,25 @@
[[ats_job-list]][conformance_class]
====
[%metadata]
label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/job-list
subject:: <<rc_core,Requirements Class "Core">>
identifier:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/job-list
subject:: <<rc_core,http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/job-list>>
classification:: Target Type:Web API
conformance-test:: /conf/job-list/datetime-definition
conformance-test:: /conf/job-list/datetime-response
conformance-test:: /conf/job-list/duration-definition
conformance-test:: /conf/job-list/duration-response
conformance-test:: /conf/job-list/job-list-op
conformance-test:: /conf/job-list/job-list-success
conformance-test:: /conf/job-list/limit-definition
conformance-test:: /conf/job-list/limit-response
conformance-test:: /conf/job-list/links
conformance-test:: /conf/job-list/processID-definition
conformance-test:: /conf/job-list/processID-mandatory
conformance-test:: /conf/job-list/processID-response
conformance-test:: /conf/job-list/status-definition
conformance-test:: /conf/job-list/status-response
conformance-test:: /conf/job-list/type-definition
conformance-test:: /conf/job-list/type-response
====

include::job-list/ATS_op.adoc[]
Expand Down
8 changes: 4 additions & 4 deletions core/abstract_tests/ATS_class_json.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[conformance_class]
[[ats_json]][conformance_class]
====
[%metadata]
label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json
subject:: <<rc_core,Requirements Class "Core">>
identifier:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json
subject:: <<rc_core,http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json>>
classification:: Target Type:Web API
conformance-test:: /conf/json/definition
====

include::json/ATS_definition.adoc[]

10 changes: 8 additions & 2 deletions core/abstract_tests/ATS_class_oas30.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
[[ats_oas30]][conformance_class]
====
[%metadata]
label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30
subject:: <<rc_oas30,Requirements Class "OpenAPI Specification 3.0">>
identifier:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30
subject:: <<rc_oas30,http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30>>
inherit:: <<ats_core,Conformance Class "Core">>
classification:: Target Type:Web API
conformance-test:: /conf/oas30/completeness
conformance-test:: /conf/oas30/exceptions-codes
conformance-test:: /conf/oas30/oas-definition-1
conformance-test:: /conf/oas30/oas-definition-2
conformance-test:: /conf/oas30/oas-impl
conformance-test:: /conf/oas30/security
====

include::oas30/ATS_completeness.adoc[]
Expand Down
11 changes: 9 additions & 2 deletions core/abstract_tests/ATS_class_ogc-process-description.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
[[ats_ogc-process-description]][conformance_class]
====
[%metadata]
label:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description
subject:: <<rc_ogc-process-description,Requirements Class "OGC Process Description">>
identifier:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description
subject:: <<rc_ogc-process-description,http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description>>
classification:: Target Type:Web API
conformance-test:: /conf/ogc-process-description/input-def
conformance-test:: /conf/ogc-process-description/input-mixed-type
conformance-test:: /conf/ogc-process-description/inputs-def
conformance-test:: /conf/ogc-process-description/json-encoding
conformance-test:: /conf/ogc-process-description/output-def
conformance-test:: /conf/ogc-process-description/output-mixed-type
conformance-test:: /conf/ogc-process-description/outputs-def
====

include::ogc-process-description/ATS_json-encoding.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/callback/job-callback
target:: <<req_callback_job-callback,/req/callback/job-callback>>
target:: /req/callback/job-callback
test-purpose:: Validate the passing of a subscriber-URL in an execute request.
test-method::
+
Expand Down
3 changes: 2 additions & 1 deletion core/abstract_tests/core/ATS_api-definition-op.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
====
[%metadata]
identifier:: /conf/core/api-definition-op
target:: <<req_core_api-definition-op,/req/core/api-definition-op>>
target:: /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`.
2. Issue a HTTP GET request on that path
Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/core/ATS_api-definition-success.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/api-definition-success
target:: <<req_core_api-definition-success,/req/core/api-definition-success>>
target:: /req/core/api-definition-success
test-purpose:: Validate that the API Definition complies with the required structure and contents.
test-method::
+
Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/core/ATS_conformance-op.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/conformance-op
target:: <<req_core_conformance-op,/req/core/conformance-op>>
target:: /req/core/conformance-op
test-purpose:: Validate that a Conformance Declaration can be retrieved from the expected location.
test-method::
+
Expand Down
4 changes: 2 additions & 2 deletions core/abstract_tests/core/ATS_conformance-success.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
====
[%metadata]
identifier:: /conf/core/conformance-success
target:: <<req_core_conformance-success,/req/core/conformance-success>>
target:: /req/core/conformance-success
test-purpose:: Validate that the Conformance Declaration response complies with the required structure and contents.
test-method::
+
--
1.Validate that a document was returned with an HTTP status code of 200.
1. Validate that a document was returned with an HTTP status code of 200.
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]
Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/core/ATS_http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/http
target:: <<req_core_http,/req/core/http>>
target:: /req/core/http
test-purpose:: Validate that the resource paths advertised through the API conform with HTTP 1.1 and, where appropriate, TLS.
test-method::
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/job-exception-no-such-job
target:: <<req_core_job-exception-no-such-job,/req/core/job-exception-no-such-job>>
target:: /req/core/job-exception-no-such-job
test-purpose:: Validate that an invalid job identifier is handled correctly.
test-method::
+
Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/core/ATS_job-op.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/job-op
target:: <<req_core_job,/req/core/job>>
target:: /req/core/job-op
test-purpose:: Validate that the status info of a job can be retrieved.
test-method::
+
Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/core/ATS_job-result-op.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/job-result
target:: <<req_core_job-result,/req/core/job-result>>
target:: /req/core/job-result
test-purpose:: Validate that each process output with identifier `{outputID}` can be retrived from the `/jobs/{jobID}/results/{outputID}` endpoint.
test-method::
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/job-results-exception-no-such-job
target:: <<req_core_job-results-exception_no-such-job,/req/core/job-results-exception-no-such-job>>
target:: /req/core/job-results-exception-no-such-job
test-purpose:: Validate that the job results retrieved using an invalid job identifier complies with the require structure and contents.
test-method::
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/job-results-exception-results-not-ready
target:: <<req_core_job-results-exception_results-not-ready,/req/core/job-results-exception-results-not-ready>>
target:: /req/core/job-results-exception-results-not-ready
test-purpose:: Validate that the job results retrieved for an incomplete job complies with the require structure and contents.
test-method::
+
Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/core/ATS_job-results-failed.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/job-results-failed
target:: <<req_core_job-results-failed,/req/core/job-results-failed>>
target:: /req/core/job-results-failed
test-purpose:: Validate that the job results for a failed job complies with the require structure and contents.
test-method::
+
Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/core/ATS_job-results-op.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/job-results
target:: <<req_core_job-results,/req/core/job-results>>
target:: /req/core/job-results
test-purpose:: Validate that the results of a job can be retrieved.
test-method::
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/job-results-param-outputs-empty
target:: <<req_core_job-results-param-outputs-empty,/req/core/job-results-param-outputs-empty>>
target:: /req/core/job-results-param-outputs-empty
test-purpose:: Validate that no processing results are available when the `outputs` parameter is present in an execution request but is empty.
test-method::
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/job-results-param-outputs-omit
target:: <<req_core_job-results-param-outputs-omit,/req/core/job-results-param-outputs-omit>>
target:: /req/core/job-results-param-outputs-omit
test-purpose:: Validate that all processing results are included in the response when the `outputs` parameter is omitted from an execution request.
test-method::
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: /conf/core/job-results-param-outputs-response
target:: <<req_core_job-results-param-outputs-response,/req/core/job-results-param-outputs-response>>
target:: /req/core/job-results-param-outputs-response
test-purpose:: Validate that only the requested processing results are included in the response when the `outputs` parameter is specified on an execution request.
test-method::
+
Expand Down
Loading

0 comments on commit 145fbc1

Please sign in to comment.