opensource/sim
3
0
Fork 0
mirror of https://github.com/simstudioai/sim.git synced 2026-09-24 15:45:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(v2): close seven correctness and honesty gaps found sweeping the API (#6702)

Browse Source 
* fix(v2): close seven correctness and honesty gaps found sweeping the API

A ten-slice sweep of the live v2 surface turned up no regression from the
recent cancellation work, but did surface a set of pre-existing defects where
an endpoint either lost data, hid a failure, or reported something that was not
true. Each is fixed at the layer that owns the behavior.

Terminal execution logs. The two force-fail boundaries wrote `status: 'failed'`
without `ended_at` or `total_duration_ms`, so a force-failed run dropped out of
every duration-filtered log query — the same defect class already closed for
cancellation, still open on its sibling. The cancellation payload factory is
generalized to take the status; the cancellation call sites are untouched and
still emit a byte-identical row.

Custom tools. One malformed row failed the whole page, and because the list is
keyset-paginated that row made every page containing it permanently
unreachable. The projection now validates against the same contract schema the
route builder applies, repairing only what can be repaired without inventing
information — a stringified schema, and a missing `type` whose contract admits
exactly one value — and omitting with a warning what cannot. Both rows observed
in production are recovered rather than discarded.

Table filters. `eq`/`ne`/`in`/`nin` compiled a wrongly-typed operand into a
containment test that silently matched nothing, so a filter written against the
value the write path had stored returned an empty page instead of its rows. The
operand is now read through the same column-type registry the write used, and
rejected only where that registry refuses it. Range operators already behaved
this way; `null` and the cleared-cell sentinel still pass through untouched.

Error messages. A custom `error` on a string schema also replaced the wrong-type
wording, so supplying a number for a name reported that the name was missing.
Messages now distinguish an omitted field from a mistyped one, `topK` names its
own bounds, the knowledge search refine reports against a field rather than the
whole body, and a workspace id is bounded before it reaches a lookup.

Archived file metadata. A soft-deleted file was listed but unreadable, leaving
no way to check share state before restoring it. The read takes the same `scope`
selector the list already exposes; the default is unchanged, and the parameter
relaxes only the `deleted_at` predicate, never the authorization.

Cancellation reporting. Cancelling an already-terminal run reported a durable
write that never happened. The service now distinguishes the no-op and names the
state it observed, and both surfaces present one vocabulary instead of the
internal route deriving its own. No claim predicate or write changed.

Protocol. A 401 carries a challenge naming the header the API actually reads,
and a body that failed to parse is reported as an unsupported media type only
when the caller positively declared a non-JSON one — after the read has already
failed, so nothing that succeeds today can begin to fail.

* fix(v2): correct three regressions this branch introduced, and harden its tests

Adversarial review of the previous commit found that three of its "behavior
preserving" claims were wrong. Each is corrected here at the layer that owns it.

Table filters no longer coerce a `date` operand, and no longer throw. `date` is
the one column type whose registry `coerce` is not idempotent — it drops
sub-second precision — and the leaf that compiles a filter also builds the
unique-constraint and upsert-conflict probes, so re-reading an already-coerced
operand could stop it matching the row it was written from and admit a duplicate
inside the write transaction with no error. Throwing was the second mistake: the
v2 predicate grammar type-checks structure but not operand values, so a rejected
operand no longer failed at submission but inside the delete, update, dispatch
and cancel runners, where a filter that cannot compile means the cells it started
can no longer be cancelled. Coercion is now total — it rewrites what the registry
accepts and passes everything else through unchanged, exactly as before.

Reviving a force-failed run no longer inherits its terminal duration. Writing
`ended_at` and `total_duration_ms` on the force-fail boundary was correct in
isolation, but a partial resume flips that row back to `pending` and those
columns survived. The preserved value is meant to be the pause checkpoint — the
run's active time — and it had become wall clock measured at the failed resume,
which the checkpoint rule then faithfully carried into the next terminal write.
The revival clears them only for a row that was terminal, so an ordinary paused
row keeps the checkpoint it is supposed to keep.

Cancelling reports the terminal state it actually observed. Reclassification now
requires that nothing else went wrong, so a genuine paused-reconciliation failure
survives instead of being rewritten as an already-terminal no-op, and the claim's
own row count — not a snapshot read before it — decides whether this cancel
terminalized the run or lost a race to something else. The status the snapshot
needed rides along on the ownership query that already reads the row, rather than
the second read that query's own contract warns against.

