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

Incorporate Carl Reed review comments. #396

Merged
merged 6 commits into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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: 1 addition & 1 deletion core/abstract_tests/ATS_class_dismiss.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ 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.
NOTE: The response to dismissing a job can be presented in one of two 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
Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/ATS_class_job-list.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ include::job-list/ATS_limit-response.adoc[]
include::job-list/ATS_links.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.
NOTE: A job list may be retrieved in one of two 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.

[[job-list-schema]]
.Schema and Tests for Job List Content
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ test-purpose:: Validate the passing of a subscriber-URL in an execute request.
test-method::
+
--
1. Configure a URL endpoint to accept message body from the server.
1. Configure a URL endpoint to accept a message body from the server.

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].

Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/core/ATS_api-definition-op.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ test-method::
--
1. Construct a path for the API Definition document that ends with `/api`.

2. Issue a HTTP GET request on that path
2. Issue a HTTP GET request on that path.

3. Validate the contents of the returned document using test <<ats_core_api-definition-success,/conf/core/api-definition-success>>.
--
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 @@ -9,7 +9,7 @@ test-purpose:: Validate that the API Definition complies with the required struc
test-method::
+
--
1. Validate that a document was returned with a status code 200
1. Validate that a document was returned with a status code 200.

2. Validate the API Definition document against an appropriate schema document.
--
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 @@ -11,7 +11,7 @@ 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.

2. Issue an HTTP GET request on each path
2. Issue an HTTP GET request on each path.

3. Validate the contents of the returned document using test <<ats_core_conformance-success,/conf/core/conformance-success>>.
--
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 @@ -11,9 +11,9 @@ test-method::
--
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]
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].

3. 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".

4. Validate that the document list all OGC API conformance classes that the API implements.
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ test-method::
--
====

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.
NOTE: An exception response caused by using an invalid job identifier may be retrieved in one of two 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ test-method::
--
====

NOTE: 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.
NOTE: The job results page for a job may be retrieved in one of two 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ test-purpose:: Validate that the job results retrieved for an incomplete job com
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; ensure that the job is long-running.
1. Create a job as per <<ats_core_process-execute-op,/req/core/process-execute-op>> and note the {jobID} assigned to the job. Ensure that the job is long-running.

2. Issue an HTTP GET request to the URL '/jobs/{jobID}/results' before the job completes execution.

Expand All @@ -21,7 +21,7 @@ test-method::
--
====

NOTE: 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.
NOTE: The job results page for a job may be retrieved in one of two 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
Expand Down
6 changes: 3 additions & 3 deletions core/abstract_tests/core/ATS_job-results-failed.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ test-purpose:: Validate that the job results for a failed job complies with the
test-method::
+
--
1. Create a job as per <<ats_core_process-execute-op,/req/core/process-execute-op>> but arrange a priori that the job will fail; note the {jobID} assigned to the job.
1. Create a job as per <<ats_core_process-execute-op,/req/core/process-execute-op>> but arrange a priori that the job will fail. Note the {jobID} assigned to the job.

2. Ensure that the failed job will not result in an HTTP error code of 404.
2. Ensure that the failed job will not result in an HTTP 404 error code.

3. Issue an HTTP GET request to the URL '/jobs/{jobID}/results'.

Expand All @@ -23,7 +23,7 @@ test-method::
--
====

NOTE: 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.
NOTE: The job results page for a job may be retrieved in one of two 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
Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/core/ATS_job-success.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ test-method::
--
====

NOTE: The status info 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 status info against that schema. All supported formats should be exercised.
NOTE: The status info page for a job may be retrieved in a one of two formats. The following table identifies the applicable schema document for each format and the test to be used to validate the status info against that schema. All supported formats should be exercised.

[[job-status-info-schema]]
.Schema and Tests for the Job Status Info
Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/core/ATS_landingpage-success.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ test-method::

====

NOTE: The landing page 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 landing page against that schema. All supported formats should be exercised.
NOTE: The landing page may be retrieved in one of two formats. The following table identifies the applicable schema document for each format and the test to be used to validate the landing page against that schema. All supported formats should be exercised.

[[landing-page-schema]]
.Schema and Tests for Landing Pages
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ test-method::
--
====

