Skip to content

Commit 14e656a

Browse files
author
Lorna-Kelly
committed
Add Copilot suggestions
1 parent 4d8b5bb commit 14e656a

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

adr/v1.0-adr-shared-workflow-editor.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Proposed
99
There is a need for a shared editor for the CNCF Workflow Specification that
1010
can be used consistently by multiple implementations (e.g. Quarkus Flow,
1111
SonataFlow, ZigFlow, Synapse, Lemline), as different tools provide inconsistent
12-
authoring and visualisation experiences, leading to duplicated effort and fragmented tooling.
12+
authoring and visualization experiences, leading to duplicated effort and fragmented tooling.
1313

1414
Today we have:
1515

@@ -58,7 +58,7 @@ vendor.
5858
- Initial maintainers: representatives from at least:
5959
- CNCF Workflow Spec maintainers
6060
- Quarkus Flow / SonataFlow
61-
- Other interested engine maintainers (e.g. Zigflow / Synapse / Lemline etc.).
61+
- Other interested engine maintainers (e.g. ZigFlow / Synapse / Lemline etc.).
6262

6363
- Decision process
6464

@@ -90,8 +90,8 @@ vendor.
9090
### 1. In Scope
9191

9292
- Read-only visual representation of YAML / JSON workflow definitions
93-
- Visualise all task types and transitions
94-
- Fully expanded nested task visualisation
93+
- Visualize all task types and transitions
94+
- Fully expanded nested task visualization
9595
- Indication of basic validation issues
9696
- Editor available via NPM package
9797
- A simple demo app showing how to embed the editor as a component
@@ -113,10 +113,11 @@ vendor.
113113

114114
### 4. Validation
115115

116-
- The editor assumes workflows provided by the backend are valid.
117-
- Edge cases to handle: validation discrepancies between the TypeScript SDK and the backend (runtime implementation).
118-
- If rendering is possible, display warnings as needed.
119-
- If rendering is not possible, provide clear error feedback to user.
116+
- The editor performs lightweight client-side schema/structural validation to determine whether the workflow can be rendered.
117+
- The backend (runtime implementation) remains the source of truth for full specification conformance and advanced validation rules.
118+
- Edge cases to handle: validation discrepancies between the TypeScript SDK and the backend (runtime implementation).
119+
- If structural validation passes and rendering is possible, render the workflow.
120+
- If structural validation fails and rendering is not possible, do not attempt to render a partial/invalid diagram; provide clear, actionable error feedback to the user instead.
120121

121122
### 5. Nested Tasks & Layout Strategy
122123

0 commit comments

Comments
 (0)