ai/byre
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 17 Wiki Activity

Fix wording, docs and style inconsistencies per audit of 0139564

Browse Source
This commit is contained in:
Ian Gulliver
2026-10-23 18:36:11 -07:00
parent 5a21396775
commit 681cc2b090
42 changed files with 469 additions and 453 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/openapi.yaml
+14 -13
View File
@@ -30,7 +30,7 @@ paths:
/api/me/notifications:
put:
operationId: updateNotificationPrefs
description: Sets which new questions, finished turns, errors and rate limits notify the calling user in their open byre pages.
description: "Sets which task events notify the calling user in the app: questions, turn summaries, errors, rate limits, ready to merge, discard suggestions, merge problems and finished workflows."
requestBody:
required: true
content:
@@ -588,7 +588,7 @@ paths:
post:
operationId: mergeTask
description: >
Sets the task's merge_title to the confirmed title, then starts the same agent turn as merge-in, without
Sets the task's merge_title to the confirmed title, then starts the same agent turn as mergeIn, without
its invitation to revise the title. When that turn ends normally, byre squashes the task's worktree
into one commit titled with the task's merge_title on the project's default branch, authored by the caller with
a Co-authored-by trailer for each of the task's co-authors, pushes it to origin, fast-forwards the project's
@@ -982,8 +982,9 @@ paths:
description: >
Creates a new task whose branch and worktree start from the snapshot's commit, with an idle agent session that
continues the snapshot's agent conversation as it stood at the snapshot (the vendor's own session fork). The
new session's first turn is the first message sent to it. Refused while the task is closed, and for a snapshot
with no recorded agent message at or before it.
new session's first turn is the first message sent to it. Refused while the task is closed, for a snapshot
with no recorded agent message at or before it, and for a snapshot of an Antigravity session (agy can't fork
a conversation).
responses:
"201":
description: The new task.
@@ -1079,7 +1080,7 @@ paths:
schema: { $ref: "#/components/schemas/MessageCreate" }
responses:
"202":
description: The turn has started.
description: The session the message started a turn in or is queued for.
content:
application/json:
schema: { $ref: "#/components/schemas/AgentSession" }
@@ -1226,7 +1227,7 @@ paths:
get:
operationId: connectClient
description: >
A WebSocket over which task agents use this Mac: the server sends ClientRequest text messages and the client
A WebSocket over which task agents use the connecting Mac: the server sends ClientRequest text messages and the client
answers each with a ClientReply text message carrying the same id, in any order. The Byre-Host header names
the client, percent-encoded since device names hold characters such as ’ that headers can't carry; a newer
connection from the same host replaces the older one.
@@ -1532,7 +1533,7 @@ components:
NotificationPrefs:
type: object
description: Which task events notify this user in the macOS app.
description: Which task events notify this user in the app.
required: [questions, reports, errors, rate_limits, ready, discard, merge_problems, workflows]
properties:
questions: { type: boolean, description: Questions. On by default. }
@@ -1598,7 +1599,7 @@ components:
workflow: { type: string, description: "For a workflow run's task: the name of the workflow it froze at creation (getWorkflowRun has its copy). A run's task has no agent, worktree or branch (branch, worktree_path and base_ref are empty); its stage tasks are its subtasks, and it closes once they all have, as merged when any of them merged. Absent for other tasks." }
workflow_stage: { type: string, description: "For a stage task of a workflow run: the name of the stage it runs; parent_task_id is the run's task. Absent for other tasks." }
audit: { type: string, description: "The default branch commit an audit audits, on the task of a run of its project's audit workflow; absent for other tasks." }
background: { type: boolean, description: "Whether the task is an audit's run or stage task that hasn't asked for attention yet: no question, ready_for_merge or error so far (for a run, from any of its stage tasks). The app keeps it out of the task switcher and shows it muted on the project's dashboard, and the lead gets no signals about it." }
background: { type: boolean, description: "Whether the task is an audit's run or stage task that hasn't asked for attention yet: no question, ready_for_merge, suggest_discard (unless its workflow has auto_discard), error or rate limit so far (for a run, from any of its stage tasks). The app keeps it out of the task switcher and shows it muted on the project's dashboard, and the lead gets no signals about it." }
state:
type: string
description: "The one state the task is in, kept by the store in the same transaction as every change to it (a task.state event carries each change). The first that holds: merged or discarded once closed; for a workflow run's task, finished once the run finished, running while one of its stage tasks is running, else idle; discarding; asking while it has an open question; pushing once a Merge's turn has ended and byre is pushing its squash commit to the remote (a task.pushing event names the commit); merging while a Merge or a merge into its parent is otherwise under way; merge_held while its Merge waits for another merge in the project; merge_after_review while a Merge with after_review waits for its review; running while one of its agents is mid-turn or has subagents running; reviewing while a review runs; review_pending between a turn's end and its snapshot's review starting or being skipped; ready_to_merge or discard_suggested when the agent's latest ready_for_merge or suggest_discard still stands; finished when it runs a workflow stage whose finish_stage has taken; idle; no_agent when it has no live agent."
@@ -1654,7 +1655,7 @@ components:
required: [unmerged_commits, unmerged_files, unreviewed_changes, review_snapshot, review_count, review_running, review_failed, review_findings, participants]
properties:
unmerged_commits: { type: integer, description: Commits on the task branch that aren't on the default branch. }
unmerged_files: { type: integer, description: "Files that differ from the merge base, uncommitted changes included." }
unmerged_files: { type: integer, description: "Files that differ from the merge-base, uncommitted changes included." }
unreviewed_changes: { type: boolean, description: Whether the worktree differs from the latest reviewable snapshot. }
review_snapshot: { type: integer, description: "The n of the latest snapshot that isn't a cut point (answer, fork, ask_human); 0 when there is none." }
review_count: { type: integer, description: The number of reviews of review_snapshot. }
@@ -1779,7 +1780,7 @@ components:
title: { type: string }
brief: { type: string }
definition: { $ref: "#/components/schemas/WorkflowDefinition" }
finished: { type: boolean, description: "Whether the final stage finished, which ends the run." }
finished: { type: boolean, description: "Whether every stage finished, which ends the run." }
stages:
type: array
description: In the definition's order.
@@ -1823,7 +1824,7 @@ components:
description: >
running: its agent is mid-turn. idle: active, and finish_stage hasn't taken. finished: active, its output
recorded. merged. discarded: discarded before finishing. cleaned_up: discarded after finishing, as byre
does to the run's other tasks when the final stage finishes.
does to the run's other tasks once every stage has finished.
discarding: { type: boolean, description: "Whether a Discard was started and the task isn't closed yet." }
forked_from: { type: string, description: "The task this attempt was forked from; absent for the stage's first attempt." }
output: { type: string, description: "The finish_stage output the stages after it get; absent until it finishes." }
@@ -1955,7 +1956,7 @@ components:
type: string
enum: [running, done, failed, skipped]
x-enum-varnames: [ReviewStateRunning, ReviewStateDone, ReviewStateFailed, ReviewStateSkipped]
description: "skipped: the snapshot's step changed no files, so no reviewer ran."
description: "skipped: the snapshot has no changes from the default branch (a subtask's from its parent's branch), so no reviewer ran."
result: { type: object, description: "done: the reviewer's submit_review arguments: summary (Markdown) and findings, each with severity, category, title, detail, path and line." }
error: { type: string, description: "failed: why." }
created_at: { type: string, format: date-time }
@@ -2386,7 +2387,7 @@ components:
type: object
required: [id, login, host, device, commit, build, connected_at]
properties:
id: { type: string, description: The ID the app made up when it started, from its Byre-Client header. }
id: { type: string, description: The id the app made up when it started, from its Byre-Client header. }
login: { type: string }
host: { type: string, description: The device's name from its Byre-Host header. }
device: { type: string, description: "The kind of device the app runs on (Mac or iPhone), from its Byre-Device header." }