NOTE: The interface of a process may be describing using a number of different models or process description languages. The following table identifies the applicable schema document for each process description model described in this standard.
NOTE: The interface of a process may be described using one of a number of different models or process description languages. The following table identifies the applicable schema document for each process description model described in this standard.

[[process-description-model]]
.Schema and Tests for Process Description Models
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ test-method::
--
====

NOTE: An exception response caused by the use of an invalid process 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 using an invalid process identifier may be retrieved in one of two 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.

[[no-such-process]]
.Schema and Tests for Non-existent Process
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ test-method::
--
1. Get a description of each process offered by the server using test <<ats_core_process-description,/conf/core/process-description>>.

2. Inspect the description of each process and identify the list of processes that have inputs with a maximum cardinality greater that one.
2. Inspect the description of each process and identify the list of processes that have inputs with a maximum cardinality greater than one.

3. For each identified process construct an execute request according to test <<ats_core_process-execute-request,/conf/core/process-execute-request>> taking care to encode the inputs with maximum cardinality > 1 according to the requirement <<req_core_process-execute-input-array,/req/core/process-execute-input-array>>.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ test-method::

3. For each identified process construct an execute request according to test <<ats_core_process-execute-request,/conf/core/process-execute-request>> taking care to encode values for the identified bounding box inputs in-line in the execute request.

4. Verify that each process execute successfulle according to the relevant requirement (one of: <<ats_core_process-execute-success-async,/req/core/process-execute-success-async>>, <<ats_core_process-execute-sync-many-json,/req/core/process-execute-sync-many-json>>, <<ats_core_process-execute-sync-one,/req/core/process-execute-sync-one>>, <<ats_core_process-execute-sync-one-default-content,/req/core/process-execute-sync-one-default-content>>) based on the combination of execute parameters.
4. Verify that each process executes successfully according to the relevant requirement (one of: <<ats_core_process-execute-success-async,/req/core/process-execute-success-async>>, <<ats_core_process-execute-sync-many-json,/req/core/process-execute-sync-many-json>>, <<ats_core_process-execute-sync-one,/req/core/process-execute-sync-one>>, <<ats_core_process-execute-sync-one-default-content,/req/core/process-execute-sync-one-default-content>>) based on the combination of execute parameters.
--
====
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ test-method::

3. For each identified process construct an execute request according to test <<ats_core_process-execute-request,/conf/core/process-execute-request>> taking care to encode binary input values in-line in the execute request according to requirement <<req_core_process-execute-input-inline-binary,/req/core/process-execute-input-inline-binary>>.

4. Verify that each process execute successfully according to the relevant requirement (one of: <<ats_core_process-execute-success-async,/req/core/process-execute-success-async>>, <<ats_core_process-execute-sync-many-json,/req/core/process-execute-sync-many-json>>, <<ats_core_process-execute-sync-one,/req/core/process-execute-sync-one>>, <<ats_core_process-execute-sync-one-default-content,/req/core/process-execute-sync-one-default-content>>) base on the combination of execute parameters.
4. Verify that each process executes successfully according to the relevant requirement (one of: <<ats_core_process-execute-success-async,/req/core/process-execute-success-async>>, <<ats_core_process-execute-sync-many-json,/req/core/process-execute-sync-many-json>>, <<ats_core_process-execute-sync-one,/req/core/process-execute-sync-one>>, <<ats_core_process-execute-sync-one-default-content,/req/core/process-execute-sync-one-default-content>>) base on the combination of execute parameters.
--
====
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ test-method::

3. For each identified process construct an execute request according to test <<ats_core_process-execute-request,/conf/core/process-execute-request>> taking care to encode the identified mix-content inputs in-line in the execute request according to requirement <<req_core_process-execute-input-inline-mixed,/req/core/process-execute-input-inline-mixed>>.

4. Verify that each process execute successfully according to the relevant requirement (one of: <<ats_core_process-execute-success-async,/req/core/process-execute-success-async>>, <<ats_core_process-execute-sync-many-json,/req/core/process-execute-sync-many-json>>, <<ats_core_process-execute-sync-one,/req/core/process-execute-sync-one>>, <<ats_core_process-execute-sync-one-default-content,/req/core/process-execute-sync-one-default-content>>) base on the combination of execute parameters.
4. Verify that each process executes successfully according to the relevant requirement (one of: <<ats_core_process-execute-success-async,/req/core/process-execute-success-async>>, <<ats_core_process-execute-sync-many-json,/req/core/process-execute-sync-many-json>>, <<ats_core_process-execute-sync-one,/req/core/process-execute-sync-one>>, <<ats_core_process-execute-sync-one-default-content,/req/core/process-execute-sync-one-default-content>>) base on the combination of execute parameters.
--
====
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ test-method::

