26c0f59a79
Co-authored-by: blackboxprogramming <118287761+blackboxprogramming@users.noreply.github.com>
14 lines
448 B
Plaintext
14 lines
448 B
Plaintext
---
|
|
id: openapi-reference
|
|
title: OpenAPI Reference
|
|
sidebar_position: 2
|
|
slug: /reference/openapi-intro
|
|
---
|
|
|
|
The HTTP surface area for BlackRoad OS is defined in `blackroad-os-api`. The spec is pulled at build time and rendered with Redoc.
|
|
|
|
- Rendered spec is available at `/reference/openapi` in the navigation
|
|
- Source file: `static/api/openapi.yaml` (populated via `npm run fetch:openapi`)
|
|
|
|
Use the Reference navigation to open the rendered spec.
|