Eve library

ISIS v2 WS10-003: SDK Route Parity Alignment

Guide

Revision 1

On this page

Scope#

Closed SDK/backend route parity gaps by ensuring @isis/client WorkflowsResource API operations map to deployed backend routes.

Implemented Artifacts#

  • Workflow-registry routes and schemas now expose previously missing SDK-backed endpoints:
    • apps/isis/workflow-registry/src/routes/workflows.ts
    • apps/isis/workflow-registry/src/routes/templates.ts
    • apps/isis/workflow-registry/src/schemas/workflow.schema.ts
    • apps/isis/workflow-registry/src/services/workflow.service.ts
    • apps/isis/workflow-registry/src/index.ts
    • apps/isis/workflow-registry/openapi.yaml
  • Route coverage and contract tests:
    • apps/isis/workflow-registry/src/routes/workflows.auth.spec.ts
    • apps/isis/workflow-registry/src/openapi.contract.spec.ts
  • SDK parity gate:
    • libs/isis/client/src/resources/workflows.route-parity.spec.ts

Delivered Route Coverage#

  • Added workflow import/export endpoints:
    • POST /api/v1/workflows/import
    • GET /api/v1/workflows/{id}/export
  • Added workflow stats + star endpoints:
    • GET /api/v1/workflows/{id}/stats
    • POST /api/v1/workflows/{id}/star
    • DELETE /api/v1/workflows/{id}/star
  • Added featured template endpoint:
    • GET /api/v1/templates/featured

Verification#

bash
pnpm --filter @isis/workflow-registry exec vitest run src/routes/workflows.auth.spec.ts src/openapi.contract.spec.ts --reporter=dot
pnpm --filter @isis/client exec vitest run src/resources/workflows.route-parity.spec.ts --reporter=dot

Outcome#

WS10-003 is now closed with explicit deployed routes for all WorkflowsResource HTTP operations and a client-side parity test that fails if SDK routes drift from backend OpenAPI contracts.