# Admin API documentation — retired

The per-endpoint markdown reference that previously lived under this directory has been replaced by an OpenAPI 3.1 specification. The OpenAPI source is the new authoritative reference for the **273 admin-api endpoints** across `apps/admin_api`.

## Where to read the docs now

- **Interactive reference (recommended):** <http://localhost:8000/scalar/admin.html> — run `yarn docs:serve` from the repo root, then open this URL in a browser. The sidebar has every endpoint grouped by tag (Accounts, Moderation, Channels, Media, RDC, Topics, Fabricator Orders / Scans / Jobs, Inventory, Shipping, DHL, OAuth, Knowledge Base, Workers, CNC, Fusion, Pose, Health).
- **Landing page:** <http://localhost:8000/scalar/> — the four other Bigscreen APIs (auth, public, cloud admin, cloud public) are also there.
- **Spec source:**
    - Root: [`docs/openapi/admin-api.yaml`](../../openapi/admin-api.yaml)
    - Per-module: [`docs/openapi/modules/*.yaml`](../../openapi/modules/)
    - Shared schemas: [`docs/openapi/components/schemas/*.yaml`](../../openapi/components/schemas/)
    - Generated bundle: [`docs/openapi/admin-api.bundled.yaml`](../../openapi/admin-api.bundled.yaml) (regenerated by `yarn docs:bundle`)
- **Auth posture:** in the root spec's `description` + `components.securitySchemes` blocks. The four auth domains (`/admin/*`, `/fusion/*`, `/cnc/*`, `/pose/*`) and `/health` each have a dedicated security scheme.

## What happened to the markdown files

The per-module `.md` files in this directory are now thin redirect stubs that point at the equivalent spec location. The previously generated artifacts (`_endpoints.md`, `_test-coverage.md`, `_drift.md`) and their backing scripts (`docs/scripts/check_admin_api_drift.ts`, `build_endpoint_index.ts`, `build_test_coverage_index.ts`) have been removed — the bundled spec is the single source of truth now.

For broader context on the OpenAPI rollout — including the other four specs — see [`docs/openapi/README.md`](../../openapi/README.md).