A custom tool that cannot be projected now answers the same way everywhere: the
list omits it, and reading or patching it by id reports it as absent rather than
as a server fault. Analytics stops reporting a cancellation for a request that
cancelled nothing.

The tests around all of this were audited by mutating each fix and checking the
suite noticed. Where it did not, the assertion is stronger now: the absent
content-type branch is genuinely exercised rather than relying on a header the
client library supplies, the duration encoder is pinned to the column it must
measure from, execution ownership is pinned to both ids it must match, and the
archived-file concealment test proves it conceals the archived read specifically.
Two tests that asserted a paused branch they could not observe are gone; the
rendered-SQL test that can decide it already covers them.

* fix(execution): report a workflow-group cancellation as the write it performed

Cancelling a workflow-group run whose log had already been cancelled, but whose
cell sidecar still needed reconciliation, durably cancelled that sidecar and
then reported `already_cancelled` with `durablyRecorded: false` — because the
terminal-status shortcut answered from the entry snapshot alone and never asked
what this request had written. The analytics event, which now gates on that
field, stopped firing for a cancellation that really happened.

The outcome a cancel reports is the same question whichever path answers it, so
there is now one vocabulary for it rather than one the direct claim tracked and
one the group transition did not. Every group result maps to that outcome
through a total map, so a new group result cannot compile without deciding what
it wrote, and the reclassification leads with whether this request wrote at all.

A group transition that reports itself already cancelled is deliberately mapped
as unknown rather than as a no-op: it leaves the sidecar alone but still
terminalizes a log that was active, and the result does not say which happened.
That costs nothing today, because the only snapshot that would reclassify proves
the log was already terminal.

* fix(execution): have a workflow-group cancellation report the writes it made

Three review findings landed on the same reporting logic, each a different face
of one cause: the caller could not see what the group transaction had written, so
it inferred. It inferred from an entry snapshot, then from the returned kind, and
the remaining blind spot was the kind that covers two different transactions —
a repair that terminalizes an active log, and a genuine no-op — which left a
cancel that wrote nothing still claiming a durable write when it lost a race.

The transaction now reports both writes it can make, each read from that
statement's own returning row and recorded immediately before the throw that
already depended on it, so the report cannot drift from the write. The caller
derives its outcome from those rather than from the kind, and the kind is back to
naming the situation instead of standing in for the work.

