scriptoriumadmin/fabro
1
0
Fork 0
mirror of https://github.com/fabro-sh/fabro.git synced 2026-08-28 05:27:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Describe the parallel branch fields in generated clients

Browse source 
`parallel_group_id` used `oneOf: [$ref StageId, null]`, and the generator
drops a sibling description in that position, so the TypeScript client
documented the field as "Canonical stage execution identifier in
`node_id@visit` form" — the shared StageId text, which says nothing about
what this field means. Switching to `allOf` lets the field's own
description through.

Dropping `type: "null"` also makes the contract match the server, which
omits both fields rather than sending null (`skip_serializing_if` on
`Option`, pinned by list_run_stages_exposes_parallel_branch_identity).
The Rust types are unchanged — still `Option<StageId>` and `Option<u32>`,
which accept an explicit null on input either way — so this only narrows
what clients are told to expect on the wire. Wording updated to match,
and reworded to avoid an apostrophe the generator escapes into the
JSDoc.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Bryan Helmkamp 2026-07-28 18:05:24 -04:00
parent 503e21fbc1
commit f91e51162f
No known key found for this signature in database
2 changed files with 9 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/public/api-reference/fabro-api.yaml
View file

@ -12794,21 +12794,20 @@ components:
replay after the run was resumed.
example: verify@1
parallel_group_id:
oneOf:
allOf:
- $ref: "#/components/schemas/StageId"
- type: "null"
description: >-
Exact StageId of the parent parallel execution. Clients can compare
this directly with a parallel stage's `id`. Null for stages that
are not parallel branches.
this directly with the `id` of a parallel stage. Omitted for stages
that are not parallel branches.
example: review_fork@1
parallel_branch_index:
type: ["integer", "null"]
type: integer
format: uint32
minimum: 0
description: >-
Zero-based outgoing-edge index within the parent parallel
execution. Null for stages that are not parallel branches.
execution. Omitted for stages that are not parallel branches.
example: 1
provider_used:
oneOf:

8
lib/packages/fabro-api-client/src/models/run-stage.ts generated
View file

@ -61,13 +61,13 @@ export interface RunStage {
*/
'resumed_from_stage_id'?: string | null;
/**
* Canonical stage execution identifier in `node_id@visit` form.
* Exact StageId of the parent parallel execution. Clients can compare this directly with the `id` of a parallel stage. Omitted for stages that are not parallel branches.
*/
'parallel_group_id'?: string | null;
'parallel_group_id'?: string;
/**
* Zero-based outgoing-edge index within the parent parallel execution. Null for stages that are not parallel branches.
* Zero-based outgoing-edge index within the parent parallel execution. Omitted for stages that are not parallel branches.
*/
'parallel_branch_index'?: number | null;
'parallel_branch_index'?: number;
'provider_used'?: StageModelUsage | null;
/**
* Wall-clock time the latest attempt of this stage started, if known.