Skip to content
Rymflux Documentation
Esc
navigateopen⌘Jpreview
On this page

OpenAPI specifications (source of truth)

OpenAPI specifications (source of truth)

Purpose Canonical API contracts. User API reference is derived from these.
Audience Developers, API consumers (via derived docs)
Typical owner API owners
Phase 3
Stream Internal

What belongs here

Canonical API contracts. User API reference is derived from these.

Do not put here

Only documenting happy paths; drifting from implementation.

Next

  • In-repo stub policy: ../../../GOVERNANCE.md
  • Upstream chapters / templates / examples: ../../../KIT.md (does not break after copy)
  • This folder → upstream chapter: primer/07-phase-3-detailed-design.md
  • Upstream template(s): (OpenAPI YAML)
  • Note: Upstream recipe: recipes/openapi-to-user-api-ref.md

Was this page helpful?