Skip to main content

​
Welcome

The VTurb General API is the public REST surface for VTurb. It is dev-first and agents-first: the OpenAPI contract in API Reference is generated from the API’s own request specs, so it always reflects real behavior (ADR-0015).

​
How the docs are built

  • Contract — openapi.yaml here is the public spec (docs/openapi/public/openapi.yaml) with the editorial OpenAPI Overlay applied. Rebuild with bin/rails openapi:build.
  • Governance — CI runs oasdiff against the base branch and fails on any breaking change; additive changes pass.
  • Platform fields — dashboard-only fields are served on the same routes via the VTurb-Surface: platform header and are deliberately out of this public contract (ADR-0023). They are not documented here.