API docs by Redocly

Stage Events (1.0.0)

Download OpenAPI specification:

Terradue: info@terradue.com License: Apache-2.0

This API provides real-time stage events streaming capabilities.

Send CloudEvent.

Sends a structured-mode CloudEvent.

For more information, see CloudEvents - Version 1.0.2.

Authorizations:
BearerToken
header Parameters
X-Kafka-Topic
required
string^[^.]+\.[^.]+\.(\d+[hmsd]\.calendar|prepared|...

The named resource that serves as a feed for messages.

Pattern is {{workflow.namespace}}.{{workflow.uid}}.(\d+[hmsd]\.calendar|prepared|completed|failed|piped|staged|ordered), where:

Topic Semantic
{{workflow.namespace}}.{{workflow.uid}}.\d+[hmsd].calendar CWL and input parameters are wrapped w/ stage-in/out steps
{{workflow.namespace}}.{{workflow.uid}}.prepared CWL and input parameters are wrapped w/ stage-in/out steps
{{workflow.namespace}}.{{workflow.uid}}.completed Workflow completed its life cycle and CommandLineTools/Calrissian stderr/out logs are collected
{{workflow.namespace}}.{{workflow.uid}}.failed Workflow failed during its life cycle and CommandLineTools/Calrissian stderr/out logs are collected
{{workflow.namespace}}.{{workflow.uid}}.piped Feature Collection is generated
{{workflow.namespace}}.{{workflow.uid}}.staged Results are posted in Catalog via stac-postman
{{workflow.namespace}}.{{workflow.uid}}.ordered A STAC Item transitioned from order:status=orderable to order:status=ordered;
Request Body schema: application/cloudevents+json
required

A structured-mode CloudEvent.

One of
source
required
string^[^:]+:[^:]+:[^:]+$

Identifies the context in which an event happened.

Pattern is {workflow.namespace}}:{{workflow.annotations.eoap.ogc.org/id}}:{{steps.name}}.

subject
required
string^[^:]+:[^:]+:[^:]+$

The subject of the event in the context of the event producer (identified by source).

Pattern is {{workflow.namespace}}:{{workflow.uid}}:{{workflow.name}}.

partitionkey
required
string

A partition key for the event, typically for the purposes of defining a causal relationship/grouping between multiple events.

Implementors note: set it equals to the subject by default.

type
required
string
Default: "calendar-event"

Contains a value describing the type of event related to the originating occurrence.

Value: "calendar-event"
required
object (CalendarData)

The event payload.

Request samples

Content type
application/cloudevents+json
Example
{
  • "source": "seda:workflows:scan-calendar:5s",
  • "type": "calendar-event",
  • "subject": "workflows:scan-calendar:5s",
  • "partitionkey": "workflows:scan-calendar:5s",
  • "data": {
    }
}

Response samples

Content type
text/plain
success