Eve library

ISIS Client-to-API Route Inventory

Guide

Revision 1

On this page

Generated: 2026-02-22

Scope#

  • Ticket: ISIS-0148 / F15-001.
  • Goal: inventory every public async method in @isis/client resource classes and map each to currently implemented live API routes.
  • Basis of truth for live routes: route declarations in generation API, workflow registry, and output registry route files.

Source Files#

  • Client: libs/isis/client/src/resources/generation.ts
  • Client: libs/isis/client/src/resources/workflows.ts
  • Client: libs/isis/client/src/resources/outputs.ts
  • Client: libs/isis/client/src/resources/models.ts
  • API routes: apps/isis/generation-api/src/routes/jobs.ts
  • API routes: apps/isis/generation-api/src/routes/models.ts
  • API routes: apps/isis/workflow-registry/src/routes/workflows.ts
  • API routes: apps/isis/workflow-registry/src/routes/templates.ts
  • API routes: apps/isis/output-registry/src/routes/outputs.ts
  • API routes: apps/isis/output-registry/src/routes/provenance.ts
  • API routes: apps/isis/output-registry/src/routes/policies.ts

Summary#

  • Backend routes inventoried: 63
  • Client methods inventoried: 111
  • Methods mapped to implemented routes: 102
  • Methods mapped to missing routes: 9
Resource Methods Matched (direct) Matched (delegated) Missing route Internal-only
GenerationResource 30 16 14 0 0
WorkflowsResource 37 22 6 9 0
OutputsResource 33 25 8 0 0
ModelsResource 11 11 0 0 0

Missing Endpoint Signatures (Grouped)#

  • DELETE /api/v1/workflows/:param/star <- WorkflowsResource.unstar
  • GET /api/v1/templates/featured <- WorkflowsResource.getFeaturedTemplates
  • GET /api/v1/workflows/:param/executions <- WorkflowsResource.getExecutionHistory
  • GET /api/v1/workflows/:param/executions/:param <- WorkflowsResource.getExecution
  • GET /api/v1/workflows/:param/export <- WorkflowsResource.export
  • GET /api/v1/workflows/:param/stats <- WorkflowsResource.getStats
  • POST /api/v1/workflows/:param/run <- WorkflowsResource.run
  • POST /api/v1/workflows/:param/star <- WorkflowsResource.star
  • POST /api/v1/workflows/import <- WorkflowsResource.import

GenerationResource#

Client file: libs/isis/client/src/resources/generation.ts

Method Effective endpoint(s) Parity Notes
submitJob() POST /api/v1/jobs Matched (direct)
submitBatch() POST /api/v1/jobs/batch Matched (direct)
getJob() GET /api/v1/jobs/:param Matched (direct)
getJobStatus() GET /api/v1/jobs/:param/status Matched (direct)
listJobs() GET /api/v1/jobs Matched (direct)
cancelJob() POST /api/v1/jobs/:param/cancel Matched (direct)
deleteJob() DELETE /api/v1/jobs/:param Matched (direct)
getJobOutput() GET /api/v1/jobs/:param Matched (delegated) Delegates via getJob()
retryJob() POST /api/v1/jobs/:param/retry Matched (direct)
getQueueStats() GET /api/v1/jobs/stats Matched (direct)
getQueueHealth() GET /api/v1/jobs/admin/queue/health Matched (direct)
getProviderOperations() GET /api/v1/jobs/providers/operations Matched (direct)
getRunPodOperations() GET /api/v1/jobs/runpod/operations Matched (direct)
getFeatureFlags() GET /api/v1/jobs/feature-flags Matched (direct)
updateFeatureFlag() PATCH /api/v1/jobs/feature-flags/:param Matched (direct)
clearFeatureFlagOverride() PATCH /api/v1/jobs/feature-flags/:param Matched (direct)
getQueuePosition() GET /api/v1/jobs/:param/queue-position Matched (direct)
waitForJob() GET /api/v1/jobs/:param Matched (delegated) Delegates via getJob()
submitAndWait() POST /api/v1/jobs<br>GET /api/v1/jobs/:param Matched (delegated) Delegates via submitJob(), waitForJob()
textToImage() POST /api/v1/jobs Matched (delegated) Delegates via submitJob()
imageToImage() POST /api/v1/jobs Matched (delegated) Delegates via submitJob()
textToVideo() POST /api/v1/jobs Matched (delegated) Delegates via submitJob()
imageToVideo() POST /api/v1/jobs Matched (delegated) Delegates via submitJob()
textTo3D() POST /api/v1/jobs Matched (delegated) Delegates via submitJob()
imageTo3D() POST /api/v1/jobs Matched (delegated) Delegates via submitJob()
upscale() POST /api/v1/jobs Matched (delegated) Delegates via submitJob()
inpaint() POST /api/v1/jobs Matched (delegated) Delegates via submitJob()
textToAudio() POST /api/v1/jobs Matched (delegated) Delegates via submitJob()
voiceSynthesis() POST /api/v1/jobs Matched (delegated) Delegates via submitJob()
musicGeneration() POST /api/v1/jobs Matched (delegated) Delegates via submitJob()

