Reference

Canonical lookup — env-vars, HTTP API, OPEA protocol extensions, glossary.

Mission

The Reference section is exhaustive lookup material — env-var tables, HTTP API contracts, OPEA protocol extensions, the Kong / Nginx route map, the ArangoDB collection schema, the service-registry enum. Unlike how-to docs, the order is alphabetical / canonical, not narrative.

Pages in this section

  • Environment variables — every supported env-var with default, scope, and the container that reads it. Single source of truth (generated from env + docker-compose.yaml).
  • Backend HTTP API — every public endpoint, request/response shape, auth requirement, error semantics.
  • OPEA protocol extensions — the GENIE.AI additions to the standard OPEA protocol (genieai_api_protocol.py).
  • Kong / Nginx routes — path-prefix → backend service mapping.
  • ArangoDB collections — every collection with field schema.
  • Service registry enum — service roles, OTel service.name, Docker service block names, and image references (the OPEA ServiceType enum lives in genie-ai-overlay/core/constants.py; service names are string literals set per service via setup_tracing(...)).
  • Glossary — full glossary, same as Get started → Glossary.
  • Deploy — install recipes that consume these references.
  • Configure — runtime tunables that map onto the env-vars page.
  • API contracts — narrative version of every HTTP endpoint.
Environment variables (single source)

Every supported env-var with default, scope, and the container that reads it — generated from env and docker-compose.yaml.

Backend HTTP API

Every public endpoint with request/response shape, auth requirement, and error semantics.

Source Tree Analysis

A walk-through of the GENIE.AI repository structure: every component, its purpose, and its dependencies.

OPEA protocol extensions

GENIE.AI extensions to the standard OPEA protocol — genieai_api_protocol.py.

Kong / Nginx routes

Path-prefix → backend service mapping, CORS, rate limits, and the public allowlist.

ArangoDB collections

Every collection in the GENIE.AI knowledge graph with field schema.

Service registry enum

Canonical service-name enum — genieai-* service names, OTel attributes, and image tags.

Glossary

The full glossary — every acronym from A to W.

Last modified September 30, 2026: fix(docs): Wave 79 P1+P2 corrections (33d1d8cf1)