ores.reporting.api

Table of Contents

1. Diagram

ores.reporting.api component 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 generated codecs, 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

  • fort — formatted table rendering.

7. Build dependencies

What the shared profile cannot know, declared here rather than hand-edited into the generated build file. Each block is spliced into its generated file after the profile's baseline.

8. See also

9. Test dependencies

The suites link what the profile cannot know about.

target_link_libraries(${lib_target_name}
    PUBLIC
        ores.eventing.api.lib
        ores.platform.lib
        ores.workflow.api.lib
    PRIVATE
        ores.utility.lib
        faker-cxx::faker-cxx
        libfort::fort)

target_link_libraries(${lib_target_name} PRIVATE ores.codec.pch)
target_link_libraries(${tests_target_name}
    PRIVATE
        ores.reporting.api.lib
        ores.telemetry.core.lib
        ores.utility.lib
        ores.testing.lib
        faker-cxx::faker-cxx
        Catch2::Catch2
        ores.openssl_cleanup
        Threads::Threads)

Emacs 29.3 (Org mode 9.6.15)