WorkflowsResource#

Client file: libs/isis/client/src/resources/workflows.ts

Method Effective endpoint(s) Parity Notes
create() POST /api/v1/workflows Matched (direct)
get() GET /api/v1/workflows/:param Matched (direct)
getMetadata() GET /api/v1/workflows/:param/metadata Matched (direct)
list() GET /api/v1/workflows Matched (direct)
update() PATCH /api/v1/workflows/:param Matched (direct)
delete() DELETE /api/v1/workflows/:param Matched (direct)
restore() POST /api/v1/workflows/:param/restore Matched (direct)
clone() POST /api/v1/workflows/:param/clone Matched (direct)
listVersions() GET /api/v1/workflows/:param/versions Matched (direct)
getVersion() GET /api/v1/workflows/:param/versions/:param Matched (direct)
getVersionByTag() GET /api/v1/workflows/:param/versions/tag/:param Matched (direct)
createVersion() POST /api/v1/workflows/:param/versions Matched (direct)
deprecateVersion() POST /api/v1/workflows/:param/versions/:param/deprecate Matched (direct)
deleteVersion() DELETE /api/v1/workflows/:param/versions/:param Matched (direct)
restoreVersion() POST /api/v1/workflows/:param/versions/:param/restore Matched (direct)
setCurrentVersion() POST /api/v1/workflows/:param/versions/:param/activate Matched (direct)
validate() POST /api/v1/workflows/validate Matched (direct)
validateById() POST /api/v1/workflows/:param/validate Matched (direct)
import() POST /api/v1/workflows/import Missing route Missing: POST /api/v1/workflows/import
export() GET /api/v1/workflows/:param/export Missing route Missing: GET /api/v1/workflows/:param/export
listTemplates() GET /api/v1/templates Matched (direct)
getTemplate() GET /api/v1/templates/:param Matched (direct)
createFromTemplate() POST /api/v1/templates/:param/create Matched (direct)
getFeaturedTemplates() GET /api/v1/templates/featured Missing route Missing: GET /api/v1/templates/featured
getStats() GET /api/v1/workflows/:param/stats Missing route Missing: GET /api/v1/workflows/:param/stats
star() POST /api/v1/workflows/:param/star Missing route Missing: POST /api/v1/workflows/:param/star
unstar() DELETE /api/v1/workflows/:param/star Missing route Missing: DELETE /api/v1/workflows/:param/star
search() GET /api/v1/workflows Matched (delegated) Delegates via list()
getByEngine() GET /api/v1/workflows Matched (delegated) Delegates via list()
getByCategory() GET /api/v1/workflows Matched (delegated) Delegates via list()
getByTags() GET /api/v1/workflows Matched (delegated) Delegates via list()
publish() GET /api/v1/workflows/:param<br>PATCH /api/v1/workflows/:param Matched (delegated) Delegates via get(), update()
archive() GET /api/v1/workflows/:param<br>PATCH /api/v1/workflows/:param Matched (delegated) Delegates via get(), update()
getAuditLogs() GET /api/v1/workflows/audit-logs Matched (direct)
run() POST /api/v1/workflows/:param/run Missing route Missing: POST /api/v1/workflows/:param/run
getExecutionHistory() GET /api/v1/workflows/:param/executions Missing route Missing: GET /api/v1/workflows/:param/executions
getExecution() GET /api/v1/workflows/:param/executions/:param Missing route Missing: GET /api/v1/workflows/:param/executions/:param

OutputsResource#

Client file: libs/isis/client/src/resources/outputs.ts

