Skip to main content
← Back to list
01Issue
FeatureOpenSwamp CLI
AssigneesNone

Relationships

#1422 Docs: document workflow-scope ReportContext fields in extension report reference

Opened by stack72 · 7/26/2026

Problem

The extension report reference (content/manual/reference/extensions/report.md) documents ReportContext fields but only covers the method-scope fields (modelType, modelId, methodName, dataHandles, dataRepository). The workflow-scope context has additional fields that are undocumented:

  • workflowId — the workflow definition ID
  • workflowRunId — the run ID
  • workflowName — the workflow name
  • workflowStatus"succeeded" | "failed"
  • inputs — the workflow invocation inputs (added in swamp-club#1400 / PR #1981)
  • stepExecutions — array of per-step execution details

Proposed Fix

Add a "Workflow-scope context" subsection to the ReportContext section documenting the additional fields available when scope: "workflow". Consider also adding a workflow-scope report example alongside the existing method-scope example.

Context

PR #1981 added inputs to WorkflowReportContext so workflow-scope reports can access invocation inputs directly. This makes the documentation gap more impactful since extension authors now have a new useful field they won't discover from the docs.

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED

Open

7/26/2026, 11:57:58 PM

No activity in this phase yet.

03Sludge Pulse

Sign in to post a ripple.