ores.reporting.api
Table of Contents
1. Diagram
Figure 1: ores.reporting.api
2. Summary
ores.reporting.api is a header-only library defining the shared contract for
the reporting domain. It provides domain types for report types, definitions,
instances, concurrency policies, and run status values, together with JSON
and table I/O via rfl, and the NATS protocol schemas consumed by
ores.reporting.core and UI clients.
3. Inputs
- Domain entity type definitions: report type, definition, instance, concurrency policy headers.
4. Outputs
- C++ headers for all reporting domain types with JSON and table I/O.
- NATS protocol headers for report management operations.
5. Entry points
include/ores.reporting.api/domain/— all domain entity headers.include/ores.reporting.api/messaging/— NATS protocol message headers.
6. Dependencies
rfl— JSON serialisation via reflection.fort— formatted table rendering.
7. See also
- ores.reporting — component group overview.
- ores.reporting.core — business logic, persistence, and NATS handlers.
- ores.reporting Messaging Reference — full NATS subject and message catalogue.