ores.workflow.api

Table of Contents

1. Diagram

ores.workflow.api component diagram

Figure 1: ores.workflow.api

2. Summary

ores.workflow.api is a header-only library defining the shared contract for the workflow domain. It provides workflow and workflow-step domain types with JSON I/O via rfl, and the NATS protocol schemas consumed by ores.workflow.core and UI clients.

3. Inputs

  • Domain entity type definitions across domain/ headers.

4. Outputs

  • C++ headers for workflow domain types with JSON I/O.
  • NATS protocol headers for workflow management operations.

5. Entry points

  • include/ores.workflow.api/domain/ — all domain entity headers.
  • include/ores.workflow.api/messaging/ — NATS protocol message headers.

6. Dependencies

  • rfl — JSON serialisation via reflection.

7. See also

Emacs 29.3 (Org mode 9.6.15)