Method Effective endpoint(s) Parity Notes
create() POST /api/v1/outputs Matched (direct)
get() GET /api/v1/outputs/:param Matched (direct)
list() GET /api/v1/outputs Matched (direct)
update() PATCH /api/v1/outputs/:param Matched (direct)
delete() DELETE /api/v1/outputs/:param Matched (direct)
deleteBatch() POST /api/v1/outputs/batch-delete Matched (direct)
getStats() GET /api/v1/outputs/stats Matched (direct)
getDownloadUrl() GET /api/v1/outputs/:param/download Matched (direct)
getUploadUrl() POST /api/v1/outputs/upload-url Matched (direct)
moveTier() POST /api/v1/outputs/:param/move-tier Matched (direct)
restore() POST /api/v1/outputs/:param/restore Matched (direct)
getProvenance() GET /api/v1/outputs/:param/provenance Matched (direct)
createProvenance() POST /api/v1/outputs/:param/provenance Matched (direct)
updateProvenance() PATCH /api/v1/provenance/:param Matched (direct)
getLineage() GET /api/v1/outputs/:param/lineage Matched (direct)
addLineageEdge() POST /api/v1/outputs/lineage Matched (direct)
removeLineageEdge() DELETE /api/v1/outputs/lineage/:param/:param Matched (direct)
getAncestors() GET /api/v1/outputs/:param/ancestors Matched (direct)
getDescendants() GET /api/v1/outputs/:param/descendants Matched (direct)
listPolicies() GET /api/v1/policies Matched (direct)
getPolicy() GET /api/v1/policies/:param Matched (direct)
createPolicy() POST /api/v1/policies Matched (direct)
updatePolicy() PATCH /api/v1/policies/:param Matched (direct)
deletePolicy() DELETE /api/v1/policies/:param Matched (direct)
applyPolicy() POST /api/v1/policies/apply Matched (direct)
search() GET /api/v1/outputs Matched (delegated) Delegates via list()
getByType() GET /api/v1/outputs Matched (delegated) Delegates via list()
getByJobId() GET /api/v1/outputs Matched (delegated) Delegates via list()
getByWorkflowId() GET /api/v1/outputs Matched (delegated) Delegates via list()
getByTags() GET /api/v1/outputs Matched (delegated) Delegates via list()
archive() PATCH /api/v1/outputs/:param Matched (delegated) Delegates via update()
addTags() GET /api/v1/outputs/:param<br>PATCH /api/v1/outputs/:param Matched (delegated) Delegates via get(), update()
removeTags() GET /api/v1/outputs/:param<br>PATCH /api/v1/outputs/:param Matched (delegated) Delegates via get(), update()

ModelsResource#

Client file: libs/isis/client/src/resources/models.ts

Method Effective endpoint(s) Parity Notes
register() POST /api/v1/models Matched (direct)
list() GET /api/v1/models Matched (direct)
get() GET /api/v1/models/:param Matched (direct)
update() PUT /api/v1/models/:param Matched (direct)
delete() DELETE /api/v1/models/:param Matched (direct)
getVersions() GET /api/v1/models/:param/versions Matched (direct)
getUploadUrl() POST /api/v1/models/:param/upload-url Matched (direct)
completeUpload() POST /api/v1/models/:param/upload-complete Matched (direct)
getDownloadUrl() GET /api/v1/models/:param/download-url Matched (direct)
getByName() GET /api/v1/models/by-name/:param/:param Matched (direct)
getAuditLogs() GET /api/v1/models/audit-logs Matched (direct)

Key Findings for Follow-on Tickets#

  • F15-003 (workflows): route parity fixed for metadata, clone, activate, tag lookup, and validateById; remaining workflow gaps are import/export, featured templates, stats, star/unstar, run, and executions.
  • F15-004 (outputs): route parity fixed for batch delete, storage URL/tier/restore operations, provenance update, lineage edge delete, ancestors/descendants, and policy patch endpoint.
  • F15-005 decision is accepted via docs/domains/isis/adr/ADR-0005-api-contract-parity-and-sdk-deprecation-policy.md: implement all remaining missing workflow signatures; no SDK removals in the current parity cycle.

Notes#

  • GenerationResource.getQueueStats() currently targets GET /api/v1/jobs/stats; generation API now also exposes GET /api/v1/queue/stats compatibility alias.
  • GenerationResource.getJobOutput() delegates to getJob() (reads job.output) and does not call existing GET /api/v1/jobs/:id/output; this is functional but not optimized for lightweight output-only fetch.
  • OpenAPI-to-route drift is now contract-tested via: apps/isis/generation-api/src/openapi.contract.spec.ts, apps/isis/workflow-registry/src/openapi.contract.spec.ts, and apps/isis/output-registry/src/openapi.contract.spec.ts.
  • CI now enforces a dedicated breaking-change gate for these tests through the isis-api-route-contracts job in .github/workflows/ci.yml; build and final ci-success are blocked on this gate.