From 3c8b3f736160cb0c56f738759781aa9348db8253 Mon Sep 17 00:00:00 2001 From: Panagiotis Vretanos Date: Mon, 31 Mar 2025 09:09:25 -0400 Subject: [PATCH 1/2] Fix parameter and path name consistency. --- README.md | 10 ++-- core/abstract_tests/ATS_class_core.adoc | 2 +- .../dismiss/ATS_job-dismiss-op.adoc | 4 +- .../openapi/ogcapi-processes-1-example.yaml | 2 +- .../job-list/REC_access-control-job-list.adoc | 2 +- core/requirements/core/REQ_job-result-op.adoc | 2 +- .../kvp-execute/REQ_array-input-value.adoc | 6 +- .../REQ_binary-input-value-qualified.adoc | 6 +- .../kvp-execute/REQ_binary-input-value.adoc | 6 +- .../kvp-execute/REQ_boolean-input-value.adoc | 6 +- .../kvp-execute/REQ_complex-input-value.adoc | 6 +- .../kvp-execute/REQ_input-by-reference.adoc | 4 +- .../kvp-execute/REQ_input-cardinality.adoc | 8 +-- .../kvp-execute/REQ_numeric-input-value.adoc | 6 +- core/requirements/kvp-execute/REQ_output.adoc | 6 +- .../kvp-execute/REQ_string-input-value.adoc | 6 +- .../clause_8_ogc-process-description.adoc | 2 +- .../abstract_tests/cwl/replace/ATS_body.adoc | 2 +- .../docker/replace/ATS_body.adoc | 2 +- .../dru/replace/ATS_content-type.adoc | 2 +- .../dru/replace/ATS_put-op.adoc | 2 +- .../dru/undeploy/ATS_delete-op.adoc | 4 +- .../dru/undeploy/ATS_response-immutable.adoc | 2 +- .../dru/undeploy/ATS_response.adoc | 2 +- .../ogcapppkg/replace/ATS_body.adoc | 2 +- .../deploy/REQ_response-duplicate.adoc | 2 +- .../deploy/REQ_response-immutable.adoc | 2 +- .../deploy/REQ_response-pid.adoc | 2 +- .../deploy/REQ_response-success.adoc | 2 +- .../package/REQ_get-op.adoc | 4 +- .../replace/REQ_put-op.adoc | 4 +- .../undeploy/REQ_delete-op.adoc | 4 +- .../clause_12_security_considerations.adoc | 4 +- .../standard/sections/clause_1_scope.adoc | 2 +- .../clause_6_deploy_replace_undeploy.adoc | 6 +- .../create/REQ_response-jobid.adoc | 2 +- .../create/REQ_response-success.adoc | 2 +- .../job-management/definition/REQ_get-op.adoc | 4 +- .../job-management/start/REQ_post-op.adoc | 4 +- .../job-management/update/REQ_patch-op.adoc | 4 +- .../provenance/inputs/REQ_get-op.adoc | 4 +- .../provenance/prov/REQ_get-op.adoc | 4 +- .../clause_12_security_considerations.adoc | 2 +- .../sections/clause_6_job_management.adoc | 10 ++-- ...REQ_cwl-workflows_adhoc-cwl-execution.adoc | 2 +- ...deployable-workflows_selected-outputs.adoc | 2 +- ...eneo-workflows_adhoc-openeo-execution.adoc | 2 +- .../clause_10_deployable_workflow.adoc | 4 +- .../sections/clause_14_media_types.adoc | 2 +- .../workflows/sections/clause_6_overview.adoc | 2 +- .../sections/clause_7_nested_processes.adoc | 2 +- ogcapi-ogc-org-processes-overview.md | 12 ++-- openapi.yaml | 4 +- openapi/ogcapi-processes.bundled.json | 60 +++++++++---------- openapi/ogcapi-processes.yaml | 26 ++++---- .../processes-core/generic/complex.yaml | 2 +- .../generic/simple-boolean.yaml | 2 +- .../generic/simple-numeric.yaml | 2 +- .../processes-core/generic/simple-string.yaml | 2 +- .../processes-core/{jobId.yaml => jobID.yaml} | 2 +- .../{outputId.yaml => outputID.yaml} | 0 ...rocessId-path.yaml => processID-path.yaml} | 2 +- ...cessId-query.yaml => processID-query.yaml} | 0 openapi/paths/processes-core/pExecution.yaml | 2 +- openapi/paths/processes-core/pJob.yaml | 4 +- openapi/paths/processes-core/pJobResults.yaml | 2 +- openapi/paths/processes-core/pJobsList.yaml | 2 +- .../processes-core/pProcessDescription.yaml | 2 +- openapi/paths/processes-dru/pPackage.yaml | 4 +- .../pProcessDescriptionReplaceUndeploy.yaml | 6 +- openapi/paths/processes-dru/pReplace.yaml | 2 +- openapi/paths/processes-dru/pUndeploy.yaml | 2 +- .../paths/processes-job-management/pJob.yaml | 2 +- .../pJobDefinition.yaml | 2 +- .../processes-job-management/pJobInputs.yaml | 2 +- .../processes-job-management/pJobResults.yaml | 2 +- .../pExecution-workflows.yaml | 2 +- .../execute-workflows.yaml | 2 +- 78 files changed, 169 insertions(+), 169 deletions(-) rename openapi/parameters/processes-core/{jobId.yaml => jobID.yaml} (88%) rename openapi/parameters/processes-core/{outputId.yaml => outputID.yaml} (100%) rename openapi/parameters/processes-core/{processId-path.yaml => processID-path.yaml} (84%) rename openapi/parameters/processes-core/{processId-query.yaml => processID-query.yaml} (100%) diff --git a/README.md b/README.md index 1782c733..deb386e4 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ GET /processes Lists the processes this API offers. ``` -GET /processes/{process-id} +GET /processes/{processID} ``` Returns a detailed description of a process. @@ -41,26 +41,26 @@ GET /jobs Returns the running and finished jobs for a process (optional). ``` -POST /processes/{process-id}/execution +POST /processes/{processID}/execution ``` Executes a process, i.e. creates a new job. Inputs, outputs and the process id will have to be specified in a JSON document that needs to be send in the POST body. ``` -GET /jobs/{job-id} +GET /jobs/{jobID} ``` Returns the status of a job of a process. ``` -DELETE /jobs/{job-id} +DELETE /jobs/{jobID} ``` Cancel a job execution. ``` -GET /jobs/{job-id}/results +GET /jobs/{jobID}/results ``` Returns the result of a job of a process. diff --git a/core/abstract_tests/ATS_class_core.adoc b/core/abstract_tests/ATS_class_core.adoc index cb175024..69585b7c 100644 --- a/core/abstract_tests/ATS_class_core.adoc +++ b/core/abstract_tests/ATS_class_core.adoc @@ -4,7 +4,7 @@ ==== [%metadata] identifier:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core -subject:: <> +subject:: <> classification:: Target Type:Web API conformance-test:: /conf/core conformance-test:: /conf/core/api-definition-op diff --git a/core/abstract_tests/dismiss/ATS_job-dismiss-op.adoc b/core/abstract_tests/dismiss/ATS_job-dismiss-op.adoc index c7b0fbc1..c07652de 100644 --- a/core/abstract_tests/dismiss/ATS_job-dismiss-op.adoc +++ b/core/abstract_tests/dismiss/ATS_job-dismiss-op.adoc @@ -9,9 +9,9 @@ test-purpose:: Validate that a running job can be dismissed. test-method:: + -- -1. Create an asynchronous job as per test <>; not the job identifier, {jobID}, assigned to the job. +1. Create an asynchronous job as per test <>; not the job identifier, `{jobID}`, assigned to the job. -2. Issue an HTTP DELETE operation to the URL '/jobs/{jobID}'. +2. Issue an HTTP DELETE operation to the URL `/jobs/{jobID}`. 3. Validate the contents of the returned document using test <>. -- diff --git a/core/examples/openapi/ogcapi-processes-1-example.yaml b/core/examples/openapi/ogcapi-processes-1-example.yaml index e5e79b1e..16d325e8 100644 --- a/core/examples/openapi/ogcapi-processes-1-example.yaml +++ b/core/examples/openapi/ogcapi-processes-1-example.yaml @@ -226,7 +226,7 @@ paths: application/json: schema: $ref: "https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ServerError.yaml" - '/jobs/{jobID}/results/{outputId}': + '/jobs/{jobID}/results/{outputID}': get: summary: retrieve the result of a job identified by it output ID description: |- 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 e375a1d0..1bd88af6 100644 --- a/core/recommendations/job-list/REC_access-control-job-list.adoc +++ b/core/recommendations/job-list/REC_access-control-job-list.adoc @@ -4,5 +4,5 @@ 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-ids. +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/requirements/core/REQ_job-result-op.adoc b/core/requirements/core/REQ_job-result-op.adoc index 817b9a73..977aca3c 100644 --- a/core/requirements/core/REQ_job-result-op.adoc +++ b/core/requirements/core/REQ_job-result-op.adoc @@ -5,5 +5,5 @@ identifier:: /req/core/job-result label:: /req/core/job-result -For each <> with identifier `outputId`, the server SHALL support the HTTP GET operation at the path `/jobs/{jobID}/results/{outputID}`. +For each <> with identifier `outputID`, the server SHALL support the HTTP GET operation at the path `/jobs/{jobID}/results/{outputID}`. ==== diff --git a/core/requirements/kvp-execute/REQ_array-input-value.adoc b/core/requirements/kvp-execute/REQ_array-input-value.adoc index f35318f5..13c13835 100644 --- a/core/requirements/kvp-execute/REQ_array-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_array-input-value.adoc @@ -8,7 +8,7 @@ label:: /req/kvp-execute/array-input-value [.component,class=conditions] -- . The process input value is specified in-line in an execute request. -. A process input, with identifier `{input-name}`, is defined as type `array` in the <>. +. A process input, with identifier `{inputID}`, is defined as type `array` in the <>. -- [.component,class=part] @@ -22,7 +22,7 @@ The input parameter SHALL have the following characteristics: [source,yaml] ---- -name: {input-name} +name: {inputID} in: query required: false schema: @@ -31,7 +31,7 @@ style: form explode: false ---- -where the token `{input-name}` represents the identifier of the input. +where the token `{inputID}` represents 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 3e6ea4f3..66f8ba7d 100644 --- a/core/requirements/kvp-execute/REQ_binary-input-value-qualified.adoc +++ b/core/requirements/kvp-execute/REQ_binary-input-value-qualified.adoc @@ -8,7 +8,7 @@ label:: /req/kvp-execute/binary-input-value-qualified [.component,class=conditions] -- . The process input value is specified in-line in an execute request. -. A process input, with identifier `{input-name}`, is defined as <> type in the <>. +. A process input, with identifier `{inputID}`, is defined as <> type in the <>. . The input value needs to <> with a <> specification. -- @@ -18,7 +18,7 @@ The input parameter SHALL have the following characteristics: [source,YAML] ---- -name: {input-name} +name: {inputID} in: query required: false schema: @@ -42,6 +42,6 @@ style: deepObject explode: true ---- -where the token `{input-name}` represents the identifier of the input. +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 ab3bdca4..cd6b7295 100644 --- a/core/requirements/kvp-execute/REQ_binary-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_binary-input-value.adoc @@ -8,7 +8,7 @@ label:: /req/kvp-execute/binary-input-value [.component,class=conditions] -- . The process input value is specified in-line in an execute request. -. A process input, with identifier `{input-name}`, is defined as <> type in the <>. +. A process input, with identifier `{inputID}`, is defined as <> type in the <>. . The input value does not need to be <> with a <> specification. -- @@ -18,7 +18,7 @@ The input parameter SHALL have the following characteristics: [source,YAML] ---- -name: {input-name} +name: {inputID} in: query required: false schema: @@ -28,6 +28,6 @@ style: form explode: false ---- -where the token `{input-name}` represents the identifier of the input. +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 25f1503c..c81d4715 100644 --- a/core/requirements/kvp-execute/REQ_boolean-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_boolean-input-value.adoc @@ -8,7 +8,7 @@ label:: /req/kvp-execute/boolean-input-value [.component,class=conditions] -- . The process input value is specified in-line in an execute request. -. A process input, with identifier `{input-name}` is defined as type `boolean` in the <>. +. A process input, with identifier `{inputID}` is defined as type `boolean` in the <>. -- [.component,class=part] @@ -17,7 +17,7 @@ The input parameter SHALL have the following characteristics: [source,YAML] ---- -name: {input-name} +name: {inputID} in: query required: false schema: @@ -26,6 +26,6 @@ style: form explode: false ---- -where the token `{input-name}` represented the identifier of the input. +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 0c5b3913..a3d92417 100644 --- a/core/requirements/kvp-execute/REQ_complex-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_complex-input-value.adoc @@ -8,7 +8,7 @@ label:: /req/kvp-execute/complex-input-value [.component,class=conditions] -- . The process input value is specified in-line in an execute request. -. A process input, with identifier `{input-name}`, is defined as type `object` in the <>. +. A process input, with identifier `{inputID}`, is defined as type `object` in the <>. -- [.component,class=part] @@ -22,7 +22,7 @@ The input parameter SHALL have the following characteristics: [source,yaml] ---- -name: {input-name} +name: {inputID} in: query required: false schema: @@ -31,7 +31,7 @@ style: form explode: false ---- -where the token `{input-name}` represents the identifier of the input. +where the token `{inputID}` represents the identifier of the input. -- ==== diff --git a/core/requirements/kvp-execute/REQ_input-by-reference.adoc b/core/requirements/kvp-execute/REQ_input-by-reference.adoc index 354b5f13..a215e87d 100644 --- a/core/requirements/kvp-execute/REQ_input-by-reference.adoc +++ b/core/requirements/kvp-execute/REQ_input-by-reference.adoc @@ -16,7 +16,7 @@ If the input cardinality is 1 then the input parameter SHALL have the following [source,YAML] ---- -name: {input-name} +name: {inputID} in: query required: false schema: @@ -41,7 +41,7 @@ style: deepObject explode: true ---- -where the token `{input-name}` represented the identifier of the input. +where the token `{inputID}` represented the identifier of the input. -- [.component,class=part] diff --git a/core/requirements/kvp-execute/REQ_input-cardinality.adoc b/core/requirements/kvp-execute/REQ_input-cardinality.adoc index 9f9a9859..36cd177f 100644 --- a/core/requirements/kvp-execute/REQ_input-cardinality.adoc +++ b/core/requirements/kvp-execute/REQ_input-cardinality.adoc @@ -8,8 +8,8 @@ label:: /req/kvp-execute/input-cardinality [.component,class=conditions] -- . The process input value is specified in-line in an execute request. -. A process input, with identifier `{input-name}`, is defined as having a cardinality greater than one (i.e. `minOccurs` > 1) in the <>. -. The number of input values specified for the `{input-name}` process input is greater than one. +. A process input, with identifier `{inputID}`, is defined as having a cardinality greater than one (i.e. `minOccurs` > 1) in the <>. +. The number of input values specified for the `{inputID}` process input is greater than one. -- [.component,class=part] @@ -23,7 +23,7 @@ The input parameter SHALL have the following characteristics: [source,yaml] ---- -name: {input-name} +name: {inputID} in: query required: false schema: @@ -39,7 +39,7 @@ style: form explode: false ---- -where the token `{input-name}` represents the identifier of the input. +where the token `{inputID}` represents the identifier of the input. -- [.component,class=part] diff --git a/core/requirements/kvp-execute/REQ_numeric-input-value.adoc b/core/requirements/kvp-execute/REQ_numeric-input-value.adoc index bbcf3067..90e6f8df 100644 --- a/core/requirements/kvp-execute/REQ_numeric-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_numeric-input-value.adoc @@ -8,7 +8,7 @@ label:: /req/kvp-execute/numeric-input-value [.component,class=conditions] -- . The process input value is specified in-line in an execute request. -. A process input, with identifier `{input-name}`, is defined as a numeric type input in the <>. +. A process input, with identifier `{inputID}`, is defined as a numeric type input in the <>. -- [.component,class=part] @@ -17,7 +17,7 @@ The input parameter SHALL have the following characteristics: [source,YAML] ---- -name: {input-name} +name: {inputID} in: query required: false schema: @@ -26,6 +26,6 @@ style: form explode: false ---- -where the token `{input-name}` represented the identifier of the input and the token {numeric-type} is the value `number` or `integer`. +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 ec6ba2db..f5c43462 100644 --- a/core/requirements/kvp-execute/REQ_output.adoc +++ b/core/requirements/kvp-execute/REQ_output.adoc @@ -7,7 +7,7 @@ label:: /req/kvp-execute/output [.component,class=conditions] -- -. A process output, with identifier `{output-name}`, is defined in the <>. +. A process output, with identifier `{outputID}`, is defined in the <>. -- [.component,class=part] @@ -16,7 +16,7 @@ The output parameter SHALL have the following characteristics: [source,yaml] ---- -name: {output-name} +name: {outputID} in: query required: false schema: @@ -39,6 +39,6 @@ style: deepObject explode: true ---- -where the token `{output-name}` represents the identifier of the output. +where the token `{outputID}` represents the identifier of the output. -- ==== diff --git a/core/requirements/kvp-execute/REQ_string-input-value.adoc b/core/requirements/kvp-execute/REQ_string-input-value.adoc index db189205..64b2b14c 100644 --- a/core/requirements/kvp-execute/REQ_string-input-value.adoc +++ b/core/requirements/kvp-execute/REQ_string-input-value.adoc @@ -8,7 +8,7 @@ label:: /req/kvp-execute/string-input-value [.component,class=conditions] -- . The process input value is specified in-line in an execute request. -. A process input, with identifier `{input-name}`, is defined as type `string` in the <>. +. A process input, with identifier `{inputID}`, is defined as type `string` in the <>. -- [.component,class=part] @@ -17,7 +17,7 @@ The input parameter SHALL have the following characteristics: [source,YAML] ---- -name: {input-name} +name: {inputID} in: query required: false schema: @@ -26,6 +26,6 @@ style: form explode: false ---- -where the token `{input-name}` represents the identifier of the input. +where the token `{inputID}` represents the identifier of the input. -- ==== diff --git a/core/sections/clause_8_ogc-process-description.adoc b/core/sections/clause_8_ogc-process-description.adoc index 95f27d2f..050f2be3 100644 --- a/core/sections/clause_8_ogc-process-description.adoc +++ b/core/sections/clause_8_ogc-process-description.adoc @@ -346,7 +346,7 @@ NOTE: This schema can also be obtained from https://raw.githubusercontent.com/op === Example -The following URL is an example of retrieving a <> from the `/processes/{processId}` endpoint. +The following URL is an example of retrieving a <> from the `/processes/{processID}` endpoint. [source] ---- https://processing.example.org/processes/EchoProcess diff --git a/extensions/deploy_replace_undeploy/standard/abstract_tests/cwl/replace/ATS_body.adoc b/extensions/deploy_replace_undeploy/standard/abstract_tests/cwl/replace/ATS_body.adoc index 235d8850..d005386a 100644 --- a/extensions/deploy_replace_undeploy/standard/abstract_tests/cwl/replace/ATS_body.adoc +++ b/extensions/deploy_replace_undeploy/standard/abstract_tests/cwl/replace/ATS_body.adoc @@ -11,7 +11,7 @@ test-method:: -- 1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/processes" link on the landing page as well as for the {root}/processes path. -2. Append `/{processId}` to each path, where `{processId}` is a mutable process id. +2. Append `/{processID}` to each path, where `{processID}` is a mutable process id. 3. Send a PUT request for one path using the media type "application/cwl" and the application package content diff --git a/extensions/deploy_replace_undeploy/standard/abstract_tests/docker/replace/ATS_body.adoc b/extensions/deploy_replace_undeploy/standard/abstract_tests/docker/replace/ATS_body.adoc index 474ce5d6..ccc6db36 100644 --- a/extensions/deploy_replace_undeploy/standard/abstract_tests/docker/replace/ATS_body.adoc +++ b/extensions/deploy_replace_undeploy/standard/abstract_tests/docker/replace/ATS_body.adoc @@ -11,7 +11,7 @@ test-method:: -- 1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/processes" link on the landing page as well as for the {root}/processes path. -2. Append `/{processId}` to each path, where `{processId}` is the process id retrieved from <>. +2. Append `/{processID}` to each path, where `{processID}` is the process id retrieved from <>. 3. Send a PUT request for one path using the media type "application/ogcapppkg+json" with as body a default OGC Application Package diff --git a/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/replace/ATS_content-type.adoc b/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/replace/ATS_content-type.adoc index 9d84f535..12da6137 100644 --- a/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/replace/ATS_content-type.adoc +++ b/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/replace/ATS_content-type.adoc @@ -11,7 +11,7 @@ test-method:: -- 1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/processes" link on the landing page as well as for the {root}/processes path. -2. Append `/{processId}` to each path, where `{processId}` is a mutable process id. +2. Append `/{processID}` to each path, where `{processID}` is a mutable process id. 3. Issue an HTTP PUT request with an unsupported media type, i.e. `text/plain`, on each path. diff --git a/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/replace/ATS_put-op.adoc b/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/replace/ATS_put-op.adoc index 0e3e74d9..a9b51ffd 100644 --- a/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/replace/ATS_put-op.adoc +++ b/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/replace/ATS_put-op.adoc @@ -11,7 +11,7 @@ test-method:: -- 1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/processes" link on the landing page as well as for the {root}/processes path. -2. Append `/{processId}` to each path, where `{processId}` is not an existing process id, i.e. `not-existing-process`. +2. Append `/{processID}` to each path, where `{processID}` is not an existing process id, i.e. `not-existing-process`. 3. Issue an HTTP PUT request for each path. diff --git a/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/undeploy/ATS_delete-op.adoc b/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/undeploy/ATS_delete-op.adoc index 137a3b9c..c5835e9d 100644 --- a/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/undeploy/ATS_delete-op.adoc +++ b/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/undeploy/ATS_delete-op.adoc @@ -5,13 +5,13 @@ [%metadata] identifier:: /conf/dru/undeploy-delete-op target:: /req/deploy-replace-undeploy/undeploy-delete-op -test-purpose:: Validate that the server supports HTTP DELETE operation at the path /processes/{processId} +test-purpose:: Validate that the server supports HTTP DELETE operation at the path /processes/{processID} test-method:: + -- 1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/processes" link on the landing page as well as for the {root}/processes path. -2. Append `/{processId}` to each path, where `{processId}` is not an existing process id, i.e. `not-existing-process`. +2. Append `/{processID}` to each path, where `{processID}` is not an existing process id, i.e. `not-existing-process`. 3. Issue an HTTP DELETE request for each path. diff --git a/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/undeploy/ATS_response-immutable.adoc b/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/undeploy/ATS_response-immutable.adoc index e5e43a53..3289cf05 100644 --- a/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/undeploy/ATS_response-immutable.adoc +++ b/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/undeploy/ATS_response-immutable.adoc @@ -11,7 +11,7 @@ test-method:: -- 1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/processes" link on the landing page as well as for the {root}/processes path. -2. Append `/{processId}` to each path, where `{processId}` is not a mutable process id. +2. Append `/{processID}` to each path, where `{processID}` is not a mutable process id. 3. Issue an HTTP DELETE request on each path. diff --git a/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/undeploy/ATS_response.adoc b/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/undeploy/ATS_response.adoc index b226f827..7509ddce 100644 --- a/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/undeploy/ATS_response.adoc +++ b/extensions/deploy_replace_undeploy/standard/abstract_tests/dru/undeploy/ATS_response.adoc @@ -11,7 +11,7 @@ test-method:: -- 1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/processes" link on the landing page as well as for the {root}/processes path. -2. Append `/{processId}` to each path, where `{processId}` is a mutable process id. +2. Append `/{processID}` to each path, where `{processID}` is a mutable process id. 3. Issue an HTTP DELETE request on one path. diff --git a/extensions/deploy_replace_undeploy/standard/abstract_tests/ogcapppkg/replace/ATS_body.adoc b/extensions/deploy_replace_undeploy/standard/abstract_tests/ogcapppkg/replace/ATS_body.adoc index 73aa21b6..171222f7 100644 --- a/extensions/deploy_replace_undeploy/standard/abstract_tests/ogcapppkg/replace/ATS_body.adoc +++ b/extensions/deploy_replace_undeploy/standard/abstract_tests/ogcapppkg/replace/ATS_body.adoc @@ -11,7 +11,7 @@ test-method:: -- 1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/processes" link on the landing page as well as for the {root}/processes path. -2. Append `/{processId}` to each path, where `{processId}` is the process id retrieved from <>. +2. Append `/{processID}` to each path, where `{processID}` is the process id retrieved from <>. 3. Issue an HTTP PUT request using the media type "application/ogcapppkg+json" with as body a default OGC Application Package or the application package URL, if any, for each path diff --git a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-duplicate.adoc b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-duplicate.adoc index a375095c..816710fa 100644 --- a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-duplicate.adoc +++ b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-duplicate.adoc @@ -5,7 +5,7 @@ label:: /req/deploy-replace-undeploy/deploy-response-duplicate part:: If a process with the same identifier already exists on the server, the code of the response SHALL be `409`. -part:: A response with HTTP status code `409` MAY include a `Location` header with the URI of the duplicated processes (path: `/processes/{processId}`). +part:: A response with HTTP status code `409` MAY include a `Location` header with the URI of the duplicated processes (path: `/processes/{processID}`). part:: The content of that response SHALL be based upon the OpenAPI 3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/exception.yaml[exception.yaml]. part:: The `type` of the exception SHALL be “http://www.opengis.net/def/exceptions/ogcapi-processes-2/1.0/duplicated-process”. diff --git a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-immutable.adoc b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-immutable.adoc index 5f683f0a..8f04acf4 100644 --- a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-immutable.adoc +++ b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-immutable.adoc @@ -5,7 +5,7 @@ label:: /req/deploy-replace-undeploy/deploy-response-immutable part:: If a process with the same identifier already exists on the server and is immutable, the code of the response SHALL be `403`. -part:: A response with HTTP status code `403` MAY include a `Location` header with the URI of the existing process (path: `/processes/{processId}`). +part:: A response with HTTP status code `403` MAY include a `Location` header with the URI of the existing process (path: `/processes/{processID}`). part:: The content of that response shall be based upon the OpenAPI 3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/exception.yaml[exception.yaml]. part:: The `type` of the exception SHALL be “http://www.opengis.net/def/exceptions/ogcapi-processes-2/1.0/immutable-process”. diff --git a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-pid.adoc b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-pid.adoc index 4cc24485..b4b8c517 100644 --- a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-pid.adoc +++ b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-pid.adoc @@ -3,5 +3,5 @@ ==== [%metadata] label:: /req/deploy-replace-undeploy/deploy-response-pid -part:: If the operation completes, the server SHALL assign the processes identifier (i.e. `{processId}`) specified in the processes description for the newly added processes. +part:: If the operation completes, the server SHALL assign the processes identifier (i.e. `{processID}`) specified in the processes description for the newly added processes. ==== diff --git a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-success.adoc b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-success.adoc index 620699e8..92a0c8f8 100644 --- a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-success.adoc +++ b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/deploy/REQ_response-success.adoc @@ -4,6 +4,6 @@ [%metadata] label:: /req/deploy-replace-undeploy/deploy-response-success part:: A successful execution of the operation SHALL be reported as a response with a HTTP status code `201`. -part:: A response with HTTP status code `201` SHALL include a `Location` header with the URI of the deployed processes (path: `/processes/{processId}`). +part:: A response with HTTP status code `201` SHALL include a `Location` header with the URI of the deployed processes (path: `/processes/{processID}`). part:: If the operation is not executed immediately, but is added to a processing queue, the response SHALL have a HTTP status code `202`. ==== diff --git a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/package/REQ_get-op.adoc b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/package/REQ_get-op.adoc index e7bdc35d..b86beff9 100644 --- a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/package/REQ_get-op.adoc +++ b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/package/REQ_get-op.adoc @@ -3,7 +3,7 @@ ==== [%metadata] label:: /req/deploy-replace-undeploy/package-get-op -part:: For every dynamically added process (using method: POST on path: /processes/{processId}), the server SHALL support the HTTP GET operation at the path `/processes/{processId}/package`. -part:: The parameter `processId` is each `id` property in the process collection response (JSONPath: `$.processes[*].id`). +part:: For every dynamically added process (using method: POST on path: /processes/{processID}), the server SHALL support the HTTP GET operation at the path `/processes/{processID}/package`. +part:: The parameter `processID` is each `id` property in the process collection response (JSONPath: `$.processes[*].id`). ==== diff --git a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/replace/REQ_put-op.adoc b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/replace/REQ_put-op.adoc index 63b7f964..eee084e3 100644 --- a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/replace/REQ_put-op.adoc +++ b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/replace/REQ_put-op.adoc @@ -3,6 +3,6 @@ ==== [%metadata] label:: /req/deploy-replace-undeploy/replace-put-op -part:: For every dynamically deployed processes (path '/processes/{processId}'), the server SHALL support the HTTP PUT operation. -part:: The parameter 'processId' is each 'id' property in the process collection response (JSONPath: `$.processes[*].id`). +part:: For every dynamically deployed processes (path '/processes/{processID}'), the server SHALL support the HTTP PUT operation. +part:: The parameter 'processID' is each 'id' property in the process collection response (JSONPath: `$.processes[*].id`). ==== diff --git a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/undeploy/REQ_delete-op.adoc b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/undeploy/REQ_delete-op.adoc index 1f3b37f2..0dadbdd2 100644 --- a/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/undeploy/REQ_delete-op.adoc +++ b/extensions/deploy_replace_undeploy/standard/requirements/deploy-replace-undeploy/undeploy/REQ_delete-op.adoc @@ -3,6 +3,6 @@ ==== [%metadata] label:: /req/deploy-replace-undeploy/undeploy-delete-op -part:: For every dynamically added process (path: `/processes/{processId}`), the server SHALL support the HTTP DELETE operation. -part:: The parameter `processId` is each `id` property in the process collection response (JSONPath: `$.processes[*].id`). +part:: For every dynamically added process (path: `/processes/{processID}`), the server SHALL support the HTTP DELETE operation. +part:: The parameter `processID` is each `id` property in the process collection response (JSONPath: `$.processes[*].id`). ==== diff --git a/extensions/deploy_replace_undeploy/standard/sections/clause_12_security_considerations.adoc b/extensions/deploy_replace_undeploy/standard/sections/clause_12_security_considerations.adoc index 1207e44b..55e9b075 100644 --- a/extensions/deploy_replace_undeploy/standard/sections/clause_12_security_considerations.adoc +++ b/extensions/deploy_replace_undeploy/standard/sections/clause_12_security_considerations.adoc @@ -8,7 +8,7 @@ Users making modifications to process resources need to: . Be authenticated, . Have "modification privileges" on the processes offered through the API, -. Have access to one or more of the POST, PUT and/or DELETE methods on the processes / processes/{processId} endpoints. +. Have access to one or more of the POST, PUT and/or DELETE methods on the processes / processes/{processID} endpoints. The API definition, as defined in Clause 7.3 from <>, must reflect this in the resource paths and their available methods. @@ -116,4 +116,4 @@ Client Server |<------------------------------------------------------------------| ``` -However, for security reasons, the server may also decide to return other status codes to hide information from a potential attacker. For example, the server may decide to return a 401 response even for a valid, but un-privileged user. Or the server may return a 404 response ("Not Found") to hide the fact that the resource exists in the first place, typically if the user would also not be privileged to fetch the resource with a GET operation. \ No newline at end of file +However, for security reasons, the server may also decide to return other status codes to hide information from a potential attacker. For example, the server may decide to return a 401 response even for a valid, but un-privileged user. Or the server may return a 404 response ("Not Found") to hide the fact that the resource exists in the first place, typically if the user would also not be privileged to fetch the resource with a GET operation. diff --git a/extensions/deploy_replace_undeploy/standard/sections/clause_1_scope.adoc b/extensions/deploy_replace_undeploy/standard/sections/clause_1_scope.adoc index 9d9dc8dd..72800763 100644 --- a/extensions/deploy_replace_undeploy/standard/sections/clause_1_scope.adoc +++ b/extensions/deploy_replace_undeploy/standard/sections/clause_1_scope.adoc @@ -26,7 +26,7 @@ method. |Resource endpoint 3+|HTTP method | |**POST** |**PUT** |**DELETE** |`/processes` |<> |n/a |n/a -|`/processes/{processId}` |n/a |<> |<> +|`/processes/{processID}` |n/a |<> |<> |=== diff --git a/extensions/deploy_replace_undeploy/standard/sections/clause_6_deploy_replace_undeploy.adoc b/extensions/deploy_replace_undeploy/standard/sections/clause_6_deploy_replace_undeploy.adoc index 87a8fd7f..e08afdbe 100644 --- a/extensions/deploy_replace_undeploy/standard/sections/clause_6_deploy_replace_undeploy.adoc +++ b/extensions/deploy_replace_undeploy/standard/sections/clause_6_deploy_replace_undeploy.adoc @@ -110,7 +110,7 @@ Client Server |------------------------------------------------------------>| | | | HTTP/1.1 201 Created | - | Location: /processes/{processId} | + | Location: /processes/{processID} | |<------------------------------------------------------------| ``` @@ -171,7 +171,7 @@ NOTE: The new process definition replaces the old process definition. Version co ``` Client Server | | - | PUT /processes/{processId} HTTP/1.1 | + | PUT /processes/{processID} HTTP/1.1 | | Content-Type: application/ogcapppkg+json | | | | ... Body contains a formal description of the process to | @@ -235,7 +235,7 @@ previously deployed process. ``` Client Server | | - | DELETE /processes/{processId} HTTP/1.1 | + | DELETE /processes/{processID} HTTP/1.1 | |------------------------------------------------------------>| | | | HTTP/1.1 204 OK | diff --git a/extensions/job_management/standard/requirements/job-management/create/REQ_response-jobid.adoc b/extensions/job_management/standard/requirements/job-management/create/REQ_response-jobid.adoc index bd8ec9c9..7997af5f 100644 --- a/extensions/job_management/standard/requirements/job-management/create/REQ_response-jobid.adoc +++ b/extensions/job_management/standard/requirements/job-management/create/REQ_response-jobid.adoc @@ -3,5 +3,5 @@ ==== [%metadata] label:: /req/job-management/create-response-jobid -part:: If the operation completes, the server SHALL generate a job identifier (i.e. `{jobId}`) for the created job. +part:: If the operation completes, the server SHALL generate a job identifier (i.e. `{jobID}`) for the created job. ==== diff --git a/extensions/job_management/standard/requirements/job-management/create/REQ_response-success.adoc b/extensions/job_management/standard/requirements/job-management/create/REQ_response-success.adoc index aea1e23f..a9787954 100644 --- a/extensions/job_management/standard/requirements/job-management/create/REQ_response-success.adoc +++ b/extensions/job_management/standard/requirements/job-management/create/REQ_response-success.adoc @@ -4,5 +4,5 @@ [%metadata] label:: /req/job-management/create-response-success part:: A successful execution of the operation SHALL be reported as a response with a HTTP status code `201`. -part:: A response with HTTP status code `201` SHALL include a `Location` header with the URI of the deployed processes (path: `/jobs/{jobId}`). +part:: A response with HTTP status code `201` SHALL include a `Location` header with the URI of the deployed processes (path: `/jobs/{jobID}`). ==== diff --git a/extensions/job_management/standard/requirements/job-management/definition/REQ_get-op.adoc b/extensions/job_management/standard/requirements/job-management/definition/REQ_get-op.adoc index f3a25f2d..29c5739e 100644 --- a/extensions/job_management/standard/requirements/job-management/definition/REQ_get-op.adoc +++ b/extensions/job_management/standard/requirements/job-management/definition/REQ_get-op.adoc @@ -3,7 +3,7 @@ ==== [%metadata] label:: /req/job-management/definition-get-op -part:: For every jobs (using method: POST on path: /jobs/{jobId}), the server SHALL support the HTTP GET operation at the path `/jobs/{jobId}/definition`. -part:: The parameter `jobId` is each `id` property in the job-list response (JSONPath: `$.jobs[*].id`). +part:: For every jobs (using method: POST on path: /jobs/{jobID}), the server SHALL support the HTTP GET operation at the path `/jobs/{jobID}/definition`. +part:: The parameter `jobID` is each `id` property in the job-list response (JSONPath: `$.jobs[*].id`). ==== diff --git a/extensions/job_management/standard/requirements/job-management/start/REQ_post-op.adoc b/extensions/job_management/standard/requirements/job-management/start/REQ_post-op.adoc index ec2a6278..4ddf195c 100644 --- a/extensions/job_management/standard/requirements/job-management/start/REQ_post-op.adoc +++ b/extensions/job_management/standard/requirements/job-management/start/REQ_post-op.adoc @@ -3,6 +3,6 @@ ==== [%metadata] label:: /req/job-management/start-post-op -part:: For every created jobs (path: `/jobs/{jobId}/results`), the server SHALL support the HTTP POST operation. -part:: The parameter `jobId` is each `jobID` property in the job list response (JSONPath: `$.jobs[*].id`). +part:: For every created jobs (path: `/jobs/{jobID}/results`), the server SHALL support the HTTP POST operation. +part:: The parameter `jobID` is each `id` property in the job list response (JSONPath: `$.jobs[*].id`). ==== diff --git a/extensions/job_management/standard/requirements/job-management/update/REQ_patch-op.adoc b/extensions/job_management/standard/requirements/job-management/update/REQ_patch-op.adoc index 75a25576..797b8da8 100644 --- a/extensions/job_management/standard/requirements/job-management/update/REQ_patch-op.adoc +++ b/extensions/job_management/standard/requirements/job-management/update/REQ_patch-op.adoc @@ -3,6 +3,6 @@ ==== [%metadata] label:: /req/job-management/update-patch-op -part:: For every created jobs (path '/jobs/{jobId}'), the server SHALL support the HTTP PATCH operation. -part:: The parameter 'jobId' is each 'jobID' property in the jobs list response (JSONPath: `$.jobs[*].id`). +part:: For every created jobs (path `/jobs/{jobID}`), the server SHALL support the HTTP PATCH operation. +part:: The parameter `jobID` is each `id` property in the jobs list response (JSONPath: `$.jobs[*].id`). ==== diff --git a/extensions/job_management/standard/requirements/provenance/inputs/REQ_get-op.adoc b/extensions/job_management/standard/requirements/provenance/inputs/REQ_get-op.adoc index d4174f99..8e6aefd6 100644 --- a/extensions/job_management/standard/requirements/provenance/inputs/REQ_get-op.adoc +++ b/extensions/job_management/standard/requirements/provenance/inputs/REQ_get-op.adoc @@ -3,6 +3,6 @@ ==== [%metadata] label:: /req/provenance/inputs-get-op -part:: For every created jobs (path: `/jobs/{jobId}/inputs`), the server SHALL support the HTTP GET operation. -part:: The parameter `jobId` is each `jobID` property in the job list response (JSONPath: `$.jobs[*].id`). +part:: For every created jobs (path: `/jobs/{jobID}/inputs`), the server SHALL support the HTTP GET operation. +part:: The parameter `jobID` is each `id` property in the job list response (JSONPath: `$.jobs[*].id`). ==== diff --git a/extensions/job_management/standard/requirements/provenance/prov/REQ_get-op.adoc b/extensions/job_management/standard/requirements/provenance/prov/REQ_get-op.adoc index 2e06e8a6..fbc9f16b 100644 --- a/extensions/job_management/standard/requirements/provenance/prov/REQ_get-op.adoc +++ b/extensions/job_management/standard/requirements/provenance/prov/REQ_get-op.adoc @@ -3,6 +3,6 @@ ==== [%metadata] label:: /req/provenance/prov-get-op -part:: For every created jobs (path: `/jobs/{jobId}/prov`), the server SHALL support the HTTP GET operation. -part:: The parameter `{jobId}` is each `id` property in the job list response (JSONPath: `$.jobs[*].id`). +part:: For every created jobs (path: `/jobs/{jobID}/prov`), the server SHALL support the HTTP GET operation. +part:: The parameter `{jobID}` is each `id` property in the job list response (JSONPath: `$.jobs[*].id`). ==== diff --git a/extensions/job_management/standard/sections/clause_12_security_considerations.adoc b/extensions/job_management/standard/sections/clause_12_security_considerations.adoc index 4386682f..e772ada3 100644 --- a/extensions/job_management/standard/sections/clause_12_security_considerations.adoc +++ b/extensions/job_management/standard/sections/clause_12_security_considerations.adoc @@ -8,6 +8,6 @@ Users making modifications to job resources need to: . Be authenticated, . Have "modification privileges" on the jobs offered through the API, -. Have access to one or more of the POST and/or PATCH methods on the jobs /job and /jobs/{jobId} endpoints. +. Have access to one or more of the POST and/or PATCH methods on the jobs `/job` and `/jobs/{jobID}` endpoints. The API definition, as defined in Clause 7.3 from <>, must reflect this in the resource paths and their available methods. diff --git a/extensions/job_management/standard/sections/clause_6_job_management.adoc b/extensions/job_management/standard/sections/clause_6_job_management.adoc index 7d3ed495..bb5d02af 100644 --- a/extensions/job_management/standard/sections/clause_6_job_management.adoc +++ b/extensions/job_management/standard/sections/clause_6_job_management.adoc @@ -10,9 +10,9 @@ create, update and start jobs. The HTTP POST method on the `/jobs` path is used on to create new jobs. -The HTTP PATCH method on the `/jobs/{jobId}` is used to update the definition of a previously created jobs that are accessible via the Processes API endpoint. +The HTTP PATCH method on the `/jobs/{jobID}` is used to update the definition of a previously created jobs that are accessible via the Processes API endpoint. -Finally, the HTTP POST method on the `/job/{jobId}/results` is used to start a job. +Finally, the HTTP POST method on the `/job/{jobID}/results` is used to start a job. Creating or updating a job requires that a formal description of the new or updated jobs be provided by the client. This Standard does not @@ -86,7 +86,7 @@ Client Server |------------------------------------------------------------>| | | | HTTP/1.1 201 Created | - | Location: /jobs/{jobId} | + | Location: /jobs/{jobID} | |<------------------------------------------------------------| ``` @@ -148,7 +148,7 @@ NOTE: The new job definition replaces the old job definition. Version control is ``` Client Server | | - | PATCH /jobs/{jobId} HTTP/1.1 | + | PATCH /jobs/{jobID} HTTP/1.1 | | Content-Type: application/json | | | |------------------------------------------------------------>| @@ -209,7 +209,7 @@ the execution of a previously created jobs. ``` Client Server | | - | POST /jobs/{jobId}/results HTTP/1.1 | + | POST /jobs/{jobID}/results HTTP/1.1 | |------------------------------------------------------------>| | | | HTTP/1.1 200 OK | diff --git a/extensions/workflows/requirements/cwl-workflows/REQ_cwl-workflows_adhoc-cwl-execution.adoc b/extensions/workflows/requirements/cwl-workflows/REQ_cwl-workflows_adhoc-cwl-execution.adoc index d6c82c91..843ded12 100644 --- a/extensions/workflows/requirements/cwl-workflows/REQ_cwl-workflows_adhoc-cwl-execution.adoc +++ b/extensions/workflows/requirements/cwl-workflows/REQ_cwl-workflows_adhoc-cwl-execution.adoc @@ -6,4 +6,4 @@ description:: For executing a workflow defined using the Common Workflow Languag part:: The Implementation SHALL support ad-hoc execution of a CWL workflow definition (`Content-Type: application/cwl+json`) POSTed to `/processes/CWL/execution`. ==== -TODO: Verify whether a `{processId}` for the execution end-point is relevant or not for CWL. +TODO: Verify whether a `{processID}` for the execution end-point is relevant or not for CWL. diff --git a/extensions/workflows/requirements/deployable-workflows/REQ_deployable-workflows_selected-outputs.adoc b/extensions/workflows/requirements/deployable-workflows/REQ_deployable-workflows_selected-outputs.adoc index 26ee7b66..4d9fbf52 100644 --- a/extensions/workflows/requirements/deployable-workflows/REQ_deployable-workflows_selected-outputs.adoc +++ b/extensions/workflows/requirements/deployable-workflows/REQ_deployable-workflows_selected-outputs.adoc @@ -3,7 +3,7 @@ [%metadata] identifier:: /req/deployable-workflows/parameterized-outputs description:: For deploying workflow definitions defined as an execution request: -part:: The Implementation SHALL support selecting specific outputs of processess involved in workflow definition using the `"$output"` key and a corresponding output name value as part of an output of a process (within the `outputs` of an execution request or nested input process). +part:: The Implementation SHALL support selecting specific outputs of processess involved in workflow definition using the `"$output"` key and a corresponding output identifier value as part of an output of a process (within the `outputs` of an execution request or nested input process). part:: The deployed process SHALL have a corresponding output for each output selected using the `"$output"` using the specified name. part:: Each output of the deployed process SHALL inherit the expected data type of the output in the context where the `"$output"` key is specified. part:: If no "$output" key appears in a workflow definition, the Implementation SHALL assume that all outputs from the top-level process are returned, using the same name as specified in the description of that top-level process. diff --git a/extensions/workflows/requirements/openeo-workflows/REQ_openeo-workflows_adhoc-openeo-execution.adoc b/extensions/workflows/requirements/openeo-workflows/REQ_openeo-workflows_adhoc-openeo-execution.adoc index fef6caf5..6db560cc 100644 --- a/extensions/workflows/requirements/openeo-workflows/REQ_openeo-workflows_adhoc-openeo-execution.adoc +++ b/extensions/workflows/requirements/openeo-workflows/REQ_openeo-workflows_adhoc-openeo-execution.adoc @@ -6,4 +6,4 @@ description:: For executing a workflow defined as an OpenEO Process Graph: part:: The Implementation SHALL support ad-hoc execution of a workflow defined using an OpenEO Process Graph POSTed to `/processes/OpenEO/execution` ==== -TODO: Verify whether a `{processId}` for the execution end-point is relevant or not for OpenEO. +TODO: Verify whether a `{processID}` for the execution end-point is relevant or not for OpenEO. diff --git a/extensions/workflows/sections/clause_10_deployable_workflow.adoc b/extensions/workflows/sections/clause_10_deployable_workflow.adoc index 62ad8467..08a285c2 100644 --- a/extensions/workflows/sections/clause_10_deployable_workflow.adoc +++ b/extensions/workflows/sections/clause_10_deployable_workflow.adoc @@ -16,8 +16,8 @@ include::../requirements/requirements_class_deployable-workflows.adoc[] The following requirements describe the ability of an implementation to deploy a new process defined as an _OGC API - Processes - Part 1: Core_ execution request with _OGC API - Processes - Part 2: Deploy, Replace, Undeploy_, -including parameterizing inputs as external inputs to the deployed process using `{ "$input" : "{input name}" }` as input objects (in `"inputs"`), -and selecting specific outputs to be returned from the deployed process using `{ "$output" : "{output name}" } as output objects (in `"outputs"`). +including parameterizing inputs as external inputs to the deployed process using `{ "$input" : "{inputID}" }` as input objects (in `"inputs"`), +and selecting specific outputs to be returned from the deployed process using `{ "$output" : "{outputID}" } as output objects (in `"outputs"`). If no `"$output"` object is used within a deployed workflow definition, the deployed process is assumed to return all outputs from the top-level process with the same names as that process. diff --git a/extensions/workflows/sections/clause_14_media_types.adoc b/extensions/workflows/sections/clause_14_media_types.adoc index ba84dc4b..c3b52da3 100644 --- a/extensions/workflows/sections/clause_14_media_types.adoc +++ b/extensions/workflows/sections/clause_14_media_types.adoc @@ -3,7 +3,7 @@ The following follow media types are referenced by this specification. -* `application/json`: As with _OGC API - Processes - Part 1: Core_, used for the `Content-Type` of execution requests posted (`POST`) to `/processes/{processId}/execution`, +* `application/json`: As with _OGC API - Processes - Part 1: Core_, used for the `Content-Type` of execution requests posted (`POST`) to `/processes/{processID}/execution`, as well as to deploy workflow definitions using _OGC API - Processes - Part 2: Deploy, Replace, Undeploy_ by posting (`POST`) to `/processes`. ** A new media type (`application/ogcmoaw+json` -- Modular OGC API Workflow JSON, `application/ogcexec+json`, `application/ogcexecreq+json`?) could be registered with IANA to specifically reference _OGC API - Processes_ execution requests. diff --git a/extensions/workflows/sections/clause_6_overview.adoc b/extensions/workflows/sections/clause_6_overview.adoc index 2826f249..7302bbf3 100644 --- a/extensions/workflows/sections/clause_6_overview.adoc +++ b/extensions/workflows/sections/clause_6_overview.adoc @@ -3,7 +3,7 @@ As an extension to https://docs.ogc.org/is/18-062r2/18-062r2.html[_OGC API - Processes - Part 1: Core_], this specification defines conformance classes for: -* extending execution requests submitted to `/processes/{processId}/execution` +* extending execution requests submitted to `/processes/{processID}/execution` ** referencing local and remote nested processes as inputs (`"process"`) (<>), ** referencing local and remote OGC API collections as inputs (`"collection"`) (<>), ** modifying data accessed as inputs and returned as outputs (filtering with `"filter"`, selecting and deriving fields with `"properties"`, sorting with `"sortBy"`) (<>), diff --git a/extensions/workflows/sections/clause_7_nested_processes.adoc b/extensions/workflows/sections/clause_7_nested_processes.adoc index a8797842..5d6239ba 100644 --- a/extensions/workflows/sections/clause_7_nested_processes.adoc +++ b/extensions/workflows/sections/clause_7_nested_processes.adoc @@ -7,7 +7,7 @@ The _Nested Processes_ conformance class allows to use the output of a process a Unless an implementation also conforms to the _Remote Processes_ conformance class, only local processes are supported. Specifying a full process URI at the top-level for a process execution request is optional, since the execution request -will be posted to a specific `{processId}`, but allows the workflow definition to be self-describing and reusable, enabling GIS clients to easily +will be posted to a specific `{processID}`, but allows the workflow definition to be self-describing and reusable, enabling GIS clients to easily load the workflow definition as a data source, or publish it as a new virtual collection to any OGC API supporting execution requests as a content type for a `POST` method to `/collections`. diff --git a/ogcapi-ogc-org-processes-overview.md b/ogcapi-ogc-org-processes-overview.md index b35b39bb..deb60c4b 100644 --- a/ogcapi-ogc-org-processes-overview.md +++ b/ogcapi-ogc-org-processes-overview.md @@ -15,35 +15,35 @@ GET /processes Lists the processes this API offers. ``` -GET /processes/{process-id} +GET /processes/{processID} ``` Returns a detailed description of a process. ``` -GET /processes/{process-id}/jobs +GET /processes/{processID}/jobs ``` Returns the running and finished jobs for a process (optional). ``` -POST /processes/{process-id}/jobs +POST /processes/{processID}/jobs ``` Executes a process, i.e. creates a new job. Inputs and outputs will have to be specified in a JSON document that needs to be send in the POST body. ``` -GET /processes/{process-id}/jobs/{job-id} +GET /processes/{processID}/jobs/{jobID} ``` Returns the status of a job of a process. ``` -DELETE /processes/{process-id}/jobs/{job-id} +DELETE /processes/{processID}/jobs/{jobID} ``` Cancel a job execution. ``` -GET /processes/{process-id}/jobs/{job-id}/results +GET /processes/{processID}/jobs/{jobID}/results ``` Returns the result of a job of a process. diff --git a/openapi.yaml b/openapi.yaml index 5dc0d90c..4d7808c7 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -143,7 +143,7 @@ paths: responses: 200: description: Results received successfully - /jobs/{jobId}: + /jobs/{jobID}: get: summary: retrieve the status of a job description: | @@ -180,7 +180,7 @@ paths: $ref: "https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/NotFound.yaml" 500: $ref: "https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/responses/ServerError.yaml" - /jobs/{jobId}/results: + /jobs/{jobID}/results: get: summary: retrieve the result(s) of a job description: | diff --git a/openapi/ogcapi-processes.bundled.json b/openapi/ogcapi-processes.bundled.json index e30b5532..b4d69698 100644 --- a/openapi/ogcapi-processes.bundled.json +++ b/openapi/ogcapi-processes.bundled.json @@ -3537,7 +3537,7 @@ } } }, - "/processes/{processId}": { + "/processes/{processID}": { "get": { "summary": "retrieve a process description", "description": "The process description contains information about inputs and outputs and a link to the execution-endpoint for the process. The Core does not mandate the use of a specific process description to specify the interface of a process. That said, the Core requirements class makes the following recommendation:\n\nImplementations SHOULD consider supporting the OGC process description.\n\nFor more information, see [Section 7.8](https://docs.ogc.org/is/18-062r2/18-062r2.html#sc_process_description).\n", @@ -3547,7 +3547,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/processId-path" + "$ref": "#/components/parameters/processID-path" } ], "responses": { @@ -3568,7 +3568,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/processId-path" + "$ref": "#/components/parameters/processID-path" } ], "requestBody": { @@ -3624,7 +3624,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/processId-path" + "$ref": "#/components/parameters/processID-path" } ], "responses": { @@ -3643,7 +3643,7 @@ } } }, - "/processes/{processId}/package": { + "/processes/{processID}/package": { "get": { "summary": "retrieve the formal description used to deploy a process", "description": "Access the formal description that can be used to deploy a process on an OGC API - Processes Server Instance.\n", @@ -3653,7 +3653,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/processId-path" + "$ref": "#/components/parameters/processID-path" } ], "responses": { @@ -11477,17 +11477,17 @@ } } }, - "$ref": "#/paths/~1processes~1%7BprocessId%7D~1package/get/responses/200/content/application~1cwl/schema/definitions/CWLGraphOrFile" + "$ref": "#/paths/processes/{processID}/package/get/responses/200/content/application/cwl/schema/definitions/CWLGraphOrFile" } }, "application/cwl+json": { "schema": { - "$ref": "#/paths/~1processes~1%7BprocessId%7D~1package/get/responses/200/content/application~1cwl/schema" + "$ref": "#/paths/processes/{processID}/package/get/responses/200/content/application/cwl/schema" } }, "application/cwl+yaml": { "schema": { - "$ref": "#/paths/~1processes~1%7BprocessId%7D~1package/get/responses/200/content/application~1cwl/schema" + "$ref": "#/paths/processes/{processID}/package/get/responses/200/content/application/cwl/schema" } } } @@ -11498,7 +11498,7 @@ } } }, - "/processes/{processId}/execution": { + "/processes/{processID}/execution": { "post": { "summary": "execute a process.", "description": "Executes a process (this may result in the creation of a job resource e.g., for _asynchronous execution_).\n\nFor more information, see [Section 7.9](https://docs.ogc.org/is/18-062r2/18-062r2.html#sc_create_job).\n", @@ -11508,7 +11508,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/processId-path" + "$ref": "#/components/parameters/processID-path" }, { "name": "response", @@ -11545,7 +11545,7 @@ "process": { "type": "string", "format": "uri-reference", - "description": "URI to the process execution end point (i.e., `.../processes/{processId}/execution`)" + "description": "URI to the process execution end point (i.e., `.../processes/{processID}/execution`)" }, "inputs": { "additionalProperties": { @@ -11591,7 +11591,7 @@ } }, { - "$ref": "#/paths/~1processes~1%7BprocessId%7D~1execution/post/requestBody/content/application~1json/schema/allOf/1" + "$ref": "#/paths/processes/{processID}/execution/post/requestBody/content/application/json/schema/allOf/1" } ] }, @@ -11604,7 +11604,7 @@ ] }, { - "$ref": "#/paths/~1processes~1%7BprocessId%7D~1execution/post/requestBody/content/application~1json/schema" + "$ref": "#/paths/processes/{processID/execution/post/requestBody/content/application/json/schema" } ] }, @@ -11622,7 +11622,7 @@ } }, { - "$ref": "#/paths/~1processes~1%7BprocessId%7D~1execution/post/requestBody/content/application~1json/schema/allOf/1" + "$ref": "#/paths/processes/{processID}/execution/post/requestBody/content/application/json/schema/allOf/1" } ] } @@ -11634,7 +11634,7 @@ "$ref": "#/components/schemas/format" }, { - "$ref": "#/paths/~1processes~1%7BprocessId%7D~1execution/post/requestBody/content/application~1json/schema/allOf/1" + "$ref": "#/paths/processes/{processID}/execution/post/requestBody/content/application/json/schema/allOf/1" }, { "type": "object", @@ -11645,7 +11645,7 @@ "value": { "oneOf": [ { - "$ref": "#/paths/~1processes~1%7BprocessId%7D~1execution/post/requestBody/content/application~1json/schema/allOf/0/properties/inputs/additionalProperties/oneOf/0/oneOf/0" + "$ref": "#/paths/processes/{processID}/execution/post/requestBody/content/application/json/schema/allOf/0/properties/inputs/additionalProperties/oneOf/0/oneOf/0" }, { "type": "object" @@ -11664,7 +11664,7 @@ { "type": "array", "items": { - "$ref": "#/paths/~1processes~1%7BprocessId%7D~1execution/post/requestBody/content/application~1json/schema/allOf/0/properties/inputs/additionalProperties/oneOf/0" + "$ref": "#/paths/processes/{processID}/execution/post/requestBody/content/application/json/schema/allOf/0/properties/inputs/additionalProperties/oneOf/0" } } ] @@ -11788,7 +11788,7 @@ "$ref": "#/components/parameters/limit" }, { - "$ref": "#/components/parameters/processId-query" + "$ref": "#/components/parameters/processID-query" }, { "$ref": "#/components/parameters/status" @@ -11816,7 +11816,7 @@ } } }, - "/jobs/{jobId}": { + "/jobs/{jobID}": { "get": { "summary": "retrieve the status of a job", "description": "Shows the status of a job.\n\n For more information, see [Section 7.10](https://docs.ogc.org/is/18-062r2/18-062r2.html#sc_retrieve_status_info).\n", @@ -11826,7 +11826,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/jobId" + "$ref": "#/components/parameters/jobID" } ], "responses": { @@ -11850,7 +11850,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/jobId" + "$ref": "#/components/parameters/jobID" } ], "responses": { @@ -11866,7 +11866,7 @@ } } }, - "/jobs/{jobId}/results": { + "/jobs/{jobID}/results": { "get": { "summary": "retrieve the result(s) of a job", "description": "Lists available results of a job. In case of a failure, lists exceptions instead.\n\nFor more information, see [Section 7.11](https://docs.ogc.org/is/18-062r2/18-062r2.html#sc_retrieve_job_results).\n", @@ -11876,7 +11876,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/jobId" + "$ref": "#/components/parameters/jobID" }, { "in": "header", @@ -13442,15 +13442,15 @@ "type": "string" } }, - "processId-path": { - "name": "processId", + "processID-path": { + "name": "processID", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/processes-list" } }, - "outputId": { + "outputID": { "name": "outputID", "in": "path", "description": "identifier of an output", @@ -13459,8 +13459,8 @@ "type": "string" } }, - "jobId": { - "name": "jobId", + "jobID": { + "name": "jobID", "in": "path", "description": "local identifier of a job", "required": true, @@ -13468,7 +13468,7 @@ "type": "string" } }, - "processId-query": { + "processID-query": { "name": "processID", "in": "query", "required": false, diff --git a/openapi/ogcapi-processes.yaml b/openapi/ogcapi-processes.yaml index 97f3eac8..2ef74bb3 100644 --- a/openapi/ogcapi-processes.yaml +++ b/openapi/ogcapi-processes.yaml @@ -35,28 +35,28 @@ paths: # OGC API - Processes Part 2: Deploy, Replace, Undeploy $ref: 'paths/processes-dru/pProcessListDeploy.yaml' - /processes/{processId}: + /processes/{processID}: # OGC API - Processes Part 1: Core #$ref: 'paths/processes-core/pProcessDescription.yaml' # OGC API - Processes Part 2: Deploy, Replace, Undeploy $ref: 'paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml' - /processes/{processId}/package: + /processes/{processID}/package: # OGC API - Processes Part 2: Deploy, Replace, Undeploy $ref: 'paths/processes-dru/pPackage.yaml' - /processes/{processId}/execution: + /processes/{processID}/execution: $ref: 'paths/processes-workflows/pExecution-workflows.yaml' # OGC API - Processes - Part 1: Core (Jobs, required for ASync execution) /jobs: $ref: 'paths/processes-core/pJobsList.yaml' - /jobs/{jobId}: + /jobs/{jobID}: $ref: 'paths/processes-core/pJob.yaml' - /jobs/{jobId}/results: + /jobs/{jobID}/results: $ref: 'paths/processes-core/pJobResults.yaml' @@ -176,19 +176,19 @@ components: $ref: 'parameters/common-crs/subset-crs.yaml' # Processes - Core - processId-path: - $ref: 'parameters/processes-core/processId-path.yaml' + processID-path: + $ref: 'parameters/processes-core/processID-path.yaml' # Processes - Core (1.1?) - outputId: - $ref: 'parameters/processes-core/outputId.yaml' + outputID: + $ref: 'parameters/processes-core/outputID.yaml' # Processes - Core (Jobs) - jobId: - $ref: 'parameters/processes-core/jobId.yaml' + jobID: + $ref: 'parameters/processes-core/jobID.yaml' # Processes - Core (Querying Jobs) - processId-query: - $ref: 'parameters/processes-core/processId-query.yaml' + processID-query: + $ref: 'parameters/processes-core/processID-query.yaml' output: $ref: 'parameters/processes-core/output.yaml' limit: diff --git a/openapi/parameters/processes-core/generic/complex.yaml b/openapi/parameters/processes-core/generic/complex.yaml index 83257025..e1799897 100644 --- a/openapi/parameters/processes-core/generic/complex.yaml +++ b/openapi/parameters/processes-core/generic/complex.yaml @@ -1,4 +1,4 @@ -name: {input-name} +name: {inputID} in: query required: false schema: diff --git a/openapi/parameters/processes-core/generic/simple-boolean.yaml b/openapi/parameters/processes-core/generic/simple-boolean.yaml index 6764f61b..e6e89f5a 100644 --- a/openapi/parameters/processes-core/generic/simple-boolean.yaml +++ b/openapi/parameters/processes-core/generic/simple-boolean.yaml @@ -1,4 +1,4 @@ -name: {input-name} +name: {inputID} in: query required: false schema: diff --git a/openapi/parameters/processes-core/generic/simple-numeric.yaml b/openapi/parameters/processes-core/generic/simple-numeric.yaml index af987123..8832c1ac 100644 --- a/openapi/parameters/processes-core/generic/simple-numeric.yaml +++ b/openapi/parameters/processes-core/generic/simple-numeric.yaml @@ -1,4 +1,4 @@ -name: {input-name} +name: {inputID} in: query required: false schema: diff --git a/openapi/parameters/processes-core/generic/simple-string.yaml b/openapi/parameters/processes-core/generic/simple-string.yaml index 83257025..e1799897 100644 --- a/openapi/parameters/processes-core/generic/simple-string.yaml +++ b/openapi/parameters/processes-core/generic/simple-string.yaml @@ -1,4 +1,4 @@ -name: {input-name} +name: {inputID} in: query required: false schema: diff --git a/openapi/parameters/processes-core/jobId.yaml b/openapi/parameters/processes-core/jobID.yaml similarity index 88% rename from openapi/parameters/processes-core/jobId.yaml rename to openapi/parameters/processes-core/jobID.yaml index 80881e5e..3965f427 100644 --- a/openapi/parameters/processes-core/jobId.yaml +++ b/openapi/parameters/processes-core/jobID.yaml @@ -1,4 +1,4 @@ -name: jobId +name: jobID in: path description: local identifier of a job required: true diff --git a/openapi/parameters/processes-core/outputId.yaml b/openapi/parameters/processes-core/outputID.yaml similarity index 100% rename from openapi/parameters/processes-core/outputId.yaml rename to openapi/parameters/processes-core/outputID.yaml diff --git a/openapi/parameters/processes-core/processId-path.yaml b/openapi/parameters/processes-core/processID-path.yaml similarity index 84% rename from openapi/parameters/processes-core/processId-path.yaml rename to openapi/parameters/processes-core/processID-path.yaml index 27a89fd0..067f3add 100644 --- a/openapi/parameters/processes-core/processId-path.yaml +++ b/openapi/parameters/processes-core/processID-path.yaml @@ -1,4 +1,4 @@ -name: processId +name: processID in: path required: true schema: diff --git a/openapi/parameters/processes-core/processId-query.yaml b/openapi/parameters/processes-core/processID-query.yaml similarity index 100% rename from openapi/parameters/processes-core/processId-query.yaml rename to openapi/parameters/processes-core/processID-query.yaml diff --git a/openapi/paths/processes-core/pExecution.yaml b/openapi/paths/processes-core/pExecution.yaml index fd5a97a1..6063a048 100644 --- a/openapi/paths/processes-core/pExecution.yaml +++ b/openapi/paths/processes-core/pExecution.yaml @@ -8,7 +8,7 @@ post: tags: - Processes parameters: - - $ref: "../../parameters/processes-core/processId-path.yaml" + - $ref: "../../parameters/processes-core/processID-path.yaml" - $ref: "../../parameters/processes-core/prefer-header-execution.yaml" requestBody: description: |- diff --git a/openapi/paths/processes-core/pJob.yaml b/openapi/paths/processes-core/pJob.yaml index 9bb103a1..cd652e9c 100644 --- a/openapi/paths/processes-core/pJob.yaml +++ b/openapi/paths/processes-core/pJob.yaml @@ -8,7 +8,7 @@ get: tags: - Jobs parameters: - - $ref: "../../parameters/processes-core/jobId.yaml" + - $ref: "../../parameters/processes-core/jobID.yaml" responses: 200: $ref: "../../responses/processes-core/rStatus.yaml" @@ -26,7 +26,7 @@ delete: tags: - Jobs parameters: - - $ref: "../../parameters/processes-core/jobId.yaml" + - $ref: "../../parameters/processes-core/jobID.yaml" responses: 200: $ref: "../../responses/processes-core/rStatus.yaml" diff --git a/openapi/paths/processes-core/pJobResults.yaml b/openapi/paths/processes-core/pJobResults.yaml index f2f852b3..0da7f155 100644 --- a/openapi/paths/processes-core/pJobResults.yaml +++ b/openapi/paths/processes-core/pJobResults.yaml @@ -8,7 +8,7 @@ get: tags: - Jobs parameters: - - $ref: "../../parameters/processes-core/jobId.yaml" + - $ref: "../../parameters/processes-core/jobID.yaml" - $ref: "../../parameters/processes-core/prefer-header-results.yaml" responses: 200: diff --git a/openapi/paths/processes-core/pJobsList.yaml b/openapi/paths/processes-core/pJobsList.yaml index ca6258cb..5282426b 100644 --- a/openapi/paths/processes-core/pJobsList.yaml +++ b/openapi/paths/processes-core/pJobsList.yaml @@ -9,7 +9,7 @@ get: - Jobs parameters: - $ref: "../../parameters/processes-core/limit.yaml" - - $ref: "../../parameters/processes-core/processId-query.yaml" + - $ref: "../../parameters/processes-core/processID-query.yaml" - $ref: "../../parameters/processes-core/status.yaml" - $ref: "../../parameters/processes-core/minDuration.yaml" - $ref: "../../parameters/processes-core/maxDuration.yaml" diff --git a/openapi/paths/processes-core/pProcessDescription.yaml b/openapi/paths/processes-core/pProcessDescription.yaml index 222be6eb..30d48264 100644 --- a/openapi/paths/processes-core/pProcessDescription.yaml +++ b/openapi/paths/processes-core/pProcessDescription.yaml @@ -11,7 +11,7 @@ get: tags: - Processes parameters: - - $ref: "../../parameters/processes-core/processId-path.yaml" + - $ref: "../../parameters/processes-core/processID-path.yaml" responses: 200: $ref: "../../responses/processes-core/rProcessDescription.yaml" diff --git a/openapi/paths/processes-dru/pPackage.yaml b/openapi/paths/processes-dru/pPackage.yaml index af709bab..a0674178 100644 --- a/openapi/paths/processes-dru/pPackage.yaml +++ b/openapi/paths/processes-dru/pPackage.yaml @@ -6,7 +6,7 @@ get: tags: - DRU parameters: - - $ref: "../../parameters/processes-core/processId-path.yaml" + - $ref: "../../parameters/processes-core/processID-path.yaml" responses: 200: description: The formal used to deploy a process @@ -24,4 +24,4 @@ get: schema: $ref: "https://raw.githubusercontent.com/common-workflow-lab/cwl-ts-auto/main/json_schemas/cwl_schema.yaml" 404: - $ref: "../../responses/common-core/rNotFound.yaml" \ No newline at end of file + $ref: "../../responses/common-core/rNotFound.yaml" diff --git a/openapi/paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml b/openapi/paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml index 4a40d3f1..39bd5816 100644 --- a/openapi/paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml +++ b/openapi/paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml @@ -11,7 +11,7 @@ get: tags: - Processes parameters: - - $ref: "../../parameters/processes-core/processId-path.yaml" + - $ref: "../../parameters/processes-core/processID-path.yaml" responses: 200: $ref: "../../responses/processes-core/rProcessDescription.yaml" @@ -27,7 +27,7 @@ put: tags: - DRU parameters: - - $ref: "../../parameters/processes-core/processId-path.yaml" + - $ref: "../../parameters/processes-core/processID-path.yaml" requestBody: description: |- An OGC Application Package used to deploy a new process. @@ -68,7 +68,7 @@ delete: tags: - DRU parameters: - - $ref: "../../parameters/processes-core/processId-path.yaml" + - $ref: "../../parameters/processes-core/processID-path.yaml" responses: 204: $ref: "../../responses/processes-core/rEmpty.yaml" diff --git a/openapi/paths/processes-dru/pReplace.yaml b/openapi/paths/processes-dru/pReplace.yaml index 3c049db8..f8905433 100644 --- a/openapi/paths/processes-dru/pReplace.yaml +++ b/openapi/paths/processes-dru/pReplace.yaml @@ -8,7 +8,7 @@ put: tags: - DRU parameters: - - $ref: "../../parameters/processes-core/processId-path.yaml" + - $ref: "../../parameters/processes-core/processID-path.yaml" requestBody: description: |- An OGC Application Package used to deploy a new process. diff --git a/openapi/paths/processes-dru/pUndeploy.yaml b/openapi/paths/processes-dru/pUndeploy.yaml index ce0e38d0..e123f4da 100644 --- a/openapi/paths/processes-dru/pUndeploy.yaml +++ b/openapi/paths/processes-dru/pUndeploy.yaml @@ -8,7 +8,7 @@ delete: tags: - DRU parameters: - - $ref: "../../parameters/processes-core/processId-path.yaml" + - $ref: "../../parameters/processes-core/processID-path.yaml" responses: 204: $ref: "../../responses/processes-core/rEmpty.yaml" diff --git a/openapi/paths/processes-job-management/pJob.yaml b/openapi/paths/processes-job-management/pJob.yaml index d5b3f12a..90eaee6d 100644 --- a/openapi/paths/processes-job-management/pJob.yaml +++ b/openapi/paths/processes-job-management/pJob.yaml @@ -6,7 +6,7 @@ patch: tags: - Jobs Management parameters: - - $ref: "../../parameters/processes-core/jobId.yaml" + - $ref: "../../parameters/processes-core/jobID.yaml" # If we want to use similar mechanism as the workflows, we can use the # following parameter. #- $ref: "../../parameters/processes-workflows/response.yaml" diff --git a/openapi/paths/processes-job-management/pJobDefinition.yaml b/openapi/paths/processes-job-management/pJobDefinition.yaml index ef2c5b2e..223cd806 100644 --- a/openapi/paths/processes-job-management/pJobDefinition.yaml +++ b/openapi/paths/processes-job-management/pJobDefinition.yaml @@ -6,7 +6,7 @@ get: tags: - Jobs Management parameters: - - $ref: "../../parameters/processes-core/jobId.yaml" + - $ref: "../../parameters/processes-core/jobID.yaml" responses: 200: $ref: "../../schemas/processes-workflows/execute-workflows.yaml" diff --git a/openapi/paths/processes-job-management/pJobInputs.yaml b/openapi/paths/processes-job-management/pJobInputs.yaml index 96ef8b02..376307de 100644 --- a/openapi/paths/processes-job-management/pJobInputs.yaml +++ b/openapi/paths/processes-job-management/pJobInputs.yaml @@ -6,7 +6,7 @@ get: tags: - Jobs Management parameters: - - $ref: "../../parameters/processes-core/jobId.yaml" + - $ref: "../../parameters/processes-core/jobID.yaml" responses: 200: $ref: "../../schemas/processes-management/rInputs.yaml" diff --git a/openapi/paths/processes-job-management/pJobResults.yaml b/openapi/paths/processes-job-management/pJobResults.yaml index a5baeab6..a8d16876 100644 --- a/openapi/paths/processes-job-management/pJobResults.yaml +++ b/openapi/paths/processes-job-management/pJobResults.yaml @@ -14,7 +14,7 @@ post: tags: - Jobs Management parameters: - - $ref: "../../parameters/processes-core/jobId.yaml" + - $ref: "../../parameters/processes-core/jobID.yaml" responses: 200: $ref: "../../responses/processes-core/rExecuteAsync.yaml" diff --git a/openapi/paths/processes-workflows/pExecution-workflows.yaml b/openapi/paths/processes-workflows/pExecution-workflows.yaml index 22f7482d..3f9e88ab 100644 --- a/openapi/paths/processes-workflows/pExecution-workflows.yaml +++ b/openapi/paths/processes-workflows/pExecution-workflows.yaml @@ -8,7 +8,7 @@ post: tags: - Processes parameters: - - $ref: "../../parameters/processes-core/processId-path.yaml" + - $ref: "../../parameters/processes-core/processID-path.yaml" - $ref: "../../parameters/processes-workflows/response.yaml" - $ref: "../../parameters/processes-core/prefer-header-execution.yaml" requestBody: diff --git a/openapi/schemas/processes-workflows/execute-workflows.yaml b/openapi/schemas/processes-workflows/execute-workflows.yaml index 1f1c7117..059133c5 100644 --- a/openapi/schemas/processes-workflows/execute-workflows.yaml +++ b/openapi/schemas/processes-workflows/execute-workflows.yaml @@ -4,7 +4,7 @@ allOf: process: type: string format: uri-reference - description: URI to the process execution end point (i.e., `.../processes/{processId}/execution`) + description: URI to the process execution end point (i.e., `.../processes/{processID}/execution`) inputs: additionalProperties: $ref: "input-workflows.yaml" From 04f378d4da0f8f4819ce977e436ba8474af7f9de Mon Sep 17 00:00:00 2001 From: Panagiotis Vretanos Date: Sun, 27 Apr 2025 17:58:30 -0400 Subject: [PATCH 2/2] Update actions/cache to V4. --- .github/workflows/generate.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/generate.yml b/.github/workflows/generate.yml index 83c82f96..a9fc8e73 100644 --- a/.github/workflows/generate.yml +++ b/.github/workflows/generate.yml @@ -18,12 +18,12 @@ jobs: matrix: os: [ ubuntu-latest ] steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 with: token: ${{ github.token }} submodules: true - - uses: actions/cache@v2 + - uses: actions/cache@v4 with: path: ~/.fontist key: fontist-${{ runner.os }}