The group path can now always answer whether it wrote. The only remaining
unknown is the direct claim when its update throws or is never attempted, which
genuinely has no row count to report.
This commit is contained in:
Waleed
2026-08-14 14:14:30 -07:00
committed by GitHub
parent 237f973a11
commit cf78946529
47 changed files with 2919 additions and 155 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/openapi-v2-billing.json
+4 -2
View File
@@ -47,7 +47,8 @@
"schema": {
"description": "Workspace whose payer should be resolved. Workspace API keys are pinned to their own workspace.",
"type": "string",
"minLength": 1
"minLength": 1,
"maxLength": 128
}
}
],
@@ -133,7 +134,8 @@
"schema": {
"description": "Restrict results to one workspace whose payer the caller can inspect.",
"type": "string",
"minLength": 1
"minLength": 1,
"maxLength": 128
}
},
{
apps/docs/openapi-v2-files-audit.json
+34 -1
View File
@@ -51,6 +51,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace whose files should be listed."
}
},
@@ -343,6 +344,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the upload session."
}
},
@@ -433,6 +435,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the upload session."
}
},
@@ -537,6 +540,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the upload session."
}
},
@@ -629,6 +633,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the file."
}
}
@@ -721,6 +726,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the file."
}
}
@@ -965,8 +971,21 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the file."
}
},
{
"name": "scope",
"in": "query",
"required": false,
"description": "Which lifecycle set to read from: `active` (default) resolves live files only and returns `404` for a file a `DELETE` soft-deleted; `archived` also resolves soft-deleted files, so metadata stays readable before `POST /files/{fileId}/restore`. Authorization is identical for both.",
"schema": {
"default": "active",
"description": "Which lifecycle set to read from: `active` (default) resolves live files only and returns `404` for a file a `DELETE` soft-deleted; `archived` also resolves soft-deleted files, so metadata stays readable before `POST /files/{fileId}/restore`. Authorization is identical for both.",
"type": "string",
"enum": ["active", "archived"]
}
}
],
"responses": {
@@ -1060,7 +1079,8 @@
"schema": {
"description": "Filter to actions in one workspace.",
"type": "string",
"minLength": 1
"minLength": 1,
"maxLength": 128
}
},
{
@@ -1361,6 +1381,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the file."
}
}
@@ -1655,6 +1676,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace whose folders should be listed."
}
},
@@ -1898,6 +1920,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace containing the folder."
}
},
@@ -2437,6 +2460,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace in which to create the file."
},
"name": {
@@ -2651,6 +2675,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace in which the file will be registered."
},
"name": {
@@ -2822,6 +2847,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the file."
},
"name": {
@@ -2877,6 +2903,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the archived file."
}
},
@@ -3352,6 +3379,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace containing the files."
},
"fileIds": {
@@ -3446,6 +3474,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the file."
},
"isActive": {
@@ -3496,6 +3525,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the file."
},
"content": {
@@ -3572,6 +3602,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace containing the files."
},
"fileIds": {
@@ -3683,6 +3714,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace in which to create the folder."
},
"path": {
@@ -3701,6 +3733,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace containing the folder."
},
"path": {
apps/docs/openapi-v2-knowledge.json
+15
View File
@@ -47,6 +47,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace whose knowledge bases should be listed."
}
},
@@ -885,6 +886,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the knowledge base."
}
}
@@ -1077,6 +1079,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the knowledge base."
}
},
@@ -1178,6 +1181,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the knowledge base."
}
},
@@ -1293,6 +1297,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the knowledge base."
}
},
@@ -1635,6 +1640,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace whose folders should be listed."
}
},
@@ -1881,6 +1887,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace containing the folder."
}
},
@@ -2469,6 +2476,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace in which to create the knowledge base."
},
"name": {
@@ -2509,6 +2517,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the knowledge base."
},
"name": {
@@ -2798,6 +2807,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the knowledge bases."
},
"knowledgeBaseIds": {
@@ -3116,6 +3126,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the knowledge base."
},
"operation": {
@@ -3467,6 +3478,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the knowledge base."
},
"name": {
@@ -3918,6 +3930,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the knowledge base."
},
"filename": {
@@ -4113,6 +4126,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace in which to create the folder."
},
"path": {
@@ -4131,6 +4145,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace containing the folder."
},
"path": {
apps/docs/openapi-v2-logs.json
+1
View File
@@ -47,6 +47,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace whose execution logs should be returned."
}
},
apps/docs/openapi-v2-resources.json
+23
View File
@@ -67,6 +67,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace to retrieve."
}
}
@@ -132,6 +133,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace to retrieve."
}
},
@@ -221,6 +223,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the MCP server."
}
},
@@ -424,6 +427,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the MCP server."
}
}
@@ -575,6 +579,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the MCP server."
}
}
@@ -651,6 +656,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the MCP server."
}
},
@@ -729,6 +735,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the skill."
}
},
@@ -932,6 +939,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the skill."
}
}
@@ -1086,6 +1094,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the skill."
}
}
@@ -1151,6 +1160,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the custom tool."
}
},
@@ -1354,6 +1364,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the custom tool."
}
}
@@ -1508,6 +1519,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the custom tool."
}
}
@@ -1573,6 +1585,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace whose credentials should be listed."
}
},
@@ -1720,6 +1733,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace whose secret metadata should be listed."
}
},
@@ -1969,6 +1983,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace the request is authorized against. A workspace secret is deleted from it; a personal secret is deleted for the caller in all of their workspaces."
}
},
@@ -2291,6 +2306,7 @@
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"name": {
@@ -2668,6 +2684,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace in which to register the server."
},
"name": {
@@ -2854,6 +2871,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the MCP server."
},
"name": {
@@ -3252,6 +3270,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace in which to create the skill."
},
"name": {
@@ -3345,6 +3364,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the skill."
},
"name": {
@@ -3618,6 +3638,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace in which to create the custom tool."
},
"title": {
@@ -3811,6 +3832,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the custom tool."
},
"title": {
@@ -4182,6 +4204,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace the request is authorized against. A workspace secret is written to it; a personal secret is written to the caller and is available in all of their workspaces."
},
"scope": {
apps/docs/openapi-v2-tables.json
+35
View File
@@ -47,6 +47,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace whose tables should be listed."
}
},
@@ -739,6 +740,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the table."
}
},
@@ -2648,6 +2650,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the transfer resource."
}
},
@@ -2733,6 +2736,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the transfer resource."
}
},
@@ -2823,6 +2827,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the transfer resource."
}
},
@@ -2927,6 +2932,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the transfer resource."
}
},
@@ -3102,6 +3108,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the transfer resource."
}
}
@@ -3176,6 +3183,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the transfer resource."
}
}
@@ -3255,6 +3263,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the transfer resource."
}
}
@@ -3402,6 +3411,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace whose folders should be listed."
}
},
@@ -3648,6 +3658,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace containing the folder."
}
},
@@ -4304,6 +4315,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"schema": {
@@ -4455,6 +4467,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"name": {
@@ -4588,6 +4601,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the table."
},
"column": {
@@ -4680,6 +4694,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace that owns the table."
},
"columnName": {
@@ -4768,6 +4783,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"columnName": {
@@ -4929,6 +4945,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"rows": {
@@ -4950,6 +4967,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"data": {
@@ -5161,6 +5179,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"filter": {
@@ -5232,6 +5251,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"filter": {
@@ -5284,6 +5304,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"data": {
@@ -5372,6 +5393,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"data": {
@@ -5432,6 +5454,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"predicate": {
@@ -5532,6 +5555,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"predicate": {
@@ -6481,6 +6505,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"group": {
@@ -6668,6 +6693,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"groupId": {
@@ -6938,6 +6964,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"groupId": {
@@ -6996,6 +7023,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"groupIds": {
@@ -7084,6 +7112,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
}
},
@@ -7158,6 +7187,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"q": {
@@ -7676,6 +7706,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"source": {
@@ -8159,6 +8190,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"format": {
@@ -8274,6 +8306,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique workspace identifier."
},
"scope": {
@@ -8398,6 +8431,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace in which to create the folder."
},
"path": {
@@ -8429,6 +8463,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace containing the folder."
},
"path": {
apps/docs/openapi-v2-workflows.json
+13 -3
View File
@@ -51,6 +51,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace whose workflows should be listed."
}
},
@@ -1712,6 +1713,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace whose folders should be listed."
}
},
@@ -1964,6 +1966,7 @@
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace containing the folder."
}
},
@@ -2499,6 +2502,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace in which to create the workflow."
},
"name": {
@@ -3828,6 +3832,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace in which to import the workflow."
},
"workflow": {
@@ -4660,7 +4665,7 @@
},
"durablyRecorded": {
"type": "boolean",
"description": "Whether cancellation was recorded durably."
"description": "Whether this request durably recorded a cancellation. Always false for a run that was already terminal, where the request is satisfied but nothing was written."
},
"locallyAborted": {
"type": "boolean",
@@ -4671,10 +4676,13 @@
"description": "Whether a paused execution was cancelled."
},
"reason": {
"description": "Machine-readable cancellation outcome, present on every cancellation including full successes. `recorded` is the success value. `redis_unavailable` and `redis_write_failed` mean the distributed cancellation signal was not written, so an already-running execution may not observe the cancellation. `paused_event_publish_failed` and `paused_database_cancel_failed` name the failing step for a paused run.",
"description": "Machine-readable cancellation outcome, present on every cancellation including full successes. `recorded` is the success value. `already_cancelled`, `already_completed`, and `already_failed` mean the run had already reached that terminal state, so nothing was cancelled and `durablyRecorded` is false. `redis_unavailable` and `redis_write_failed` mean the distributed cancellation signal was not written, so an already-running execution may not observe the cancellation. `paused_event_publish_failed` and `paused_database_cancel_failed` name the failing step for a paused run.",
"type": "string",
"enum": [
"recorded",
"already_cancelled",
"already_completed",
"already_failed",
"redis_unavailable",
"redis_write_failed",
"paused_event_publish_failed",
@@ -4692,7 +4700,7 @@
],
"additionalProperties": false,
"title": "Cancel workflow run result",
"description": "Outcome of a workflow run cancellation request. Cancellation is best-effort: a run already in a terminal state succeeds with no effect, so poll the run to observe its final state."
"description": "Outcome of a workflow run cancellation request. Cancellation is best-effort: a run already in a terminal state succeeds with no effect, reported as `durablyRecorded: false` with an `already_*` reason naming the state observed."
},
"CancelWorkflowRunResponse": {
"type": "object",
@@ -4838,6 +4846,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace in which to create the folder."
},
"path": {
@@ -4881,6 +4890,7 @@
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Workspace containing the folder."
},
"path": {