ores.dq.api
Table of Contents
2. Summary
ores.dq.api is a header-only library defining the shared contract for the
data-quality domain. It provides domain types for badges, badge definitions,
datasets, dataset bundles, coding schemes, change-management records, and
artefact types, together with JSON and table I/O via generated codecs, and the NATS
message protocol schemas consumed by ores.dq.core and all domain components
that interact with the DQ system.
3. Inputs
- Domain entity type definitions across
domain/headers. - NATS protocol message definitions.
4. Outputs
- C++ headers for all DQ domain types with JSON and table I/O variants.
- NATS protocol headers for badge, dataset, and change-management operations.
5. Entry points
include/ores.dq.api/domain/— all domain entity headers.include/ores.dq.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
- ores.dq — component group overview.
- ores.dq.core — business logic, persistence, and NATS handlers.
- ores.dq Messaging Reference — full NATS subject and message catalogue.
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
PRIVATE
ores.utility.lib
faker-cxx::faker-cxx
libfort::fort
Boost::boost)
target_link_libraries(${lib_target_name} PRIVATE ores.codec.pch)
target_link_libraries(${tests_target_name}
PRIVATE
ores.dq.api.lib
ores.telemetry.core.lib
ores.utility.lib
ores.testing.lib
faker-cxx::faker-cxx
Catch2::Catch2
ores.openssl_cleanup
Threads::Threads)
