Workflow syntax

Syntax of Apolo-Flow workflows

The Workflow syntax section serves as a foundational guide for understanding and working with the various workflow types supported by our platform. These workflows enable users to define and orchestrate complex tasks and processes in YAML format, leveraging the flexibility and power of declarative configuration.

For further details about the specifics of each workflow type, refer to the respective documentation pages:

• Expression Syntax

• Live Workflow Syntax

• Batch Workflow Syntax

• Project Configuration Syntax

• Actions Syntax

JSON Schemas for Workflow Types

To streamline the process of creating and managing workflows, we provide JSON Schemas for each workflow type. These schemas help users validate their YAML files and enable intelligent features such as autocomplete and syntax checking in compatible editors. By using these schemas, users can ensure that their workflows conform to the expected structure and conventions, reducing errors and improving development efficiency.

We have made JSON Schemas available for the following workflow types:

• Live and Batch Workflow Syntax: flow-schema.json

• Actions Syntax: action-schema.json

• Project Configuration Syntax: project-schema.json

These schemas can be integrated directly into your YAML files. For users of editors like VSCode and PyCharm, our platform's templates come pre-configured with the schema association via a comment. For example, in the YAML file:

# yaml-language-server: $schema=<URL to the relevant JSON Schema>  

This configuration allows the YAML editor to automatically reference the appropriate schema, enabling features such as schema-based validation and autocomplete.