You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f0f101e
Browse filesBrowse the repository at this point in the historyBrowse files
docs: retire the workflow slot from four more hand-written pages (#4451)
The docs-drift check on PR #4473 earned its keep: my symbol-shaped grep
(`IWorkflowService`, `WorkflowProtocol`, `api/v1/workflow`) found three pages
and missed four PROSE mentions that describe the same retired slot in words.
- `api/plugin-endpoints.mdx` documented three `/workflow/*` routes under a
"not yet mounted … return 404 today" caveat. The caveat was already the
tell: routes that 404 for the whole life of the declaration are not "not
yet", and the slot behind them is gone now. The section becomes a redirect
naming the three live mechanisms.
- `kernel/services-checklist.mdx` carried it in three more places — the
legend's 36-method count (now 33), the `null`-provider explanation, and a
full "6. workflow Service" section still describing the three methods as
pending rather than removed.
The remaining `workflow` hits in `content/docs` are the ordinary English word
(approval workflow, build workflow, GitHub Actions workflows) and stay.
Copy file name to clipboardExpand all lines: content/docs/api/plugin-endpoints.mdx
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,19 +26,21 @@ Authenticate with email and password (better-auth's email sign-in route, mounted
26
26
27
27
The following endpoints become available when the corresponding plugin is installed and registered with the kernel. Use the discovery `services` map to check availability.
28
28
29
-
### Workflow (`/workflow`) — Plugin Required
29
+
### Workflow (`/workflow`) — removed in v17
30
30
31
31
<Callouttype="warn">
32
-
Not yet mounted. These routes are declared in the API protocol but the core dispatcher registers no `/workflow` handler and no bundled plugin provides a `workflow` service (only an in-memory dev stub), so they return **404** today. `discovery.services.workflow` reports `unavailable` in a standard install.
32
+
There is no workflow endpoint, and there is no `workflow` service slot. The
33
+
three routes documented here were declared in the API protocol and served by
34
+
nothing — no dispatcher handler, no plugin — so they 404'd for the whole life
35
+
of the declaration. The slot, the `WorkflowProtocol` methods behind it and the
36
+
discovery fields that reported it were all retired in v17 ([#4451](https://github.com/objectstack-ai/objectstack/issues/4451)).
37
+
Use the live mechanisms instead: an object validation rule of type
38
+
`state_machine` for lifecycle transitions, an `approval` flow node for human
39
+
approval pauses (ADR-0019), and lifecycle hooks / `record_change` flows for
40
+
record-triggered automation.
33
41
</Callout>
34
42
35
-
| Method | Endpoint | Description |
36
-
|:-------|:---------|:------------|
37
-
| GET |`/workflow/:object/config`| Get workflow configuration |
38
-
| GET |`/workflow/:object/:recordId/state`| Get record's workflow state |
39
-
| POST |`/workflow/:object/:recordId/transition`| Execute state transition |
40
-
41
-
Approve/reject are **not** workflow routes (ADR-0019): approval is a flow node, and decisions are recorded on the approvals runtime via `POST /approvals/requests/:id/approve` and `POST /approvals/requests/:id/reject`.
43
+
Approve/reject were never workflow routes (ADR-0019): approval is a flow node, and decisions are recorded on the approvals runtime via `POST /approvals/requests/:id/approve` and `POST /approvals/requests/:id/reject`.
0 commit comments