diff --git a/core/abstract_tests/ATS_class_callback.adoc b/core/abstract_tests/ATS_class_callback.adoc index 7565f3a3..9cc64f0f 100644 --- a/core/abstract_tests/ATS_class_callback.adoc +++ b/core/abstract_tests/ATS_class_callback.adoc @@ -3,8 +3,8 @@ .Callback ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/callback -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/callback +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/callback/job-callback ==== diff --git a/core/abstract_tests/ATS_class_collection-input.adoc b/core/abstract_tests/ATS_class_collection-input.adoc index 69883e03..29e83f56 100644 --- a/core/abstract_tests/ATS_class_collection-input.adoc +++ b/core/abstract_tests/ATS_class_collection-input.adoc @@ -3,8 +3,8 @@ .Collection Input ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/collection-input -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/collection-input +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/collection-input/referencing conformance-test:: /conf/collection-input/collection-access diff --git a/core/abstract_tests/ATS_class_collection-output.adoc b/core/abstract_tests/ATS_class_collection-output.adoc index da192e07..497d0939 100644 --- a/core/abstract_tests/ATS_class_collection-output.adoc +++ b/core/abstract_tests/ATS_class_collection-output.adoc @@ -3,8 +3,8 @@ .Collection Output ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/collection-output -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/collection-output +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/collection-output/response-definition conformance-test:: /conf/collection-output/response-response-many diff --git a/core/abstract_tests/ATS_class_core.adoc b/core/abstract_tests/ATS_class_core.adoc index cbeb5e44..7ff28037 100644 --- a/core/abstract_tests/ATS_class_core.adoc +++ b/core/abstract_tests/ATS_class_core.adoc @@ -3,8 +3,8 @@ .Core ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/core -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/core +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/core/test-process conformance-test:: /conf/core/landingpage-op diff --git a/core/abstract_tests/ATS_class_dismiss.adoc b/core/abstract_tests/ATS_class_dismiss.adoc index b652fb5a..d86fe158 100644 --- a/core/abstract_tests/ATS_class_dismiss.adoc +++ b/core/abstract_tests/ATS_class_dismiss.adoc @@ -3,8 +3,8 @@ .Dismiss ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/dismiss -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/dismiss +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/dismiss/job-dismiss-op conformance-test:: /conf/dismiss/job-dismiss-success @@ -21,6 +21,6 @@ NOTE: The response to dismissing a job can be presented in one of two formats. T [cols="3",options="header"] |=== |Format |Schema Document |Test ID -|HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/statusInfo.yaml[statusInfo.yaml] |<> -|JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/statusInfo.yaml[statusInfo.yaml] |<> +|HTML |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/statusInfo.yaml[statusInfo.yaml] |<> +|JSON |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/statusInfo.yaml[statusInfo.yaml] |<> |=== diff --git a/core/abstract_tests/ATS_class_html.adoc b/core/abstract_tests/ATS_class_html.adoc index e173a8dd..93730132 100644 --- a/core/abstract_tests/ATS_class_html.adoc +++ b/core/abstract_tests/ATS_class_html.adoc @@ -3,8 +3,8 @@ .HTML ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/html -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/html +subject:: <> inherit:: <> classification:: Target Type:Web API conformance-test:: /conf/html/content diff --git a/core/abstract_tests/ATS_class_job-list.adoc b/core/abstract_tests/ATS_class_job-list.adoc index 5b777e08..10a11021 100644 --- a/core/abstract_tests/ATS_class_job-list.adoc +++ b/core/abstract_tests/ATS_class_job-list.adoc @@ -3,8 +3,8 @@ .Job List ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/job-list -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/job-list +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/job-list/job-list-op conformance-test:: /conf/job-list/type-definition @@ -60,8 +60,8 @@ NOTE: A job list may be retrieved in one of two formats. The following table ide [cols="3",options="header"] |=== |Format |Schema Document |Test ID -|HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/jobList.yaml[jobList.yaml] |<> -|JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/jobList.yaml[jobList.yaml] |<> +|HTML |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/jobList.yaml[jobList.yaml] |<> +|JSON |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/jobList.yaml[jobList.yaml] |<> |=== include::job-list/ATS_success.adoc[] diff --git a/core/abstract_tests/ATS_class_json.adoc b/core/abstract_tests/ATS_class_json.adoc index 552f9059..6d37a850 100644 --- a/core/abstract_tests/ATS_class_json.adoc +++ b/core/abstract_tests/ATS_class_json.adoc @@ -3,8 +3,8 @@ .JSON ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/json -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/json +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/json/definition ==== diff --git a/core/abstract_tests/ATS_class_kvp-execute.adoc b/core/abstract_tests/ATS_class_kvp-execute.adoc index a489d1a8..756566ab 100644 --- a/core/abstract_tests/ATS_class_kvp-execute.adoc +++ b/core/abstract_tests/ATS_class_kvp-execute.adoc @@ -3,8 +3,8 @@ .KVP-encoded Execute ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/kvp-execute -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/kvp-execute +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/kvp-execute/numeric-input-value conformance-test:: /conf/kvp-execute/string-input-value diff --git a/core/abstract_tests/ATS_class_local-filtering.adoc b/core/abstract_tests/ATS_class_local-filtering.adoc index a577dfdc..994fc72f 100644 --- a/core/abstract_tests/ATS_class_local-filtering.adoc +++ b/core/abstract_tests/ATS_class_local-filtering.adoc @@ -3,8 +3,8 @@ .Local Filtering ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/local-filtering -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/local-filtering +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/collection-input/local-filtering ==== diff --git a/core/abstract_tests/ATS_class_oas.adoc b/core/abstract_tests/ATS_class_oas.adoc index c3cd86ad..1be2b6c6 100644 --- a/core/abstract_tests/ATS_class_oas.adoc +++ b/core/abstract_tests/ATS_class_oas.adoc @@ -3,8 +3,8 @@ .OpenAPI ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas +subject:: <> inherit:: <> classification:: Target Type:Web API conformance-test:: /conf/oas/completeness diff --git a/core/abstract_tests/ATS_class_oas30.adoc b/core/abstract_tests/ATS_class_oas30.adoc index a940eefd..5b88feb7 100644 --- a/core/abstract_tests/ATS_class_oas30.adoc +++ b/core/abstract_tests/ATS_class_oas30.adoc @@ -3,8 +3,8 @@ .OpenAPI 3.0 ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas30 -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas30 +subject:: <> inherit:: <> inherit:: <> classification:: Target Type:Web API diff --git a/core/abstract_tests/ATS_class_oas31.adoc b/core/abstract_tests/ATS_class_oas31.adoc index 92054d65..0d07c655 100644 --- a/core/abstract_tests/ATS_class_oas31.adoc +++ b/core/abstract_tests/ATS_class_oas31.adoc @@ -3,8 +3,8 @@ ./OpenAPI 3.1 ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas31 -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas31 +subject:: <> inherit:: <> inherit:: <> classification:: Target Type:Web API diff --git a/core/abstract_tests/ATS_class_ogc-process-description.adoc b/core/abstract_tests/ATS_class_ogc-process-description.adoc index e3e92dac..f801210e 100644 --- a/core/abstract_tests/ATS_class_ogc-process-description.adoc +++ b/core/abstract_tests/ATS_class_ogc-process-description.adoc @@ -3,14 +3,16 @@ .Process Description ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/ogc-process-description -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/ogc-process-description +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/ogc-process-description/json-encoding conformance-test:: /conf/ogc-process-description/links conformance-test:: /conf/ogc-process-description/inputs-def conformance-test:: /conf/ogc-process-description/input-def conformance-test:: /conf/ogc-process-description/input-multiple-types +conformance-test:: /conf/ogc-process-description/input-multiple-types +conformance-test:: /conf/ogc-process-description/data-access-apis conformance-test:: /conf/ogc-process-description/outputs-def conformance-test:: /conf/ogc-process-description/output-def conformance-test:: /conf/ogc-process-description/output-multiple-types @@ -26,6 +28,8 @@ include::ogc-process-description/ATS_input-def.adoc[] include::ogc-process-description/ATS_input-multiple-types.adoc[] +include::ogc-process-description/ATS_data-access-apis.adoc[] + include::ogc-process-description/ATS_outputs-def.adoc[] include::ogc-process-description/ATS_output-def.adoc[] diff --git a/core/abstract_tests/ATS_class_query-param-profile.adoc b/core/abstract_tests/ATS_class_query-param-profile.adoc index 364dca71..e02fe4b8 100644 --- a/core/abstract_tests/ATS_class_query-param-profile.adoc +++ b/core/abstract_tests/ATS_class_query-param-profile.adoc @@ -3,8 +3,8 @@ .Query Profile Parameter ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/query-param-profile -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/query-param-profile +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/query-param-profile/definition conformance-test:: /conf/query-param-profile/response diff --git a/core/abstract_tests/ATS_class_remote-collections.adoc b/core/abstract_tests/ATS_class_remote-collections.adoc index c2149de5..1edef484 100644 --- a/core/abstract_tests/ATS_class_remote-collections.adoc +++ b/core/abstract_tests/ATS_class_remote-collections.adoc @@ -3,8 +3,8 @@ .Remote Collections ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/remote-collections -subject:: <> +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/remote-collections +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/remote-collections/access conformance-test:: /conf/remote-collections/referencing diff --git a/core/abstract_tests/collection-input/ATS_collection-input_access.adoc b/core/abstract_tests/collection-input/ATS_collection-input_access.adoc index 26877da9..96bacc5a 100644 --- a/core/abstract_tests/collection-input/ATS_collection-input_access.adoc +++ b/core/abstract_tests/collection-input/ATS_collection-input_access.adoc @@ -1,5 +1,4 @@ [[ats_collection-input_collection-access]] - [abstract_test] ==== [%metadata] diff --git a/core/abstract_tests/collection-input/ATS_collection-input_filtering.adoc b/core/abstract_tests/collection-input/ATS_collection-input_filtering.adoc index decf984d..89e805ff 100644 --- a/core/abstract_tests/collection-input/ATS_collection-input_filtering.adoc +++ b/core/abstract_tests/collection-input/ATS_collection-input_filtering.adoc @@ -1,5 +1,4 @@ [[ats_collection-input_filtering]] - [abstract_test] ==== [%metadata] diff --git a/core/abstract_tests/collection-input/ATS_collection-input_pass-through.adoc b/core/abstract_tests/collection-input/ATS_collection-input_pass-through.adoc index 911c7b0d..9bf071a1 100644 --- a/core/abstract_tests/collection-input/ATS_collection-input_pass-through.adoc +++ b/core/abstract_tests/collection-input/ATS_collection-input_pass-through.adoc @@ -1,5 +1,4 @@ [[ats_collection-input_pass-through]] - [abstract_test] ==== [%metadata] diff --git a/core/abstract_tests/collection-input/ATS_collection-input_property-selection.adoc b/core/abstract_tests/collection-input/ATS_collection-input_property-selection.adoc index c61fe298..6bbea5b0 100644 --- a/core/abstract_tests/collection-input/ATS_collection-input_property-selection.adoc +++ b/core/abstract_tests/collection-input/ATS_collection-input_property-selection.adoc @@ -1,5 +1,4 @@ [[ats_collection-input_property-selection]] - [abstract_test] ==== [%metadata] diff --git a/core/abstract_tests/collection-input/ATS_collection-input_referencing.adoc b/core/abstract_tests/collection-input/ATS_collection-input_referencing.adoc index b934eda2..a8efd3d4 100644 --- a/core/abstract_tests/collection-input/ATS_collection-input_referencing.adoc +++ b/core/abstract_tests/collection-input/ATS_collection-input_referencing.adoc @@ -1,5 +1,4 @@ [[ats_collection-input_referencing]] - [abstract_test] ==== [%metadata] diff --git a/core/abstract_tests/core/ATS_conformance-op.adoc b/core/abstract_tests/core/ATS_conformance-op.adoc index 94a71dff..ce0adf03 100644 --- a/core/abstract_tests/core/ATS_conformance-op.adoc +++ b/core/abstract_tests/core/ATS_conformance-op.adoc @@ -9,7 +9,7 @@ test-purpose:: Validate that a Conformance Declaration can be retrieved from the 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. +1. Construct a path for each "rel=https://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. diff --git a/core/abstract_tests/core/ATS_conformance-success.adoc b/core/abstract_tests/core/ATS_conformance-success.adoc index 86d5c924..42b478c0 100644 --- a/core/abstract_tests/core/ATS_conformance-success.adoc +++ b/core/abstract_tests/core/ATS_conformance-success.adoc @@ -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/2.0/openapi/schemas/confClasses.yaml[confClasses.yaml]. +2. Validate the response document against OpenAPI 3.0 schema link: https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/confClasses.yaml[confClasses.yaml]. -3. Validate that the document includes the conformance class "http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/core". +3. Validate that the document includes the conformance class "https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/core". 4. Validate that the document list all OGC API conformance classes that the API implements. -- 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 index 2f9df594..d1d272c8 100644 --- a/core/abstract_tests/core/ATS_job-exception-no-such-job.adoc +++ b/core/abstract_tests/core/ATS_job-exception-no-such-job.adoc @@ -13,7 +13,7 @@ test-method:: 2. Validate that the document was returned with a 404. -3. 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 "https://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/no-such-job". 4. Validate the document for all supported media types using the resources and tests identified in <> -- @@ -26,6 +26,6 @@ NOTE: An exception response caused by using an invalid job identifier may be ret [cols="3",options="header"] |=== |Format |Schema Document |Test ID -|HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> -|JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> +|HTML |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> +|JSON |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> |=== diff --git a/core/abstract_tests/core/ATS_job-result-op.adoc b/core/abstract_tests/core/ATS_job-result-op.adoc index 16dcabe0..030674c4 100644 --- a/core/abstract_tests/core/ATS_job-result-op.adoc +++ b/core/abstract_tests/core/ATS_job-result-op.adoc @@ -11,6 +11,6 @@ test-method:: -- 1. Negotiate asynchronous process execution as per test <> or <>. -2. Validate that each process output can be retrived as per requirement <>. +2. Validate that each process output can be retrived as per requirement <>. -- ==== diff --git a/core/abstract_tests/core/ATS_job-results-exception-invalid-query-parameter-value.adoc b/core/abstract_tests/core/ATS_job-results-exception-invalid-query-parameter-value.adoc index 0ba8f43f..5c6802fa 100644 --- a/core/abstract_tests/core/ATS_job-results-exception-invalid-query-parameter-value.adoc +++ b/core/abstract_tests/core/ATS_job-results-exception-invalid-query-parameter-value.adoc @@ -15,6 +15,6 @@ test-method:: 3. Verify that the body of the response conforms to the https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/exception.yaml[exception.yaml] schema. -4. Verify that the `type` of the exception is "http://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/invalid-query-parameter-value". +4. Verify that the `type` of the exception is "https://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/invalid-query-parameter-value". -- ==== 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 index f71b3c78..5df75adb 100644 --- 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 @@ -13,7 +13,7 @@ test-method:: 2. Validate that the document was returned with a 404. -3. 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 "https://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/no-such-job". 4. Validate the document for all supported media types using the resources and tests identified in <> -- @@ -26,6 +26,6 @@ NOTE: The job results page for a job may be retrieved in one of two formats. The [cols="3",options="header"] |=== |Format |Schema Document |Test ID -|HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> -|JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> +|HTML |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> +|JSON |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> |=== diff --git a/core/abstract_tests/core/ATS_job-results-exception-results-not-available.adoc b/core/abstract_tests/core/ATS_job-results-exception-results-not-available.adoc index 79ebf5ee..e918c450 100644 --- a/core/abstract_tests/core/ATS_job-results-exception-results-not-available.adoc +++ b/core/abstract_tests/core/ATS_job-results-exception-results-not-available.adoc @@ -19,6 +19,6 @@ test-method:: 5. Verify that the body of the response contains an exception message that conforms to the https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/exception.yaml[exception.yaml] schema. -6. Verify that the `type` of the excpetion is "http://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/result-not-available". +6. Verify that the `type` of the excpetion is "https://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/result-not-available". -- ==== 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 index 2faf4e61..d2246534 100644 --- 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 @@ -15,7 +15,7 @@ test-method:: 3. Validate that the document was returned with a 404. -4. Validate that the document contains the exception `type` "http://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/result-not-ready". +4. Validate that the document contains the exception `type` "https://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/result-not-ready". 5. Validate the document for all supported media types using the resources and tests identified in <> -- @@ -28,6 +28,6 @@ NOTE: The job results page for a job may be retrieved in one of two formats. The [cols="3",options="header"] |=== |Format |Schema Document |Test ID -|HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> -|JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> +|HTML |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> +|JSON |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> |=== diff --git a/core/abstract_tests/core/ATS_job-results-failed.adoc b/core/abstract_tests/core/ATS_job-results-failed.adoc index 8f9b5e91..5f5b48e2 100644 --- a/core/abstract_tests/core/ATS_job-results-failed.adoc +++ b/core/abstract_tests/core/ATS_job-results-failed.adoc @@ -30,6 +30,6 @@ NOTE: The job results page for a job may be retrieved in one of two formats. The [cols="3",options="header"] |=== |Format |Schema Document |Test ID -|HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> -|JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> +|HTML |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> +|JSON |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> |=== diff --git a/core/abstract_tests/core/ATS_job-success.adoc b/core/abstract_tests/core/ATS_job-success.adoc index bc85a7b6..917f8a3d 100644 --- a/core/abstract_tests/core/ATS_job-success.adoc +++ b/core/abstract_tests/core/ATS_job-success.adoc @@ -26,6 +26,6 @@ NOTE: The status info page for a job may be retrieved in a one of two formats. T [cols="3",options="header"] |=== |Format |Schema Document |Test ID -|HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/statusInfo.yaml[statusInfo.yaml] |<> -|JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/statusInfo.yaml[statusInfo.yaml] |<> +|HTML |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/statusInfo.yaml[statusInfo.yaml] |<> +|JSON |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/statusInfo.yaml[statusInfo.yaml] |<> |=== diff --git a/core/abstract_tests/core/ATS_landingpage-success.adoc b/core/abstract_tests/core/ATS_landingpage-success.adoc index 7fe51e57..4bc3a781 100644 --- a/core/abstract_tests/core/ATS_landingpage-success.adoc +++ b/core/abstract_tests/core/ATS_landingpage-success.adoc @@ -18,9 +18,9 @@ test-method:: .. Validate that the landing page includes a "service-desc" and/or "service-doc" link to an API Definition. -.. Validate that the landing page includes a "http://www.opengis.net/def/rel/ogc/1.0/conformance" link to the conformance class declaration. +.. Validate that the landing page includes a "https://www.opengis.net/def/rel/ogc/1.0/conformance" link to the conformance class declaration. -.. Validate that the landing page includes a "http://www.opengis.net/def/rel/ogc/1.0/processes" link to the list of processes. +.. Validate that the landing page includes a "https://www.opengis.net/def/rel/ogc/1.0/processes" link to the list of processes. -- @@ -33,6 +33,6 @@ NOTE: The landing page may be retrieved in one of two formats. The following tab [cols="3",options="header"] |=== |Format |Schema Document |Test ID -|HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/landingPage.yaml[landingPage.yaml] |<> -|JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/landingPage.yaml[landingPage.yaml] |<> +|HTML |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/landingPage.yaml[landingPage.yaml] |<> +|JSON |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/landingPage.yaml[landingPage.yaml] |<> |=== diff --git a/core/abstract_tests/core/ATS_process-description-success.adoc b/core/abstract_tests/core/ATS_process-description-success.adoc index 74b3949b..118f005a 100644 --- a/core/abstract_tests/core/ATS_process-description-success.adoc +++ b/core/abstract_tests/core/ATS_process-description-success.adoc @@ -22,5 +22,5 @@ NOTE: The interface of a process may be described using one of a number of diffe [cols="3",options="header"] |=== |Model |Schema Document |Test ID -|OGC Process Description JSON|link:http://schemas.opengis.net/ogcapi/features/part1/2.0/openapi/schemas/process.yaml[process.yaml] |<> +|OGC Process Description JSON|link:https://schemas.opengis.net/ogcapi/features/part1/2.0/openapi/schemas/process.yaml[process.yaml] |<> |=== diff --git a/core/abstract_tests/core/ATS_process-exception-no-such-process.adoc b/core/abstract_tests/core/ATS_process-exception-no-such-process.adoc index bc2e212f..8bc64d70 100644 --- a/core/abstract_tests/core/ATS_process-exception-no-such-process.adoc +++ b/core/abstract_tests/core/ATS_process-exception-no-such-process.adoc @@ -13,7 +13,7 @@ test-method:: 2. Validate that the document was returned with a 404. -3. Validate that the document contains the exception `type` "http://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/no-such-process". +3. Validate that the document contains the exception `type` "https://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/no-such-process". 4. Validate the document for all supported media types using the resources and tests identified in <> -- @@ -26,6 +26,6 @@ NOTE: An exception response caused by using an invalid process identifier may be [cols="3",options="header"] |=== |Format |Schema Document |Test ID -|HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> -|JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> +|HTML |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> +|JSON |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/exception.yaml[exception.yaml] |<> |=== diff --git a/core/abstract_tests/core/ATS_process-execute-outputs-empty.adoc b/core/abstract_tests/core/ATS_process-execute-outputs-empty.adoc index 0e75a74b..b9948956 100644 --- a/core/abstract_tests/core/ATS_process-execute-outputs-empty.adoc +++ b/core/abstract_tests/core/ATS_process-execute-outputs-empty.adoc @@ -12,6 +12,6 @@ test-method:: 2. Ensure that the content of the `outputs` parameter, specified in the <>, is empty. -3. Verify that no processing outputs are generated (see tests: <>, <>). +3. Verify that no processing outputs are generated (see tests: <>, <>). -- ==== diff --git a/core/abstract_tests/core/ATS_process-list-success.adoc b/core/abstract_tests/core/ATS_process-list-success.adoc index 85b0eb05..0a9232df 100644 --- a/core/abstract_tests/core/ATS_process-list-success.adoc +++ b/core/abstract_tests/core/ATS_process-list-success.adoc @@ -22,6 +22,6 @@ NOTE: The process list may be retrieved in one of two formats. The following tab [cols="3",options="header"] |=== |Format |Schema Document |Test ID -|HTML |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/processList.yaml[processList.yaml] |<> -|JSON |link:http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/processList.yaml[processList.yaml] |<> +|HTML |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/processList.yaml[processList.yaml] |<> +|JSON |link:https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/processList.yaml[processList.yaml] |<> |=== diff --git a/core/abstract_tests/kvp-execute/ATS_bbox-crs-input-value.adoc b/core/abstract_tests/kvp-execute/ATS_bbox-crs-input-value.adoc index 8ab8b470..3acb24e9 100644 --- a/core/abstract_tests/kvp-execute/ATS_bbox-crs-input-value.adoc +++ b/core/abstract_tests/kvp-execute/ATS_bbox-crs-input-value.adoc @@ -5,7 +5,7 @@ [%metadata] identifier:: /conf/kvp-execute/bbox-crs-input-value target:: /req/kvp-execute/bbox-crs-input-value -test-purpose:: Verify that bbox-valued process inputs for KVP-encoded execute request with CRSs other than http://www.opengis.net/def/crs/OGC/1.3/CRS84 or http://www.opengis.net/def/crs/OGC/0/CRS84h are correctly handled. +test-purpose:: Verify that bbox-valued process inputs for KVP-encoded execute request with CRSs other than https://www.opengis.net/def/crs/OGC/1.3/CRS84 or https://www.opengis.net/def/crs/OGC/0/CRS84h are correctly handled. test-method:: + -- @@ -15,7 +15,7 @@ test-method:: 3. Inspect the input definitions of each process and identify the processes that have at least one bounding-box-typed input. -4. Identify that subset of the processes identified in Step #2 that support CRSs other than http://www.opengis.net/def/crs/OGC/1.3/CRS84 or http://www.opengis.net/def/crs/OGC/0/CRS84h. +4. Identify that subset of the processes identified in Step #2 that support CRSs other than https://www.opengis.net/def/crs/OGC/1.3/CRS84 or https://www.opengis.net/def/crs/OGC/0/CRS84h. 5. Compose a KVP-encoded execute request encoding the bbox-typed input(s) according to <> and encoding the CRS according to <>. diff --git a/core/abstract_tests/local-filtering/ATS_local-filtering.adoc b/core/abstract_tests/local-filtering/ATS_local-filtering.adoc index 157a732b..6d68fa71 100644 --- a/core/abstract_tests/local-filtering/ATS_local-filtering.adoc +++ b/core/abstract_tests/local-filtering/ATS_local-filtering.adoc @@ -1,5 +1,4 @@ [[ats_collection-input_local-filtering]] - [abstract_test] ==== [%metadata] diff --git a/core/abstract_tests/ogc-process-description/ATS_data-access-apis.adoc b/core/abstract_tests/ogc-process-description/ATS_data-access-apis.adoc index 513cd57a..9a39e0a3 100644 --- a/core/abstract_tests/ogc-process-description/ATS_data-access-apis.adoc +++ b/core/abstract_tests/ogc-process-description/ATS_data-access-apis.adoc @@ -1,5 +1,4 @@ [[ats_ogc-process-description_data-access-apis]] - [abstract_test] ==== [%metadata] diff --git a/core/abstract_tests/query-param-profile/ATS_definition.adoc b/core/abstract_tests/query-param-profile/ATS_definition.adoc index 787d9e24..d4c8eab5 100644 --- a/core/abstract_tests/query-param-profile/ATS_definition.adoc +++ b/core/abstract_tests/query-param-profile/ATS_definition.adoc @@ -11,6 +11,6 @@ test-method:: -- 1. Verify that the `profile` query parameter complies with its schema definition in requirement <>. -2. Verify that each element in the profile list is either a HTTP(S) URI or a profile identifier (i.e. `{profileId}`) in the URI template `\http://www.opengis.net/def/profile/OGC/0/{profileId}`. +2. Verify that each element in the profile list is either a HTTP(S) URI or a profile identifier (i.e. `{profileId}`) in the URI template `\https://www.opengis.net/def/profile/OGC/0/{profileId}`. -- ==== diff --git a/core/abstract_tests/query-param-profile/ATS_response.adoc b/core/abstract_tests/query-param-profile/ATS_response.adoc index fb1b441a..37fd9b5b 100644 --- a/core/abstract_tests/query-param-profile/ATS_response.adoc +++ b/core/abstract_tests/query-param-profile/ATS_response.adoc @@ -11,7 +11,7 @@ test-method:: -- 1. Execute one or more requests that include the `profile` parameter. -2. Ensure that the value of the `profile` parameter is a list of one or more HTTP(S) URIs OR profile identifiers (i.e. `{profileId}`) from the URI template `\http://www.opengis.net/def/profile/OGC/0/{profileId}`. +2. Ensure that the value of the `profile` parameter is a list of one or more HTTP(S) URIs OR profile identifiers (i.e. `{profileId}`) from the URI template `\https://www.opengis.net/def/profile/OGC/0/{profileId}`. 3. Assuming that the requested response format supports web links in accordance with <>, verify that the response document includes at least one link with `rel="profile"`. -- diff --git a/core/abstract_tests/remote-collections/ATS_remote-collections_access.adoc b/core/abstract_tests/remote-collections/ATS_remote-collections_access.adoc index 21a3f5f8..fc6f1e7d 100644 --- a/core/abstract_tests/remote-collections/ATS_remote-collections_access.adoc +++ b/core/abstract_tests/remote-collections/ATS_remote-collections_access.adoc @@ -1,4 +1,4 @@ -[[ats_remote-collections-access]] +[[ats_remote-collections_access]] [abstract_test] ==== [%metadata] diff --git a/core/abstract_tests/remote-collections/ATS_remote-collections_referencing.adoc b/core/abstract_tests/remote-collections/ATS_remote-collections_referencing.adoc index 63e2b0af..8f1b00e2 100644 --- a/core/abstract_tests/remote-collections/ATS_remote-collections_referencing.adoc +++ b/core/abstract_tests/remote-collections/ATS_remote-collections_referencing.adoc @@ -12,7 +12,7 @@ test-method:: 2. Inspect the description of the inputs of each process and identify those inputs that support collection inputs (e.g. see test <>). -3. Compose <> that includes the identified inputs and using a supported <> (see test: <> to identify supported <>). +3. Compose <> that includes the identified inputs and using a supported <> (see test: <> to identify supported <>). 4. Use the `collection` parameter in the <>, as defined in <>, to reference remote collections from which input values will be retrieved. diff --git a/core/examples/json/ConfClasses.json b/core/examples/json/ConfClasses.json index a71305ef..563006c3 100644 --- a/core/examples/json/ConfClasses.json +++ b/core/examples/json/ConfClasses.json @@ -1,8 +1,8 @@ { "conformsTo": [ - "http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core", - "http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json", - "http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/html", - "http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30" + "http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/core", + "http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/json", + "http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/html", + "http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas30" ] } diff --git a/core/recommendations/collection-output/PER_collection-output_dynamic.adoc b/core/recommendations/collection-output/PER_collection-output_dynamic.adoc index 18f31714..df976896 100644 --- a/core/recommendations/collection-output/PER_collection-output_dynamic.adoc +++ b/core/recommendations/collection-output/PER_collection-output_dynamic.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/collection-output/dynamic -label:: /per/collection-output/dynamic The server MAY arrange for the <> to be a "virtual" collection with processing being triggered at run-time each time the data of the collection is accessed using an <> and taking into account any spatial, temporal and other filters specified on that data access request. ==== diff --git a/core/recommendations/collection-output/PER_collection-output_response-response-one.adoc b/core/recommendations/collection-output/PER_collection-output_response-response-one.adoc index 32b5f830..e82740be 100644 --- a/core/recommendations/collection-output/PER_collection-output_response-response-one.adoc +++ b/core/recommendations/collection-output/PER_collection-output_response-response-one.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/collection-output/response-response-one -label:: /per/collection-output/response-response-one [.component,class=conditions] -- diff --git a/core/recommendations/collection-output/PER_collection-output_static.adoc b/core/recommendations/collection-output/PER_collection-output_static.adoc index 2fd37558..fbf380c4 100644 --- a/core/recommendations/collection-output/PER_collection-output_static.adoc +++ b/core/recommendations/collection-output/PER_collection-output_static.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/collection-output/static -label:: /per/collection-output/static The server MAY perform all the requested processing up front resulting in a fully materialized and static <>. ==== diff --git a/core/recommendations/core/PER_additional-status-codes.adoc b/core/recommendations/core/PER_additional-status-codes.adoc index d4a27c3d..d2e73df5 100644 --- a/core/recommendations/core/PER_additional-status-codes.adoc +++ b/core/recommendations/core/PER_additional-status-codes.adoc @@ -1,9 +1,8 @@ -[[per_core_additiona-status-codes]] +[[per_core_additional-status-codes]] [permission] ==== [%metadata] identifier:: /per/core/additional-status-codes -label:: /per/core/additional-status-codes Servers MAY support other capabilities of the HTTP protocol and, therefore, MAY return other status codes than those listed in <>, too. diff --git a/core/recommendations/core/PER_alternative-process-description.adoc b/core/recommendations/core/PER_alternative-process-description.adoc index bf19f24f..d3f397a8 100644 --- a/core/recommendations/core/PER_alternative-process-description.adoc +++ b/core/recommendations/core/PER_alternative-process-description.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/alternative-process-description -label:: /per/core/alternative-process-description Servers MAY support alternative means of describing the inputs and outputs of a process. ==== diff --git a/core/recommendations/core/PER_alternative-process-paths.adoc b/core/recommendations/core/PER_alternative-process-paths.adoc index 7a4cf153..771c76e9 100644 --- a/core/recommendations/core/PER_alternative-process-paths.adoc +++ b/core/recommendations/core/PER_alternative-process-paths.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/alternative-process-paths -label:: /per/core/alternative-process-paths Servers MAY support alternative API paths. ==== diff --git a/core/recommendations/core/PER_api-definition-uri.adoc b/core/recommendations/core/PER_api-definition-uri.adoc index 6c7bc98d..3e9868a0 100644 --- a/core/recommendations/core/PER_api-definition-uri.adoc +++ b/core/recommendations/core/PER_api-definition-uri.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/api-definition-uri -label:: /per/core/api-definition-uri 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. ==== diff --git a/core/recommendations/core/PER_job-results-exception-job-gone.adoc b/core/recommendations/core/PER_job-results-exception-job-gone.adoc new file mode 100644 index 00000000..947e9971 --- /dev/null +++ b/core/recommendations/core/PER_job-results-exception-job-gone.adoc @@ -0,0 +1,8 @@ +[[per_core_job-results-exception_job-gone]] +[permission] +==== +[%metadata] +identifier:: /per/core/job-results-exception-job-gone + +If the operation is executed using a job identifier that once existed, the server MAY response with a HTTP status code 410. +==== diff --git a/core/recommendations/core/PER_job-results-success-async-many-other-formats.adoc b/core/recommendations/core/PER_job-results-success-async-many-other-formats.adoc index 61e1e3b0..c0eaa1a1 100644 --- a/core/recommendations/core/PER_job-results-success-async-many-other-formats.adoc +++ b/core/recommendations/core/PER_job-results-success-async-many-other-formats.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/job-results-async-many-other-formats -label:: /per/core/job-results-async-many-other-formats [.component,class=conditions] -- @@ -11,7 +10,14 @@ label:: /per/core/job-results-async-many-other-formats . The number of requested (whether <> or <>) outputs in the <> is 2 or more. -- -part:: Servers MAY support other response formats or encodings (e.g. ZIP or `multipart/*`) that do not conform to <> schema. +[.component,class=part] +-- +Servers MAY support other response formats or encodings (e.g. ZIP or `multipart/*`) that do not conform to https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/results.yaml[results.yaml]. +-- + +[.component,class=part] +-- +This Standard does not provide any guidance on these other formats or encodings. +-- -part:: This Standard does not provide any guidance on these other formats or encodings. ==== diff --git a/core/recommendations/core/PER_job-status.adoc b/core/recommendations/core/PER_job-status.adoc index 8dbd1592..190750e5 100644 --- a/core/recommendations/core/PER_job-status.adoc +++ b/core/recommendations/core/PER_job-status.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/job-status -label:: /per/core/job-status [.component,class=part] -- diff --git a/core/recommendations/core/PER_process-exception-job-gone.adoc b/core/recommendations/core/PER_process-exception-job-gone.adoc new file mode 100644 index 00000000..fda8e51c --- /dev/null +++ b/core/recommendations/core/PER_process-exception-job-gone.adoc @@ -0,0 +1,8 @@ +[[per_core_process-exception_job-gone]] +[permission] +==== +[%metadata] +identifier:: /per/core/process-exception-job-gone + +If the operation is executed using a job identifier that once existed, the server MAY response with a HTTP status code 410. +==== diff --git a/core/recommendations/core/PER_process-exception-process-gone.adoc b/core/recommendations/core/PER_process-exception-process-gone.adoc new file mode 100644 index 00000000..878a66a7 --- /dev/null +++ b/core/recommendations/core/PER_process-exception-process-gone.adoc @@ -0,0 +1,8 @@ +[[per_core_process-exception_process-gone]] +[permission] +==== +[%metadata] +identifier:: /per/core/process-exception-process-gone + +If the operation is executed using a process identifier that once existed, the server MAY response with a HTTP status code 410. +==== diff --git a/core/recommendations/core/PER_process-execute-input-inline-bbox.adoc b/core/recommendations/core/PER_process-execute-input-inline-bbox.adoc index f0ebd6fc..0a592e61 100644 --- a/core/recommendations/core/PER_process-execute-input-inline-bbox.adoc +++ b/core/recommendations/core/PER_process-execute-input-inline-bbox.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/process-execute-input-inline-bbox -label:: /per/core/process-execute-input-inline-bbox Servers MAY copy the contents of <> into another file and adjust the `default` and `enum` values as required. ==== diff --git a/core/recommendations/core/PER_process-execute-multiple-output-pkg.adoc b/core/recommendations/core/PER_process-execute-multiple-output-pkg.adoc index 9bc47f67..c634a69b 100644 --- a/core/recommendations/core/PER_process-execute-multiple-output-pkg.adoc +++ b/core/recommendations/core/PER_process-execute-multiple-output-pkg.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/process-execute-multiple-output-pkg -label:: /per/core/process-execute-multiple-output-pkg A server MAY, through content negotiation, respond with something other than that specified by requirement <>. A server MAY, for example, respond with a https://www.iso.org/standard/60101.html[ZIP] file or a https://www.w3.org/Protocols/rfc1341/7_2_Multipart.html[multi-part MIME] document containing all the requested output values. ==== diff --git a/core/recommendations/core/PER_process-execute-success-sync-many-other-formats.adoc b/core/recommendations/core/PER_process-execute-success-sync-many-other-formats.adoc index 1470f882..766aa4d3 100644 --- a/core/recommendations/core/PER_process-execute-success-sync-many-other-formats.adoc +++ b/core/recommendations/core/PER_process-execute-success-sync-many-other-formats.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/process-execute-sync-many-other-formats -label:: /per/core/process-execute-sync-many-other-formats [.component,class=conditions] -- @@ -11,9 +10,14 @@ label:: /per/core/process-execute-sync-many-other-formats . The number of requested (whether <>) outputs in the <> is 2 or more. -- -part:: Servers MAY support other response formats or encodings (e.g. ZIP or `multipart/*`) that do not conform to <> schema. +[.component,class=part] +-- +Servers MAY support other response formats or encodings (e.g. ZIP or `multipart/*`) that do not conform to https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/results.yaml[results.yaml]. +-- -part:: This Standard does not provide any guidance on these other formats or encodings. +[.component,class=part] +-- +This Standard does not provide any guidance on these other formats or encodings. +-- -part:: Servers that do not which to support these alternate formats SHOULD respond with an HTTP status code of 406 (Not Acceptable), as per https://datatracker.ietf.org/doc/html/rfc2616#section-12[HTTP content negotiation rules]. ==== diff --git a/core/recommendations/core/PER_process-execute-sync-job.adoc b/core/recommendations/core/PER_process-execute-sync-job.adoc index 67d4b4f5..82f2cf06 100644 --- a/core/recommendations/core/PER_process-execute-sync-job.adoc +++ b/core/recommendations/core/PER_process-execute-sync-job.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/process-execute-sync-job -label:: /per/core/process-execute-sync-job Servers MAY support the creation of a job for synchronously executed processes. ==== diff --git a/core/recommendations/core/PER_process-execute-sync-one-result.adoc b/core/recommendations/core/PER_process-execute-sync-one-result.adoc index b6095d52..e413493b 100644 --- a/core/recommendations/core/PER_process-execute-sync-one-result.adoc +++ b/core/recommendations/core/PER_process-execute-sync-one-result.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/process-execute-sync-one-result -label:: /per/core/process-execute-sync-one-result [.component,class=conditions] -- diff --git a/core/recommendations/core/PER_process-list-limit-default-minimum-maximum.adoc b/core/recommendations/core/PER_process-list-limit-default-minimum-maximum.adoc index ddcbb849..ef410bfd 100644 --- a/core/recommendations/core/PER_process-list-limit-default-minimum-maximum.adoc +++ b/core/recommendations/core/PER_process-list-limit-default-minimum-maximum.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/limit-default-minimum-maximum -label:: /per/core/limit-default-minimum-maximum -part:: The values for `minimum`, `maximum` and `default` in requirement `/req/core/limit-definition` are only examples and MAY be changed. +The values for `minimum`, `maximum` and `default` in requirement `/req/core/limit-definition` are only examples and MAY be changed. ==== diff --git a/core/recommendations/core/PER_process-list-limit-response.adoc b/core/recommendations/core/PER_process-list-limit-response.adoc index 1faa6697..ea98c6b7 100644 --- a/core/recommendations/core/PER_process-list-limit-response.adoc +++ b/core/recommendations/core/PER_process-list-limit-response.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/limit-response -label:: /per/core/limit-response -part:: The server MAY return fewer process summaries than requested (but not more). +The server MAY return fewer process summaries than requested (but not more). ==== diff --git a/core/recommendations/core/PER_process-list-prev.adoc b/core/recommendations/core/PER_process-list-prev.adoc index 3e0db6c3..e5643e24 100644 --- a/core/recommendations/core/PER_process-list-prev.adoc +++ b/core/recommendations/core/PER_process-list-prev.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/core/prev -label:: /per/core/prev -part:: A response to dereferencing a next page link (relation: `next`) MAY include a prev page link (relation: `prev`) to the resource that included the next page link (relation: `next`). +A response to dereferencing a next page link (relation: `next`) MAY include a prev page link (relation: `prev`) to the resource that included the next page link (relation: `next`). ==== diff --git a/core/recommendations/core/REC_access-control-expose-headers.adoc b/core/recommendations/core/REC_access-control-expose-headers.adoc index f65176ce..937575d9 100644 --- a/core/recommendations/core/REC_access-control-expose-headers.adoc +++ b/core/recommendations/core/REC_access-control-expose-headers.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/access-control-expose-headers -label:: /rec/core/access-control-expose-headers If the server is intended to be accessed from the browser and if Cross-origin resource sharing is supported, the `Access-Control-Expose-Headers` header SHOULD be used and the header SHOULD contain the value `location` to enable the browser to access the `location` header of the response. ==== diff --git a/core/recommendations/core/REC_api-definition-oas.adoc b/core/recommendations/core/REC_api-definition-oas.adoc index 99895f34..0705ed9e 100644 --- a/core/recommendations/core/REC_api-definition-oas.adoc +++ b/core/recommendations/core/REC_api-definition-oas.adoc @@ -3,8 +3,15 @@ ==== [%metadata] identifier:: /rec/core/api-definition-oas -label:: /rec/core/api-definition-oas -* If the API definition document is defined using the OpenAPI Specification 3.0, the document SHOULD conform to the <>. -* If the API definition document is defined using the OpenAPI Specification 3.1, the document SHOULD conform to the <>. +[.component,class=part] +-- +If the API definition document is defined using the OpenAPI Specification 3.0, the document SHOULD conform to the <>. +-- + +[.component,class=part] +-- +If the API definition document is defined using the OpenAPI Specification 3.1, the document SHOULD conform to the <>. +-- + ==== diff --git a/core/recommendations/core/REC_content-length.adoc b/core/recommendations/core/REC_content-length.adoc index abcd8b41..9af3e8df 100644 --- a/core/recommendations/core/REC_content-length.adoc +++ b/core/recommendations/core/REC_content-length.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/content-length -label:: /rec/core/content-length The server SHOULD include the HTTP 1.1 `Content-Length` header in all responses. ==== diff --git a/core/recommendations/core/REC_cross-origin.adoc b/core/recommendations/core/REC_cross-origin.adoc index 22844492..fec3c066 100644 --- a/core/recommendations/core/REC_cross-origin.adoc +++ b/core/recommendations/core/REC_cross-origin.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/cross-origin -label:: /rec/core/cross-origin If the server is intended to be accessed from the browser, cross-origin requests SHOULD be supported. Note that support can also be added in a proxy layer on top of the server. ==== diff --git a/core/recommendations/core/REC_header-profile-link.adoc b/core/recommendations/core/REC_header-profile-link.adoc index 612c0bdc..4d55910f 100644 --- a/core/recommendations/core/REC_header-profile-link.adoc +++ b/core/recommendations/core/REC_header-profile-link.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/header-profile-link -label:: /rec/core/header-profile-link [.component,class=conditions] -- @@ -12,6 +11,6 @@ An <> is requested. [.component,class=part] -- -The server SHOULD include a profile link (href: `http://www.opengis.net/def/profile/OGC/0/ogc-process-description`, relation: `profile`) in the response https://datatracker.ietf.org/doc/html/rfc8288#section-3[HTTP headers] (see https://datatracker.ietf.org/doc/html/rfc6906[RFC 6906, The 'profile' Link Relation Type]). +The server SHOULD include a profile link (href: `https://www.opengis.net/def/profile/OGC/0/ogc-process-description`, relation: `profile`) in the response https://datatracker.ietf.org/doc/html/rfc8288#section-3[HTTP headers] (see https://datatracker.ietf.org/doc/html/rfc6906[RFC 6906, The 'profile' Link Relation Type]). -- ==== diff --git a/core/recommendations/core/REC_html.adoc b/core/recommendations/core/REC_html.adoc index 4fd9ad8d..ddb440a6 100644 --- a/core/recommendations/core/REC_html.adoc +++ b/core/recommendations/core/REC_html.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/html -label:: /rec/core/html To support browsing an implementation of OGC API - Processes with a web browser and to enable search engines to crawl and index a process, implementations SHOULD consider to support an HTML encoding. ==== diff --git a/core/recommendations/core/REC_http-head.adoc b/core/recommendations/core/REC_http-head.adoc index f0b53c51..042b2f68 100644 --- a/core/recommendations/core/REC_http-head.adoc +++ b/core/recommendations/core/REC_http-head.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/http-head -label:: /rec/core/http-head The server SHOULD support the HTTP 1.1 method HEAD for all resources that support the method GET. ==== diff --git a/core/recommendations/core/REC_job-links.adoc b/core/recommendations/core/REC_job-links.adoc index e86c6575..f9e3e4c7 100644 --- a/core/recommendations/core/REC_job-links.adoc +++ b/core/recommendations/core/REC_job-links.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/job-links -label:: /rec/core/job-links [.component,class=part] -- diff --git a/core/recommendations/core/REC_job-results-success-async-many-json-prefer-minimal.adoc b/core/recommendations/core/REC_job-results-success-async-many-json-prefer-minimal.adoc index 66de0dba..337f06d2 100644 --- a/core/recommendations/core/REC_job-results-success-async-many-json-prefer-minimal.adoc +++ b/core/recommendations/core/REC_job-results-success-async-many-json-prefer-minimal.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/job-results-async-many-json-prefer-minimal -label:: /rec/core/job-results-async-many-json-prefer-minimal [.component,class=conditions] -- diff --git a/core/recommendations/core/REC_job-results-success-async-many-json-prefer-none.adoc b/core/recommendations/core/REC_job-results-success-async-many-json-prefer-none.adoc index 7f916743..6bbbfd42 100644 --- a/core/recommendations/core/REC_job-results-success-async-many-json-prefer-none.adoc +++ b/core/recommendations/core/REC_job-results-success-async-many-json-prefer-none.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/job-results-async-many-json-prefer-none -label:: /rec/core/job-results-async-many-json-prefer-none [.component,class=conditions] -- diff --git a/core/recommendations/core/REC_job-results-success-async-many-json-prefer-representation.adoc b/core/recommendations/core/REC_job-results-success-async-many-json-prefer-representation.adoc index d76a5651..40c9e66d 100644 --- a/core/recommendations/core/REC_job-results-success-async-many-json-prefer-representation.adoc +++ b/core/recommendations/core/REC_job-results-success-async-many-json-prefer-representation.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/job-results-async-many-json-prefer-representation -label:: /rec/core/job-results-async-many-json-prefer-representation [.component,class=conditions] -- diff --git a/core/recommendations/core/REC_job-status.adoc b/core/recommendations/core/REC_job-status.adoc index b58602ed..6d41fb62 100644 --- a/core/recommendations/core/REC_job-status.adoc +++ b/core/recommendations/core/REC_job-status.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/job-status -label:: /rec/core/job-status [.component,class=part] -- diff --git a/core/recommendations/core/REC_link-header.adoc b/core/recommendations/core/REC_link-header.adoc index 10936bd7..3e92b3aa 100644 --- a/core/recommendations/core/REC_link-header.adoc +++ b/core/recommendations/core/REC_link-header.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/link-header -label:: /rec/core/link-header [.component,class=part] -- diff --git a/core/recommendations/core/REC_ogc-process-description.adoc b/core/recommendations/core/REC_ogc-process-description.adoc index 77652d3f..b1b00aa1 100644 --- a/core/recommendations/core/REC_ogc-process-description.adoc +++ b/core/recommendations/core/REC_ogc-process-description.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/ogc-process-description -label:: /rec/core/ogc-process-description Implementations SHOULD consider supporting the <>. ==== diff --git a/core/recommendations/core/REC_problem-details.adoc b/core/recommendations/core/REC_problem-details.adoc index 713bd814..d07c9193 100644 --- a/core/recommendations/core/REC_problem-details.adoc +++ b/core/recommendations/core/REC_problem-details.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/problem-details -label:: /rec/core/problem-details A server SHOULD include a "Problem Details" report in an error response in accordance with https://datatracker.ietf.org/doc/html/rfc9457[RFC 9457]. ==== diff --git a/core/recommendations/core/REC_process-execute-handle-prefer.adoc b/core/recommendations/core/REC_process-execute-handle-prefer.adoc deleted file mode 100644 index f84f35d6..00000000 --- a/core/recommendations/core/REC_process-execute-handle-prefer.adoc +++ /dev/null @@ -1,9 +0,0 @@ -[[rec_core_process-execute-handle-prefer]] -[recommendation] -==== -[%metadata] -identifier:: /rec/core/process-execute-handle-prefer -label:: /rec/core/process-execute-handle-prefer - -A client that accompanies an <> with the HTTP https://datatracker.ietf.org/doc/html/rfc7240#section-2[`Prefer`] header asserting a https://tools.ietf.org/html/rfc7240#section-4.1[`respond-async`] preference and/or a https://tools.ietf.org/html/rfc7240#section-4.3[`wait`] preference SHOULD be prepared to receive either an asynchronous or a synchronous response. -==== diff --git a/core/recommendations/core/REC_process-execute-handle-return-preference.adoc b/core/recommendations/core/REC_process-execute-handle-return-preference.adoc index 4779886a..a7de5e53 100644 --- a/core/recommendations/core/REC_process-execute-handle-return-preference.adoc +++ b/core/recommendations/core/REC_process-execute-handle-return-preference.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/process-execute-handle-return-preference -label:: /rec/core/process-execute-handle-return-preference A client that accompanies an <> with the HTTP https://datatracker.ietf.org/doc/html/rfc7240#section-2[`Prefer`] header asserting a https://tools.ietf.org/html/rfc7240#section-4.2[`return`] preference SHOULD be prepared to receive output values either: diff --git a/core/recommendations/core/REC_process-execute-honor-prefer.adoc b/core/recommendations/core/REC_process-execute-honor-prefer.adoc index 22dabc69..3647ac32 100644 --- a/core/recommendations/core/REC_process-execute-honor-prefer.adoc +++ b/core/recommendations/core/REC_process-execute-honor-prefer.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/process-execute-honor-prefer -label:: /rec/core/process-execute-honor-prefer [.component,class=conditions] -- diff --git a/core/recommendations/core/REC_process-execute-honor-return-preference.adoc b/core/recommendations/core/REC_process-execute-honor-return-preference.adoc index 6dea3872..6f86b4b9 100644 --- a/core/recommendations/core/REC_process-execute-honor-return-preference.adoc +++ b/core/recommendations/core/REC_process-execute-honor-return-preference.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/process-execute-honor-prefer-return -label:: /rec/core/process-execute-honor-prefer-return If an <> *is accompanied* with the HTTP https://datatracker.ietf.org/doc/html/rfc7240#section-2[`Prefer`] header asserting a https://datatracker.ietf.org/doc/html/rfc7240#section-4.2[`return`] preference, then the server SHOULD honor that preference. diff --git a/core/recommendations/core/REC_process-execute-mode-auto.adoc b/core/recommendations/core/REC_process-execute-mode-auto.adoc index 823815da..974fd45d 100644 --- a/core/recommendations/core/REC_process-execute-mode-auto.adoc +++ b/core/recommendations/core/REC_process-execute-mode-auto.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/process-execute-mode-auto -label:: /rec/core/process-execute-mode-auto A client that requests a process be executed in `auto` mode SHOULD be prepared to receive either an asynchronous or a synchronous response. ==== diff --git a/core/recommendations/core/REC_process-execute-preference-applied.adoc b/core/recommendations/core/REC_process-execute-preference-applied.adoc index 3fbd0d2c..d7aaa274 100644 --- a/core/recommendations/core/REC_process-execute-preference-applied.adoc +++ b/core/recommendations/core/REC_process-execute-preference-applied.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/process-execute-preference-applied -label:: /rec/core/process-execute-preference-applied If an <> is accompanied with the HTTP https://datatracker.ietf.org/doc/html/rfc7240#section-2[`Prefer`] header then, in the <>, servers SHOULD include the HTTP https://datatracker.ietf.org/doc/html/rfc7240#section-3[`Preference-Applied`] response header as an indication as to which https://datatracker.ietf.org/doc/html/rfc7240#section-2[`Prefer`] tokens were honored by the server. ==== diff --git a/core/recommendations/core/REC_process-execute-success-sync-many-json-prefer-minimal.adoc b/core/recommendations/core/REC_process-execute-success-sync-many-json-prefer-minimal.adoc index f3df187a..bfd6f14f 100644 --- a/core/recommendations/core/REC_process-execute-success-sync-many-json-prefer-minimal.adoc +++ b/core/recommendations/core/REC_process-execute-success-sync-many-json-prefer-minimal.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/process-execute-sync-many-json-prefer-minimal -label:: /rec/core/process-execute-sync-many-json-prefer-minimal [.component,class=conditions] -- diff --git a/core/recommendations/core/REC_process-execute-success-sync-many-json-prefer-none.adoc b/core/recommendations/core/REC_process-execute-success-sync-many-json-prefer-none.adoc index 6da17433..af3ba3f7 100644 --- a/core/recommendations/core/REC_process-execute-success-sync-many-json-prefer-none.adoc +++ b/core/recommendations/core/REC_process-execute-success-sync-many-json-prefer-none.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/process-execute-sync-many-json-prefer-none -label:: /rec/core/process-execute-sync-many-json-prefer-none [.component,class=conditions] -- diff --git a/core/recommendations/core/REC_process-execute-success-sync-many-json-prefer-representation.adoc b/core/recommendations/core/REC_process-execute-success-sync-many-json-prefer-representation.adoc index 9aa3dd52..5f718e1c 100644 --- a/core/recommendations/core/REC_process-execute-success-sync-many-json-prefer-representation.adoc +++ b/core/recommendations/core/REC_process-execute-success-sync-many-json-prefer-representation.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/process-execute-sync-many-json-prefer-representation -label:: /rec/core/process-execute-sync-many-json-prefer-representation [.component,class=conditions] -- diff --git a/core/recommendations/core/REC_process-list-next-1.adoc b/core/recommendations/core/REC_process-list-next-1.adoc index bdede695..314fb316 100644 --- a/core/recommendations/core/REC_process-list-next-1.adoc +++ b/core/recommendations/core/REC_process-list-next-1.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/next-1 -label:: /rec/core/next-1 If more processes summaries have been selected than returned in the response, a `200`-response SHOULD include a link to the next page (relation: `next`) of process summaries. ==== diff --git a/core/recommendations/core/REC_process-list-next-2.adoc b/core/recommendations/core/REC_process-list-next-2.adoc index 3d192a2d..d83d1520 100644 --- a/core/recommendations/core/REC_process-list-next-2.adoc +++ b/core/recommendations/core/REC_process-list-next-2.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/next-2 -label:: /rec/core/next-2 Dereferencing a next page link (relation: `next`) SHOULD return additional process summaries from the set of selected process summaries that have not yet been returned. ==== diff --git a/core/recommendations/core/REC_process-list-next-3.adoc b/core/recommendations/core/REC_process-list-next-3.adoc index 6e43350b..32d9c19a 100644 --- a/core/recommendations/core/REC_process-list-next-3.adoc +++ b/core/recommendations/core/REC_process-list-next-3.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/next-3 -label:: /rec/core/next-3 The number of process summaries in a response to dereferencing a next page link (relation: `next`) SHOULD follow the same rules as for the response to the original query and again include a next page link (relation: `next`), if there are more process summaries in the selection that have not yet been returned. ==== diff --git a/core/recommendations/core/REC_test-process.adoc b/core/recommendations/core/REC_test-process.adoc index 8f3a872a..a61f226c 100644 --- a/core/recommendations/core/REC_test-process.adoc +++ b/core/recommendations/core/REC_test-process.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/core/test-process -label:: /rec/core/test-process If a server implementing the OGC API - Processes - Part 1: Core is tested using CITE tests, the server SHOULD offer one of the following options: diff --git a/core/recommendations/html/PER_media-types.adoc b/core/recommendations/html/PER_media-types.adoc index e773d74a..abefc750 100644 --- a/core/recommendations/html/PER_media-types.adoc +++ b/core/recommendations/html/PER_media-types.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/html/media-types -label:: /per/html/media-types A HTML media type may be further qualified with additional subtype, suffix and parameter components. For example, `test/html; charset=UTF-8`. ==== diff --git a/core/recommendations/job-list/PER_jl-limit-default-minimum-maximum.adoc b/core/recommendations/job-list/PER_jl-limit-default-minimum-maximum.adoc index c511941d..fc22d0f6 100644 --- a/core/recommendations/job-list/PER_jl-limit-default-minimum-maximum.adoc +++ b/core/recommendations/job-list/PER_jl-limit-default-minimum-maximum.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/job-list/limit-default-minimum-maximum -label:: /per/job-list/limit-default-minimum-maximum -part:: The values for `minimum`, `maximum` and `default` in requirement `/req/job-list/limit-definition` are only examples and MAY be changed. +The values for `minimum`, `maximum` and `default` in requirement `/req/job-list/limit-definition` are only examples and MAY be changed. ==== diff --git a/core/recommendations/job-list/PER_jl-limit-response.adoc b/core/recommendations/job-list/PER_jl-limit-response.adoc index d2330e7f..5071d19d 100644 --- a/core/recommendations/job-list/PER_jl-limit-response.adoc +++ b/core/recommendations/job-list/PER_jl-limit-response.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/job-list/limit-response -label:: /per/job-list/limit-response -part:: The server MAY return fewer jobs than requested (but not more). +The server MAY return fewer jobs than requested (but not more). ==== diff --git a/core/recommendations/job-list/PER_prev.adoc b/core/recommendations/job-list/PER_prev.adoc index 8ba0a888..aa501b3b 100644 --- a/core/recommendations/job-list/PER_prev.adoc +++ b/core/recommendations/job-list/PER_prev.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/job-list/prev -label:: /per/job-list/prev -part:: A response to dereferencing a next page link (relation: `next`) MAY include a previous page link (relation: `prev`) to the resource that included the next page link (relation: `next`). +A response to dereferencing a next page link (relation: `next`) MAY include a previous page link (relation: `prev`) to the resource that included the next page link (relation: `next`). ==== diff --git a/core/recommendations/job-list/REC_access-control-job-list.adoc b/core/recommendations/job-list/REC_access-control-job-list.adoc index 1bd88af6..3f5a8608 100644 --- a/core/recommendations/job-list/REC_access-control-job-list.adoc +++ b/core/recommendations/job-list/REC_access-control-job-list.adoc @@ -2,7 +2,6 @@ ==== [%metadata] identifier:: /rec/job-list/access-control-job-list -label:: /rec/job-list/access-control-job-list Servers implementing the conformance class 'Job List' SHOULD have an access control in place for the /jobs endpoint to prevent misuse of job identifiers. ==== diff --git a/core/recommendations/job-list/REC_landing-page.adoc b/core/recommendations/job-list/REC_landing-page.adoc index 019095ac..927f6b60 100644 --- a/core/recommendations/job-list/REC_landing-page.adoc +++ b/core/recommendations/job-list/REC_landing-page.adoc @@ -3,9 +3,8 @@ ==== [%metadata] identifier:: /rec/job-list/job-list-landing-page -label:: /rec/job-list/job-list-landing-page A link to the following resource SHOULD be added to the API landing page: -/jobs (relation type 'http://www.opengis.net/def/rel/ogc/1.0/job-list') +/jobs (relation type 'https://www.opengis.net/def/rel/ogc/1.0/job-list') ==== diff --git a/core/recommendations/job-list/REC_next-1.adoc b/core/recommendations/job-list/REC_next-1.adoc index c5681bb6..685314fb 100644 --- a/core/recommendations/job-list/REC_next-1.adoc +++ b/core/recommendations/job-list/REC_next-1.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/job-list/next-1 -label:: /rec/job-list/next-1 If more jobs have been selected than returned in the respose, a `200`-response SHOULD include a link to the next page (relation: `next`) of jobs. ==== diff --git a/core/recommendations/job-list/REC_next-2.adoc b/core/recommendations/job-list/REC_next-2.adoc index 317099d5..0073a8c5 100644 --- a/core/recommendations/job-list/REC_next-2.adoc +++ b/core/recommendations/job-list/REC_next-2.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/job-list/next-2 -label:: /rec/job-list/next-2 Dereferencing a next page link (relation: `next`) SHOULD return additional jobs from the set of selected jobs that have not yet been returned. ==== diff --git a/core/recommendations/job-list/REC_next-3.adoc b/core/recommendations/job-list/REC_next-3.adoc index 2806ae15..241132d1 100644 --- a/core/recommendations/job-list/REC_next-3.adoc +++ b/core/recommendations/job-list/REC_next-3.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/job-list/next-3 -label:: /rec/job-list/next-3 If there are more jobs in the selection that have not yet been returned, the number of jobs in a response to dereferencing a next page link (relation: `next`) SHOULD follow the same rules as for the response to the original query and again include a next page link (relation: `next`). ==== diff --git a/core/recommendations/json/PER_media-types.adoc b/core/recommendations/json/PER_media-types.adoc index c47ef4b2..ee50bc09 100644 --- a/core/recommendations/json/PER_media-types.adoc +++ b/core/recommendations/json/PER_media-types.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /per/json/media-types -label:: /per/json/media-types A JSON media type may be further qualified with additional subtype, suffix and parameter components. For example, `application/ld+json; charset=UTF-8`. ==== diff --git a/core/recommendations/kvp-execute/PER_boolean-input-value.adoc b/core/recommendations/kvp-execute/PER_boolean-input-value.adoc index 7187dc29..4b6552f9 100644 --- a/core/recommendations/kvp-execute/PER_boolean-input-value.adoc +++ b/core/recommendations/kvp-execute/PER_boolean-input-value.adoc @@ -3,9 +3,15 @@ ==== [%metadata] identifier:: /per/kvp-execute/boolean-input-value -label:: /per/kvp-execute/boolean-input-value -part:: The characteristics of a boolean-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2[`enum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.3[`const`]) that apply to any type. +[.component,class=part] +-- +The characteristics of a boolean-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2[`enum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.3[`const`]) that apply to any type. +-- + +[.component,class=part] +-- +The characteristics definition of a boolean-valued input parameter MAY include https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9[basic meta-data annotations] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.1[`title` and `description`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.2[`default`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3[`deprecated`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4[`readOnly`, `writeOnly`] and https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.5[`examples`]. +-- -part:: The characteristics definition of a boolean-valued input parameter MAY include https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9[basic meta-data annotations] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.1[`title` and `description`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.2[`default`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3[`deprecated`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4[`readOnly`, `writeOnly`] and https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.5[`examples`]. ==== diff --git a/core/recommendations/kvp-execute/PER_complex-input-value.adoc b/core/recommendations/kvp-execute/PER_complex-input-value.adoc index fb0299eb..3bfb47b3 100644 --- a/core/recommendations/kvp-execute/PER_complex-input-value.adoc +++ b/core/recommendations/kvp-execute/PER_complex-input-value.adoc @@ -3,11 +3,20 @@ ==== [%metadata] identifier:: /per/kvp-execute/complex-input-value -label:: /per/kvp-execute/complex-input-value -part:: The characteristics of a complex-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8[keywords for string-encoded data] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.3[`contentEncoding`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.5[`contentMediaType`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.6[`contentSchema`]). +[.component,class=part] +-- +The characteristics of a complex-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8[keywords for string-encoded data] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.3[`contentEncoding`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.5[`contentMediaType`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.6[`contentSchema`]). +-- -part:: The characteristics of a complex-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2[`enum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.3[`const`]) that apply to any type. +[.component,class=part] +-- +The characteristics of a complex-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2[`enum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.3[`const`]) that apply to any type. +-- + +[.component,class=part] +-- +The characteristics of a complex-valued input parameter MAY include https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9[basic meta-data annotations] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.1[`title` and `description`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.2[`default`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3[`deprecated`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4[`readOnly`, `writeOnly`] and https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.5[`examples`]. +-- -part:: The characteristics of a complex-valued input parameter MAY include https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9[basic meta-data annotations] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.1[`title` and `description`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.2[`default`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3[`deprecated`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4[`readOnly`, `writeOnly`] and https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.5[`examples`]. ==== diff --git a/core/recommendations/kvp-execute/PER_numeric-input-value.adoc b/core/recommendations/kvp-execute/PER_numeric-input-value.adoc index 8c47bdad..7fd2ec47 100644 --- a/core/recommendations/kvp-execute/PER_numeric-input-value.adoc +++ b/core/recommendations/kvp-execute/PER_numeric-input-value.adoc @@ -3,11 +3,20 @@ ==== [%metadata] identifier:: /per/kvp-execute/numeric-input-value -label:: /per/kvp-execute/numeric-input-value -part:: The characteristics of a numeric input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1[`multipleOf`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2[`maximum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.3[`exclusiveMaximum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4[`minimum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.5[`exclusiveMinimum`]). +[.component,class=part] +-- +The characteristics of a numeric input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1[`multipleOf`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2[`maximum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.3[`exclusiveMaximum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4[`minimum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.5[`exclusiveMinimum`]). +-- -part:: The characteristics of a numeric input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2[`enum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2[`const`]) that apply to any type. +[.component,class=part] +-- +The characteristics of a numeric input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2[`enum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2[`const`]) that apply to any type. +-- + +[.component,class=part] +-- +The characteristics of a numeric input parameter MAY include https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9[basic meta-data annotations] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.1[`title`, `description`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.2[`default`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3[`deprecated`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4[`readOnly`, `writeOnly`] and https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.5[`examples`]). +-- -part:: The characteristics of a numeric input parameter MAY include https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9[basic meta-data annotations] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.1[`title`, `description`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.2[`default`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3[`deprecated`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4[`readOnly`, `writeOnly`] and https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.5[`examples`]). ==== diff --git a/core/recommendations/kvp-execute/PER_string-input-value.adoc b/core/recommendations/kvp-execute/PER_string-input-value.adoc index a21f3a3b..e135d161 100644 --- a/core/recommendations/kvp-execute/PER_string-input-value.adoc +++ b/core/recommendations/kvp-execute/PER_string-input-value.adoc @@ -3,15 +3,30 @@ ==== [%metadata] identifier:: /per/kvp-execute/string-input-value -label:: /per/kvp-execute/string-input-value -part:: The characteristics of a string-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1[`maxLength`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2[`minLength`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3[`pattern`]). +[.component,class=part] +-- +The characteristics of a string-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1[`maxLength`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2[`minLength`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3[`pattern`]). +-- -part:: The characteristics of a string-valued input parameter MAY include the https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-7[`format`] validation keyword. +[.component,class=part] +-- +The characteristics of a string-valued input parameter MAY include the https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-7[`format`] validation keyword. +-- -part:: The characteristics of a string-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8[keywords for string-encoded data] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.3[`contentEncoding`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.5[`contentMediaType`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.6[`contentSchema`]). +[.component,class=part] +-- +The characteristics of a string-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8[keywords for string-encoded data] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.3[`contentEncoding`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.5[`contentMediaType`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.6[`contentSchema`]). +-- -part:: The characteristics of a string-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2[`enum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.3[`const`]) that apply to any type. +[.component,class=part] +-- +The characteristics of a string-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2[`enum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.3[`const`]) that apply to any type. +-- + +[.component,class=part] +-- +The characteristics of a string-valued input parameter MAY include https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9[basic meta-data annotations] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.1[`title` and `description`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.2[`default`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3[`deprecated`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4[`readOnly`, `writeOnly`] and https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.5[`examples`]. +-- -part:: The characteristics of a string-valued input parameter MAY include https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9[basic meta-data annotations] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.1[`title` and `description`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.2[`default`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3[`deprecated`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4[`readOnly`, `writeOnly`] and https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.5[`examples`]. ==== diff --git a/core/recommendations/ogc-process-description/PER_extend-data-access-apis-values.adoc b/core/recommendations/ogc-process-description/PER_extend-data-access-apis-values.adoc index 9e894e4b..70a3093e 100644 --- a/core/recommendations/ogc-process-description/PER_extend-data-access-apis-values.adoc +++ b/core/recommendations/ogc-process-description/PER_extend-data-access-apis-values.adoc @@ -3,10 +3,6 @@ ==== [%metadata] identifier:: /per/ogc-process-description/extend-data-access-apis-values -label:: /per/ogc-process-description/extend-data-access-apis-values -[.component,class=part] --- The list of values for the `dataAccessApi` paramater MAY be extended as necessary to accomondate other, perhaps even non_OGC, data access APIs. --- ==== diff --git a/core/recommendations/ogc-process-description/REC_format-key.adoc b/core/recommendations/ogc-process-description/REC_format-key.adoc index 8a9d9e3c..50c79fe1 100644 --- a/core/recommendations/ogc-process-description/REC_format-key.adoc +++ b/core/recommendations/ogc-process-description/REC_format-key.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/ogc-process-description/format-key -label:: /rec/ogc-process-description/format-key Servers SHOULD use the `format` key in the schema description of a process input or output (key: `schema`) to provide additional semantic context that can aid in the interpretation and validation of process input or output values in an <> request. ==== diff --git a/core/recommendations/ogc-process-description/REC_format-short-code.adoc b/core/recommendations/ogc-process-description/REC_format-short-code.adoc index a90295c3..07659253 100644 --- a/core/recommendations/ogc-process-description/REC_format-short-code.adoc +++ b/core/recommendations/ogc-process-description/REC_format-short-code.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/ogc-process-description/format-short-code -label:: /rec/ogc-process-description/format-short-code In addition to the key values listed in <>, servers SHOULD also accept the short codes. ==== diff --git a/core/recommendations/ogc-process-description/REC_format-value-registration.adoc b/core/recommendations/ogc-process-description/REC_format-value-registration.adoc index 84996afa..87b7cb5d 100644 --- a/core/recommendations/ogc-process-description/REC_format-value-registration.adoc +++ b/core/recommendations/ogc-process-description/REC_format-value-registration.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/ogc-process-description/format-value-registration -label:: /rec/ogc-process-description/format-value-registration Servers wishing to extend this list of `format` key values, SHOULD officially register such values with the https://www.ogc.org/ogcna[OGC Naming Authority]. ==== diff --git a/core/recommendations/ogc-process-description/REC_links.adoc b/core/recommendations/ogc-process-description/REC_links.adoc index 8242f5ab..7921726b 100644 --- a/core/recommendations/ogc-process-description/REC_links.adoc +++ b/core/recommendations/ogc-process-description/REC_links.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /rec/ogc-process-description/process-links -label:: /rec/ogc-process-description/process-links [.component,class=part] -- diff --git a/core/recommendations/query-param-profile/PER_default.adoc b/core/recommendations/query-param-profile/PER_default.adoc index 53962d86..4227dc1d 100644 --- a/core/recommendations/query-param-profile/PER_default.adoc +++ b/core/recommendations/query-param-profile/PER_default.adoc @@ -3,5 +3,6 @@ ==== [%metadata] identifier:: /per/query-param-profile/default -part:: The server MAY specify a default value for the query parameter "profile". + +The server MAY specify a default value for the query parameter "profile". ==== diff --git a/core/recommendations/query-param-profile/PER_profiles-of-media-type.adoc b/core/recommendations/query-param-profile/PER_profiles-of-media-type.adoc index ac3736d3..c3c682be 100644 --- a/core/recommendations/query-param-profile/PER_profiles-of-media-type.adoc +++ b/core/recommendations/query-param-profile/PER_profiles-of-media-type.adoc @@ -3,6 +3,15 @@ ==== [%metadata] identifier:: /per/query-param-profile/profiles-of-media-type -part:: For any media type that can represent a resource, the server MAY support only a subset of the profiles offered for the resource. -part:: The subset of supported profiles for a media type MAY be empty, too. + +[.component,class=part] +-- +For any media type that can represent a resource, the server MAY support only a subset of the profiles offered for the resource. +-- + +[.component,class=part] +-- +The subset of supported profiles for a media type MAY be empty, too. +-- + ==== diff --git a/core/recommendations/query-param-profile/REC_link-header.adoc b/core/recommendations/query-param-profile/REC_link-header.adoc index 6eae85c3..5c192384 100644 --- a/core/recommendations/query-param-profile/REC_link-header.adoc +++ b/core/recommendations/query-param-profile/REC_link-header.adoc @@ -3,5 +3,6 @@ ==== [%metadata] identifier:: /rec/query-param-profile/link-header -part:: The response SHOULD include links to the selected profile(s) in the HTTP response headers. + +The response SHOULD include links to the selected profile(s) in the HTTP response headers. ==== diff --git a/core/recommendations/query-param-profile/REC_negotiation.adoc b/core/recommendations/query-param-profile/REC_negotiation.adoc index b9727402..f811a144 100644 --- a/core/recommendations/query-param-profile/REC_negotiation.adoc +++ b/core/recommendations/query-param-profile/REC_negotiation.adoc @@ -3,6 +3,15 @@ ==== [%metadata] identifier:: /rec/query-param-profile/negotiation -part:: If the server supports one or more of the requested profile(s) for the media type and resource, these profiles SHOULD be used for the response. -part:: The profile negotiation SHOULD NOT result in an error, e.g., because a requested profile cannot be provided. + +[.component,class=part] +-- +If the server supports one or more of the requested profile(s) for the media type and resource, these profiles SHOULD be used for the response. +-- + +[.component,class=part] +-- +The profile negotiation SHOULD NOT result in an error, e.g., because a requested profile cannot be provided. +-- + ==== diff --git a/core/requirements/callback/REQ_process-execute-callback.adoc b/core/requirements/callback/REQ_process-execute-callback.adoc index abe837b4..19af45c0 100644 --- a/core/requirements/callback/REQ_process-execute-callback.adoc +++ b/core/requirements/callback/REQ_process-execute-callback.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/callback/job-callback -label:: /req/callback/job-callback [.component,class=part] -- @@ -21,4 +20,5 @@ The schema of the `subscriber` element of the <> r include::../../../openapi/schemas/processes-core/subscriber.yaml[] -- + ==== diff --git a/core/requirements/collection-input/REQ_collection-input_access.adoc b/core/requirements/collection-input/REQ_collection-input_access.adoc index 4a96e436..3c0038bb 100644 --- a/core/requirements/collection-input/REQ_collection-input_access.adoc +++ b/core/requirements/collection-input/REQ_collection-input_access.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/collection-input/collection-access -label:: /req/collection-input/collection-access [.component,class=description] -- @@ -19,6 +18,10 @@ The server SHALL support accessing <> us -- The server SHALL, in the <> and for each relevant input, indicate which <> can be used to retrive input values for that input from the <>. -- + ==== -NOTE: For <>, the specification is agnostic to how data flows from the <> to the process. +[NOTE] +==== +For <>, the specification is agnostic to how data flows from the <> to the process. +==== diff --git a/core/requirements/collection-input/REQ_collection-input_filtering.adoc b/core/requirements/collection-input/REQ_collection-input_filtering.adoc index 4de511dc..2fc8f20d 100644 --- a/core/requirements/collection-input/REQ_collection-input_filtering.adoc +++ b/core/requirements/collection-input/REQ_collection-input_filtering.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/collection-input/filtering -label:: /req/collection-input/filtering [.component,class=description] -- diff --git a/core/requirements/collection-input/REQ_collection-input_pass-through.adoc b/core/requirements/collection-input/REQ_collection-input_pass-through.adoc index 6c3d745f..e64a7d25 100644 --- a/core/requirements/collection-input/REQ_collection-input_pass-through.adoc +++ b/core/requirements/collection-input/REQ_collection-input_pass-through.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/collection-input/pass-through -label:: /req/collection-input/pass-through [.component,class=description] -- @@ -18,6 +17,7 @@ The server SHALL support the following parameters: as defined in the <> schema. -- + ==== diff --git a/core/requirements/collection-input/REQ_collection-input_property-selection.adoc b/core/requirements/collection-input/REQ_collection-input_property-selection.adoc index 62951c98..11110ebb 100644 --- a/core/requirements/collection-input/REQ_collection-input_property-selection.adoc +++ b/core/requirements/collection-input/REQ_collection-input_property-selection.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/collection-input/property-selection -label:: /req/collection-input/property-selection [.component,class=description] -- diff --git a/core/requirements/collection-input/REQ_collection-input_referencing.adoc b/core/requirements/collection-input/REQ_collection-input_referencing.adoc index 7390ae34..eba5fa83 100644 --- a/core/requirements/collection-input/REQ_collection-input_referencing.adoc +++ b/core/requirements/collection-input/REQ_collection-input_referencing.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/collection-input/referencing -label:: /req/collection-input/referencing .component,class=description] -- @@ -32,8 +31,6 @@ The server SHALL interpret Relative-URIs as relative to the parent process withi ==== -NOTE: PAV: The last part of this requirement is not clear to me. - [[collection-value-schema]] .Schema for the collection parameter [source,yaml] diff --git a/core/requirements/collection-output/REQ_collection-output_data-access-mechanisms.adoc b/core/requirements/collection-output/REQ_collection-output_data-access-mechanisms.adoc index 891ee5e2..65e098cb 100644 --- a/core/requirements/collection-output/REQ_collection-output_data-access-mechanisms.adoc +++ b/core/requirements/collection-output/REQ_collection-output_data-access-mechanisms.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/collection-output/data-access-mechanisms -label:: /req/collection-output/data-access-mechanisms [.component,class=description] -- @@ -14,6 +13,7 @@ For returning resulting output data as a response to <> corresponding to the data access links included in the target <>. -- + ==== diff --git a/core/requirements/collection-output/REQ_collection-output_response-def.adoc b/core/requirements/collection-output/REQ_collection-output_response-def.adoc index 2e0b59ef..80a0293d 100644 --- a/core/requirements/collection-output/REQ_collection-output_response-def.adoc +++ b/core/requirements/collection-output/REQ_collection-output_response-def.adoc @@ -3,10 +3,7 @@ ==== [%metadata] identifier:: /req/collection-output/response-definition -label:: /req/collection-output/response-definition -[.component,class=part] --- The server SHALL, at the execution endpoint (path: `/processes/{processId}/execution`), support a parameter `response` with the following characteristics (using an OpenAPI Specification fragment): [source,yaml] @@ -18,5 +15,4 @@ schema: type: string enum: [ collection ] ---- --- ==== diff --git a/core/requirements/collection-output/REQ_collection-output_response-response-many.adoc b/core/requirements/collection-output/REQ_collection-output_response-response-many.adoc index 20c5f738..1cfab5b5 100644 --- a/core/requirements/collection-output/REQ_collection-output_response-response-many.adoc +++ b/core/requirements/collection-output/REQ_collection-output_response-response-many.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/collection-output/response-response-many -label:: /req/collection-output/response-response-many [.component,class=conditions] -- @@ -31,4 +30,5 @@ The content of response SHALL conform to the <> sch -- Each collection output in the response SHALL be a link to a <>. -- + ==== diff --git a/core/requirements/collection-output/REQ_collection-output_response-response-one.adoc b/core/requirements/collection-output/REQ_collection-output_response-response-one.adoc index 5018d29c..54518678 100644 --- a/core/requirements/collection-output/REQ_collection-output_response-response-one.adoc +++ b/core/requirements/collection-output/REQ_collection-output_response-response-one.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/collection-output/response-response-one -label:: /req/collection-output/response-response-one [.component,class=conditions] -- @@ -21,4 +20,5 @@ The server SHALL response with an HTTP status code of https://datatracker.ietf.o -- The response SHALL include a https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.2[`Location`] response header redirecting to a <>. -- + ==== diff --git a/core/requirements/core/REQ_api-definition-op.adoc b/core/requirements/core/REQ_api-definition-op.adoc index 7dd2af50..0386d7a6 100644 --- a/core/requirements/core/REQ_api-definition-op.adoc +++ b/core/requirements/core/REQ_api-definition-op.adoc @@ -3,8 +3,6 @@ ==== [%metadata] identifier:: /req/core/api-definition-op -label:: /req/core/api-definition-op -The URIs of all API definitions referenced from the landing page -SHALL support the HTTP GET method. +The URIs of all API definitions referenced from the landing page SHALL support the HTTP GET method. ==== diff --git a/core/requirements/core/REQ_api-definition-success.adoc b/core/requirements/core/REQ_api-definition-success.adoc index 90755aa8..c938321c 100644 --- a/core/requirements/core/REQ_api-definition-success.adoc +++ b/core/requirements/core/REQ_api-definition-success.adoc @@ -3,10 +3,15 @@ ==== [%metadata] identifier:: /req/core/api-definition-success -label:: /req/core/api-definition-success -A successful execution of the operation to get the API definition document SHALL be reported as a -response with a HTTP status code `200`. +[.component,class=part] +-- +A successful execution of the operation to get the API definition document SHALL be reported as a response with a HTTP status code `200`. +-- +[.component,class=part] +-- The server SHALL return an API definition document. +-- + ==== diff --git a/core/requirements/core/REQ_conformance-op.adoc b/core/requirements/core/REQ_conformance-op.adoc index f70a0426..7cd27367 100644 --- a/core/requirements/core/REQ_conformance-op.adoc +++ b/core/requirements/core/REQ_conformance-op.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/conformance-op -label:: /req/core/conformance-op The server SHALL support the HTTP GET operation at the path `/conformance`. ==== diff --git a/core/requirements/core/REQ_conformance-success.adoc b/core/requirements/core/REQ_conformance-success.adoc index 8c786530..d2a7a91e 100644 --- a/core/requirements/core/REQ_conformance-success.adoc +++ b/core/requirements/core/REQ_conformance-success.adoc @@ -3,10 +3,15 @@ ==== [%metadata] identifier:: /req/core/conformance-success -label:: /req/core/conformance-success -A successful execution of the operation SHALL be reported as a response with a -HTTP status code `200`. +[.component,class=part] +-- +A successful execution of the operation SHALL be reported as a response with a HTTP status code `200`. +-- +[.component,class=part] +-- The content of that response SHALL be based upon the OpenAPI 3.0 schema link:https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/confClasses.yaml[req-classes.yaml] and list all OGC API - Processes conformance classes that an implementation of the Processes API conforms to. +-- + ==== diff --git a/core/requirements/core/REQ_http.adoc b/core/requirements/core/REQ_http.adoc index ca3c27f8..b37076fd 100644 --- a/core/requirements/core/REQ_http.adoc +++ b/core/requirements/core/REQ_http.adoc @@ -3,10 +3,15 @@ ==== [%metadata] identifier:: /req/core/http -label:: /req/core/http +[.component,class=part] +-- The server SHALL conform to <>. +-- + +[.component,class=part] +-- +If the server supports HTTPS, the server SHALL also conform to <>. +-- -If the server supports HTTPS, the server SHALL also conform to -<>. ==== diff --git a/core/requirements/core/REQ_job-exception-no-such-job.adoc b/core/requirements/core/REQ_job-exception-no-such-job.adoc index a5d78597..b0e410f7 100644 --- a/core/requirements/core/REQ_job-exception-no-such-job.adoc +++ b/core/requirements/core/REQ_job-exception-no-such-job.adoc @@ -3,10 +3,20 @@ ==== [%metadata] identifier:: /req/core/job-exception-no-such-job -label:: /req/core/job-exception-no-such-job +[.component,class=part] +-- If the operation is executed using an invalid job identifier, the response SHALL have HTTP status code 404. -The content of that response SHALL be based upon the OpenAPI -3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/exception.yaml[exception.yaml]. -The `type` of the exception SHALL be "http://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/no-such-job". +-- + +[.component,class=part] +-- +The content of that response SHALL be based upon the OpenAPI 3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/exception.yaml[exception.yaml]. +-- + +[.component,class=part] +-- +The `type` of the exception SHALL be "https://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/no-such-job". +-- + ==== diff --git a/core/requirements/core/REQ_job-op.adoc b/core/requirements/core/REQ_job-op.adoc index 3e04e98c..081b73af 100644 --- a/core/requirements/core/REQ_job-op.adoc +++ b/core/requirements/core/REQ_job-op.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/job-op -label:: /req/core/job-op The server SHALL support the HTTP GET operation at the path `/jobs/{jobID}`. ==== diff --git a/core/requirements/core/REQ_job-result-op.adoc b/core/requirements/core/REQ_job-result-op.adoc index dcb51a3f..61b3fd34 100644 --- a/core/requirements/core/REQ_job-result-op.adoc +++ b/core/requirements/core/REQ_job-result-op.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/job-result-op -label:: /req/core/job-result-op For each output, with output identifier `outputID`, defined in the <> and requested (whether <> or <>) in an <>, the server SHALL support the HTTP GET operation at the path `/jobs/{jobID}/results/{outputID}`. ==== diff --git a/core/requirements/core/REQ_job-results-exception-invalid-query-parameter-value.adoc b/core/requirements/core/REQ_job-results-exception-invalid-query-parameter-value.adoc index feb1dc81..176325de 100644 --- a/core/requirements/core/REQ_job-results-exception-invalid-query-parameter-value.adoc +++ b/core/requirements/core/REQ_job-results-exception-invalid-query-parameter-value.adoc @@ -2,11 +2,21 @@ [requirement] ==== [%metadata] -identifier:: /req/core/job-results-exception/invalid-query-parameter-value -label:: /req/core/job-results-exception/invalid-query-parameter-value +identifier:: /req/core/job-results-exception-invalid-query-parameter-value +[.component,class=part] +-- If the operation is executed using an invalid query parameter value, the response SHALL have HTTP status code 400. -The content of that response SHALL be based upon the OpenAPI -3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/exception.yaml[exception.yaml]. -The `type` of the exception SHALL be "http://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/invalid-query-parameter-value". +-- + +[.component,class=part] +-- +The content of that response SHALL be based upon the OpenAPI 3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/exception.yaml[exception.yaml]. +-- + +[.component,class=part] +-- +The `type` of the exception SHALL be "https://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/invalid-query-parameter-value". +-- + ==== diff --git a/core/requirements/core/REQ_job-results-exception-no-such-job.adoc b/core/requirements/core/REQ_job-results-exception-no-such-job.adoc index 2353074f..528c44f4 100644 --- a/core/requirements/core/REQ_job-results-exception-no-such-job.adoc +++ b/core/requirements/core/REQ_job-results-exception-no-such-job.adoc @@ -3,17 +3,10 @@ ==== [%metadata] identifier:: /req/core/job-results-exception-no-such-job -label:: /req/core/job-results-exception-no-such-job - - -[.component,class=conditions] --- -.The endpoint is requested using an invalid job identifier `jobID`. --- [.component,class=part] -- -The response SHALL have HTTP status code 404. +If the operation is executed using an invalid job identifier, the response SHALL have HTTP status code 404. -- [.component,class=part] @@ -23,6 +16,7 @@ The content of that response SHALL be based upon the OpenAPI 3.0 schema https:// [.component,class=part] -- -The `type` of the exception SHALL be "http://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/no-such-job". +The `type` of the exception SHALL be "https://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/no-such-job". -- + ==== diff --git a/core/requirements/core/REQ_job-results-exception-results-not-available.adoc b/core/requirements/core/REQ_job-results-exception-results-not-available.adoc index 3c18d401..214966be 100644 --- a/core/requirements/core/REQ_job-results-exception-results-not-available.adoc +++ b/core/requirements/core/REQ_job-results-exception-results-not-available.adoc @@ -2,9 +2,7 @@ [requirement] ==== [%metadata] -identifier:: /req/core/job-results-exception/results-not-available -label:: /req/core/job-results-exception/results-not-available - +identifier:: /req/core/job-results-exception-results-not-available [.component,class=conditions] -- @@ -24,8 +22,9 @@ The content of that response SHALL be based upon the OpenAPI 3.0 schema https:// [.component,class=part] -- -The `type` of the exception SHALL be "http://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/result-not-available". +The `type` of the exception SHALL be "https://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/result-not-available". -- + ==== diff --git a/core/requirements/core/REQ_job-results-exception-results-not-ready.adoc b/core/requirements/core/REQ_job-results-exception-results-not-ready.adoc index 46e916f3..ccc62237 100644 --- a/core/requirements/core/REQ_job-results-exception-results-not-ready.adoc +++ b/core/requirements/core/REQ_job-results-exception-results-not-ready.adoc @@ -2,12 +2,11 @@ [requirement] ==== [%metadata] -identifier:: /req/core/job-results-exception/results-not-ready -label:: /req/core/job-results-exception/results-not-ready +identifier:: /req/core/job-results-exception-results-not-ready [.component,class=conditions] -- -. The request is execute on a running job with valid job identifier `jobID`. +. The request is executed on a running job with valid job identifier `jobID`. -- [.component,class=part] @@ -22,6 +21,7 @@ The content of that response SHALL be based upon the OpenAPI 3.0 schema https:// [.component,class=part] -- -The `type` of the exception SHALL be "http://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/result-not-ready". +The `type` of the exception SHALL be "https://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/result-not-ready". -- + ==== diff --git a/core/requirements/core/REQ_job-results-failed.adoc b/core/requirements/core/REQ_job-results-failed.adoc index 0e459ce6..09c867d2 100644 --- a/core/requirements/core/REQ_job-results-failed.adoc +++ b/core/requirements/core/REQ_job-results-failed.adoc @@ -3,7 +3,20 @@ ==== [%metadata] identifier:: /req/core/job-results-failed -label:: /req/core/job-results-failed -If the operation is executed on a failed job using a valid job identifier, the response SHALL have a HTTP error code that corresponds to the reason for the failure. The content of that response SHALL be based upon the OpenAPI 3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/exception.yaml[exception.yaml]. The `type` of the exception SHALL correspond to the reason of the failure, e.g. InvalidParameterValue for invalid input data. +[.component,class=part] +-- +If the operation is executed on a failed job using a valid job identifier, the response SHALL have a HTTP error code that corresponds to the reason for the failure. +-- + +[.component,class=part] +-- +The content of that response SHALL be based upon the OpenAPI 3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/exception.yaml[exception.yaml]. +-- + +[.component,class=part] +-- +The `type` of the exception SHALL correspond to the reason of the failure, e.g. InvalidParameterValue for invalid input data. +-- + ==== diff --git a/core/requirements/core/REQ_job-results-op.adoc b/core/requirements/core/REQ_job-results-op.adoc index aa730083..3253856d 100644 --- a/core/requirements/core/REQ_job-results-op.adoc +++ b/core/requirements/core/REQ_job-results-op.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/job-results-op -label:: /req/core/job-results-op The server SHALL support the HTTP GET operation at the path `/jobs/{jobID}/results`. ==== diff --git a/core/requirements/core/REQ_job-results-param-outputs-response.adoc b/core/requirements/core/REQ_job-results-param-outputs-response.adoc index e094bade..c193427d 100644 --- a/core/requirements/core/REQ_job-results-param-outputs-response.adoc +++ b/core/requirements/core/REQ_job-results-param-outputs-response.adoc @@ -3,10 +3,6 @@ ==== [%metadata] identifier:: /req/core/job-results-param-outputs-response -label:: /req/core/job-results-param-outputs-response -[.component,class=part] --- -Only the outputs with identifiers specified by the optional `outputs` parameter SHALL be included in the response. --- +Only the outputs with identifers specified using the optional <> SHALL be included in the response. ==== diff --git a/core/requirements/core/REQ_job-results-param-outputs.adoc b/core/requirements/core/REQ_job-results-param-outputs.adoc index 87e8e754..cead39ba 100644 --- a/core/requirements/core/REQ_job-results-param-outputs.adoc +++ b/core/requirements/core/REQ_job-results-param-outputs.adoc @@ -3,11 +3,8 @@ ==== [%metadata] identifier:: /req/core/job-results-param-outputs -label:: /req/core/job-results-param-outputs -[.component,class=part] --- -The operation at the `/jobs/{jobID}/results` endpoint SHALL support a query parameter `outputs` with the following characteristics (using an OpenAPI Specification fragment): +The operation at the `/jobs/{jobID}/results` endpoint SHALL support a parameter `outputs` with the following characteristics (using an OpenAPI Specification fragment): [source,yaml] ---- @@ -21,5 +18,4 @@ schema: style: form explode: false ---- --- ==== diff --git a/core/requirements/core/REQ_job-results-success-async-many.adoc b/core/requirements/core/REQ_job-results-success-async-many.adoc index 1ab68585..147228c8 100644 --- a/core/requirements/core/REQ_job-results-success-async-many.adoc +++ b/core/requirements/core/REQ_job-results-success-async-many.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/job-results-async-many -label:: /req/core/job-results-async-many [.component,class=conditions] -- diff --git a/core/requirements/core/REQ_job-results-success-async-one.adoc b/core/requirements/core/REQ_job-results-success-async-one.adoc index cfba63c2..109430a0 100644 --- a/core/requirements/core/REQ_job-results-success-async-one.adoc +++ b/core/requirements/core/REQ_job-results-success-async-one.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/job-results-async-one -label:: /req/core/job-results-async-one [.component,class=conditions] -- @@ -26,4 +25,5 @@ The media type of the response SHALL be as negotiated as per the https://datatra -- The content of response body SHALL be the requested process output value in the negotiated output format. -- + ==== diff --git a/core/requirements/core/REQ_job-results-success-sync.adoc b/core/requirements/core/REQ_job-results-success-sync.adoc index 933d3ce9..8762ec93 100644 --- a/core/requirements/core/REQ_job-results-success-sync.adoc +++ b/core/requirements/core/REQ_job-results-success-sync.adoc @@ -3,12 +3,25 @@ ==== [%metadata] identifier:: /req/core/job-results-success-sync -label:: /req/core/job-results-success-sync -conditions:: The server creates a job when a process is executed synchronously. -part:: A successful execution of the operation SHALL include an HTTP https://datatracker.ietf.org/doc/html/rfc8288#section-3[`Link`] header with `rel=monitor` pointing to the created job. +[.component,class=conditions] +-- +. The server creates a job when a process is executed synchronously. +-- -part:: When resolving the `rel=monitor` link, the content type of response SHALL be `application/json`. +[.component,class=part] +-- +A successful execution of the operation SHALL include an HTTP https://datatracker.ietf.org/doc/html/rfc8288#section-3[`Link`] header with `rel=monitor` pointing to the created job. +-- + +[.component,class=part] +-- +When resolving the `rel=monitor` link, the content type of response SHALL be `application/json`. +-- + +[.component,class=part] +-- +When resolving the `rel=monitor` link, the body of the response SHALL be based upon the JSON schema fragment https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[statusInfo.yaml]. +-- -part:: When resolving the `rel=monitor` link, the body of the response SHALL be based upon the JSON schema fragment https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[statusInfo.yaml]. ==== diff --git a/core/requirements/core/REQ_job-success.adoc b/core/requirements/core/REQ_job-success.adoc index 86f0ad68..4bb9475f 100644 --- a/core/requirements/core/REQ_job-success.adoc +++ b/core/requirements/core/REQ_job-success.adoc @@ -3,42 +3,40 @@ ==== [%metadata] identifier:: /req/core/job-success -label:: /req/core/job-success [.component,class=part] ---- -A successful execution of the operation SHALL be reported as a -response with a HTTP status code 200. ---- +-- +A successful execution of the operation SHALL be reported as a response with a HTTP status code 200. +-- [.component,class=part] ---- -The content of that response SHALL be based upon the OpenAPI -3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[statusInfo.yaml]. ---- +-- +The content of that response SHALL be based upon the OpenAPI 3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[statusInfo.yaml]. +-- [.component,class=part] ---- +-- The value of the `id` parameter SHALL be the identifier assigned by the server for the job. ---- +-- [.component,class=part] ---- -The value of the `status` parameter SHALL inidicate the state of the job at the time the request is made for the status information. ---- +-- +The value of the `status` parameter SHALL indicate the state of the job at the time the request is made for the status information. +-- [.component,class=part] ---- +-- The value of the `processingEntityType` parameter SHALL indicate the type of server that created the job (e.g. "ogc-api-processes", "openeo", "ogc-api-coverages", etc.). ---- +-- [.component,class=part] ---- +-- The value of the `processingEntityType` parameter SHALL be `ogc-api-processes` to indicate that a server that conforms to this Standard created the job. ---- +-- [.component,class=part] ---- +-- The value of the `processingEntityType` parameter SHALL not change if a different representation of the job status information is requested. ---- +-- + ==== diff --git a/core/requirements/core/REQ_landingpage-op.adoc b/core/requirements/core/REQ_landingpage-op.adoc index 1cc60d9c..20b62da4 100644 --- a/core/requirements/core/REQ_landingpage-op.adoc +++ b/core/requirements/core/REQ_landingpage-op.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/landingpage-op -label:: /req/core/landingpage-op The server SHALL support the HTTP GET operation at the path `/`. ==== diff --git a/core/requirements/core/REQ_landingpage-success.adoc b/core/requirements/core/REQ_landingpage-success.adoc index bcfcd124..4e741f3f 100644 --- a/core/requirements/core/REQ_landingpage-success.adoc +++ b/core/requirements/core/REQ_landingpage-success.adoc @@ -3,15 +3,19 @@ ==== [%metadata] identifier:: /req/core/landingpage-success -label:: /req/core/landingpage-success -A successful execution of the operation SHALL be reported as a response with a -HTTP status code `200`. +[.component,class=part] +-- +A successful execution of the operation SHALL be reported as a response with a HTTP status code `200`. +-- -The content of that response SHALL be based upon the OpenAPI 3.0 schema link:https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/landingPage.yaml[landingPage.yaml] -and include at least links to the following resources: +[.component,class=part] +-- +The content of that response SHALL be based upon the OpenAPI 3.0 schema link:https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/landingPage.yaml[landingPage.yaml] and include at least links to the following resources: * the API definition (relation type 'service-desc' or 'service-doc') -* `/conformance` (relation type 'http://www.opengis.net/def/rel/ogc/1.0/conformance') -* `/processes` (relation type 'http://www.opengis.net/def/rel/ogc/1.0/processes') +* `/conformance` (relation type 'https://www.opengis.net/def/rel/ogc/1.0/conformance') +* `/processes` (relation type 'https://www.opengis.net/def/rel/ogc/1.0/processes') +-- + ==== diff --git a/core/requirements/core/REQ_process-description-op.adoc b/core/requirements/core/REQ_process-description-op.adoc index cf9a43b4..2f96fbb4 100644 --- a/core/requirements/core/REQ_process-description-op.adoc +++ b/core/requirements/core/REQ_process-description-op.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-description-op -label:: /req/core/process-description-op The server SHALL support the HTTP GET operation at the path `/processes/{processID}`. ==== diff --git a/core/requirements/core/REQ_process-description-success.adoc b/core/requirements/core/REQ_process-description-success.adoc index bf18799b..7e00f0e7 100644 --- a/core/requirements/core/REQ_process-description-success.adoc +++ b/core/requirements/core/REQ_process-description-success.adoc @@ -3,8 +3,15 @@ ==== [%metadata] identifier:: /req/core/process-description-success -label:: /req/core/process-description-success -part:: A successful execution of the operation SHALL be reported as a response with a HTTP status code 200. -part:: The content of the response SHALL be a process description. +[.component,class=part] +-- +A successful execution of the operation SHALL be reported as a response with a HTTP status code 200. +-- + +[.component,class=part] +-- +The content of the response SHALL be a process description. +-- + ==== diff --git a/core/requirements/core/REQ_process-exception-no-such-process.adoc b/core/requirements/core/REQ_process-exception-no-such-process.adoc index 5bf1a746..4db0ace5 100644 --- a/core/requirements/core/REQ_process-exception-no-such-process.adoc +++ b/core/requirements/core/REQ_process-exception-no-such-process.adoc @@ -2,11 +2,21 @@ [requirement] ==== [%metadata] -identifier:: /req/core/process-exception/no-such-process -label:: /req/core/process-exception/no-such-process +identifier:: /req/core/process-exception-no-such-process +[.component,class=part] +-- If the operation is executed using an invalid process identifier, the response SHALL be HTTP status code 404. -The content of that response SHALL be based upon the OpenAPI -3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/exception.yaml[exception.yaml]. -The `type` of the exception SHALL be "http://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/no-such-process". +-- + +[.component,class=part] +-- +The content of that response SHALL be based upon the OpenAPI 3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/exception.yaml[exception.yaml]. +-- + +[.component,class=part] +-- +The `type` of the exception SHALL be "https://www.opengis.net/def/exceptions/ogcapi-processes-1/1.0/no-such-process". +-- + ==== diff --git a/core/requirements/core/REQ_process-execute-auto-execution-mode.adoc b/core/requirements/core/REQ_process-execute-auto-execution-mode.adoc index 1172eb22..343ae0f4 100644 --- a/core/requirements/core/REQ_process-execute-auto-execution-mode.adoc +++ b/core/requirements/core/REQ_process-execute-auto-execution-mode.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-auto-execution-mode -label:: /req/core/process-execute-auto-execution-mode [.component,class=conditions] -- @@ -24,4 +23,5 @@ The server SHALL respond synchronously if, according to the job control options -- The server SHALL respond, at its discretion, either synchronously or asynchronously if, according to the job control options in the <>, the process can be executed in either mode. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-default-execution-mode.adoc b/core/requirements/core/REQ_process-execute-default-execution-mode.adoc index e8f0092b..a7fa4c14 100644 --- a/core/requirements/core/REQ_process-execute-default-execution-mode.adoc +++ b/core/requirements/core/REQ_process-execute-default-execution-mode.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-default-execution-mode -label:: /req/core/process-execute-default-execution-mode [.component,class=conditions] -- @@ -24,4 +23,5 @@ The server SHALL respond synchronously if, according to the job control options -- The server SHALL respond synchronously if, according to the job control options in the <>, the process can be executed in either mode. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-input-array.adoc b/core/requirements/core/REQ_process-execute-input-array.adoc index 412740bb..270567c7 100644 --- a/core/requirements/core/REQ_process-execute-input-array.adoc +++ b/core/requirements/core/REQ_process-execute-input-array.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-input-array -label:: /req/core/process-execute-input-array [.component,class=conditions] -- @@ -19,4 +18,5 @@ The server SHALL support process input values encoded as an array. -- This SHALL be true even if the input consists of a single value. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-input-inline-bbox.adoc b/core/requirements/core/REQ_process-execute-input-inline-bbox.adoc index 5cd3327d..dbaffbe4 100644 --- a/core/requirements/core/REQ_process-execute-input-inline-bbox.adoc +++ b/core/requirements/core/REQ_process-execute-input-inline-bbox.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-input-inline-bbox -label:: /req/core/process-execute-input-inline-bbox Servers SHALL support process input values that conform to the <> schema. ==== diff --git a/core/requirements/core/REQ_process-execute-input-inline-binary.adoc b/core/requirements/core/REQ_process-execute-input-inline-binary.adoc index 549746e8..4f6bcfbe 100644 --- a/core/requirements/core/REQ_process-execute-input-inline-binary.adoc +++ b/core/requirements/core/REQ_process-execute-input-inline-binary.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-input-inline-binary -label:: /req/core/process-execute-input-inline-binary [.component,class=conditions] -- @@ -15,4 +14,5 @@ label:: /req/core/process-execute-input-inline-binary -- The service SHALL support binary values encoded as base64-encoded strings. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-input-inline-multiple-types.adoc b/core/requirements/core/REQ_process-execute-input-inline-multiple-types.adoc index 8413a966..1654c0c8 100644 --- a/core/requirements/core/REQ_process-execute-input-inline-multiple-types.adoc +++ b/core/requirements/core/REQ_process-execute-input-inline-multiple-types.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-input-multiple-types -label:: /req/core/process-execute-input-multiple-types [.component,class=conditions] -- @@ -26,4 +25,5 @@ The value of the `value` key SHALL be an instance of <>. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-input-inline-object.adoc b/core/requirements/core/REQ_process-execute-input-inline-object.adoc index 7efdf000..bfd8c7fd 100644 --- a/core/requirements/core/REQ_process-execute-input-inline-object.adoc +++ b/core/requirements/core/REQ_process-execute-input-inline-object.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-input-inline-object -label:: /req/core/process-execute-input-inline-object [.component,class=conditions] -- @@ -20,4 +19,5 @@ The server SHALL support process input values encoded as qualified values (https -- The value of the `value` key SHALL be an _object_ instance of <>. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-input-validation.adoc b/core/requirements/core/REQ_process-execute-input-validation.adoc index 50c132d8..6a720c1d 100644 --- a/core/requirements/core/REQ_process-execute-input-validation.adoc +++ b/core/requirements/core/REQ_process-execute-input-validation.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-input-validation -label:: /req/core/process-execute-input-validation [.component,class=part] -- @@ -14,4 +13,5 @@ For process input values specified in-line in an <>, the server SHALL resolve the value and then validate it as if the value had been specified in-line in the <> (i.e. as per requirement *_A_*). -- + ==== diff --git a/core/requirements/core/REQ_process-execute-op.adoc b/core/requirements/core/REQ_process-execute-op.adoc index a3c18679..d56ae207 100644 --- a/core/requirements/core/REQ_process-execute-op.adoc +++ b/core/requirements/core/REQ_process-execute-op.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-op -label:: /req/core/process-execute-op The server SHALL support the HTTP POST operation at the path `/processes/{processID}/execution`. ==== diff --git a/core/requirements/core/REQ_process-execute-outputs-empty.adoc b/core/requirements/core/REQ_process-execute-outputs-empty.adoc index 32affae5..9ae1d939 100644 --- a/core/requirements/core/REQ_process-execute-outputs-empty.adoc +++ b/core/requirements/core/REQ_process-execute-outputs-empty.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-empty-outputs -label:: /req/core/process-execute-empty-outputs [.component,class=conditions] -- @@ -14,4 +13,5 @@ label:: /req/core/process-execute-empty-outputs -- An empty "outputs" parameter in the <> SHALL indicate that the execution of a process should occur without generating a response body. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-outputs-omitted.adoc b/core/requirements/core/REQ_process-execute-outputs-omitted.adoc index 3509fb50..c60282fc 100644 --- a/core/requirements/core/REQ_process-execute-outputs-omitted.adoc +++ b/core/requirements/core/REQ_process-execute-outputs-omitted.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-omitted-outputs -label:: /req/core/process-execute-omitted-outputs [.component,class=conditions] -- @@ -15,4 +14,5 @@ label:: /req/core/process-execute-omitted-outputs -- Omitting the "outputs" parameter in the <> SHALL be equivalent to explicitly requesting all of the defined outputs of the process. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-request.adoc b/core/requirements/core/REQ_process-execute-request.adoc index 65d54490..e6598a78 100644 --- a/core/requirements/core/REQ_process-execute-request.adoc +++ b/core/requirements/core/REQ_process-execute-request.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-request -label:: /req/core/process-execute-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]. diff --git a/core/requirements/core/REQ_process-execute-success-async-outputs-empty.adoc b/core/requirements/core/REQ_process-execute-success-async-outputs-empty.adoc index cee9e856..67cebc11 100644 --- a/core/requirements/core/REQ_process-execute-success-async-outputs-empty.adoc +++ b/core/requirements/core/REQ_process-execute-success-async-outputs-empty.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-success-async-outputs-empty -label:: /req/core/process-execute-success-async-outputs-empty [.component,class=conditions] -- @@ -18,7 +17,7 @@ The server SHALL asynchoronously execute the process but SHALL not produce any r [.component,class=part] -- -Attempting to retieve any of the process's defined outputs via the `/jobs/{jobID}/results[/{outputID}]` path SHALL result in a response that has HTTP status code 404. +Attempting to retieve any of the process's defined outputs via the `/jobs/{jobID}/results[/{outputID}]` path SHALL result in a HTTP status code 404 response. -- ==== diff --git a/core/requirements/core/REQ_process-execute-success-async-outputs-omitted.adoc b/core/requirements/core/REQ_process-execute-success-async-outputs-omitted.adoc index d1dc0f29..57485704 100644 --- a/core/requirements/core/REQ_process-execute-success-async-outputs-omitted.adoc +++ b/core/requirements/core/REQ_process-execute-success-async-outputs-omitted.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-success-async-outputs-omitted -label:: /req/core/process-execute-success-async-outputs-omitted [.component,class=conditions] -- @@ -15,4 +14,5 @@ label:: /req/core/process-execute-success-async-outputs-omitted -- The server SHALL produce and make available for retrieval all of the outputs defined for the process in its <>. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-success-async-outputs.adoc b/core/requirements/core/REQ_process-execute-success-async-outputs.adoc index 5706a10a..2b2225d1 100644 --- a/core/requirements/core/REQ_process-execute-success-async-outputs.adoc +++ b/core/requirements/core/REQ_process-execute-success-async-outputs.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-success-async-outputs -label:: /req/core/process-execute-success-async-outputs [.component,class=conditions] -- @@ -20,4 +19,5 @@ The server SHALL produce and make available for retrieval all of the outputs spe -- The server SHALL respond with an HTTP status code of `404` if an attempt is made to access an unrequested output via the `/jobs/{jobsID}/resultes/{outputID}` path. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-success-async.adoc b/core/requirements/core/REQ_process-execute-success-async.adoc index 21846874..fbb8e4af 100644 --- a/core/requirements/core/REQ_process-execute-success-async.adoc +++ b/core/requirements/core/REQ_process-execute-success-async.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-success-async -label:: /req/core/process-execute-success-async [.component,class=conditions] -- @@ -24,5 +23,5 @@ The header of the response SHALL return the HTTP https://datatracker.ietf.org/do -- The content of the response SHALL be based upon the JSON Schema fragment https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[statusInfo.yaml]. -- -==== +==== diff --git a/core/requirements/core/REQ_process-execute-success-sync-many-json.adoc b/core/requirements/core/REQ_process-execute-success-sync-many-json.adoc index 915cc1dd..53635e34 100644 --- a/core/requirements/core/REQ_process-execute-success-sync-many-json.adoc +++ b/core/requirements/core/REQ_process-execute-success-sync-many-json.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-sync-many-json -label:: /req/core/process-execute-sync-many-json [.component,class=conditions] -- @@ -32,4 +31,5 @@ The response HTTP headers SHALL include a `Link: href="https://www.opengis.net/d -- The content of response SHALL conform to the <> schema. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-success-sync-one-default-content.adoc b/core/requirements/core/REQ_process-execute-success-sync-one-default-content.adoc index 00449f41..abf8146e 100644 --- a/core/requirements/core/REQ_process-execute-success-sync-one-default-content.adoc +++ b/core/requirements/core/REQ_process-execute-success-sync-one-default-content.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-sync-one-default-content -label:: /req/core/process-execute-sync-one-default-content [.component,class=conditions] -- @@ -21,6 +20,10 @@ The media type of the response SHALL be the default media type for the requested -- The content of response body SHALL be the requested process output value in the default output format. -- + ==== -NOTE: For servers that support the <> conformance class see requirements <> and <> for determining the default format for a process output. +[NOTE] +==== +For servers that support the <> conformance class see requirements <> and <> for determining the default format for a process output. +==== diff --git a/core/requirements/core/REQ_process-execute-success-sync-one.adoc b/core/requirements/core/REQ_process-execute-success-sync-one.adoc index 5ec4fdae..b2a4f926 100644 --- a/core/requirements/core/REQ_process-execute-success-sync-one.adoc +++ b/core/requirements/core/REQ_process-execute-success-sync-one.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-sync-one -label:: /req/core/process-execute-sync-one [.component,class=conditions] -- @@ -25,4 +24,5 @@ The media type of the response SHALL be as negotiated as per the https://datatra -- The content of response body SHALL be the requested process output value in the negotiated output format. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-success-sync-outputs-empty.adoc b/core/requirements/core/REQ_process-execute-success-sync-outputs-empty.adoc index ec81bcee..740276ae 100644 --- a/core/requirements/core/REQ_process-execute-success-sync-outputs-empty.adoc +++ b/core/requirements/core/REQ_process-execute-success-sync-outputs-empty.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-success-sync-empty-outputs -label:: /req/core/process-execute-success-sync-empty-outputs [.component,class=conditions] -- @@ -20,6 +19,7 @@ A successful execution of the operation SHALL be reported with a response with a -- The response body SHALL be empty. -- + ==== diff --git a/core/requirements/core/REQ_process-execute-success-sync-outputs-omitted.adoc b/core/requirements/core/REQ_process-execute-success-sync-outputs-omitted.adoc index c819e182..3b8bafe3 100644 --- a/core/requirements/core/REQ_process-execute-success-sync-outputs-omitted.adoc +++ b/core/requirements/core/REQ_process-execute-success-sync-outputs-omitted.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-execute-success-sync-outputs-omitted -label:: /req/core/process-execute-success-sync-outputs-omitted [.component,class=conditions] -- @@ -15,4 +14,5 @@ label:: /req/core/process-execute-success-sync-outputs-omitted -- The server's response SHALL include all outputs defined for the process in its <>. -- + ==== diff --git a/core/requirements/core/REQ_process-list-limit-def.adoc b/core/requirements/core/REQ_process-list-limit-def.adoc index bb7e73fc..3db59300 100644 --- a/core/requirements/core/REQ_process-list-limit-def.adoc +++ b/core/requirements/core/REQ_process-list-limit-def.adoc @@ -3,10 +3,7 @@ ==== [%metadata] identifier:: /req/core/pl-limit-definition -label:: /req/core/pl-limit-definition -[.component,class=part] --- The operation SHALL support a parameter `limit` with the following characteristics (using an OpenAPI Specification fragment): [source,yaml] @@ -22,5 +19,4 @@ schema: style: form explode: false ---- --- ==== diff --git a/core/requirements/core/REQ_process-list-limit-response.adoc b/core/requirements/core/REQ_process-list-limit-response.adoc index fed1b889..7135fe84 100644 --- a/core/requirements/core/REQ_process-list-limit-response.adoc +++ b/core/requirements/core/REQ_process-list-limit-response.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/pl-limit-response -label:: /req/core/pl-limit-response [.component,class=part] -- @@ -14,4 +13,5 @@ The response SHALL not contain more process summaries than specified by the opti -- If the API definition specifies a maximum value for `limit` parameter, the response SHALL not contain more process summaries than this maximum value. -- + ==== diff --git a/core/requirements/core/REQ_process-list-links.adoc b/core/requirements/core/REQ_process-list-links.adoc index 46deb843..040ed13c 100644 --- a/core/requirements/core/REQ_process-list-links.adoc +++ b/core/requirements/core/REQ_process-list-links.adoc @@ -3,14 +3,9 @@ ==== [%metadata] identifier:: /req/core/pl-links -label:: /req/core/pl-links -part:: -+ --- A `200`-response SHALL include the following links: * a link to this response document (relation: `self`), * a link to the response document in every other media type supported by the service (relation: `alternate`). --- ==== diff --git a/core/requirements/core/REQ_process-list-op.adoc b/core/requirements/core/REQ_process-list-op.adoc index 6e446972..472e29b7 100644 --- a/core/requirements/core/REQ_process-list-op.adoc +++ b/core/requirements/core/REQ_process-list-op.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-list-op -label:: /req/core/process-list-op The server SHALL support the HTTP GET operation at the path `/processes`. ==== diff --git a/core/requirements/core/REQ_process-list-success.adoc b/core/requirements/core/REQ_process-list-success.adoc index e8d585e2..a6be44b9 100644 --- a/core/requirements/core/REQ_process-list-success.adoc +++ b/core/requirements/core/REQ_process-list-success.adoc @@ -3,10 +3,15 @@ ==== [%metadata] identifier:: /req/core/process-list-success -label:: /req/core/process-list-success -A successful execution of the _process_ operation SHALL be reported as a -response with a HTTP status code 200. -The content of that response SHALL be based upon the OpenAPI -3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/processList.yaml[processList.yaml]. +[.component,class=part] +-- +A successful execution of the _process_ operation SHALL be reported as a response with a HTTP status code 200. +-- + +[.component,class=part] +-- +The content of that response SHALL be based upon the OpenAPI 3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/processList.yaml[processList.yaml]. +-- + ==== diff --git a/core/requirements/core/REQ_process-summary-links.adoc b/core/requirements/core/REQ_process-summary-links.adoc index 506d32d8..0cfe7ca5 100644 --- a/core/requirements/core/REQ_process-summary-links.adoc +++ b/core/requirements/core/REQ_process-summary-links.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/core/process-summary-links -label:: /req/core/process-summary-links [.component,class=part] -- @@ -14,4 +13,5 @@ Each process summary SHALL include a link (relation: `self`) that points to the -- Each process summary SHALL include one or more links (relation: `alternate`) that points to each alternative representation of the full description of the process (path: `/processes/{processID}`). -- + ==== diff --git a/core/requirements/core/REQ_test-process.adoc b/core/requirements/core/REQ_test-process.adoc index fe717502..12831e0c 100644 --- a/core/requirements/core/REQ_test-process.adoc +++ b/core/requirements/core/REQ_test-process.adoc @@ -3,10 +3,6 @@ ==== [%metadata] identifier:: /req/core/test-process -label:: /req/core/test-process -If a server implementing the OGC API - Processes - Part 1: Core is tested using CITE tests, the server SHALL offer at least one testable process. Please refer to -//<> -Recommendation A.1 -for further guidance. +If a server implementing the OGC API - Processes - Part 1: Core is tested using CITE tests, the server SHALL offer at least one testable process. Please refer to recommendation <> for further guidance. ==== diff --git a/core/requirements/dismiss/REQ_job-dismiss-op.adoc b/core/requirements/dismiss/REQ_job-dismiss-op.adoc index 9d0b2569..214e9a94 100644 --- a/core/requirements/dismiss/REQ_job-dismiss-op.adoc +++ b/core/requirements/dismiss/REQ_job-dismiss-op.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/dismiss/job-dismiss-op -label:: /req/dismiss/job-dismiss-op The server SHALL support the HTTP DELETE operation at the path `/jobs/{jobID}`. ==== diff --git a/core/requirements/dismiss/REQ_job-dismiss-status.adoc b/core/requirements/dismiss/REQ_job-dismiss-status.adoc index 5b6506d8..a3d8dbde 100644 --- a/core/requirements/dismiss/REQ_job-dismiss-status.adoc +++ b/core/requirements/dismiss/REQ_job-dismiss-status.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/dismiss/job-dismiss-status -label:: /req/dismiss/job-dismiss-status [.component,class=part] -- @@ -14,6 +13,7 @@ If the job is currently in the `accepted` or `running` state, then the server SH -- If the job is currently in the `sucessful`, `failed` or `dismissed` state, the the server SHALL remove the job and it SHALL not longer be accessible via the Processes API. -- + ==== NOTE: This standard makes no statments regarding the dispoisition of artifacts created by a job once a job has been removed and is no longer accessible via the Processes API. diff --git a/core/requirements/dismiss/REQ_job-dismiss-success.adoc b/core/requirements/dismiss/REQ_job-dismiss-success.adoc index e39c988d..3118af9d 100644 --- a/core/requirements/dismiss/REQ_job-dismiss-success.adoc +++ b/core/requirements/dismiss/REQ_job-dismiss-success.adoc @@ -3,7 +3,20 @@ ==== [%metadata] identifier:: /req/dismiss/job-dismiss-success -label:: /req/dismiss/job-dismiss-success -A successful execution of the operation SHALL be reported as a response with a HTTP status code 200. The content of that response SHALL be based upon the OpenAPI 3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[statusInfo.yaml]. The status SHALL be set to "dismissed". +[.component,class=part] +-- +A successful execution of the operation SHALL be reported as a response with a HTTP status code 200. +-- + +[.component,class=part] +-- +The content of that response SHALL be based upon the OpenAPI 3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[statusInfo.yaml]. +-- + +[.component,class=part] +-- +The status SHALL be set to "dismissed". +-- + ==== diff --git a/core/requirements/html/REQ_content.adoc b/core/requirements/html/REQ_content.adoc index 05882587..3a0a4f7d 100644 --- a/core/requirements/html/REQ_content.adoc +++ b/core/requirements/html/REQ_content.adoc @@ -3,11 +3,8 @@ ==== [%metadata] identifier:: /req/html/content -label:: /req/html/content -Every `200`-response of the server with the media type "text/html" SHALL be a -<> document that includes the following -information in the HTML body: +Every `200`-response of the server with the media type "text/html" SHALL be a <> document that includes the following information in the HTML body: * all information identified in the schemas of the link:https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responseObject[Response Object] diff --git a/core/requirements/html/REQ_definition.adoc b/core/requirements/html/REQ_definition.adoc index ba16c3e4..ed2204d5 100644 --- a/core/requirements/html/REQ_definition.adoc +++ b/core/requirements/html/REQ_definition.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/html/definition -label:: /req/html/definition `200`-responses of the server SHALL support the following media type: diff --git a/core/requirements/job-list/REQ_datetime-def.adoc b/core/requirements/job-list/REQ_datetime-def.adoc index dfbae9a9..de100f88 100644 --- a/core/requirements/job-list/REQ_datetime-def.adoc +++ b/core/requirements/job-list/REQ_datetime-def.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/job-list/datetime-definition -label:: /req/job-list/datetime-definition [.component,class=part] -- diff --git a/core/requirements/job-list/REQ_datetime-response.adoc b/core/requirements/job-list/REQ_datetime-response.adoc index aabd0069..5940cd32 100644 --- a/core/requirements/job-list/REQ_datetime-response.adoc +++ b/core/requirements/job-list/REQ_datetime-response.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/job-list/datetime-response -label:: /req/job-list/datetime-response If the `datetime` parameter is specified with the operation, only jobs that have a value for the `created` property (see: https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[statusInfo.yaml] that intersects the temporal information in the `datetime` parameter SHALL be included in the response. ==== diff --git a/core/requirements/job-list/REQ_duration-def.adoc b/core/requirements/job-list/REQ_duration-def.adoc index 6c0ed157..e0fa5303 100644 --- a/core/requirements/job-list/REQ_duration-def.adoc +++ b/core/requirements/job-list/REQ_duration-def.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/job-list/duration-definition -label:: /req/job-list/duration-definition [.component,class=part] -- @@ -32,4 +31,5 @@ schema: type: integer ---- -- + ==== diff --git a/core/requirements/job-list/REQ_duration-response.adoc b/core/requirements/job-list/REQ_duration-response.adoc index 2644fe59..84f8f1dd 100644 --- a/core/requirements/job-list/REQ_duration-response.adoc +++ b/core/requirements/job-list/REQ_duration-response.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/job-list/duration-response -label:: /req/job-list/duration-response [.component,class=conditions] -- @@ -46,4 +45,5 @@ For completed jobs, the duration SHALL be computed as the value of the `finished -- Jobs for which runtime statistics are not included in the https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[status information] or are incomplete for computing the duration of the job SHALL be omitted from the response. -- + ==== diff --git a/core/requirements/job-list/REQ_jl-limit-def.adoc b/core/requirements/job-list/REQ_jl-limit-def.adoc index 726bf23a..a8ba6b25 100644 --- a/core/requirements/job-list/REQ_jl-limit-def.adoc +++ b/core/requirements/job-list/REQ_jl-limit-def.adoc @@ -3,10 +3,7 @@ ==== [%metadata] identifier:: /req/job-list/limit-definition -label:: /req/job-list/limit-definition -[.component,class=part] --- The operation SHALL support a parameter `limit` with the following characteristics (using an OpenAPI Specification fragment): [source,yaml] @@ -20,5 +17,4 @@ schema: maximum: 10000 default: 10 ---- --- ==== diff --git a/core/requirements/job-list/REQ_jl-limit-response.adoc b/core/requirements/job-list/REQ_jl-limit-response.adoc index d885f7d6..511eb019 100644 --- a/core/requirements/job-list/REQ_jl-limit-response.adoc +++ b/core/requirements/job-list/REQ_jl-limit-response.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/job-list/limit-response -label:: /req/job-list/limit-response [.component,class=part] -- @@ -14,4 +13,5 @@ The response SHALL not contain more jobs than specified by the optional `limit` -- If the API definition specifies a maximum value for `limit` parameter, the response SHALL not contain more jobs than this maximum value. -- + ==== diff --git a/core/requirements/job-list/REQ_links.adoc b/core/requirements/job-list/REQ_links.adoc index 1a222096..04d92380 100644 --- a/core/requirements/job-list/REQ_links.adoc +++ b/core/requirements/job-list/REQ_links.adoc @@ -3,13 +3,9 @@ ==== [%metadata] identifier:: /req/job-list/links -label:: /req/job-list/links -[.component,class=part] --- A `200`-response SHALL include the following links: * a link to this response document (relation: `self`), * a link to the response document in every other media type supported by the service (relation: `alternate`). --- ==== diff --git a/core/requirements/job-list/REQ_op.adoc b/core/requirements/job-list/REQ_op.adoc index f1bbff16..2c570614 100644 --- a/core/requirements/job-list/REQ_op.adoc +++ b/core/requirements/job-list/REQ_op.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/job-list/job-list-op -label:: /req/job-list/job-list-op The server SHALL support the HTTP GET operation at the path `/jobs`. ==== diff --git a/core/requirements/job-list/REQ_processid-def.adoc b/core/requirements/job-list/REQ_processid-def.adoc index f8ed4d42..ea917446 100644 --- a/core/requirements/job-list/REQ_processid-def.adoc +++ b/core/requirements/job-list/REQ_processid-def.adoc @@ -3,10 +3,7 @@ ==== [%metadata] identifier:: /req/job-list/processID-definition -label:: /req/job-list/processID-definition -[.component,class=part] --- The operation SHALL support a parameter `processID` with the following characteristics (using an OpenAPI Specification fragment): [source,yaml] @@ -19,5 +16,4 @@ schema: items: type: string ---- --- ==== diff --git a/core/requirements/job-list/REQ_processid-mandatory.adoc b/core/requirements/job-list/REQ_processid-mandatory.adoc index 63bcade4..e56913ae 100644 --- a/core/requirements/job-list/REQ_processid-mandatory.adoc +++ b/core/requirements/job-list/REQ_processid-mandatory.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/job-list/processID-mandatory -label:: /req/job-list/processID-mandatory If the server supports this conformance class, the optional `processID` property in the https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[statusInfo.yaml] schema SHALL be mandatory. ==== diff --git a/core/requirements/job-list/REQ_processid-response.adoc b/core/requirements/job-list/REQ_processid-response.adoc index 0008e20b..3d30ebfa 100644 --- a/core/requirements/job-list/REQ_processid-response.adoc +++ b/core/requirements/job-list/REQ_processid-response.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/job-list/processid-response -label:: /req/job-list/processid-response If the `processID` parameter is specified with the operation, only jobs that have a value for the `processID` property (see: https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[statusInfo.yaml]) that matches one of the values specified for the `processID` parameter SHALL be included in the response. ==== diff --git a/core/requirements/job-list/REQ_status-def.adoc b/core/requirements/job-list/REQ_status-def.adoc index 4edadec1..2c8065f5 100644 --- a/core/requirements/job-list/REQ_status-def.adoc +++ b/core/requirements/job-list/REQ_status-def.adoc @@ -3,10 +3,7 @@ ==== [%metadata] identifier:: /req/job-list/status-definition -label:: /req/job-list/status-definition -[.component,class=part] --- The operation SHALL support a parameter `status` with the following characteristics (using an OpenAPI Specification fragment): [source,yaml] @@ -19,5 +16,4 @@ schema: items: type: string ---- --- ==== diff --git a/core/requirements/job-list/REQ_status-response.adoc b/core/requirements/job-list/REQ_status-response.adoc index 7ebfce74..18a17ab2 100644 --- a/core/requirements/job-list/REQ_status-response.adoc +++ b/core/requirements/job-list/REQ_status-response.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/job-list/status-response -label:: /req/job-list/status-response If the `status` parameter is specified with the operation, only jobs that have a value for the `status` property (see: https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/statusInfo.yaml[statusInfo.yaml]) that matches one of the specified values of the `status` parameter SHALL be included in the response. ==== diff --git a/core/requirements/job-list/REQ_success.adoc b/core/requirements/job-list/REQ_success.adoc index f81b57c6..1b23385a 100644 --- a/core/requirements/job-list/REQ_success.adoc +++ b/core/requirements/job-list/REQ_success.adoc @@ -3,10 +3,15 @@ ==== [%metadata] identifier:: /req/job-list/job-list-success -label:: /req/job-list/job-list-success -A successful execution of the operation SHALL be reported as a -response with a HTTP status code 200. -The content of that response SHALL be based upon the OpenAPI -3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/jobList.yaml[jobList.yaml]. +[.component,class=part] +-- +A successful execution of the operation SHALL be reported as a response with a HTTP status code 200. +-- + +[.component,class=part] +-- +The content of that response SHALL be based upon the OpenAPI 3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/jobList.yaml[jobList.yaml]. +-- + ==== diff --git a/core/requirements/job-list/REQ_type-def.adoc b/core/requirements/job-list/REQ_type-def.adoc index bf57e137..ced3b038 100644 --- a/core/requirements/job-list/REQ_type-def.adoc +++ b/core/requirements/job-list/REQ_type-def.adoc @@ -3,10 +3,7 @@ ==== [%metadata] identifier:: /req/job-list/type-definition -label:: /req/job-list/type-definition -[.component,class=part] --- The operation SHALL support a parameter `type` with the following characteristics (using an OpenAPI Specification fragment): [source,yaml] @@ -19,5 +16,4 @@ schema: items: type: string ---- --- ==== diff --git a/core/requirements/job-list/REQ_type-response.adoc b/core/requirements/job-list/REQ_type-response.adoc index a55be089..42c4776c 100644 --- a/core/requirements/job-list/REQ_type-response.adoc +++ b/core/requirements/job-list/REQ_type-response.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/job-list/type-response -label:: /req/job-list/type-response [.component,class=part] -- @@ -14,4 +13,5 @@ If the parameter is provided and its value is `process` then only jobs created b -- If the parameter is omitted, then all jobs SHALL be included in the response. -- + ==== diff --git a/core/requirements/json/REQ_definition.adoc b/core/requirements/json/REQ_definition.adoc index 506fa32c..1f384e94 100644 --- a/core/requirements/json/REQ_definition.adoc +++ b/core/requirements/json/REQ_definition.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/json/definition -label:: /req/json/definition `200`-responses of the server SHALL support the following media type: diff --git a/core/requirements/kvp-execute/REQ_array-input-value.adoc b/core/requirements/kvp-execute/REQ_array-input-value.adoc index 98316043..c9295805 100644 --- a/core/requirements/kvp-execute/REQ_array-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_array-input-value.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/array-input-value -label:: /req/kvp-execute/array-input-value [.component,class=conditions] -- diff --git a/core/requirements/kvp-execute/REQ_bbox-crs-input-value.adoc b/core/requirements/kvp-execute/REQ_bbox-crs-input-value.adoc index fd214389..ee2ab3cd 100644 --- a/core/requirements/kvp-execute/REQ_bbox-crs-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_bbox-crs-input-value.adoc @@ -3,11 +3,10 @@ ==== [%metadata] identifier:: /req/kvp-execute/bbox-crs-input-value -label:: /req/kvp-execute/bbox-crs-input-value [.component,class=conditions] -- -. The server supports CRSs other than http://www.opengis.net/def/crs/OGC/1.3/CRS84 or http://www.opengis.net/def/crs/OGC/0/CRS84h. +. The server supports CRSs other than https://www.opengis.net/def/crs/OGC/1.3/CRS84 or https://www.opengis.net/def/crs/OGC/0/CRS84h. . The process input value is specified in-line in an <>. . The process defines an input parameter named `{bbox-input-name}`. -- @@ -23,4 +22,5 @@ include::../../../openapi/parameters/processes-core/bbox-crs.yaml[] where the token `{bbox-input-name}` represents the identifier of a bbox input parameter and the token `{bbox-input-name}[crs]` represents the identifier of a corresponding input that indicates which CRS is being used for the coordinates of the `{bbox-input-name}` parameter. -- + ==== diff --git a/core/requirements/kvp-execute/REQ_bbox-input-value.adoc b/core/requirements/kvp-execute/REQ_bbox-input-value.adoc index 2f18f0f3..1de70413 100644 --- a/core/requirements/kvp-execute/REQ_bbox-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_bbox-input-value.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/bbox-input-value -label:: /req/kvp-execute/bbox-input-value [.component,class=conditions] -- @@ -22,4 +21,5 @@ include::../../../openapi/parameters/common-geodata/bbox.yaml[] where the token `{bbox-input-name}` represented the identifier of the input. -- + ==== diff --git a/core/requirements/kvp-execute/REQ_binary-input-value-qualified.adoc b/core/requirements/kvp-execute/REQ_binary-input-value-qualified.adoc index 1656548b..71391dd6 100644 --- a/core/requirements/kvp-execute/REQ_binary-input-value-qualified.adoc +++ b/core/requirements/kvp-execute/REQ_binary-input-value-qualified.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/binary-input-value-qualified -label:: /req/kvp-execute/binary-input-value-qualified [.component,class=conditions] -- @@ -44,4 +43,5 @@ explode: true where the token `{inputID}` represents the identifier of the input. -- + ==== diff --git a/core/requirements/kvp-execute/REQ_binary-input-value.adoc b/core/requirements/kvp-execute/REQ_binary-input-value.adoc index 1cc8841b..7ebf7e43 100644 --- a/core/requirements/kvp-execute/REQ_binary-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_binary-input-value.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/binary-input-value -label:: /req/kvp-execute/binary-input-value [.component,class=conditions] -- @@ -30,4 +29,5 @@ explode: false where the token `{inputID}` represents the identifier of the input. -- + ==== diff --git a/core/requirements/kvp-execute/REQ_boolean-input-value.adoc b/core/requirements/kvp-execute/REQ_boolean-input-value.adoc index d9c88431..cb533754 100644 --- a/core/requirements/kvp-execute/REQ_boolean-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_boolean-input-value.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/boolean-input-value -label:: /req/kvp-execute/boolean-input-value [.component,class=conditions] -- @@ -28,4 +27,5 @@ explode: false where the token `{inputID}` represented the identifier of the input. -- + ==== diff --git a/core/requirements/kvp-execute/REQ_complex-input-value.adoc b/core/requirements/kvp-execute/REQ_complex-input-value.adoc index 4b2f554a..d5da6e5f 100644 --- a/core/requirements/kvp-execute/REQ_complex-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_complex-input-value.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/complex-input-value -label:: /req/kvp-execute/complex-input-value [.component,class=conditions] -- diff --git a/core/requirements/kvp-execute/REQ_f-definition.adoc b/core/requirements/kvp-execute/REQ_f-definition.adoc index 4252b628..6e917c08 100644 --- a/core/requirements/kvp-execute/REQ_f-definition.adoc +++ b/core/requirements/kvp-execute/REQ_f-definition.adoc @@ -1,8 +1,10 @@ [[req_kvp-execute_f-definition]] -[width="90%",cols="2,6a"] -|=== -^|*Requirement {counter:req-id}* |*/req/kvp-execute/f-definition* -^|A |The operation SHALL support a response parameter `response[f]` with the following characteristics: +[requirement] +==== +[%metadata] +identifier:: /req/kvp-execute/f-definition + +The operation SHALL support a response parameter `response[f]` with the following characteristics: [source,YAML] ---- @@ -20,4 +22,4 @@ schema: style: deepObject explode: true ---- -|=== +==== diff --git a/core/requirements/kvp-execute/REQ_f-response.adoc b/core/requirements/kvp-execute/REQ_f-response.adoc index 0706a801..cc0d77d6 100644 --- a/core/requirements/kvp-execute/REQ_f-response.adoc +++ b/core/requirements/kvp-execute/REQ_f-response.adoc @@ -1,6 +1,8 @@ [[req_kvp-execute_f-response]] -[width="90%",cols="2,6a"] -|=== -^|*Requirement {counter:req-id}* |*/req/kvp-execute/f-response* -^|A |The `response[f]` parameter SHALL behave in the same way that the https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.2[HTTP `Accept` header] behaves. -|=== +[requirement] +==== +[%metadata] +identifier:: /req/kvp-execute/f-response + +The `response[f]` parameter SHALL behave in the same way that the https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.2[HTTP `Accept` header] behaves. +==== diff --git a/core/requirements/kvp-execute/REQ_input-by-reference.adoc b/core/requirements/kvp-execute/REQ_input-by-reference.adoc index 1ac648ac..d9133532 100644 --- a/core/requirements/kvp-execute/REQ_input-by-reference.adoc +++ b/core/requirements/kvp-execute/REQ_input-by-reference.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/input-by-reference -label:: /req/kvp-execute/input-by-reference [.component,class=conditions] -- diff --git a/core/requirements/kvp-execute/REQ_input-cardinality.adoc b/core/requirements/kvp-execute/REQ_input-cardinality.adoc index 0519db22..a3197cb1 100644 --- a/core/requirements/kvp-execute/REQ_input-cardinality.adoc +++ b/core/requirements/kvp-execute/REQ_input-cardinality.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/input-cardinality -label:: /req/kvp-execute/input-cardinality [.component,class=conditions] -- @@ -51,4 +50,5 @@ List elements that are objects SHALL be encoded as <>. -- + ==== diff --git a/core/requirements/kvp-execute/REQ_input-query-parameter-values.adoc b/core/requirements/kvp-execute/REQ_input-query-parameter-values.adoc index 0df1070c..9387f6a8 100644 --- a/core/requirements/kvp-execute/REQ_input-query-parameter-values.adoc +++ b/core/requirements/kvp-execute/REQ_input-query-parameter-values.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/input-query-parameter-values -label:: /req/kvp-execute/input-query-parameter-values [.component,class=part] -- @@ -14,4 +13,5 @@ The server SHALL support process input values specified in-line as the value of -- The server SHALL support process input values specified by reference as specified in <>. -- + ==== diff --git a/core/requirements/kvp-execute/REQ_input-query-parameters.adoc b/core/requirements/kvp-execute/REQ_input-query-parameters.adoc index f34084d7..6ad91e12 100644 --- a/core/requirements/kvp-execute/REQ_input-query-parameters.adoc +++ b/core/requirements/kvp-execute/REQ_input-query-parameters.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/input-query-parameters -label:: /req/kvp-execute/input-query-parameters [.component,class=part] -- @@ -19,4 +18,5 @@ The name of this URI query parameter SHALL be the identifier of the correspondin -- The name of this URI query parameter SHALL be case in-sensitive. -- + ==== diff --git a/core/requirements/kvp-execute/REQ_numeric-input-value.adoc b/core/requirements/kvp-execute/REQ_numeric-input-value.adoc index 09fceed7..ac6c6772 100644 --- a/core/requirements/kvp-execute/REQ_numeric-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_numeric-input-value.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/numeric-input-value -label:: /req/kvp-execute/numeric-input-value [.component,class=conditions] -- @@ -28,4 +27,5 @@ explode: false where the token `{inputID}` represented the identifier of the input and the token {numeric-type} is the value `number` or `integer`. -- + ==== diff --git a/core/requirements/kvp-execute/REQ_output.adoc b/core/requirements/kvp-execute/REQ_output.adoc index 366a1982..3612ac8f 100644 --- a/core/requirements/kvp-execute/REQ_output.adoc +++ b/core/requirements/kvp-execute/REQ_output.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/output -label:: /req/kvp-execute/output [.component,class=conditions] -- @@ -41,4 +40,5 @@ explode: true where the token `{outputID}` represents the identifier of the output. -- + ==== diff --git a/core/requirements/kvp-execute/REQ_prefer-definition.adoc b/core/requirements/kvp-execute/REQ_prefer-definition.adoc index 2edac302..88a115d4 100644 --- a/core/requirements/kvp-execute/REQ_prefer-definition.adoc +++ b/core/requirements/kvp-execute/REQ_prefer-definition.adoc @@ -1,8 +1,10 @@ [[req_kvp-execute_prefer-definition]] -[width="90%",cols="2,6a"] -|=== -^|*Requirement {counter:req-id}* |*/req/kvp-execute/prefer-definition* -^|A |The operation SHALL support a parameter `response[prefer]` with the following characteristics: +[requirement] +==== +[%metadata] +identifier:: /req/kvp-execute/prefer-definition + +The operation SHALL support a parameter `response[prefer]` with the following characteristics: [source,YAML] ---- @@ -20,4 +22,4 @@ schema: style: deepObject explode: true ---- -|=== +==== diff --git a/core/requirements/kvp-execute/REQ_prefer-response.adoc b/core/requirements/kvp-execute/REQ_prefer-response.adoc index 664851a5..c803ae53 100644 --- a/core/requirements/kvp-execute/REQ_prefer-response.adoc +++ b/core/requirements/kvp-execute/REQ_prefer-response.adoc @@ -1,6 +1,8 @@ [[req_kvp-execute_prefer-response]] -[width="90%",cols="2,6a"] -|=== -^|*Requirement {counter:req-id}* |*/req/kvp-execute/f-response* -^|A |The `response[prefer]` parameter SHALL behave in the same way that the https://datatracker.ietf.org/doc/html/rfc7240[HTTP `Prefer` header] behaves. -|=== +[requirement] +==== +[%metadata] +identifier:: /req/kvp-execute/prefer-response + +The `response[prefer]` parameter SHALL behave in the same way that the https://datatracker.ietf.org/doc/html/rfc7240[HTTP `Prefer` header] behaves. +==== diff --git a/core/requirements/kvp-execute/REQ_process-execute-op.adoc b/core/requirements/kvp-execute/REQ_process-execute-op.adoc index e4d0e384..8211ef7a 100644 --- a/core/requirements/kvp-execute/REQ_process-execute-op.adoc +++ b/core/requirements/kvp-execute/REQ_process-execute-op.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/process-execute-op -label:: /req/kvp-execute/process-execute-op The server SHALL support the HTTP GET operation at the path `/processes/{processID}/execution`. ==== diff --git a/core/requirements/kvp-execute/REQ_string-input-value.adoc b/core/requirements/kvp-execute/REQ_string-input-value.adoc index a3dbfd6b..a9f5f111 100644 --- a/core/requirements/kvp-execute/REQ_string-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_string-input-value.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/kvp-execute/string-input-value -label:: /req/kvp-execute/string-input-value [.component,class=conditions] -- @@ -28,4 +27,5 @@ explode: false where the token `{inputID}` represents the identifier of the input. -- + ==== diff --git a/core/requirements/local-filtering/REQ_local-filtering.adoc b/core/requirements/local-filtering/REQ_local-filtering.adoc index 24ce292f..f1922dba 100644 --- a/core/requirements/local-filtering/REQ_local-filtering.adoc +++ b/core/requirements/local-filtering/REQ_local-filtering.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/local-filtering -label:: /req/local-filtering [.component,class=description] -- diff --git a/core/requirements/oas/REQ_completeness.adoc b/core/requirements/oas/REQ_completeness.adoc index 7cd82f40..8bb79717 100644 --- a/core/requirements/oas/REQ_completeness.adoc +++ b/core/requirements/oas/REQ_completeness.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/oas/completeness -label:: /req/oas/completeness The OpenAPI definition SHALL specify for each operation all HTTP Status Codes and Response Objects that the server uses in responses. This includes the successful execution of an operation as well as all error situations that originate from the server. ==== diff --git a/core/requirements/oas/REQ_definition.adoc b/core/requirements/oas/REQ_definition.adoc index 28030698..18a6c8a6 100644 --- a/core/requirements/oas/REQ_definition.adoc +++ b/core/requirements/oas/REQ_definition.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/oas/definition -label:: /req/oas/definition The content of the response of the HTTP GET operation at the landing page SHALL include the following links to the API definition: diff --git a/core/requirements/oas/REQ_exception-codes.adoc b/core/requirements/oas/REQ_exception-codes.adoc index 6f7f15df..067001db 100644 --- a/core/requirements/oas/REQ_exception-codes.adoc +++ b/core/requirements/oas/REQ_exception-codes.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/oas/exceptions-codes -label:: /req/oas/exceptions-codes For error situations that originate from the server, the API definition SHALL cover all applicable HTTP Status Codes. ==== diff --git a/core/requirements/oas/REQ_implementation.adoc b/core/requirements/oas/REQ_implementation.adoc index 527aac3f..2b40121c 100644 --- a/core/requirements/oas/REQ_implementation.adoc +++ b/core/requirements/oas/REQ_implementation.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/oas/oas-impl -label:: /req/oas/oas-impl The server SHALL implement all capabilities specified in the OpenAPI definition. ==== diff --git a/core/requirements/oas/REQ_security.adoc b/core/requirements/oas/REQ_security.adoc index 6d942453..d0cf84a4 100644 --- a/core/requirements/oas/REQ_security.adoc +++ b/core/requirements/oas/REQ_security.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/oas/security -label:: /req/oas/security For cases, where the operations of the server are access-controlled, the security scheme(s) SHALL be documented in the OpenAPI definition. ==== diff --git a/core/requirements/oas30/REQ_oas-definition.adoc b/core/requirements/oas30/REQ_oas-definition.adoc index 404a8f64..fc3c2bf6 100644 --- a/core/requirements/oas30/REQ_oas-definition.adoc +++ b/core/requirements/oas30/REQ_oas-definition.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/oas30/oas-definition -label:: /req/oas30/oas-definition -The JSON representation SHALL conform to the http://spec.openapis.org/oas/v3.0.4[OpenAPI Specification 3.0]. +The JSON representation SHALL conform to the https://spec.openapis.org/oas/v3.0.4[OpenAPI Specification 3.0]. ==== diff --git a/core/requirements/oas31/REQ_oas-definition.adoc b/core/requirements/oas31/REQ_oas-definition.adoc index 27684e31..53dbdb8f 100644 --- a/core/requirements/oas31/REQ_oas-definition.adoc +++ b/core/requirements/oas31/REQ_oas-definition.adoc @@ -3,8 +3,7 @@ ==== [%metadata] identifier:: /req/oas31/oas-definition -label:: /req/oas31/oas-definition -The JSON representation SHALL conform to the http://spec.openapis.org/oas/v3.1.1[OpenAPI Specification 3.1]. +The JSON representation SHALL conform to the https://spec.openapis.org/oas/v3.1.1[OpenAPI Specification 3.1]. ==== diff --git a/core/requirements/ogc-process-description/REQ_data-access-apis.adoc b/core/requirements/ogc-process-description/REQ_data-access-apis.adoc index bce73532..ce0806f6 100644 --- a/core/requirements/ogc-process-description/REQ_data-access-apis.adoc +++ b/core/requirements/ogc-process-description/REQ_data-access-apis.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/ogc-process-description/data-access-apis -label:: /req/ogc-process-description/data-access-apis [.component,class=part] -- diff --git a/core/requirements/ogc-process-description/REQ_data-classes.adoc b/core/requirements/ogc-process-description/REQ_data-classes.adoc index 0d7e450f..6baeee5a 100644 --- a/core/requirements/ogc-process-description/REQ_data-classes.adoc +++ b/core/requirements/ogc-process-description/REQ_data-classes.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/ogc-process-description/data-classes -label:: /req/ogc-process-description/data-classes [.component,class=part] -- @@ -14,8 +13,9 @@ The `dataClasses` parameter SHALL be an array of zero or more items. -- Each item in the `dataClasses` array SHALL be one of the following: -. The identifier of a data class in the OGC Data Classes Register (the `dataClassId` value in the URI template http://www.opengis.net/def/dataClass/OGC/0/{dataClassId}); +. The identifier of a data class in the OGC Data Classes Register (the `dataClassId` value in the URI template https://www.opengis.net/def/dataClass/OGC/0/{dataClassId}); . A HTTP(S) URI of a data class. -- + ==== diff --git a/core/requirements/ogc-process-description/REQ_execution-unit-requirements.adoc b/core/requirements/ogc-process-description/REQ_execution-unit-requirements.adoc index 62e3f37b..2d7b54d2 100644 --- a/core/requirements/ogc-process-description/REQ_execution-unit-requirements.adoc +++ b/core/requirements/ogc-process-description/REQ_execution-unit-requirements.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/ogc-process-description/execution-unit-requirements -label:: /req/ogc-process-description/execution-unit-requirements [.component,class=part] -- @@ -25,4 +24,5 @@ The `staging` parameter SHALL indicate how referenced input data should be prepa * A value of `local-file` indicates that referenced input data SHALL be locally staged for the process' execution unit. * A value of `remote-access` indicates that a reference to input data SHALL be passed to the execution unit as-is since the process' execution unit itself know how to dereference the input data. -- + ==== diff --git a/core/requirements/ogc-process-description/REQ_input-def.adoc b/core/requirements/ogc-process-description/REQ_input-def.adoc index da62a6d3..a07ef436 100644 --- a/core/requirements/ogc-process-description/REQ_input-def.adoc +++ b/core/requirements/ogc-process-description/REQ_input-def.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/ogc-process-description/input-def -label:: /req/ogc-process-description/input-def [.component,class=part] -- @@ -24,4 +23,5 @@ The value of the `schema` parameter SHALL be a JSON fragment that validates acco -- Servers SHALL use this schema fragment to validate the components of a <> in an <> that is an instance of <>. -- + ==== diff --git a/core/requirements/ogc-process-description/REQ_input-multiple-types.adoc b/core/requirements/ogc-process-description/REQ_input-multiple-types.adoc index f9ca8caf..f30ef317 100644 --- a/core/requirements/ogc-process-description/REQ_input-multiple-types.adoc +++ b/core/requirements/ogc-process-description/REQ_input-multiple-types.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/ogc-process-description/input-multiple-types -label:: /req/ogc-process-description/input-multiple-types [.component,class=part] -- @@ -19,4 +18,5 @@ Each sub-schema SHALL be a JSON fragment that validates according to the JSON Sc -- The first sub-schema in the https://tools.ietf.org/html/draft-bhutton-json-schema-00#section-10.2.1.3[`oneOf`] array SHALL be considered the default format. -- + ==== diff --git a/core/requirements/ogc-process-description/REQ_inputs-def.adoc b/core/requirements/ogc-process-description/REQ_inputs-def.adoc index 25dea30e..e0cbf02f 100644 --- a/core/requirements/ogc-process-description/REQ_inputs-def.adoc +++ b/core/requirements/ogc-process-description/REQ_inputs-def.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/ogc-process-description/inputs-def -label:: /req/ogc-process-description/inputs-def [.component,class=part] -- @@ -14,4 +13,5 @@ Each process <> SHALL be listed in the `i -- The key for each process input in the `inputs` section of the process definition SHALL be the identifier for that input. -- + ==== diff --git a/core/requirements/ogc-process-description/REQ_json-encoding.adoc b/core/requirements/ogc-process-description/REQ_json-encoding.adoc index ad0f1598..39843b94 100644 --- a/core/requirements/ogc-process-description/REQ_json-encoding.adoc +++ b/core/requirements/ogc-process-description/REQ_json-encoding.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/ogc-process-description/json-encoding -label:: /req/ogc-process-description/json-encoding [.component,class=part] -- @@ -14,4 +13,5 @@ A JSON-encoded OGC process description SHALL validate against the JSON Schema: h -- The JSON-encoded OGC process description SHALL include, in the `links` section, a profile link (href: `https://www.opengis.net/def/profile/OGC/0/ogc-process-description`, relation: `profile`); -- + ==== diff --git a/core/requirements/ogc-process-description/REQ_links.adoc b/core/requirements/ogc-process-description/REQ_links.adoc index c711ce40..23be9263 100644 --- a/core/requirements/ogc-process-description/REQ_links.adoc +++ b/core/requirements/ogc-process-description/REQ_links.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/ogc-process-description/links -label:: /req/ogc-process-description/links [.component,class=part] -- diff --git a/core/requirements/ogc-process-description/REQ_output-def.adoc b/core/requirements/ogc-process-description/REQ_output-def.adoc index 12b8fdf6..54358a57 100644 --- a/core/requirements/ogc-process-description/REQ_output-def.adoc +++ b/core/requirements/ogc-process-description/REQ_output-def.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/ogc-process-description/output-def -label:: /req/ogc-process-description/output-def [.component,class=part] -- @@ -14,4 +13,5 @@ The schema of each <> SHALL be specified -- The value of the `schema` parameter SHALL be a JSON fragment that validates according to the JSON Schema: https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/schema.yaml[schema.yaml]. -- + ==== diff --git a/core/requirements/ogc-process-description/REQ_output-multiple-types.adoc b/core/requirements/ogc-process-description/REQ_output-multiple-types.adoc index ea7b3c90..abd01643 100644 --- a/core/requirements/ogc-process-description/REQ_output-multiple-types.adoc +++ b/core/requirements/ogc-process-description/REQ_output-multiple-types.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/ogc-process-description/output-multiple-types -label:: /req/ogc-process-description/output-multiple-types [.component,class=part] -- @@ -19,4 +18,5 @@ Each sub-schema SHALL be a JSON fragment that validates according to the JSON Sc -- The first sub-schema in the https://tools.ietf.org/html/draft-bhutton-json-schema-00#section-10.2.1.3[`oneOf`] array SHALL be considered the default format. -- + ==== diff --git a/core/requirements/ogc-process-description/REQ_outputs-def.adoc b/core/requirements/ogc-process-description/REQ_outputs-def.adoc index 45c0882f..384f9f71 100644 --- a/core/requirements/ogc-process-description/REQ_outputs-def.adoc +++ b/core/requirements/ogc-process-description/REQ_outputs-def.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/ogc-process-description/outputs-def -label:: /req/ogc-process-description/outputs-def [.component,class=part] -- @@ -14,4 +13,5 @@ Each process output definition SHALL be listed in the `outputs` section accordin -- The key for each process output in the `output` section of the process definition SHALL be the identifier for that output. -- + ==== diff --git a/core/requirements/ogc-process-description/REQ_value-passing.adoc b/core/requirements/ogc-process-description/REQ_value-passing.adoc index 25f25b6e..aad16288 100644 --- a/core/requirements/ogc-process-description/REQ_value-passing.adoc +++ b/core/requirements/ogc-process-description/REQ_value-passing.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/ogc-process-description/value-passing -label:: /req/ogc-process-description/value-passing [.component,class=part] -- @@ -25,4 +24,5 @@ If an input value can be passed by value (https://raw.githubusercontent.com/open -- If an input value can be passed by reference (https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/inputDescription.yaml[`"byReference"`]), then input values shall be referenced in an <> using a https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/common-core/link.yaml[link]. -- + ==== diff --git a/core/requirements/query-param-profile/REQ_definition.adoc b/core/requirements/query-param-profile/REQ_definition.adoc index 86181de1..b862666c 100644 --- a/core/requirements/query-param-profile/REQ_definition.adoc +++ b/core/requirements/query-param-profile/REQ_definition.adoc @@ -3,9 +3,16 @@ ==== [%metadata] identifier:: /req/query-param-profile/definition -part:: A server implementation SHALL support the Profile (`profile`) parameter for the GET operation. -part:: The following OpenAPI 3.0 schema fragment SHALL define the characteristics of the `profile` parameter: -+ + +[.component,class=part] +-- +A server implementation SHALL support the Profile (`profile`) parameter for the GET operation. +-- + +[.component,class=part] +-- +The following OpenAPI 3.0 schema fragment SHALL define the characteristics of the `profile` parameter: + [source,YAML] ---- name: profile @@ -18,10 +25,15 @@ schema: explode: false style: form ---- +-- -part:: Each item SHALL be one of the following: -+ -* A HTTP(S) URI of a profile, e.g., in the OGC Profile Register (\http://www.opengis.net/def/profile); +[.component,class=part] +-- +Each item SHALL be one of the following: + +* A HTTP(S) URI of a profile, e.g., in the OGC Profile Register (\https://www.opengis.net/def/profile); * A Safe CURIE of a profile in the OGC Profile Register (e.g., `[ogc-profile:my-profile]`); -* A profile identifier (the `profileId` value in the URI template `\http://www.opengis.net/def/profile/OGC/0/{profileId}`) +* A profile identifier (the `profileId` value in the URI template `\https://www.opengis.net/def/profile/OGC/0/{profileId}`) +-- + ==== diff --git a/core/requirements/query-param-profile/REQ_response.adoc b/core/requirements/query-param-profile/REQ_response.adoc index 66adfb4d..f48b4878 100644 --- a/core/requirements/query-param-profile/REQ_response.adoc +++ b/core/requirements/query-param-profile/REQ_response.adoc @@ -3,6 +3,15 @@ ==== [%metadata] identifier:: /req/query-param-profile/response -part:: The query parameter is not required, that is, omitting the parameter in a request SHALL not result in an error. -part:: If the media type of the response supports web links in accordance with <>, the response SHALL include links to the selected profile(s) with the link relation type "profile". + +[.component,class=part] +-- +The query parameter is not required, that is, omitting the parameter in a request SHALL not result in an error. +-- + +[.component,class=part] +-- +If the media type of the response supports web links in accordance with <>, the response SHALL include links to the selected profile(s) with the link relation type "profile". +-- + ==== diff --git a/core/requirements/remote-collections/REQ_remote-collections_access.adoc b/core/requirements/remote-collections/REQ_remote-collections_access.adoc index 7aa54317..c7fb6aac 100644 --- a/core/requirements/remote-collections/REQ_remote-collections_access.adoc +++ b/core/requirements/remote-collections/REQ_remote-collections_access.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/remote-collections/access -label:: /req/remote-collections/access [.component,class=description] -- @@ -19,4 +18,5 @@ The server SHALL support accessing <> -- The server SHALL, in the <> and for each relevant input, indicate which <> can be used to retrive input values for that input from the <>. -- + ==== diff --git a/core/requirements/remote-collections/REQ_remote-collections_referencing.adoc b/core/requirements/remote-collections/REQ_remote-collections_referencing.adoc index 9925ca21..3f765d17 100644 --- a/core/requirements/remote-collections/REQ_remote-collections_referencing.adoc +++ b/core/requirements/remote-collections/REQ_remote-collections_referencing.adoc @@ -3,7 +3,6 @@ ==== [%metadata] identifier:: /req/remote-collections/referencing -label:: /req/remote-collections/referencing .component,class=description] -- @@ -24,4 +23,5 @@ The value of the `collection` parameter SHALL be a URI identifying a <> and other factors, which supported <> should be employed to retrived input values from the <>. -- + ==== diff --git a/core/requirements/requirements_class_callback.adoc b/core/requirements/requirements_class_callback.adoc index 40f4c75f..d7d65c4b 100644 --- a/core/requirements/requirements_class_callback.adoc +++ b/core/requirements/requirements_class_callback.adoc @@ -1,10 +1,10 @@ [[rc_callback]] [requirements_class] +.Requirements Class 'Callback' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/callback -label:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/callback -obligation:: requirement +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/callback subject:: Web API -inherit:: <> +inherit:: /req/core +requirement:: /req/callback/job-callback ==== diff --git a/core/requirements/requirements_class_collection-input.adoc b/core/requirements/requirements_class_collection-input.adoc index 0f3e3d1b..2e2238e3 100644 --- a/core/requirements/requirements_class_collection-input.adoc +++ b/core/requirements/requirements_class_collection-input.adoc @@ -1,8 +1,14 @@ [[rc_collection-input]] [requirements_class] +.Requirements Class 'Collection Input' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/collection-input -subject:: Collection Input -inherit:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/core +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/collection-input +subject:: Web API +inherit:: /req/core +requirement:: /req/collection-input/collection-access +requirement:: /req/collection-input/filtering +requirement:: /req/collection-input/pass-through +requirement:: /req/collection-input/property-selection +requirement:: /req/collection-input/referencing ==== diff --git a/core/requirements/requirements_class_collection-output.adoc b/core/requirements/requirements_class_collection-output.adoc index 0f36548b..a5f04035 100644 --- a/core/requirements/requirements_class_collection-output.adoc +++ b/core/requirements/requirements_class_collection-output.adoc @@ -1,9 +1,14 @@ [[rc_collection-output]] [requirements_class] +.Requirements Class 'Collection Output' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/collection-output -subject:: Collection Output -inherit:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/core -inherit:: http://www.opengis.net/spec/ogcapi-common-2/1.0/req/collections +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/collection-output +subject:: WebAPI +inherit:: https://www.opengis.net/spec/ogcapi-common-2/1.0/req/collections +inherit:: /req/core +requirement:: /req/collection-output/data-access-mechanisms +requirement:: /req/collection-output/response-definition +requirement:: /req/collection-output/response-response-many +requirement:: /req/collection-output/response-response-one ==== diff --git a/core/requirements/requirements_class_core.adoc b/core/requirements/requirements_class_core.adoc index b4851e7f..db7d4caf 100644 --- a/core/requirements/requirements_class_core.adoc +++ b/core/requirements/requirements_class_core.adoc @@ -1,13 +1,65 @@ [[rc_core]] [requirements_class] +.Requirements Class 'Core' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/core -label:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/core -obligation:: requirement +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/core subject:: Web API -inherit:: http://www.opengis.net/spec/ogcapi_common-1/1.0/req/core[API - Common Core] +inherit:: https://www.opengis.net/spec/ogcapi_common-1/1.0/req/core inherit:: <> inherit:: <> inherit:: <> +requirement:: /req/core/api-definition-op +requirement:: /req/core/api-definition-success +requirement:: /req/core/conformance-op +requirement:: /req/core/conformance-success +requirement:: /req/core/http +requirement:: /req/core/job-exception-no-such-job +requirement:: /req/core/job-op +requirement:: /req/core/job-result-op +requirement:: /req/core/job-results-exception-invalid-query-parameter-value +requirement:: /req/core/job-results-exception-no-such-job +requirement:: /req/core/job-results-exception-results-not-available +requirement:: /req/core/job-results-exception-results-not-ready +requirement:: /req/core/job-results-failed +requirement:: /req/core/job-results-op +requirement:: /req/core/job-results-param-outputs +requirement:: /req/core/job-results-param-outputs-response +requirement:: /req/core/job-results-async-many +requirement:: /req/core/job-results-async-one +requirement:: /req/core/job-results-success-sync +requirement:: /req/core/job-success +requirement:: /req/core/landingpage-op +requirement:: /req/core/landingpage-success +requirement:: /req/core/process-description-op +requirement:: /req/core/process-description-success +requirement:: /req/core/process-exception-no-such-process +requirement:: /req/core/process-execute-auto-execution-mode +requirement:: /req/core/process-execute-default-execution-mode +requirement:: /req/core/process-execute-input-array +requirement:: /req/core/process-execute-input-inline-bbox +requirement:: /req/core/process-execute-input-inline-binary +requirement:: /req/core/process-execute-input-multiple-types +requirement:: /req/core/process-execute-input-inline-object +requirement:: /req/core/process-execute-input-validation +requirement:: /req/core/process-execute-op +requirement:: /req/core/process-execute-empty-outputs +requirement:: /req/core/process-execute-omitted-outputs +requirement:: /req/core/process-execute-request +requirement:: /req/core/process-execute-success-async +requirement:: /req/core/process-execute-success-async-outputs +requirement:: /req/core/process-execute-success-async-outputs-empty +requirement:: /req/core/process-execute-success-async-outputs-omitted +requirement:: /req/core/process-execute-sync-many-json +requirement:: /req/core/process-execute-sync-one +requirement:: /req/core/process-execute-sync-one-default-content +requirement:: /req/core/process-execute-success-sync-empty-outputs +requirement:: /req/core/process-execute-success-sync-outputs-omitted +requirement:: /req/core/pl-limit-definition +requirement:: /req/core/pl-limit-response +requirement:: /req/core/pl-links +requirement:: /req/core/process-list-op +requirement:: /req/core/process-list-success +requirement:: /req/core/process-summary-links +requirement:: /req/core/test-process ==== diff --git a/core/requirements/requirements_class_dismiss.adoc b/core/requirements/requirements_class_dismiss.adoc index e946477d..c669ecdc 100644 --- a/core/requirements/requirements_class_dismiss.adoc +++ b/core/requirements/requirements_class_dismiss.adoc @@ -1,10 +1,12 @@ [[rc_dismiss]] [requirements_class] +.Requirements Class 'Dismiss' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/dismiss -label:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/dismiss -obligation:: requirement +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/dismiss subject:: Web API -inherit:: <> +inherit:: /req/core +requirement:: /req/dismiss/job-dismiss-op +requirement:: /req/dismiss/job-dismiss-status +requirement:: /req/dismiss/job-dismiss-success ==== diff --git a/core/requirements/requirements_class_html.adoc b/core/requirements/requirements_class_html.adoc index 6e0250da..1afd0551 100644 --- a/core/requirements/requirements_class_html.adoc +++ b/core/requirements/requirements_class_html.adoc @@ -1,12 +1,13 @@ [[rc_html]] [requirements_class] +.Requirements Class 'HTML' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/html -label:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/html -obligation:: requirement +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/html subject:: Web API -inherit:: <> -inherit:: http://www.opengis.net/spec/ogcapi_common/1.0/req/html[API - Common HTML] +inherit:: https://www.opengis.net/spec/ogcapi_common/1.0/req/html inherit:: <> +inherit:: /req/html +requirement:: /req/html/content +requirement:: /req/html/definition ==== diff --git a/core/requirements/requirements_class_job-list.adoc b/core/requirements/requirements_class_job-list.adoc index 9ed69929..453d2129 100644 --- a/core/requirements/requirements_class_job-list.adoc +++ b/core/requirements/requirements_class_job-list.adoc @@ -1,10 +1,25 @@ [[rc_job-list]] [requirements_class] +.Requirements Class 'Job List' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/job-list -label:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/job-list -obligation:: requirement +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/job-list subject:: Web API -inherit:: <> +inherit:: /req/core +requirement:: /req/job-list/datetime-definition +requirement:: /req/job-list/datetime-response +requirement:: /req/job-list/duration-definition +requirement:: /req/job-list/duration-response +requirement:: /req/job-list/limit-definition +requirement:: /req/job-list/limit-response +requirement:: /req/job-list/links +requirement:: /req/job-list/job-list-op +requirement:: /req/job-list/processID-definition +requirement:: /req/job-list/processID-mandatory +requirement:: /req/job-list/processid-response +requirement:: /req/job-list/status-definition +requirement:: /req/job-list/status-response +requirement:: /req/job-list/job-list-success +requirement:: /req/job-list/type-definition +requirement:: /req/job-list/type-response ==== diff --git a/core/requirements/requirements_class_json.adoc b/core/requirements/requirements_class_json.adoc index d83a9472..aad5bfdc 100644 --- a/core/requirements/requirements_class_json.adoc +++ b/core/requirements/requirements_class_json.adoc @@ -1,11 +1,11 @@ [[rc_json]] [requirements_class] +.Requirements Class 'JSON' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/json -label:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/json -obligation:: requirement +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/json subject:: Web API -inherit:: <> inherit:: <> +inherit:: /req/core +requirement:: /req/json/definition ==== diff --git a/core/requirements/requirements_class_kvp-execute.adoc b/core/requirements/requirements_class_kvp-execute.adoc index ff6af5f7..adae9a52 100644 --- a/core/requirements/requirements_class_kvp-execute.adoc +++ b/core/requirements/requirements_class_kvp-execute.adoc @@ -1,10 +1,28 @@ [[rc_kvp-execute]] [requirements_class] +.Requirements Class 'KVP-Execute' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/kvp-execute -label:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/kvp-execute -obligation:: requirement +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/kvp-execute subject:: Web API -inherit:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/core +inherit:: /req/core +requirement:: /req/kvp-execute/array-input-value +requirement:: /req/kvp-execute/bbox-crs-input-value +requirement:: /req/kvp-execute/bbox-input-value +requirement:: /req/kvp-execute/binary-input-value +requirement:: /req/kvp-execute/binary-input-value-qualified +requirement:: /req/kvp-execute/boolean-input-value +requirement:: /req/kvp-execute/complex-input-value +requirement:: /req/kvp-execute/f-definition +requirement:: /req/kvp-execute/f-response +requirement:: /req/kvp-execute/input-by-reference +requirement:: /req/kvp-execute/input-cardinality +requirement:: /req/kvp-execute/input-query-parameters +requirement:: /req/kvp-execute/input-query-parameter-values +requirement:: /req/kvp-execute/numeric-input-value +requirement:: /req/kvp-execute/output +requirement:: /req/kvp-execute/prefer-definition +requirement:: /req/kvp-execute/prefer-response +requirement:: /req/kvp-execute/process-execute-op +requirement:: /req/kvp-execute/string-input-value ==== diff --git a/core/requirements/requirements_class_local-filtering.adoc b/core/requirements/requirements_class_local-filtering.adoc index c0d8853e..ef940b82 100644 --- a/core/requirements/requirements_class_local-filtering.adoc +++ b/core/requirements/requirements_class_local-filtering.adoc @@ -1,9 +1,12 @@ [[rc_local-filtering]] [requirements_class] +.Requirements Class 'Local Filtering' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/local-filtering -subject:: Collection Input -inherit:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/core -inherit:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/collection-input +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/local-filtering +subject:: Web API +inherit:: /req/core +inherit:: /req/collection-input +inherit:: /req/remote-collections +requirement:: /req/local-filtering ==== diff --git a/core/requirements/requirements_class_oas.adoc b/core/requirements/requirements_class_oas.adoc index d9d1f7aa..1009e939 100644 --- a/core/requirements/requirements_class_oas.adoc +++ b/core/requirements/requirements_class_oas.adoc @@ -1,8 +1,13 @@ [[rc_oas]] -[cols="1,4",width="90%"] -|=== -2+|*Requirements Class* -2+|http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/oas -|Target type |Web API -|Dependency |<> -|=== +[requirements_class] +.Requirements Class 'OpenAPI' +==== +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/oas +subject:: Web API +inherit:: /req/core +requirement:: /req/oas/completeness +requirement:: /req/oas/definition +requirement:: /req/oas/exceptions-codes +requirement:: /req/oas/oas-impl +requirement:: /req/oas/security +==== diff --git a/core/requirements/requirements_class_oas30.adoc b/core/requirements/requirements_class_oas30.adoc index 46d679ba..2c7080f7 100644 --- a/core/requirements/requirements_class_oas30.adoc +++ b/core/requirements/requirements_class_oas30.adoc @@ -1,9 +1,10 @@ [[rc_oas30]] -[cols="1,4",width="90%"] -|=== -2+|*Requirements Class* -2+|http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/oas30 -|Target type |Web API -|Dependency |<> -|Dependency |<> -|=== +[requirements_class] +.Requirements Class 'OpenAPI Specification 3.0' +==== +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/oas30 +subject:: Web API +inherit:: <> +inherit:: /req/oas +requirement:: /req/oas30/oas-definition +==== diff --git a/core/requirements/requirements_class_oas31.adoc b/core/requirements/requirements_class_oas31.adoc index c0344225..c08a10a3 100644 --- a/core/requirements/requirements_class_oas31.adoc +++ b/core/requirements/requirements_class_oas31.adoc @@ -1,9 +1,10 @@ [[rc_oas31]] -[cols="1,4",width="90%"] -|=== -2+|*Requirements Class* -2+|http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/oas31 -|Target type |Web API -|Dependency |<> -|Dependency |<> -|=== +[requirements_class] +.Requirements Class 'OpenAPI Specification 3.1' +==== +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/oas31 +subject:: Web API +inherit:: <> +inherit:: /req/oas +requirement:: /req/oas31/oas-definition +==== diff --git a/core/requirements/requirements_class_ogc-process-description.adoc b/core/requirements/requirements_class_ogc-process-description.adoc index 16a1b559..8232ee14 100644 --- a/core/requirements/requirements_class_ogc-process-description.adoc +++ b/core/requirements/requirements_class_ogc-process-description.adoc @@ -1,11 +1,22 @@ [[rc_ogc-process-description]] [requirements_class] +.Requirements Class 'OGC Process Description' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/ogc-process-description -label:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/ogc-process-description -obligation:: requirement +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/ogc-process-description subject:: Web API -inherit:: <> inherit:: <> +inherit:: /req/core +requirement:: /req/ogc-process-description/data-access-apis +requirement:: /req/ogc-process-description/data-classes +requirement:: /req/ogc-process-description/execution-unit-requirements +requirement:: /req/ogc-process-description/input-def +requirement:: /req/ogc-process-description/input-multiple-types +requirement:: /req/ogc-process-description/inputs-def +requirement:: /req/ogc-process-description/json-encoding +requirement:: /req/ogc-process-description/links +requirement:: /req/ogc-process-description/output-def +requirement:: /req/ogc-process-description/output-multiple-types +requirement:: /req/ogc-process-description/outputs-def +requirement:: /req/ogc-process-description/value-passing ==== diff --git a/core/requirements/requirements_class_query-param-profile.adoc b/core/requirements/requirements_class_query-param-profile.adoc index 8c7026ea..0595935c 100644 --- a/core/requirements/requirements_class_query-param-profile.adoc +++ b/core/requirements/requirements_class_query-param-profile.adoc @@ -1,9 +1,11 @@ [[rc_query-param-profile]] [requirements_class] +./Requirements Class 'Profile Query Parameter' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/query-param-profile +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/query-param-profile subject:: Web API +inherit:: /req/core requirement:: /req/query-param-profile/definition requirement:: /req/query-param-profile/response ==== diff --git a/core/requirements/requirements_class_remote-collections.adoc b/core/requirements/requirements_class_remote-collections.adoc index ba46eb80..31cf2843 100644 --- a/core/requirements/requirements_class_remote-collections.adoc +++ b/core/requirements/requirements_class_remote-collections.adoc @@ -1,8 +1,11 @@ [[rc_remote-collections]] [requirements_class] +./Requirements Class 'Remote Collections' ==== [%metadata] -identifier:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/remote-collections -subject:: Remote Collections -inherit:: http://www.opengis.net/spec/ogcapi-processes-1/2.0/req/collection-input +identifier:: https://www.opengis.net/spec/ogcapi-processes-1/2.0/req/remote-collections +subject:: Web API +inherit:: /req/collection-input +requirement:: /req/remote-collections/access +requirement:: /req/remote-collections/referencing ==== diff --git a/core/sections/annex-bibliography.adoc b/core/sections/annex-bibliography.adoc index a29d77f6..62ab5cea 100644 --- a/core/sections/annex-bibliography.adoc +++ b/core/sections/annex-bibliography.adoc @@ -2,7 +2,11 @@ [bibliography] == Bibliography -* [[[WFS20,OGC 09-025r2]]] Open Geospatial Consortium (OGC). OGC 09-025r2: Web Feature Service 2.0 [online]. Edited by P. Vretanos. 2014 [viewed 2020-03-16]. Available at: http://docs.opengeospatial.org/is/09-025r2/09-025r2.html +* [[[OGC_06-121r9]]] OGC 06-121r9, OGC Web Service Common Specification, version 2.0 + +* [[[WFS20,OGC 09-025r2]]] Open Geospatial Consortium (OGC). OGC 09-025r2: Web Feature Service 2.0 [online]. Edited by P. Vretanos. 2014 [viewed 2020-03-16]. Available at: https://docs.opengeospatial.org/is/09-025r2/09-025r2.html + +* [[[OGC_14-065]]] OGC 14-065, OGC WPS 2.0 Interface Standard, version 2.0.2 * [[[ogc15-022,OGC 15-022]]] Matheus, A.: OGC® Testbed 11 Engineering Report: Implementing Common Security Across the OGC Suite of Service Standards, https://portal.opengeospatial.org/files/?artifact_id=63312 diff --git a/core/sections/clause_0_front_material.adoc b/core/sections/clause_0_front_material.adoc index a6056e3d..cff7f5e6 100644 --- a/core/sections/clause_0_front_material.adoc +++ b/core/sections/clause_0_front_material.adoc @@ -1,56 +1,27 @@ .Preface -The OGC API - Processes Standard defines how a client application can request the execution of a process, how the inputs to that process can be provided, and how the output from the process is handled. The Standard specified who to "wrap" computational tasks into an executable process that can be invoked by a client application. Examples of computational processes that can be supported by implementations of API Processes include raster algebra, geometry buffering, constructive area geometry, routing, imagery analysis and several others. +This Standard specified how to "wrap" computational tasks into an executable process that can be invoked by a client application. Examples of computational processes that can be supported by implementations of API Processes include raster algebra, geometry buffering, constructive area geometry, routing, imagery analysis, AI models, and others. Specifically, the OGC API - Processes Standard defines how a client application can request the execution of a process, how the inputs to that process can be provided, and how the outputs from that process are retrieved. [abstract] == Abstract -The OGC API - Processes Standard specifies a Web API that enables the execution of computing processes, the retrieval of metadata describing their purpose and functionality and the retrieval of the results of the process execution. The requirements specified in the OGC API — Processes Standard build on the OGC Web Processing Service (WPS) 2.0 Standard and specify a processing interface to communicate over a RESTful protocol using JSON encodings. +The OGC API - Processes Standard is a resource-oriented API that allows for the execution of computing processes and the retrieval of metadata describing those processes. It is the modern, RESTful successor to the older Web Processing Service (WPS) standard. It utilizes OpenAPI, JSON and modern web architectural patterns to make geospatial processing more accessible to web developers. -By way of background and context, in many cases geospatial or location data (including data from sensors) must be processed before the information can be effectively used. The OGC Web Processing Service (WPS) Interface Standard specifies a standard interface that simplifies the task of making simple or complex computational geospatial processing services accessible via web services. Such services include well-known GIS processes as well as specialized processes for spatiotemporal modeling and simulation. While the OGC WPS Standard was designed with spatial processing in mind, WPS implementations could also be used to readily insert non-spatial processing tasks into a web services environment. The WPS Standard provides a robust, interoperable, and versatile protocol for process execution on web services. Implementations of the WPS Standard can support both immediate processing for computational tasks that take little time and asynchronous processing for more complex and time-consuming tasks. Moreover, the WPS Standard defines a general process model that is designed to provide an interoperable description of processing functions. The WPS Standard was designed to support process cataloging and discovery in a distributed environment. +The key benefits of the Standard are: -The requirements in the OGC API – Processes Standard are designed to provide the same implementation functionality as a WPS implementation but are based on a more modern way of programming and interacting with resources over the web while allowing better integration into existing software packages. +* **Developer friendly:** By default, the Standard uses JSON and integrates easily with modern web frameworks and tools like Swagger/ReDoc. -The resources that are provided by a server implementing the OGC API - Processes Standard are listed in <> below and include information about the server, the list of available processes (Process list and Process description), jobs (running processes) and -results of process executions. +* **Scalable:** The Standard is designed to work well with cloud-native architectures, microservices and containerized environments. -This following table provides an overview of resources, applicable HTTP methods and links to the related document sections. +* **Modular:** The "building-blocks" approach allows servers to implement only what they need (e.g. a server might support process execution but not dynamic process deployment). -[[table_core_resources]] -.Requirements class `Core` -[cols=",,,,",options="header"] -|=== -|Resource |Path |HTTP method |Parameter |Document reference -|Landing page |`/` |GET |N/A |<> -|Conformance classes |`/conformance` |GET |N/A |<> -|Process list |`/processes` |GET |N/A |<> -|Process description |`/processes/{processID}` |GET |processID (in path)|<> -|Process execution |`/processes/{processID}/execution` |POST |processID (in path), Execute request (contained in body) |<> -|Job status info |`/jobs/{jobID}` |GET |jobID (in path) |<> -|Job results |`/jobs/{jobID}/results` |GET |jobID (in path) |<> -|Result |`/jobs/{jobID}/results/{outputID}` |GET |jobID (in path), outputID (in path) |<> -|=== - -In general, the HTTP GET operation is used to provide access to the resources described above. -However, in order to execute a process, the HTTP POST method is used to send an <> to the server. - -Additionally, the `/jobs` endpoint can be used to grant access to a list of jobs. +* **Interoperable:** Standardizing how parameters are passed to algorithms ensures that a client can trigger a process on any compliant server regardless of the underlying programming language (e.g. C, Python, Java, etc.) -.Requirements class `Job list` -[cols="27,25,10,10,28",options="header"] -|=== -|Resource |Path |HTTP method | Parameter| Document reference -|Job list |`/jobs` |GET | N/A |<> -|=== +Like other OGC APIs (such as Features or Records), OGC API Processes uses a common core for landing pages, conformance declarations, and API definitions. This consistency allows developers to use similar patterns across different types of geospatial web services. -In addition to the operations accessible through HTTP GET and POST methods, the DELETE method can be used to cancel a job execution and/or remove traces of the job execution. +== Acknowledgements -.Requirements class `Dismiss` -[cols="27,25,10,10,28",options="header"] -|=== -|Resource |Path |HTTP method | Parameter| Document reference -|Job status info |`/jobs/{jobID}` |DELETE| jobID (in path) | <> -|=== +Requirements integrated within version 2.0 of this OGC API - Processes Standard was sourced from Part 3: Workflows, whose development was undertaken as part of GeoConnections 2020-2021 and 2025-2027 projects GNS20-21IFP02 (Modular OGC API Workflows) and GNS25-27IFP2 (Advancing and Implementing OGC Standards for GeoDataCubes, DGGSs, Data Stores for Digital Twins and Cartographic Symbology). Financial support provided by GeoConnections, a national collaborative initiative led by Natural Resources Canada. GeoConnections supports the modernization of the Canadian Geospatial Data Infrastructure (CGDI). The CGDI is the collection of geospatial data, standards, policies, applications, and governance that facilitate its access, use, integration, and preservation. == Submitters diff --git a/core/sections/clause_12_oas.adoc b/core/sections/clause_12_oas.adoc index 89157a33..d1c7b39a 100644 --- a/core/sections/clause_12_oas.adoc +++ b/core/sections/clause_12_oas.adoc @@ -41,7 +41,7 @@ description: An error occurred. content: application/json: schema: - $ref: http://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/common-core/exception.yaml + $ref: https://schemas.opengis.net/ogcapi/processes/part1/2.0/openapi/schemas/common-core/exception.yaml text/html: schema: type: string @@ -53,7 +53,7 @@ content: include::../requirements/oas/REQ_security.adoc[] -The OpenAPI specification currently supports the following link:http://spec.openapis.org/oas/v3.0.3#security-scheme-object[security schemes]: +The OpenAPI specification currently supports the following link:https://spec.openapis.org/oas/v3.0.3#security-scheme-object[security schemes]: * HTTP authentication, @@ -65,7 +65,7 @@ The OpenAPI specification currently supports the following link:http://spec.open === Requirements Class "OpenAPI Specification 3.0" -Servers conforming to this requirements class define their API by an link:http://spec.openapis.org/oas/v3.0.3#openapi-document[OpenAPI 3.0 Document]. +Servers conforming to this requirements class define their API by an link:https://spec.openapis.org/oas/v3.0.3#openapi-document[OpenAPI 3.0 Document]. include::../requirements/requirements_class_oas30.adoc[] @@ -73,7 +73,7 @@ include::../requirements/oas30/REQ_oas-definition.adoc[] === Requirements Class "OpenAPI Specification 3.1" -Servers conforming to this requirements class define their API by an link:http://spec.openapis.org/oas/v3.1.0#openapi-document[OpenAPI 3.1 Document]. +Servers conforming to this requirements class define their API by an link:https://spec.openapis.org/oas/v3.1.0#openapi-document[OpenAPI 3.1 Document]. include::../requirements/requirements_class_oas31.adoc[] diff --git a/core/sections/clause_13_job_list.adoc b/core/sections/clause_13_job_list.adoc index 675c67d5..87deb69a 100644 --- a/core/sections/clause_13_job_list.adoc +++ b/core/sections/clause_13_job_list.adoc @@ -98,7 +98,7 @@ include::../recommendations/job-list/PER_prev.adoc[] ==== [source] ---- -http://processing.example.org/jobs +https://processing.example.org/jobs ---- ==== diff --git a/core/sections/clause_16_kvp-execute.adoc b/core/sections/clause_16_kvp-execute.adoc index d80f9e96..751dfaff 100644 --- a/core/sections/clause_16_kvp-execute.adoc +++ b/core/sections/clause_16_kvp-execute.adoc @@ -23,7 +23,7 @@ variables=TMAX,TMIN,PRCP [source] ---- -http://www.someserver.com/processes/echo/execution? +https://www.someserver.com/processes/echo/execution? stringInput=Value2& measureInput=%7B%22value%22%3A%7B%22measurement%22%3A10.3%2C%22uom%22%3A%22m%22%2C%22reference%22%3A%22https%3A%2F%2Fucum.org%2Fucum-essence.xml%22%7D%7D dateInput=2021-03-06T07:21:00& @@ -33,7 +33,7 @@ complexObjectInput=%22value%22%3A%7B%22property1%22%3A%22value1%22%2C%22property geometryInput=%5B%7B%22value%22%3A%22%3Cgml%3APolygongml%3Aid%3D%5C%22GID1%5C%22srsName%3D%5C%22urn%3Aogc%3Adef%3Acrs%3AOGC%3A%3ACRS84%5C%22%3E%3Cgml%3Aexterior%3E%3Cgml%3ALinearRing%3E%3Cgml%3AposList%3E-77.02451938.810529-77.02463538.810973-77.02470438.810962-77.02477638.811239-77.02495738.81121-77.02490538.811012-77.02490538.811012-77.02486538.810857-77.02502438.810832-77.02507138.811012-77.02520338.810992-77.0250638.810444-77.02451938.810529%3C%2Fgml%3AposList%3E%3C%2Fgml%3ALinearRing%3E%3C%2Fgml%3Aexterior%3E%3C%2Fgml%3APolygon%3E%22%2C%22mediaType%22%3A%22application%2Fgml%2Bxml%3Bversion%3D3.2%22%7D%2C%7B%22value%22%3A%7B%22type%22%3A%22Polygon%22%2C%22coordinates%22%3A%5B%5B%5B-176.5814819%2C-44.10896301%5D%2C%5B-176.5818024%2C-44.10964584%5D%2C%5B-176.5844116%2C-44.11236572%5D%2C%5B-176.5935974%2C-44.11021805%5D%2C%5B-176.5973511%2C-44.10743332%5D%2C%5B-176.5950928%2C-44.10562134%5D%2C%5B-176.5858459%2C-44.1043396%5D%2C%5B-176.5811157%2C-44.10667801%5D%2C%5B-176.5814819%2C-44.10896301%5D%5D%5D%7D%7D%5D& imagesInput=%5B%7B%22href%22%3A%22https%3A%2F%2Fwww.someserver.com%2Fogcapi%2FDaraa%2Fcollections%2FDaraa_DTED%2Fstyles%2FTopographic%2Fcoverage%3F...%22%2C%22type%22%3A%22image%2Ftiff%3Bapplication%3Dgeotiff%22%7D%2C%7B%22value%22%3A%22VBORw0KGgoAAAANSUhEUgAABvwAAAa4CAYAAABMB35kAAABhGlDQ1BJQ0MgcHJvZmlsZQAA%5CnKJF9kT1Iw0AcxV9TpSL1A%2BxQxCFDdbIgKuKoVShChVArtOpgcumH0KQhSXFxFFwLDn4sVh1c%5CnnHV1cBUEwQ8QNzcnRRcp8X9JoUWMB8f9eHfvcfcOEOplplkdY4Cm22Y6mRCzuRUx9IogouhH%5Cn...%5Cnj3Z5mX7%2FPCPVRJV92rpHK24xcJrzk20%2BtkeYlCPqcZNO3Lpni1OJWatPCcmgGDEqx7Om6lfa%5CnppM4k4BTe9%2Bbsn3L9%2F9%2FyWhA0PwQGW8ipCZsnZt9lsdrYEM8z%2FM8z%2FM8z%2FM8z%2FM8z%2FMzLWY1%5CnAAAACUlEQVQ871H6P6JI%2BTxS5Wn2AAAAAElFTkSuQmCC%22%2C%22encoding%22%3A%22base64%22%2C%22mediaType%22%3A%22image%2Fjp2%22%7D%5D boundingBoxInput=51.9,7,52,7.1& -boundingBoxInput-crs=http://www.opengis.net/def/crs/OGC/1.3/CRS84& +boundingBoxInput-crs=https://www.opengis.net/def/crs/OGC/1.3/CRS84& featureCollectionInput=%7B%22value%22%3A%22%3C%3Fxmlversion%3D%5C%221.0%5C%22encoding%3D%5C%22UTF-8%5C%22%3F%3E%3CFeatureCollectionxmlns%3D%5C%22http%3A%2F%2Fschemas.myserver.com%2Fnamespaces%2Fnull%5C%22xmlns%3Agml%3D%5C%22http%3A%2F%2Fwww.opengis.net%2Fgml%2F3.2%5C%22xmlns%3Axsi%3D%5C%22http%3A%2F%2Fwww.w3.org%2F2001%2FXMLSchema-instance%5C%22xsi%3AschemaLocation%3D%5C%22http%3A%2F%2Fschemas.myserver.com%2Fnamespaces%2Fnullhttps%3A%2F%2Fwww.pvretano.com%2Fmyserver%2Fogcapi%2Fdaraa%2Fschema%3Ff%3DGML32%26amp%3Bcollectionids%3DTransportationGroundCrvhttp%3A%2F%2Fwww.opengis.net%2Fgml%2F3.2http%3A%2F%2Fschemas.opengis.net%2Fschemas%2Fgml%2F3.2.1%2Fgml.xsd%5C%22%3E...%22%2C%22mediaType%22%3A%22application%2Fgml%2Bxml%3Bversion%3D3.2%22%7D& stringOutput[include]=true& measureOutput[include]=true& @@ -324,11 +324,11 @@ images=%5B%7B%22href%22%3A%22http%3A%2F%2Fwww.imagearchive.com%2Fimages%2Fimage0 Decoded value is: images=[ { - "href":"http://www.imagearchive.com/images/image01.tif", + "href":"https://www.imagearchive.com/images/image01.tif", "type":"image/tiff;applcation=geotiff" }, { - "href":"http://www.imagearchive.com/images/image19.jp2, + "href":"https://www.imagearchive.com/images/image19.jp2, "type":"image/jp2" } ] @@ -434,7 +434,7 @@ include::../requirements/kvp-execute/REQ_input-by-reference.adoc[] ==== [source] ---- -imageInput[href]=http://www.someserver.com/image.tiff&imageInput[type]=image/tiff;application=geotiff +imageInput[href]=https://www.someserver.com/image.tiff&imageInput[type]=image/tiff;application=geotiff ---- ==== diff --git a/core/sections/clause_2_conformance.adoc b/core/sections/clause_2_conformance.adoc index db392f20..51ed344c 100644 --- a/core/sections/clause_2_conformance.adoc +++ b/core/sections/clause_2_conformance.adoc @@ -1,8 +1,7 @@ - [[sc_conformance]] == Conformance -This Standard defines seven requirements / conformance classes. +This Standard defines sixteen requirements / conformance classes. The standardization targets of all conformance classes are "Web APIs." @@ -12,14 +11,15 @@ The main requirements class is: The _Core_ specifies requirements that all Web APIs have to implement. -The _Core_ does not mandate a specific encoding or format for the representation of resources defined in this Standard. Rather, two requirements classes depend on the _Core_ and specify representations for the resources specified in the _Corea_ in commonly used encodings for data on the Web: +The _Core_ does not mandate a specific encoding or format for the representation of resources defined in this Standard. Rather, two requirements classes depend on the _Core_ and specify representations for the resources specified in the _Core_ in commonly used encodings for data on the Web: * <>, and * <>. -Furthermore, the _Core_ does not mandate any encoding or format for the formal definition of the Processes API. The OpenAPI specification is one option for defining the Processes API. As such a requirements classes have been specified for OpenAPI 3.0 and 3.1, which depends on the requirements class _Core_: +Furthermore, the _Core_ does not mandate any encoding or format for the formal definition of the Processes API. The OpenAPI specification is one option for defining the Processes API. As such a requirements classes have been specified for supporting OpenAPI and specifically OpenAPI 3.0 and 3.1, which depends on the requirements class _Core_: +* <> * <> * <> @@ -39,15 +39,49 @@ The _Core_ does not mandate the use of any specific process description language * <> This class defines an information model, encoded in JSON, which may be used to -specify the interface of a process. +specify the interface of a process including the inputs that the process expects and the outputs that the process will generate. + +Besides the standard input types one might expect for a process (e.g. integer, string, double, etc.) this Standard defines the following conformance class: + +* <> + +that allows OGC API collections to be specified as process inputs. The <> class only supports collections that are local to the current deployment to be specified as process inputs. The following conformance class: + +* <> + +extends the collection input requirements to support specifying remote collections as process inputs. + +By default, the <> and <> conformance classes rely on the data server being accessed for input values to provide filtering capabilities to identify the subset of data to be fed to a process as input values. The following conformance class: + +* <> + +defines requirements that allow the processing server itself to perform filtering of input values in the cases where the value source server does not support the requested filtering operations (e.g. applying a CQL2 filter to data from a server that does not support CQL2 filtering). + +In addition to supporting collections as process inputs, the following conformance class: + +* <> + +defines requirements that allow process execution to be triggered by requesting output data using an standard <>. In this way, process execution becomes opaque, hidden behind a standard OGC data access API (e.g. features, coverages, etc.). + +In the <> executing a process requires sending a JSON-encoded execution request to the server using the HTTP POST method. To support embedding process execution requests into other documents this Standard defines the: + +* <> + +conformance class which allows process inputs to be encoded as query parameters on a URL and process execution to be invoked using the HTTP GET method. + +The standard request and response encoding used in this Standard is JSON. The standard media type for JSON is `application/json` which does not allow for the descrimition of one JSON schema from another. In order to resolve this issue the Standard supports content negotiation by profile and defines the `profile` query parameter in the: + +* <. + +conformance class. Using the `profile` query parameter JSON-encoded responses can be requested that conform to a specific JSON schemas. Three additional conformance classes are specified that extend the basic functionality of an API: -* <>, and +* <> for request a list of jobs with optional filtering capabilities, -* <>, and +* <> for cancelling active jobs or deleting completed jobs, and -* <>. +* <> for supporting a callback mechnanism to get notification of completed jobs. Additional capabilities such as support for transactions, extended job monitoring, etc., may be specified in future parts of the OGC API - Processes series or as vendor-specific extensions. @@ -58,14 +92,20 @@ Conformance with this Standard SHALL be checked using all the relevant tests spe |=== | Conformance class | URI -|<> |http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/core -|<> |http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/ogc-process-description -|<> |http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/json -|<> |http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/html -|<> |http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas -|<> |http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas30 -|<> |http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas31 -|<> |http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/job-list -|<> |http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/callback -|<> |http://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/dismiss +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/core +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/ogc-process-description +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/json +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/html +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas30 +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/oas31 +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/job-list +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/callback +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/dismiss +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/collection-input +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/remote-collections +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/collection-output +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/local-filtering +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/kvp-execute +|<> |https://www.opengis.net/spec/ogcapi-processes-1/2.0/conf/query-param-profile |=== diff --git a/core/sections/clause_3_references.adoc b/core/sections/clause_3_references.adoc index 73189011..334a012a 100644 --- a/core/sections/clause_3_references.adoc +++ b/core/sections/clause_3_references.adoc @@ -2,9 +2,11 @@ [bibliography] == References -* [[[OpenAPI30]]] OpenAPI Initiative (OAI). **OpenAPI Specification 3.0** [online]. 2020 [viewed 2024-11-04]. The latest patch version at the time of publication of this standard was 3.0.4, available at http://spec.openapis.org/oas/v3.0.4 +* [[[OpenAPI30]]] OpenAPI Initiative (OAI). **OpenAPI Specification 3.0** [online]. 2020 [viewed 2024-11-04]. The latest patch version at the time of publication of this standard was 3.0.4, available at https://spec.openapis.org/oas/v3.0.4 -* [[[OpenAPI31]]] OpenAPI Initiative (OAI). **OpenAPI Specification 3.1** [online]. 2021 [viewed 2024-11-04]. The latest patch version at the time of publication of this standard was 3.1.1, available at http://spec.openapis.org/oas/v3.1.1 +* [[[OpenAPI31]]] OpenAPI Initiative (OAI). **OpenAPI Specification 3.1** [online]. 2021 [viewed 2024-11-04]. The latest patch version at the time of publication of this standard was 3.1.1, available at https://spec.openapis.org/oas/v3.1.1 + +* [[[OGC_19-072]]] OGC 19-072, OGC API - Common - Part 1: Core, Version 1.0 * [[[rfc6906]]] Internet Engineering Task Force (IETF). RFC 6906: **The 'profile' Link Relation Type** [online]. Edited by E. Wilde. 2013]. Available at https://datatracker.ietf.org/doc/html/rfc6906.html @@ -26,17 +28,13 @@ * [[[OGC_08-131r3]]] OGC 08-131r3 -- The Specification Model -- A Standard for Modular Specifications -* [[[OGC_06-121r9]]] OGC 06-121r9, OGC Web Service Common Specification, version 2.0 - -* [[[OGC_14-065]]] OGC 14-065, OGC WPS 2.0 Interface Standard, version 2.0.2 - -* [[[rfc2246]]] IETF RFC 2246. Transport Layer Security. http://tools.ietf.org/html/rfc2246 +* [[[rfc2246]]] IETF RFC 2246. Transport Layer Security. https://tools.ietf.org/html/rfc2246 -* [[[rfc2616]]] IETF RFC 2616. Hypertext Transfer Protocol - HTTP/1.1. http://tools.ietf.org/html/rfc2616 +* [[[rfc2616]]] IETF RFC 2616. Hypertext Transfer Protocol - HTTP/1.1. https://tools.ietf.org/html/rfc2616 * [[[rfc2617]]], IETF RFC 2617. HTTP Authentication: Basic and Digest Access Authentication. https://tools.ietf.org/html/rfc2617 -* [[[rfc2387]]] IETF RFC 2387, The MIME Multipart/Related Content-type. http://tools.ietf.org/html/rfc2387 +* [[[rfc2387]]] IETF RFC 2387, The MIME Multipart/Related Content-type. https://tools.ietf.org/html/rfc2387 * [[[rfc3986]]] IETF RFC 3986: Uniform Resource Identifier (URI): Generic Syntax. https://tools.ietf.org/html/rfc3986 diff --git a/core/sections/clause_4_terms_and_definitions.adoc b/core/sections/clause_4_terms_and_definitions.adoc index 171a013a..f63ad832 100644 --- a/core/sections/clause_4_terms_and_definitions.adoc +++ b/core/sections/clause_4_terms_and_definitions.adoc @@ -6,7 +6,7 @@ [[def-collection]] ==== collection; OGC API collection -A resource that may be available as one or more sub-resource distributions that conform to one or more https://www.ogc.org/standards[OGC API standards]. (https://docs.ogc.org/DRAFTS/20-024.html[OGC API - Common - Part 2: Geospatial Data]) +(in the context of OGC APIs) A set of spatiotemporal data that may be available through one or more access mechanisms defined by https://www.ogc.org/standards[OGC API standards]. (https://docs.ogc.org/DRAFTS/20-024.html[OGC API - Common - Part 2: Geospatial Data]) [[def-collection-description]] ==== collection description document @@ -47,7 +47,7 @@ A <> that is local to the <>/ EXAMPLE: https://docs.ogc.org/is/20-057/20-057.html[_OGC API - Tiles - Part 1: Core_], https://docs.ogc.org/DRAFTS/19-087.html[_OGC API - Coverages - Part 1: Core_], https://docs.ogc.org/DRAFTS/21-038r1.html[_OGC API - Discrete Global Grid Systems - Part 1: Core_], https://docs.ogc.org/is/17-069r4/17-069r4.html[_OGC API - Features - Part 1: Core_], https://docs.ogc.org/is/19-086r6/19-086r6.html[_OGC API - Environmental Data Retrieval Standard_], https://docs.ogc.org/is/20-058/20-058.html[_OGC API - Maps - Part 1: Core_] @@ -95,17 +95,17 @@ Process outputs are the results of a process and refer to data returned by a pro [[explicit-process-output]] ==== process output (explicitly requested) -A process output with identifier `{outputID}` that is explicitly specified in the "outputs" section of an <>. +A process output that is defined in the <> and is explicitly specified using its identifier `{outputID}` in the "outputs" section of an <>. [[implicit-process-output]] ==== process output (implicitly requested) A process output that is defined in the <> and is generated as a result of an <> where the "outputs" parameter has been omitted. Omitting the "outputs" parameters of an <> is equivalent to explicitly requesting all of the outputs defined in the <> -[[def-remote-collection]] -==== remote collection +[[def-remote-collections]] +==== remote collections -A <> that is not local to the <> <>. +A <> that is available from an external OGC API deployment different from the deployment whose process is being executed. ==== REST diff --git a/core/sections/clause_5_conventions.adoc b/core/sections/clause_5_conventions.adoc index a7939f7a..838b5b4f 100644 --- a/core/sections/clause_5_conventions.adoc +++ b/core/sections/clause_5_conventions.adoc @@ -8,7 +8,7 @@ This section provides details and examples for any conventions used in the docum The normative provisions in this Standard are denoted by the URI -http://www.opengis.net/spec/ogcapi-processes-1/1.0 +https://www.opengis.net/spec/ogcapi-processes-1/1.0 All requirements, permission, recommendations, and conformance tests that appear in this document are denoted by partial URIs which are relative to this base. @@ -48,23 +48,23 @@ The following https://www.iana.org/assignments/link-relations/link-relations.xht In addition, the following link relation types are used for which no applicable registered link relation type could be identified. -* **http://www.opengis.net/def/rel/ogc/1.0/conformance**: Refers to a resource that identifies the specifications that the link's context conforms to. +* **https://www.opengis.net/def/rel/ogc/1.0/conformance**: Refers to a resource that identifies the specifications that the link's context conforms to. -* **http://www.opengis.net/def/rel/ogc/1.0/exceptions**: The target URI points to exceptions of a failed process. +* **https://www.opengis.net/def/rel/ogc/1.0/exceptions**: The target URI points to exceptions of a failed process. -* **http://www.opengis.net/def/rel/ogc/1.0/execute**: The target URI points to the execution endpoint of the server. +* **https://www.opengis.net/def/rel/ogc/1.0/execute**: The target URI points to the execution endpoint of the server. -* **http://www.opengis.net/def/rel/ogc/1.0/job-list**: The target URI points to the list of jobs. +* **https://www.opengis.net/def/rel/ogc/1.0/job-list**: The target URI points to the list of jobs. -* **http://www.opengis.net/def/rel/ogc/1.0/processes**: The target URI points to the list of processes the API offers. +* **https://www.opengis.net/def/rel/ogc/1.0/processes**: The target URI points to the list of processes the API offers. -* **http://www.opengis.net/def/rel/ogc/1.0/results**: The target URI points to the results of a job. +* **https://www.opengis.net/def/rel/ogc/1.0/results**: The target URI points to the results of a job. Each resource representation includes an array of links. Implementations are free to add additional links for all resources provided by an implementation of the Processes API. === Use of HTTPS -For simplicity, this Standard only refers to the HTTP protocol. This is not meant to exclude the use of HTTPS. This is simply a shorthand notation for "HTTP or HTTPS". In fact, most servers are expected to use <>, not <>. +For simplicity, this Standard only refers to the HTTPS protocol. This is not meant to exclude the use of HTTP. This is simply a shorthand notation for "HTTP or HTTPS". In fact, most servers are expected to use <>, not <>. OGC Web API Standards do not prohibit the use of any valid HTTP option. However, implementers should be aware that optional capabilities which are not in common use could be an impediment to interoperability. diff --git a/core/sections/clause_6_overview.adoc b/core/sections/clause_6_overview.adoc index a88d7fbb..dfe9b5d1 100644 --- a/core/sections/clause_6_overview.adoc +++ b/core/sections/clause_6_overview.adoc @@ -2,16 +2,52 @@ [[overview]] == Overview -The OGC API - Processes Standard builds on the WPS 2.0 Standard and is modularized. This means that there is a separation between: +=== Web Processing Service -* Core requirements, that specify basic capabilities and can easily be mapped to existing OGC Web Processing Services. -* More advanced functionality that is not specified in WPS 2.0. +The OGC Web Processing Service (WPS) is a legacy interface standard that defines how to offer and execute geospatial processing algorithms over the web. The WPS standard is designed to wrap any type of GIS functionality—from a simple "buffer" tool to a complex climate model—into a web service that can be discovered and invoked by any compliant client. The WPS standard is built around three mandatory "requests" (methods) that a client can send to a server. The methods are: +* **GetCapabilites:** Returns metadata about the service including a list of all + avilable processes hosted by the server. +* **DescribeProcess:** Provides a detailed description of a specific process inc +luding its required inputs and the output that it produces. +* **Execute:** Tells the server to run a specified process with the set of provi +ded inputs. + +The WPS uses a rigid RPC-style invocation method using a fixed endpoint with different values for the "request" parameter to invoke the different methods. It also relies heavily of XML and complex GML schemas. + +The requirements in the OGC API – Processes Standard are designed to provide the same functionality as a WPS implementation but based on modern resource-oriented web architectural patterns. + +=== Resources overview + +The following table provides a summary of the resources and method specified by the OGC API - Processes Standard. + +[[table_core_resources]] +.Requirements class `Core` +[cols=",,,,",options="header"] +|=== +|Resource description |Path |HTTP method |Parameter |Document reference +|Landing page |`/` |GET |N/A |<> +|Conformance classes |`/conformance` |GET |N/A |<> +|Lists all available processes offered by the server|`/processes` |GET |N/A |<> +|Provides detailed matadata about a specific process |`/processes/{processID}` |GET |processID (in path)|<> +|The endpoint used to trigger execution of a process |`/processes/{processID}/execution` |POST |processID (in path), Execute request (contained in body) |<> +|List of all current and past processing jobs|`/jobs` |GET | N/A |<> +|Status of a specific job|`/jobs/{jobID}` |GET |jobID (in path) |<> +|The endpoint to retrieve all requested processing results|`/jobs/{jobID}/results` |GET |jobID (in path) |<> +|The endpoint to retrieve a specific processing result|`/jobs/{jobID}/results/{outputID}` |GET |jobID (in path), outputID (in path) |<> +|Dismiss a job|`/jobs/{jobID}` |DELETE| jobID (in path) | <> +|=== === Encodings JSON is the encoding for requests and responses. The inputs and outputs of a process can be in any format. The formats are defined at the time of job creation and are fixed for the specific job. -<> is recommended as HTML is the core language of the World Wide Web. -A server that supports HTML will support browsing with a web browser -and will enable search engines to crawl and index the processes. +<> is recommended as HTML is the core language of the World Wide Web. A server that supports HTML will support browsing with a web browser and will enable search engines to crawl and index the processes. + +=== Execution modes + +The standard supports two ways of execution a process: + +* **Synchronous:** The client stays connected and waits for the server to finish the task and return the result immediately. This is ideal for quick calculations. + +* **Asynchronous:** The server acknowledges the request and provides a job ID. The client polls the job status and retrieves the results later. This is necessary for long-running computations. diff --git a/core/sections/clause_7_core.adoc b/core/sections/clause_7_core.adoc index bfaf46b7..fcb3d908 100644 --- a/core/sections/clause_7_core.adoc +++ b/core/sections/clause_7_core.adoc @@ -27,7 +27,7 @@ The <> contains information about in A HTTP POST request to the execution-endpoint creates a new job. The inputs and outputs need to be passed in a JSON execute-request. -The URL for accessing status information is delivered in the HTTP header `location`. +The URL for accessing status information is delivered in the HTTP header `Location`. After a process is finished (status = successful/failed), the results/exceptions can be retrieved. @@ -42,11 +42,11 @@ The OGC API - Processes Standard utilizes elements of the OGC API-Common Standar [cols="2,6"] |=== ^|*API - Processes Section* ^|*API-Common Requirements Class* -|<>| http://www.opengis.net/spec/ogcapi-common-1/2.0/req/core -|<>| http://www.opengis.net/spec/ogcapi-common-1/2.0/req/core -|<>| http://www.opengis.net/spec/ogcapi-common-1/2.0/req/core -|<>| http://www.opengis.net/spec/ogcapi-common-1/2.0/req/oas30 -|<>| http://www.opengis.net/spec/ogcapi-common-1/2.0/req/html +|<>| https://www.opengis.net/spec/ogcapi-common-1/1.0/req/landing-page +|<>| https://www.opengis.net/spec/ogcapi-common-1/1.0/req/landing-page +|<>| https://www.opengis.net/spec/ogcapi-common-1/1.0/req/landing-page +|<>| https://www.opengis.net/spec/ogcapi-common-1/2.0/req/oas30 +|<>| https://www.opengis.net/spec/ogcapi-common-1/2.0/req/html |=== @@ -128,12 +128,13 @@ include::../requirements/core/REQ_api-definition-success.adoc[] include::../recommendations/core/REC_api-definition-oas.adoc[] -If multiple API definition formats are supported by a server, use -content negotiation to select the desired representation. +If multiple API definition formats are supported by a server, use content negotiation to select the desired representation. [NOTE] ==== -Two common approaches are: +Common approaches include: + +* Standard HTTP content negotiation using the HTTP header `Accept`; * An additional path for each encoding of each resource (this can be expressed, for example, using format specific suffixes like ".html"); @@ -284,9 +285,9 @@ NOTE: This is not always the case (e.g. `image/tiff; application=geotiff; profil NOTE: A set of profile URIs for JSON content defined in this Standard can be found in the <> table. [[sc_limit_parameter]] -=== Limit parameter +=== Limit query parameter -Several resources defined in this Standard (see <>, <>) use the `limit` parameter to control the maximum number of results that are presented in a response page. +Several resources defined in this Standard (see <>, <>) use the `limit` query parameter to control the maximum number of results that are presented in a response page. * The client can request a limit it is interested in. @@ -309,7 +310,7 @@ This Standard provides requirements and recommendations about links in general a [[next-link-discussion]] This Stadard does not mandate any specific implementation approach for the `next` links. -An implementation of the Processes API could use opaque links that are managed by the server. It is up to the server to determine how long these links can be dereferenced. Clients should be prepared to receive a 404 response. +An implementation of the Processes API could use opaque links that are managed by the server. It is up to the server to determine how long these links can be dereferenced. Clients should be prepared to receive a 404 or 410 response. Another implementation approach is to use an implementation-specific parameter that specifies the index within the result set from which the server begins presenting results in the response, like `offset` or the `startIndex` parameter that was used in <>. @@ -328,7 +329,7 @@ include::../recommendations/core/REC_link-header.adoc[] [[sc_process_list]] === Retrieve a process list -The following section defines the requirements to retrieve the available processes offered by an implmentation of the Processes API. +The following section defines the requirements to retrieve the available processes offered by an implementation of the Processes API. It should be noted that the number of processes exposed via the Processes API may be very different than the number of processes offer by a back-end system upon which the Processes API is implemented. @@ -338,8 +339,7 @@ It should be noted that the number of processes exposed via the Processes API ma include::../requirements/core/REQ_process-list-op.adoc[] - -===== Parameter `limit` +===== Query parameter `limit` include::../requirements/core/REQ_process-list-limit-def.adoc[] @@ -385,13 +385,13 @@ NOTE: This schema can also be obtained from https://raw.githubusercontent.com/op The number of process summaries returned depends on the server and the parameter `limit.` -See the discussion about the `limit` parameter in the <> section. +See the discussion about the `limit` query parameter in the <> section. include::../requirements/core/REQ_process-list-links.adoc[] include::../requirements/core/REQ_process-summary-links.adoc[] -See the discussion about the `next` links in the <> section. +See the discussion about the `next` links in the <> section. include::../recommendations/core/REC_process-list-next-1.adoc[] @@ -399,7 +399,7 @@ include::../recommendations/core/REC_process-list-next-2.adoc[] include::../recommendations/core/REC_process-list-next-3.adoc[] -See the discussion about the `prev` link in the <> section. +See the discussion about the `prev` link in the <> section. include::../recommendations/core/PER_process-list-prev.adoc[] @@ -455,6 +455,7 @@ See <> for general guidance. include::../requirements/core/REQ_process-exception-no-such-process.adoc[] +include::../recommendations/core/PER_process-exception-process-gone.adoc[] [[sc_execute_process]] === Execute a process @@ -517,7 +518,7 @@ NOTE: This schema can also be obtained from https://raw.githubusercontent.com/op A process may be executed synchronously or asynchronously. -Which mode a server responds with is a function of the job control options specified in the <> and the presence or absence of the HTTP `Prefer` header (http://tools.ietf.org/rfc/rfc7240.txt[IETF RFC 7240]). +Which mode a server responds with is a function of the job control options specified in the <> and the presence or absence of the HTTP `Prefer` header (https://tools.ietf.org/rfc/rfc7240.txt[IETF RFC 7240]). include::../requirements/core/REQ_process-execute-default-execution-mode.adoc[] @@ -525,7 +526,10 @@ include::../requirements/core/REQ_process-execute-auto-execution-mode.adoc[] include::../recommendations/core/REC_process-execute-honor-prefer.adoc[] -include::../recommendations/core/REC_process-execute-handle-prefer.adoc[] +[NOTE] +==== +A client that accompanies an <> with the HTTP https://datatracker.ietf.org/doc/html/rfc7240#section-2[`Prefer`] header asserting a https://tools.ietf.org/html/rfc7240#section-4.1[`respond-async`] preference and/or a https://tools.ietf.org/html/rfc7240#section-4.3[`wait`] preference SHOULD be prepared to receive either an asynchronous or a synchronous response. +==== include::../recommendations/core/REC_process-execute-preference-applied.adoc[] @@ -738,10 +742,10 @@ In this second example, the property, `geometryInput` has a cardinality of great { "type": "string", "contentMediaType": "application/gml+xml; version=3.2", - "contentSchema": "http://schemas.opengis.net/gml/3.2.1/geometryBasic2d.xsd" + "contentSchema": "https://schemas.opengis.net/gml/3.2.1/geometryBasic2d.xsd" }, { - "$ref": "http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.json" + "$ref": "https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.json" } ] } @@ -978,11 +982,17 @@ A process output can be defined in the <> with the HTTP https://datatracker.ietf.org/doc/html/rfc7240#section-2[`Prefer`] header asserting a https://tools.ietf.org/html/rfc7240#section-4.2[`return`] preference SHOULD be prepared to receive output values either: + +* in-line in the response, +* or by reference via a hyperlink in the response. +==== ==== Example @@ -1309,6 +1319,8 @@ If the process with the specified identifier does not exist on the server, see r include::../requirements/core/REQ_job-exception-no-such-job.adoc[] +include::../recommendations/core/PER_process-exception-job-gone.adoc[] + [[sc_retrieve_job_results]] === Retrieve job results @@ -1464,6 +1476,8 @@ include::../requirements/core/REQ_job-results-exception-no-such-output.adoc[] include::../requirements/core/REQ_job-results-exception-no-such-job.adoc[] +include::../recommendations/core/PER_job-results-exception-job-gone.adoc[] + include::../requirements/core/REQ_job-results-exception-results-not-ready.adoc[] include::../requirements/core/REQ_job-results-exception-results-not-available.adoc[] diff --git a/core/sections/clause_8_collections.adoc b/core/sections/clause_8_collections.adoc index 65feefb9..3ecd70f7 100644 --- a/core/sections/clause_8_collections.adoc +++ b/core/sections/clause_8_collections.adoc @@ -42,8 +42,8 @@ A search or filter condition. This condition determines which resources from th Asserts the CRS used for the coordinate values of the `filter` parameter. The default is WGS 84 or WGS 84h depending on whether ellispoidal jeight is included with the coordinates or not: -* WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) -* WGS 84h longitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h_ +* WGS 84 longitude/latitude (https://www.opengis.net/def/crs/OGC/1.3/CRS84) +* WGS 84h longitude/latitude/ellipsoidal height (https://www.opengis.net/def/crs/OGC/0/CRS84h_ **Parameter filterLang** @@ -58,9 +58,9 @@ Only resources that have a geometry that intersects the bounding box are selecte Asserts the CRS used for the coordinate values of the `bbox` parameter. The default is WGS 84 or WGS84h depending on whether ellipsoidal height is included or not: * WGS 84 longitude/latitude [4 numbers] - (http://www.opengis.net/def/crs/OGC/1.3/CRS84) + (https://www.opengis.net/def/crs/OGC/1.3/CRS84) * WGS 84h longitude/latitude/ellipsoidal height [6 numbers] - (http://www.opengis.net/def/crs/OGC/0/CRS84h_ + (https://www.opengis.net/def/crs/OGC/0/CRS84h_ **Parameter datetime** @@ -74,8 +74,8 @@ Retrieve only part of the data by slicing or trimming along one or more axis. Fo Asserts the CRS used for the coordinate values of the `subset` parameter. The default is WGS 84 or WGS 84h depending on whether ellispoidal height in included with the coordinates or not: -* WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) -* WGS 84h longitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h_ +* WGS 84 longitude/latitude (https://www.opengis.net/def/crs/OGC/1.3/CRS84) +* WGS 84h longitude/latitude/ellipsoidal height (https://www.opengis.net/def/crs/OGC/0/CRS84h_ **Parameter geometry** @@ -85,8 +85,8 @@ Only resources that have a geometry that intersects the geometry specified using Asserts the CRS used for the coordinate values of the `geometry` parameter. The default is WGS 84 or WGS84h depending on whether ellipsoidal height is included or not: -* WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) -* WGS 84h longitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h_ +* WGS 84 longitude/latitude (https://www.opengis.net/def/crs/OGC/1.3/CRS84) +* WGS 84h longitude/latitude/ellipsoidal height (https://www.opengis.net/def/crs/OGC/0/CRS84h_ **Parameter limit** @@ -106,7 +106,7 @@ T.B.D. A list of STAC asset tags. **Parameter crs** -If the parameter is specified, then the coordinates of all geometry-valued properties in a response document are in the requested CRS. Otherwise the coordinates are in the default CRS, that is http://www.opengis.net/def/crs/OGC/1.3/CRS84 for coordinates without height and http://www.opengis.net/def/crs/OGC/0/CRS84h for coordinates with ellipsoidal height. +If the parameter is specified, then the coordinates of all geometry-valued properties in a response document are in the requested CRS. Otherwise the coordinates are in the default CRS, that is https://www.opengis.net/def/crs/OGC/1.3/CRS84 for coordinates without height and https://www.opengis.net/def/crs/OGC/0/CRS84h for coordinates with ellipsoidal height. [[sc-property-selection]] ===== Property selection & derived properties @@ -170,7 +170,7 @@ See: <> ===== Pass through parameters -See: <> +See: <> [[sc_collection_output]] === REQUIREMENTS CLASS "COLLECTION OUTPUT" diff --git a/core/sections/clause_9_process-description.adoc b/core/sections/clause_9_process-description.adoc index 6d4186b2..cf8906da 100644 --- a/core/sections/clause_9_process-description.adoc +++ b/core/sections/clause_9_process-description.adoc @@ -10,7 +10,7 @@ class. include::../requirements/requirements_class_ogc-process-description.adoc[] -The OGC process description is an information model that may be used to specify the interface of a process. This model is an evolution of the process description model originally defined in the http://docs.opengeospatial.org/is/14-065/14-065.html[OGC WPS 2.0.2 Interface Standard] but also includes elements of the http://spec.openapis.org/oas/v3.0.3[OpenAPI Specification]. Specifically, this process description languages uses https://json-schema.org/draft/2020-12/json-schema-core.html[JSON Schema] fragments to define the input and output parameters of a process. As such, this process description provides a bridge from legacy implementations to using the OGC API Framework. +The OGC process description is an information model that may be used to specify the interface of a process. This model is an evolution of the process description model originally defined in the https://docs.opengeospatial.org/is/14-065/14-065.html[OGC WPS 2.0.2 Interface Standard] but also includes elements of the https://spec.openapis.org/oas/v3.0.3[OpenAPI Specification]. Specifically, this process description languages uses https://json-schema.org/draft/2020-12/json-schema-core.html[JSON Schema] fragments to define the input and output parameters of a process. As such, this process description provides a bridge from legacy implementations to using the OGC API Framework. NOTE: The use of other schema languages for describing the interface to a process is permitted but is outside the scope of this Standards. A description of how other schema languages would be used to describe the interface of a process would need to be described in a new conformance class added to this Standard or in a new Part of the OGC API - Processes suite of standards. @@ -174,22 +174,22 @@ The <> defines a https://json-sc [options="header"] |=== ^|Key value ^|Short code ^|Description -|http://www.opengis.net/def/format/ogcapi-processes/0/geojson-feature-collection |geojson-feature-collection |Indicates that the value is an instance of a GeoJSON feature collection http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/featureCollectionGeoJSON.yaml[(featureCollectionGeoJSON.yaml)]. -|http://www.opengis.net/def/format/ogcapi-processes/0/geojson-feature |geojson-feature |Indicates that the value is an instance of a GeoJSON feature http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/featureGeoJSON.yaml[(featureGeoJSON.yaml)]. -|http://www.opengis.net/def/format/ogcapi-processes/0/geojson-geometry |geojson-geometry |Indicates that the value is an instance of a GeoJSON geometry http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml[(geometryGeoJSON.yaml)]. -|http://www.opengis.net/def/format/ogcapi-processes/0/ogc-bbox |ogc-bbox |Indicates that the value is an instance of an OGC bounding box https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/bbox.yaml[(bbox.yaml)]. -|http://www.opengis.net/def/format/ogcapi-processes/0/epsg-code |epsg-code |Indicates that the string value is a code from the https://epsg.io/[EPSG registry]. -|http://www.opengis.net/def/format/ogcapi-processes/0/wkt2-definition |wkt2-definition |Indicates that the string value is a https://docs.ogc.org/is/18-010r11/18-010r11.pdf[well-known text representation of a coordinate reference system]. -|http://www.opengis.net/def/format/ogcapi-processes/0/cql2-text-filter |cql2-text |Indicates that the string value is a filter expression encoded using the text representation of the https://docs.ogc.org/is/21-065r2/21-065r2.html[Common Query Language (CQL2)]. -|http://www.opengis.net/def/format/ogcapi-processes/0/cql2-json-filter |cql2-json |Indicates that the string value is a filter expression encoded using the JSON representation of the https://docs.ogc.org/is/21-065r2/21-065r2.html[Common Query Language (CQL2)]. -|http://www.opengis.net/def/format/ogcapi-processes/0/collection-id |collection-id |Indicates that the string value is a https://docs.ogc.org/DRAFTS/20-024.html#collection-description[collection identifier] (e.g. a feature collection identifier). -|http://www.opengis.net/def/format/ogcapi-processes/0/stac-collection |stac-collection |Indicates that the value is an instance of a https://github.com/radiantearth/stac-spec/blob/v1.1.0/collection-spec/collection-spec.md[STAC collection]. -|http://www.opengis.net/def/format/ogcapi-processes/0/stac-catalog |stac-catalog |Indicates that the value is an instance of a https://github.com/radiantearth/stac-spec/blob/v1.1.0/catalog-spec/catalog-spec.md[STAC catalog]. -|http://www.opengis.net/def/format/ogcapi-processes/0/stac-item-collection |stac-item-collection |Indicates that the value is a https://github.com/radiantearth/stac-api-spec/blob/release/v1.0.0/fragments/itemcollection/README.md[STAC ItemCollection]. -|http://www.opengis.net/def/format/ogcapi-processes/0/stac-item |stac-item |Indicates that the value is an instance of a https://github.com/radiantearth/stac-spec/blob/v1.1.0/item-spec/item-spec.md[STAC item]. -|http://www.opengis.net/def/format/ogcapi-processes/0/stac |stac |Indicates that the value is an instance of any of the STAC types listed above (i.e. one of `stac-collection`, `stac-catalog`, `stac-item-collection`, or `stac-item`). -|http://www.opengis.net/def/format/ogcapi-processes/0/ogc-feature-collection |ogc-feature-collection |Indicates that the value is an instance of an https://docs.ogc.org/is/17-069r4/17-069r4.html#_collection_[OGC feature collection]. -|http://www.opengis.net/def/format/ogcapi-processes/0/ogc-coverage-collection |ogc-coverage-collection |Indicates that the value is an instance of an https://docs.ogc.org/DRAFTS/19-087.html#_extended_collection_description_response_collectionscollectionid[OGC coverage collection]. +|https://www.opengis.net/def/format/ogcapi-processes/0/geojson-feature-collection |geojson-feature-collection |Indicates that the value is an instance of a GeoJSON feature collection https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/featureCollectionGeoJSON.yaml[(featureCollectionGeoJSON.yaml)]. +|https://www.opengis.net/def/format/ogcapi-processes/0/geojson-feature |geojson-feature |Indicates that the value is an instance of a GeoJSON feature https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/featureGeoJSON.yaml[(featureGeoJSON.yaml)]. +|https://www.opengis.net/def/format/ogcapi-processes/0/geojson-geometry |geojson-geometry |Indicates that the value is an instance of a GeoJSON geometry https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml[(geometryGeoJSON.yaml)]. +|https://www.opengis.net/def/format/ogcapi-processes/0/ogc-bbox |ogc-bbox |Indicates that the value is an instance of an OGC bounding box https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/openapi/schemas/processes-core/bbox.yaml[(bbox.yaml)]. +|https://www.opengis.net/def/format/ogcapi-processes/0/epsg-code |epsg-code |Indicates that the string value is a code from the https://epsg.io/[EPSG registry]. +|https://www.opengis.net/def/format/ogcapi-processes/0/wkt2-definition |wkt2-definition |Indicates that the string value is a https://docs.ogc.org/is/18-010r11/18-010r11.pdf[well-known text representation of a coordinate reference system]. +|https://www.opengis.net/def/format/ogcapi-processes/0/cql2-text-filter |cql2-text |Indicates that the string value is a filter expression encoded using the text representation of the https://docs.ogc.org/is/21-065r2/21-065r2.html[Common Query Language (CQL2)]. +|https://www.opengis.net/def/format/ogcapi-processes/0/cql2-json-filter |cql2-json |Indicates that the string value is a filter expression encoded using the JSON representation of the https://docs.ogc.org/is/21-065r2/21-065r2.html[Common Query Language (CQL2)]. +|https://www.opengis.net/def/format/ogcapi-processes/0/collection-id |collection-id |Indicates that the string value is a https://docs.ogc.org/DRAFTS/20-024.html#collection-description[collection identifier] (e.g. a feature collection identifier). +|https://www.opengis.net/def/format/ogcapi-processes/0/stac-collection |stac-collection |Indicates that the value is an instance of a https://github.com/radiantearth/stac-spec/blob/v1.1.0/collection-spec/collection-spec.md[STAC collection]. +|https://www.opengis.net/def/format/ogcapi-processes/0/stac-catalog |stac-catalog |Indicates that the value is an instance of a https://github.com/radiantearth/stac-spec/blob/v1.1.0/catalog-spec/catalog-spec.md[STAC catalog]. +|https://www.opengis.net/def/format/ogcapi-processes/0/stac-item-collection |stac-item-collection |Indicates that the value is a https://github.com/radiantearth/stac-api-spec/blob/release/v1.0.0/fragments/itemcollection/README.md[STAC ItemCollection]. +|https://www.opengis.net/def/format/ogcapi-processes/0/stac-item |stac-item |Indicates that the value is an instance of a https://github.com/radiantearth/stac-spec/blob/v1.1.0/item-spec/item-spec.md[STAC item]. +|https://www.opengis.net/def/format/ogcapi-processes/0/stac |stac |Indicates that the value is an instance of any of the STAC types listed above (i.e. one of `stac-collection`, `stac-catalog`, `stac-item-collection`, or `stac-item`). +|https://www.opengis.net/def/format/ogcapi-processes/0/ogc-feature-collection |ogc-feature-collection |Indicates that the value is an instance of an https://docs.ogc.org/is/17-069r4/17-069r4.html#_collection_[OGC feature collection]. +|https://www.opengis.net/def/format/ogcapi-processes/0/ogc-coverage-collection |ogc-coverage-collection |Indicates that the value is an instance of an https://docs.ogc.org/DRAFTS/19-087.html#_extended_collection_description_response_collectionscollectionid[OGC coverage collection]. |=== NOTE: This list of values has been submitted to the https://www.ogc.org/projects/groups/ogcnasc[OGC Naming Authority] for registration in their definition server. @@ -217,7 +217,7 @@ The following JSON Schema fragment illustrates the use of the `format` key to in { "type": "string", "contentMediaType": "application/gml+xml; version=3.2", - "contentSchema": "http://schemas.opengis.net/gml/3.2.1/geometryBasic2d.xsd" + "contentSchema": "https://schemas.opengis.net/gml/3.2.1/geometryBasic2d.xsd" }, { "format": "geojson-geometry"