ores.assets.api

Table of Contents

1. Diagram

ores.assets.api component diagram

Figure 1: ores.assets.api

2. Summary

ores.assets.api is a header-only library defining the shared contract for the assets domain. It provides domain types for images (SVG text), tags, and their associations, JSON serialisation via rfl, and the NATS message protocol schemas consumed by both ores.assets.core (server) and UI client components.

3. Inputs

  • Domain entity definitions in domain/ headers.
  • NATS protocol message definitions in messaging/assets_protocol.hpp.

4. Outputs

  • C++ headers: image.hpp, tag.hpp, image_tag.hpp, with JSON I/O variants (*_json_io.hpp).
  • NATS protocol header: messaging/assets_protocol.hpp.
  • Aggregate header: ores.assets.api.domain.hpp.

5. Entry points

  • include/ores.assets.api/domain/ — all domain entity headers.
  • include/ores.assets.api/messaging/assets_protocol.hpp — NATS protocol message types.

6. Dependencies

  • rfl — JSON serialisation via reflection.

7. See also

Emacs 29.3 (Org mode 9.6.15)