Skip to content

[OGC-API processes] Support process execution (/processes/{processID}/execution) #58

Open

Description

@Hneuschmidt

Support the /processes/{processID}/execution endpoint to submit jobs with OGC API processes (7.11 Execute a process).

Request body schema: https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/execute.yaml

Tasks

  • Select critical subset of requirements to implement for POC (see below)
  • Implement translation of OGC API Processes execute request -> hadoop job

Requirements

Req-Number Req-ID Requirement Status
16 /req/core/process-execute-op The server SHALL support the HTTP POST operation at the path /processes/{processID}/execution. open
17 /req/core/process-execute-request The content of a request the request body SHALL be based upon the OpenAPI 3.0 schema execute.yaml. open
18 /req/core/process-execute-inputs The server SHALL support process input values specified in-line in an execute request (i.e. by value). open
19 /req/core/process-execute-input-array Conditions: The process input is defined in the process description as having a maximum cardinality of greater than one (maxOccurs>1).
A. The server SHALL support process input values encoded as an array.
B. This SHALL be true even if the input consists of a single value.
open
20 /req/core/process-execute-input-inline-object Conditions:
1. The process input value is specified in-line in an execute request.
2. The process input is defined as an object according to its schema from the process description.
A. The server SHALL support process input values encoded as qualified values (qualifiedValue.yaml).
B. The value of the value key SHALL be an object instance of inputValue.yaml.
open
21 /req/core/process-execute-input-mixed-type Conditions
1. The process input value is specified in-line in an execute request.
2. The schema of the process input from the process description indicates that a value instance can be one of multiple input media types. In JSON Schema this is denoted by the use of the oneOf construct.
A. The server SHALL support process input values encoded as qualified values (qualifiedValue.yaml).
B. The value of the value key SHALL be an instance of inputValue.yaml.
C. The format parameter of the qualified value (qualifiedValue.yaml) SHALL be used to indicate, for this value instance, the specific input type selected from the list of type choices defined by the input value’s schema from the process description.
open
22 /req/core/process-execute-input-inline-binary Conditions
1. The process input value is specified in-line in an execute request.
2. The process input value is binary.
A. The service SHALL support binary values encoded as base64-encoded strings.
open
23 /req/core/process-execute-input-inline-bbox Servers SHALL support process input values that conform to the bbox.yaml schema. open
24 /req/core/process-execute-input-validation A. For process input values specified in-line in an execute request, the server SHALL validate each component of a process input value that is an instance of inputValue.yaml using the definition of the corresponding input from the process description.
B. For process input values specified by reference in an execute request, the server SHALL resolve the value and then validate it as if the value had been specified in-line in the execute request (i.e. as per requirement A).
open
25 /req/core/process-execute-default-execution-mode Conditions: The execute request is not accompanied with the HTTP Prefer header.
A. The server SHALL respond asynchronously if, according to the job control options in the process description, the process can only be executed asynchronously.
B. The server SHALL respond synchronously if, according to the job control options in the process description, the process can only be executed synchronously.
C. The server SHALL respond synchronously if, according to the job control options in the process description, the process can be executed in either mode.
open
26 /req/core/process-execute-auto-execution-mode Conditions: The execute request is accompanied with the HTTP Prefer header asserting a respond-async preference.
A. The server SHALL respond asynchronously if, according to the job control options in the process description, the process can only be executed asynchronously.
B. The server SHALL respond synchronously if, according to the job control options in the process description, the process can only be executed synchronously.
C. The server SHALL respond, at its discretion, either synchronously or asynchronously if, according to the job control options in the process description, the process can be executed in either mode.
open
27 /req/core/process-execute-default-outputs If a process is defined as having one or more outputs and the outputs parameter is omitted in an execute request, this SHALL be equivalent to having requested all the defined outputs in the execute request. open
28 /req/core/process-execute-sync-raw-value-one Conditions
1. The negotiated execution mode is synchronous, response=raw, transmissionMode=value
2. The number of requested outputs is 1.
A. The server SHALL respond with an HTTP status code of 200.
B. The media type of the response SHALL be as specified by the output definition from the process description.
C. The content of response SHALL be the requested process output in the requested output format.
open
29 /req/core/process-execute-sync-raw-value-multi Conditions
1. The negotiated execution mode is synchronous, response=raw, transmissionMode=value
2. The number of requested outputs is greater than 1.
A.The server SHALL respond with an HTTP status code of 200.
B.The media type of the response SHALL be multipart/related.
C. The content of response shall conform to RFC 2387, The MIME Multipart/Related Content-type.
D. Each requested output shall be encoded into one part of the response.
E. The Content-ID header for each part SHALL be the corresponding output identifier.
open
30 /req/core/process-execute-sync-raw-ref Conditions
1. The negotiated execution mode is synchronous, response=raw, transmissionMode=reference
2. The number of requested outputs is 1 or more.
A. The server SHALL respond with an HTTP status code of 204.
B. The response SHALL include one or more Link headers that reference each requested output.
open
31 /req/core/process-execute-sync-raw-mixed-multi Conditions
1. The negotiated execution mode is synchronous, response=raw,
2. Multiple transmission modes (value,reference) are requested.
3. The number of requested outputs is more than 1.
A. The server SHALL respond with an HTTP status code of 200.
B. The media type of the response SHALL be multipart/related.
C. The content of response shall conform to RFC 2387, The MIME Multipart/Related Content-type.
D. Each requested output shall be encoded into one part of the response.
E. The Content-ID header for each part SHALL be the corresponding output identifier.
F. For outputs requested by reference, the Content-Location header SHALL be included pointing to the output and the body of the part SHALL be empty.
G. For outputs requested by value, the body of the response SHALL contain the output value.
open
32 /req/core/process-execute-sync-document Conditions
1. The negotiated execution mode is synchronous, response=document, transmissionMode=value or transmissionMode=reference
2. The number of requested outputs is 1 or more.
A. The server SHALL respond with an HTTP status code of 200.
B. The media type of the response SHALL be application/json
C. The content of response SHALL conform to the results.yaml schema.
open
33 /req/core/job-results-success-sync Conditions: The server creates a job when a processes is executed synchronously.
A. A successful execution of the operation SHALL include an HTTP Link header with rel=monitor pointing to the created job.
open
34 /req/core/process-execute-success-async Conditions: The negotiated execution mode is asynchronous.
A. A successful execution of the operation SHALL be reported as a response with a HTTP status code 201.
B. The header of the response SHALL return the HTTP Location header that contains a link to the newly created job.
C. The content of the response SHALL be based upon the JSON Schema fragment statusInfo.yaml.
open

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions