Eve library

DOD-003 Certification: API/SDK/Worker/Web Contracts Aligned and Versioned

Guide

Revision 1

On this page

Date: 2026-02-22
Checklist Item: DOD-003
Ticket: ISIS-0003

Scope#

Certify that Isis service API contracts, SDK surface, worker envelope contracts, and web app integration contracts are aligned and versioned with CI enforcement.

Evidence Matrix#

Requirement Evidence Status
API-to-SDK route parity is explicitly documented and remediated docs/domains/isis/remediation/ISIS_CLIENT_ROUTE_INVENTORY.md captures F15-001 through F15-005 route parity decisions and resolved endpoint mismatches for generation, workflows, and outputs. Pass
OpenAPI contracts are versioned and tested across core services apps/isis/generation-api/openapi.yaml, apps/isis/workflow-registry/openapi.yaml, and apps/isis/output-registry/openapi.yaml exist and their contract tests passed via src/openapi.contract.spec.ts in each service. Pass
CI blocks contract drift via dedicated route-contract gate .github/workflows/ci.yml defines isis-api-route-contracts and executes service-level OpenAPI contract tests (lines 243, 269, 272, 275). Pass
Worker/API envelope contract is versioned and validated Shared package libs/isis/job-envelope provides canonical IsisJobEnvelopeSchema; pnpm --filter @isis/job-envelope exec vitest run passed (4 tests). Pass
Web app contract alignment is continuously regression tested GATE-008 regression matrix (certified in docs/domains/isis/remediation/operations-certification/GATE-008-regression-suite-ci-green.md) includes @isis/web and backend services in one CI-equivalent pass. Pass

Reproduction Commands#

bash
pnpm --filter @isis/generation-api exec vitest run src/openapi.contract.spec.ts
pnpm --filter @isis/workflow-registry exec vitest run src/openapi.contract.spec.ts
pnpm --filter @isis/output-registry exec vitest run src/openapi.contract.spec.ts
pnpm --filter @isis/job-envelope exec vitest run