Generated reference · API

Isis Workflow Registry API

OpenAPI contract for `@isis/workflow-registry`.

42endpoints2schemas0.1.0version
Source
On this page

Health (2)#

GET/healthLiveness probe
GET/readyReadiness probe

Staging Recipes (7)#

GET/api/v1/staging-recipesList workflow staging recipes
POST/api/v1/staging-recipesCreate workflow staging recipe and initialize promotion state
GET/api/v1/staging-recipes/{id}Get workflow staging recipe
PATCH/api/v1/staging-recipes/{id}Update workflow staging recipe
DELETE/api/v1/staging-recipes/{id}Delete workflow staging recipe
GET/api/v1/staging-recipes/{id}/promotionGet promotion state for a staging recipe
POST/api/v1/staging-recipes/{id}/promotion/eventsApply promotion event to a staging recipe

Templates (4)#

GET/api/v1/templatesList workflow templates
GET/api/v1/templates/featuredList featured workflow templates
GET/api/v1/templates/{id}Get workflow template
POST/api/v1/templates/{id}/createCreate workflow from template

Workflow Versions (8)#

GET/api/v1/workflows/{id}/versionsList workflow versions
POST/api/v1/workflows/{id}/versionsCreate workflow version
GET/api/v1/workflows/{id}/versions/tag/{versionTag}Get workflow version by semantic tag
GET/api/v1/workflows/{id}/versions/{version}Get workflow version
DELETE/api/v1/workflows/{id}/versions/{version}Soft delete workflow version
POST/api/v1/workflows/{id}/versions/{version}/activateActivate workflow version
POST/api/v1/workflows/{id}/versions/{version}/deprecateDeprecate workflow version
POST/api/v1/workflows/{id}/versions/{version}/restoreRestore soft-deleted workflow version

Workflows (21)#

GET/api/v1/workflowsList workflows
POST/api/v1/workflowsCreate workflow
POST/api/v1/workflows/admin/taxonomy/backfillBackfill workflow taxonomy fields and versioned provenance
GET/api/v1/workflows/audit-logsList workflow audit logs
POST/api/v1/workflows/importImport workflow from exported JSON or ComfyUI payload
POST/api/v1/workflows/packs/exportExport workflow pack payload
POST/api/v1/workflows/packs/importImport workflow pack payload
POST/api/v1/workflows/preset-bundles/exportExport preset bundle payload
POST/api/v1/workflows/preset-bundles/importImport preset bundle payload
POST/api/v1/workflows/validateValidate workflow definition payload
GET/api/v1/workflows/{id}Get workflow
PATCH/api/v1/workflows/{id}Update workflow
DELETE/api/v1/workflows/{id}Soft delete workflow
POST/api/v1/workflows/{id}/cloneClone workflow
GET/api/v1/workflows/{id}/exportExport workflow payload
GET/api/v1/workflows/{id}/metadataGet workflow metadata
POST/api/v1/workflows/{id}/restoreRestore soft-deleted workflow
POST/api/v1/workflows/{id}/starStar workflow
DELETE/api/v1/workflows/{id}/starUnstar workflow
GET/api/v1/workflows/{id}/statsGet workflow stats
POST/api/v1/workflows/{id}/validateValidate persisted workflow by id

Schemas (2)#

ErrorResponseobjectJsonObjectobject