Support POST /jobs for various workflow implementations

[fmigneault]

Description

Alternate execution endpoints POST /jobs allowing cross-walk between openEO, CWL and OGC API - Processes - Part 3: ad-hoc/nested Workflows.

• 1. support Content-Type: application/json with Content-Schema to identify the workflow type

  • ad-hoc workflows: Content-Schema: https://schemas.opengis.net/ogcapi/processes/part3/0.0/openapi/schemas/processes-workflows/execute-workflows.yaml (not yet published!) Referring to https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-workflows/execute-workflows.yaml as described in https://geolabs.fr/dl/job-management/ogcapi-processes/extensions/job_management/standard/20-044.html#_ogc_api_processes_workflow_execute_request_body)
  • Content-Type: application/cwl+json can be used for CWL, since an IANA media-type is already available
  • openEO: not planned for the moment

• 2. GET /jobs/{jobId}/run

  • not yet clear what the run output should look like... no schema defined
  • maybe cwltool --provenance ? Support CWL Prov with cwltool for OGC API - Processes IPT #673

• 3. GET /jobs/{jobID}/logs

• 4. n/a

• 5. n/a

• 6. Support status: created

  • Allow submitting POST /jobs with status: created and leave it pending until requested
  • Return a job status response (as if async, but not submitted to workers)
  • POST /jobs/{jobId}/results to request its execution (transition from created to ... see (8) )

• 7. PUT /jobs/{jobId} or PATCH /jobs/{jobId} to update the job definition

  • Job MUST be in created status to allow the operation
  • Allow modifying the execution modes, output transmission, response, etc.
    (however, some might still be again override-able when execution is requested)

• 8. n/a

• 9. POST /jobs/{jobId}/results to request execution of the pending job

  • Apply logic of Support various return preference header #414
  • Consider parameters sorted in the job (when created/updated from POST /jobs)
  • Consider parameters provided during POST /jobs/{jobId}/results as overrides (to update in job)

• 10. n/a

• 11. Content-Type: application/json; profile={openeo|ogcapi-processes} as alternate to (1) Content-Schema

References

• See discussions and details for each numbered requirement:
  Central job submission endpoint (also: POST /processes/{processID}/execution is not RESTful and is confusing for workflows) opengeospatial/ogcapi-processes#419 (comment)
• OGC09-31