@shipeasy/openapi
v3.2.0
Published
Shipeasy admin OpenAPI 3.2 spec (hand-authored, single source of truth) + the generated TypeScript client, Zod schemas, and types. Consumed by @shipeasy/cli and @shipeasy/mcp.
Readme
@shipeasy/openapi
The Shipeasy admin OpenAPI 3.2 spec (hand-authored, single source of truth)
plus the generated TypeScript client, Zod schemas, and types. Consumed by
@shipeasy/cli and @shipeasy/mcp.
Layout
spec/— the hand-authored spec, split acrosspaths/andcomponents/schemas/. Edit here.openapi.yaml— the bundled single-file spec (pnpm bundle, Redocly).src/generated/— the client / Zod / types emitted bypnpm gen:sdk(@hey-api/openapi-ts).
Scripts
| Script | What it does |
| --- | --- |
| pnpm lint:spec | Redocly lint of spec/openapi.yaml |
| pnpm bundle | bundle spec/ → openapi.yaml |
| pnpm gen | bundle + regenerate src/generated/* |
| pnpm test | spec guard tests (every op declares x-error-codes, etc.) |
Contract testing
The Contract Tests badge above tracks the
contract-tests
workflow: on every change to openapi/** it boots the real admin API server and
fuzzes this spec against it with Schemathesis —
property-based generation of valid and malformed requests for every operation,
asserting no 5xx and full status/schema conformance (the bearerSdkKey auth the
spec declares is exercised end-to-end). Run it locally with
pnpm --filter @shipeasy/ui test:contract (see apps/ui/contract-tests/).
