Publish Manual
Instructions
Publish Manual
Publish an immutable, audience-scoped snapshot at an exact manual revision.
POST
Publish Manual
Publishes an immutable snapshot of the manual at an exact head revision. Publishing is owner-governed: it requires the explicit
instructions:publish scope and the workspace OWNER role. baseRevisionNumber must equal the current head — if the manual moved since you read it, the publish fails instead of snapshotting content you haven’t seen. Honors the Idempotency-Key header.
Requirements: instructions:publish + workspace OWNER role + a verified (claimed) account.
Request
string
required
The manual id.
number
required
The head revision you intend to publish — a guard, not a pointer to history.
string[]
Audiences this publication serves. If omitted or empty, OpenTrain serves all four audiences:
ADMIN, CONTRIBUTOR, REVIEWER, and WORKER. Pass an explicit non-empty list for a narrower release.string
Release note recorded on the publication.
Response
Returns201.
object
The publication summary, including
publicationNumber and contentHash.boolean
Present and
true on an Idempotency-Key replay.