Skip to content

docs: add gateway-config/v1.md spec and close G-17#6

Merged
AdeGneus merged 1 commit into
mainfrom
specs/gateway-config-v1
Jun 9, 2026
Merged

docs: add gateway-config/v1.md spec and close G-17#6
AdeGneus merged 1 commit into
mainfrom
specs/gateway-config-v1

Conversation

@AdeGneus

@AdeGneus AdeGneus commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Creates gateway-config/v1.md — the missing spec for the gateway's gateway.yaml configuration surface. Closes gap G-17.

What's covered

Five top-level sections derived directly from internal/config/config.go:

Section Keys
gateway broker_url (required), heartbeat_interval_s (default 30)
provider name, timeout_ms; llama_cpp.*; cloud_llm.* with all vendor constraints
reporting provider, gemini.*, weekly_report.* (day/time/timezone validation), tier_c_enrichment.enabled
sim enabled, modem_path
fleet enabled, cloud_url — marked stub/deferred

Key design decisions made explicit in the spec:

  • provider (Tier 3 reasoning) and reporting.provider (advisory/product) are separate sections with separate credentials — failures in one must not affect the other
  • API keys are env var names, never values — documented and enforced
  • fleet section is an inert stub, clearly noted
  • Cross-reference to gateway-api/v1.md for the MQTT contract

Other changes

  • gaps/open.md: G-17 removed (resolved); G-15/G-16 tracking issue links added
  • gaps/resolved.md: G-17 resolution entry added
  • README.md: gateway-config/v1.md added to contracts table

Related

  • Closes ori-platform/ori-specs#5
  • G-15 still open: ori-platform/ori-gateway#41 (Tier C enrichment wiring)
  • G-16 still open: ori-platform/ori-gateway#42 (reasoning_log runtimeclient)

- Create gateway-config/v1.md documenting all gateway.yaml config keys,
  types, defaults, and validation rules across all five top-level sections:
  gateway, provider, reporting, sim, fleet.
- Explicit separation between provider (Tier 3 reasoning) and
  reporting.provider (advisory/product) with key invariants documented.
- fleet section noted as stub/deferred.
- Add gateway-config/v1.md to README contracts table.
- Move G-17 from open.md to resolved.md.
- Add issue links to G-15 (ori-gateway#41) and G-16 (ori-gateway#42).

Closes #5
@AdeGneus AdeGneus merged commit 5abb9e7 into main Jun 9, 2026
1 check passed
@AdeGneus AdeGneus deleted the specs/gateway-config-v1 branch June 9, 2026 22:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant