Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
@aiparlance/openapi — role contract, score 28/33, pass/partial/fail objectives
| Package | @aiparlance/openapi |
| CLI | aip emit openapi |
| Role | contract |
| Score | 28/33 (85%) |
| Band | Happy-path ready |
| Scorecard | transpilers/openapi/EMITTER_OBJECTIVES.md |
| ✅ Pass | ⚠️ Partial | ❌ Fail | ➖ N/A |
|---|---|---|---|
| 28 | 0 | 5 | 22 |
api.prefix, auth schemes, per-operation security from policy, x-aip-cors / x-aip-rate-limit, soft-delete notes, pagination query params, shared Error schema, 409/429.
| ID | Objective |
|---|---|
A1–A9 | Entity schemas + soft-delete read semantics in the contract |
B1, B2, B4 | required/optional, unique→409, format: email |
D1–D7 | CRUD, prefix, cors, rate_limit, pagination, typed errors, JSON |
E1–E6 | Auth schemes, policy security, owner_or_manager scopes, 401/403 |
H3–H5 | Goldens / CI / naming |
| ID | Objective |
|---|---|
B3 | Richer validation { } constraints in schema |
H1, H2 | Human docs / fixtures (prefer docs / tests emitters) |
I1, I2 | Client SDK emit / full contract↔runtime CI matrix |
npm test
node packages/cli/dist/cli.js emit openapi examples/blog-crud.aip