API reference
The Provider Data API r2 is described using the OpenAPI 3.0 specification.
The specification source is authored as split files under
provider-data-api/openapi/
and bundled into
provider-data-api/bundled-openapi-spec.yaml.
Renderings
The same specification is available rendered in several formats:
| Renderer | Style | Notes |
|---|---|---|
| Redoc | Three-panel reference | Collapsible schemas, no “try it out” |
| Swagger UI | Interactive | Includes “try it out” mode |
| Scalar | Modern reference | Clean layout, code samples |
| Stoplight Elements | Sidebar reference | Component-based, sidebar navigation |
| Widdershins | Prose (this site’s theme) | Rendered within MoJ tech-docs chrome |