Liking cljdoc? Tell your friends :D

boundary.workflow.shell.http

HTTP API routes and admin web UI handlers for workflow management.

API Endpoints (canonical): GET /api/v1/workflow/instances/:id — current state + metadata GET /api/v1/workflow/instances/:id/audit — full audit log POST /api/v1/workflow/instances — start a new workflow instance POST /api/v1/workflow/instances/:id/transition — execute a transition

Compatibility: /api/workflow/* redirects to /api/v1/workflow/* via versioning middleware.

Admin Web UI (mounted under /web/admin): GET /workflows — list all workflow instances GET /workflows/:id — instance detail with state viz + audit trail

All routes require authentication (actor extracted from ring request). Caller is responsible for mounting under an authenticated router.

HTTP API routes and admin web UI handlers for workflow management.

API Endpoints (canonical):
  GET  /api/v1/workflow/instances/:id            — current state + metadata
  GET  /api/v1/workflow/instances/:id/audit      — full audit log
  POST /api/v1/workflow/instances                — start a new workflow instance
  POST /api/v1/workflow/instances/:id/transition — execute a transition

Compatibility:
  /api/workflow/* redirects to /api/v1/workflow/* via versioning middleware.

Admin Web UI (mounted under /web/admin):
  GET  /workflows        — list all workflow instances
  GET  /workflows/:id    — instance detail with state viz + audit trail

All routes require authentication (actor extracted from ring request).
Caller is responsible for mounting under an authenticated router.
raw docstring

handle-get-audit-logclj

(handle-get-audit-log engine request)

GET /api/v1/workflow/instances/:id/audit

GET /api/v1/workflow/instances/:id/audit
sourceraw docstring

handle-get-instanceclj

(handle-get-instance engine request)

GET /api/v1/workflow/instances/:id

GET /api/v1/workflow/instances/:id
sourceraw docstring

handle-get-instance-webclj

(handle-get-instance-web store registry request)

GET /workflows/:id — render the workflow instance detail page.

GET /workflows/:id — render the workflow instance detail page.
sourceraw docstring

handle-list-instances-webclj

(handle-list-instances-web store request)

GET /workflows — render the workflow instances list page.

GET /workflows — render the workflow instances list page.
sourceraw docstring

handle-start-workflowclj

(handle-start-workflow engine request)

POST /api/v1/workflow/instances

POST /api/v1/workflow/instances
sourceraw docstring

handle-transitionclj

(handle-transition engine request)

POST /api/v1/workflow/instances/:id/transition

POST /api/v1/workflow/instances/:id/transition
sourceraw docstring

workflow-routesclj

(workflow-routes engine)

Return normalized route definitions for the workflow API.

Args: engine - WorkflowService (IWorkflowEngine)

Returns: Vector of normalized route maps (will be mounted under /api/v1 by versioning middleware)

Return normalized route definitions for the workflow API.

Args:
  engine - WorkflowService (IWorkflowEngine)

Returns:
  Vector of normalized route maps (will be mounted under /api/v1 by versioning middleware)
sourceraw docstring

workflow-web-routesclj

(workflow-web-routes store registry user-service)

Return normalized web route definitions for the workflow admin UI.

Routes are mounted under /web/admin by the HTTP handler: GET /web/admin/workflows — list all workflow instances GET /web/admin/workflows/:id — instance detail + audit trail

Args: store - IWorkflowStore registry - IWorkflowRegistry user-service - IUserService (for authentication middleware)

Returns: Vector of normalized route maps

Return normalized web route definitions for the workflow admin UI.

Routes are mounted under /web/admin by the HTTP handler:
  GET /web/admin/workflows        — list all workflow instances
  GET /web/admin/workflows/:id    — instance detail + audit trail

Args:
  store        - IWorkflowStore
  registry     - IWorkflowRegistry
  user-service - IUserService (for authentication middleware)

Returns:
  Vector of normalized route maps
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close