Skip to content

docs(trace): document the header control field #556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HappyDevs1 merged 1 commit into from
Sep 7, 2026
+6 −0
Merged

docs(trace): document the header control field #556

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/trace-format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,12 @@ already follows.
`browser` block (the same shape as the header-level one, which stays
the single-surface spelling), applied identically at record and every
replay so that surface keeps the shape it was recorded on.
- Optional `control` is the named security control this flow validates,
copied from the spec's `control:` block: `{"id": "...", "title"?: "...",
"description"?: "..."}`. `id` is the author-chosen dotted lowercase
identifier, stable across renames and re-records; `title`/`description`
are free text. Absent for flows without a `control:` block. `flowproof
audit` reads this to report which controls a repository's traces cover.

## Step line

Expand Down
Loading