OGC API - Processes¶
AntFlow uses the OGC API - Processes resource model for discovery, process descriptions, job status, and results. GitLab workflow discovery and execution are exposed through the Project API. This page describes the root OGC resources and the current implementation boundaries, not the capabilities of every OGC API - Processes server.
All paths are relative to the API base URL. The root landing page and conformance declaration are public. Root process and job operations require user API authentication.
Operations¶
| Method | Path | Success | Response and implementation |
|---|---|---|---|
GET |
/ |
200 |
LandingPage; links to discovery, documentation, and monitoring resources. |
GET |
/conformance |
200 |
ConfClass; the server's declared conformance classes. |
GET |
/processes |
200 |
ProcessList; currently an empty list, not the GitLab workflow catalog. |
GET |
/processes/{process_id} |
Not implemented | Returns 404 (NoSuchProcess); use a project-scoped process URL. |
POST |
/processes/{process_id}/execution |
Not implemented | Returns 404 (NoSuchProcess); use project execution. |
POST |
/processes/{process_id}/execute |
Not implemented | Deprecated alias for generic execution; do not use it. |
Root job endpoints are implemented; see the complete
Job API for /jobs, status, results, logs,
annotation updates, retry, and dismissal.
GET /processes accepts an optional integer limit, but the current root
implementation still returns no processes. A path's presence in OpenAPI does
not mean its underlying generic execution handler is implemented.
LandingPage¶
| Field | Type | Required | Meaning |
|---|---|---|---|
title |
string | No | Server title. |
description |
string | No | Server description. |
links |
array of Link |
Yes | Discovery and navigation links. |
Follow link relations rather than treating the UI origin as the API base URL.
Important relations include self, root, service-desc (OpenAPI),
service-doc (interactive documentation), project-search, and monitor.
OGC conformance, process-list, and job-list relations use their OGC relation URIs.
ConfClass¶
conformsTo is a required array of conformance-class URI strings. The current
server declares these OGC API - Processes Part 1 classes:
| Class | URI |
|---|---|
| Core | http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core |
| OGC process description | http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description |
| Job list | http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/job-list |
| JSON | http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json |
| OpenAPI 3.0 | http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30 |
Read the declaration from your deployed instance. It is a declaration, not evidence of external certification, and does not enable the unsupported root execution endpoints. Do not infer additional conformance classes from route names.
Link¶
| Field | Type | Required | Meaning |
|---|---|---|---|
href |
string | Yes | Target URL. |
rel |
string | No | Relation to the containing resource. |
type |
string | No | Target media type. |
hreflang |
string | No | Target language. |
title |
string | No | Human-readable label. |
Project descriptions add links such as execute, package, carbon,
project, and source. Job responses expose status, process, package,
and, when available, result and log links. Relation names and returned links
are preferable to reconstructing deployment-dependent URLs.
Process resources¶
ProcessList contains a required processes array and optional links.
AntFlow's project list can also include an errors array when requested.
ProcessSummary identifies a process with id and version and can include
title, description, keywords, metadata, links, jobControlOptions, and
outputTransmission. ProcessDescription extends that summary with input
and output definitions.
The Project API defines how these resources are derived from CWL, including AntFlow's launcher and publication inputs. Job representations and result objects are documented in the Job API.
Execution boundary¶
OGC execution documents commonly contain an inputs object. AntFlow's project
execution endpoint instead accepts a flat JSON object of workflow input
values. The UI's import/export wrapper uses execution_content; that wrapper
is a third format and is not an HTTP execution body.
Do not infer support for synchronous execution, Prefer headers, output
selection, or transmission modes merely from the OGC data model. Use the
process description and deployed OpenAPI contract for supported behavior.
For background, see OGC API - Processes concepts and the OGC API - Processes Standard.