3. For each identified process construct an execute request according to test <<ats_core_process-execute-request,/conf/core/process-execute-request>> taking care to encode the identified object inputs in-line in the execute request according to requirement <<req_core_process-execute-input-inline-object,/req/core/process-execute-input-inline-object>>.

4. Verify that each process execute successfulle according to the relevant requirement (one of: <<ats_core_process-execute-success-async,/req/core/process-execute-success-async>>, <<ats_core_process-execute-sync-many-json,/req/core/process-execute-sync-many-json>>, <<ats_core_process-execute-sync-one,/req/core/process-execute-sync-one>>, <<ats_core_process-execute-sync-one-default-content,/req/core/process-execute-sync-one-default-content>>) based on the combination of execute parameters.
4. Verify that each process executes successfully according to the relevant requirement (one of: <<ats_core_process-execute-success-async,/req/core/process-execute-success-async>>, <<ats_core_process-execute-sync-many-json,/req/core/process-execute-sync-many-json>>, <<ats_core_process-execute-sync-one,/req/core/process-execute-sync-one>>, <<ats_core_process-execute-sync-one-default-content,/req/core/process-execute-sync-one-default-content>>) based on the combination of execute parameters.
--
====
2 changes: 1 addition & 1 deletion core/abstract_tests/core/ATS_process-list-limit-def.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Verify that the `limit` query parameter complies with its definition in requirem
--
====

NOTE: The API can define different values for "minimum", "maximum" and "default".
NOTE: An implementation of the Processes API can define different values for "minimum", "maximum" and "default".
2 changes: 1 addition & 1 deletion core/abstract_tests/core/ATS_process-list-success.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ test-method::
--
====

NOTE: The process 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.
NOTE: The process list may be retrieved in one of two 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.

[[process-list-schema]]
.Schema and Tests for Lists content
Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/html/ATS_content.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ test-purpose:: Verify the content of an HTML document given an input document an
test-method::
+
--
. Validate that the document is an <<w3c-html5>> document
. Validate that the document is an <<w3c-html5>> document.

. Manually inspect the document and verify that the HTML body contains:

Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/html/ATS_definition.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ test-purpose:: Verify support for HTML
test-method::
+
--
Verify that every `200` response of every operation of the API where HTML was requested is of media type `text/html`.
Verify that every `200` response for every operation of the Processes API implementation for which HTML was requested is of media type `text/html`.
--
====
2 changes: 1 addition & 1 deletion core/abstract_tests/job-list/ATS_limit-def.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Verify that the `limit` query parameter complies with its definition in requirem
--
====

NOTE: The API can define different values for "minimum", "maximum" and "default".
NOTE: An implementation of the Processes API can define different values for "minimum", "maximum" and "default".
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ test-method::
--
1. Retrieve a description of each process according to test <<ats_core_process-description,/conf/core/process-description>>.

2. For each process identify if the process has one or more output of mixed type denoted by the use of the `oneOf` JSON Schema keyword.
2. For each process identify if the process has one or more output of mixed type denoted by using the `oneOf` JSON Schema keyword.

3. For each sub-schema or each identified output, verify that the definition validates according to the JSON Schema: https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/schema.yaml[schema.yaml].
--
Expand Down
5 changes: 2 additions & 3 deletions core/recommendations/core/PER_api-definition-uri.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@
[%metadata]
label:: /per/core/api-definition-uri

The API definition is metadata about the API and strictly not part of the API
itself, but it MAY be hosted as a sub-resource to the base path of the API, for example, at path `/api`. There is no need to include the path of the API definition in the API definition itself.
====
The API definition is metadata about the capabilities provided by an API implementation instance and strictly speaking is not part of the API itself, but the definition MAY be hosted as a sub-resource to the base path of the API, for example, at path `/api`. There is no need to include the path of the API definition in the API definition itself.
====
Loading
Loading