API reference
Three generated references are published next to this book:
- NGSI-LD HTTP API — ETSI's own OpenAPI document (
docs/openapi/ngsi-ld-api.yaml, vendored at a pinned tag), rendered with ReDoc: https://antaresbroker.joinedcontext.com/openapi/ngsi-ld.html - Operational API — the broker's own OpenAPI document for every route outside
/ngsi-ld/v1(docs/openapi/antares-admin.yaml:/q/and the peer wire/ex/v1/), rendered the same way: https://antaresbroker.joinedcontext.com/openapi/admin.html - Rust crates — rustdoc for every workspace crate, the entry point for the shared crates: https://antaresbroker.joinedcontext.com/api/
The broker serves the NGSI-LD API under /ngsi-ld/v1; the prose for the routes under /q/ is the Admin API chapter. A unit test in antares-api holds the operational document to the router: every path and method it lists is mounted, and every mounted one is listed.