Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/generate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion core/abstract_tests/ATS_class_core.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
====
[%metadata]
identifier:: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core
subject:: <<rc_core,http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core>>
subject:: <<rc_core,http://www.opengis.net/spec/ogcapi-processes-1/1.0/req/core>>
classification:: Target Type:Web API
conformance-test:: /conf/core
conformance-test:: /conf/core/api-definition-op
Expand Down
4 changes: 2 additions & 2 deletions core/abstract_tests/dismiss/ATS_job-dismiss-op.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ test-purpose:: Validate that a running job can be dismissed.
test-method::
+
--
1. Create an asynchronous job as per test <<ats_core_process-execute-op,/conf/core/process-execute-op>>; not the job identifier, {jobID}, assigned to the job.
1. Create an asynchronous job as per test <<ats_core_process-execute-op,/conf/core/process-execute-op>>; 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 <<ats_dismiss_job-dismiss-success,/conf/dismiss/job-dismiss-success>>.
--
Expand Down
2 changes: 1 addition & 1 deletion core/examples/openapi/ogcapi-processes-1-example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |-
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
====
2 changes: 1 addition & 1 deletion core/requirements/core/REQ_job-result-op.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
identifier:: /req/core/job-result
label:: /req/core/job-result

For each <<output_description_schema,defined process output>> with identifier `outputId`, the server SHALL support the HTTP GET operation at the path `/jobs/{jobID}/results/{outputID}`.
For each <<output_description_schema,defined process output>> with identifier `outputID`, the server SHALL support the HTTP GET operation at the path `/jobs/{jobID}/results/{outputID}`.
====
6 changes: 3 additions & 3 deletions core/requirements/kvp-execute/REQ_array-input-value.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<sc_process_description,process description>>.
. A process input, with identifier `{inputID}`, is defined as type `array` in the <<sc_process_description,process description>>.
--

[.component,class=part]
Expand All @@ -22,7 +22,7 @@ The input parameter SHALL have the following characteristics:

[source,yaml]
----
name: {input-name}
name: {inputID}
in: query
required: false
schema:
Expand All @@ -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.
--

====
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<req_ogc-process-description_input-binary,binary>> type in the <<sc_process_description,process description>>.
. A process input, with identifier `{inputID}`, is defined as <<req_ogc-process-description_input-binary,binary>> type in the <<sc_process_description,process description>>.
. The input value needs to <<qualified-value-schema,qualified>> with a <<format-schema,format>> specification.
--

Expand All @@ -18,7 +18,7 @@ The input parameter SHALL have the following characteristics:

[source,YAML]
----
name: {input-name}
name: {inputID}
in: query
required: false
schema:
Expand All @@ -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.
--
====
6 changes: 3 additions & 3 deletions core/requirements/kvp-execute/REQ_binary-input-value.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<req_ogc-process-description_input-binary,binary>> type in the <<sc_process_description,process description>>.
. A process input, with identifier `{inputID}`, is defined as <<req_ogc-process-description_input-binary,binary>> type in the <<sc_process_description,process description>>.
. The input value does not need to be <<qualified-value-schema,qualified>> with a <<format-schema,format>> specification.
--

Expand All @@ -18,7 +18,7 @@ The input parameter SHALL have the following characteristics:

[source,YAML]
----
name: {input-name}
name: {inputID}
in: query
required: false
schema:
Expand All @@ -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.
--
====
6 changes: 3 additions & 3 deletions core/requirements/kvp-execute/REQ_boolean-input-value.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<sc_process_description,process description>>.
. A process input, with identifier `{inputID}` is defined as type `boolean` in the <<sc_process_description,process description>>.
--

[.component,class=part]
Expand All @@ -17,7 +17,7 @@ The input parameter SHALL have the following characteristics:

[source,YAML]
----
name: {input-name}
name: {inputID}
in: query
required: false
schema:
Expand All @@ -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.
--
====
6 changes: 3 additions & 3 deletions core/requirements/kvp-execute/REQ_complex-input-value.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<sc_process_description,process description>>.
. A process input, with identifier `{inputID}`, is defined as type `object` in the <<sc_process_description,process description>>.
--

[.component,class=part]
Expand All @@ -22,7 +22,7 @@ The input parameter SHALL have the following characteristics:

[source,yaml]
----
name: {input-name}
name: {inputID}
in: query
required: false
schema:
Expand All @@ -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.
--

====
4 changes: 2 additions & 2 deletions core/requirements/kvp-execute/REQ_input-by-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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]
Expand Down
8 changes: 4 additions & 4 deletions core/requirements/kvp-execute/REQ_input-cardinality.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<sc_process_description,process description>>.
. 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 <<sc_process_description,process description>>.
. The number of input values specified for the `{inputID}` process input is greater than one.
--

[.component,class=part]
Expand All @@ -23,7 +23,7 @@ The input parameter SHALL have the following characteristics:

[source,yaml]
----
name: {input-name}
name: {inputID}
in: query
required: false
schema:
Expand All @@ -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]
Expand Down
6 changes: 3 additions & 3 deletions core/requirements/kvp-execute/REQ_numeric-input-value.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<sc_process_description,process description>>.
. A process input, with identifier `{inputID}`, is defined as a numeric type input in the <<sc_process_description,process description>>.
--

[.component,class=part]
Expand All @@ -17,7 +17,7 @@ The input parameter SHALL have the following characteristics:

[source,YAML]
----
name: {input-name}
name: {inputID}
in: query
required: false
schema:
Expand All @@ -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`.
--
====
6 changes: 3 additions & 3 deletions core/requirements/kvp-execute/REQ_output.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ label:: /req/kvp-execute/output

[.component,class=conditions]
--
. A process output, with identifier `{output-name}`, is defined in the <<sc_process_description,process description>>.
. A process output, with identifier `{outputID}`, is defined in the <<sc_process_description,process description>>.
--

[.component,class=part]
Expand All @@ -16,7 +16,7 @@ The output parameter SHALL have the following characteristics:

[source,yaml]
----
name: {output-name}
name: {outputID}
in: query
required: false
schema:
Expand All @@ -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.
--
====
6 changes: 3 additions & 3 deletions core/requirements/kvp-execute/REQ_string-input-value.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<sc_process_description,process description>>.
. A process input, with identifier `{inputID}`, is defined as type `string` in the <<sc_process_description,process description>>.
--

[.component,class=part]
Expand All @@ -17,7 +17,7 @@ The input parameter SHALL have the following characteristics:

[source,YAML]
----
name: {input-name}
name: {inputID}
in: query
required: false
schema:
Expand All @@ -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.
--
====
2 changes: 1 addition & 1 deletion core/sections/clause_8_ogc-process-description.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<sc_process_description,process description>> from the `/processes/{processId}` endpoint.
The following URL is an example of retrieving a <<sc_process_description,process description>> from the `/processes/{processID}` endpoint.
[source]
----
https://processing.example.org/processes/EchoProcess
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ test-method::
--
1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ test-method::
--
1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/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 <<ats_ogcapppkg_deploy_response-success,/conf/ogcapppkg/deploy/response-success>>.
2. Append `/{processID}` to each path, where `{processID}` is the process id retrieved from <<ats_ogcapppkg_deploy_response-success,/conf/ogcapppkg/deploy/response-success>>.

3. Send a PUT request for one path using the media type "application/ogcapppkg+json" with as body a default OGC Application Package

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ test-method::
--
1. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/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.

Expand Down
Loading