Studio Apps
validateAgainstDocContract
Validate Against Doc Contract
Check a drafted deliverable against the contract it claims, BEFORE filing it.
Arguments
markdownstringrequiredThe full markdown of the deliverable, as it would be filed.slugstringoptionalAlias of `typeSlug`. `typeSlug` wins if you send both.typeSlugstringoptionalThe contract the deliverable claims, e.g. "builddoc". Case-insensitive. Canonical name; `slug` is accepted too.
Returns
Returns { ok, problems[] }: each problem names the missing or out-of-order section, a missing lane assignment, or a bare ID that should have been a link.
Ask for it
The Cloud routes these requests to this verb.
- check this against the contract
- is this a valid builddoc
- will this pass
- validate my memo
Pair it with
The verbs that finish the job.