@shipeasy/openapi
Advanced tools
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.
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.
spec/ — the hand-authored spec, split across paths/ and
components/schemas/. Edit here.openapi.yaml — the bundled single-file spec (pnpm bundle, Redocly).src/generated/ — the client / Zod / types emitted by pnpm gen:sdk
(@hey-api/openapi-ts).| 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.) |
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/).
FAQs
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.
The npm package @shipeasy/openapi receives a total of 175 weekly downloads. As such, @shipeasy/openapi popularity was classified as not popular.
We found that @shipeasy/openapi demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST disclosed an unreleased AI tool called V-etalon and opened a broad inquiry into NVD modernization after years of automation plans produced no public enrichment system.
Security News
In his AI Council 2026 talk, Feross Aboukhadijeh covers recent package compromises, vulnerability discovery, and a more automated security model.
Security News
A new federal program will let vetted U.S. cybersecurity firms help investigate and disrupt foreign cybercrime groups under government direction.