Deliverable Specs API Reference

The public Deliverable Specs API manages acceptance contracts. For MARKDOWN_DOCUMENT, the contract can select separately governed construction guidance through templateBinding.

Endpoints

MethodPathPurpose
GET/deliverable-specsList visible specs, optionally filtered by kind or phase
GET/deliverable-specs/{ref}Resolve a spec reference
POST/deliverable-specsCreate an organization-owned spec
POST/deliverable-specs/preview-contentValidate an authored body without persistence
POST/deliverable-specs/{ref}/validate-contentTest content against the selected spec's kind handler
POST/deliverable-specs/validateValidate produced artifacts against a spec

Create Fields

FieldRequiredMeaning
slugYesKebab-case identity, optionally namespaced with one /
versionYesStrict semantic version
titleYesHuman-readable title
kindYesOne supported deliverable acceptance kind
categoryYesKebab-case catalog category
templateBindingFor guided MARKDOWN_DOCUMENTOwner-qualified Template target; rejected as inline content
contentKind-dependentJSON/custom/response acceptance body; rejected for MARKDOWN_DOCUMENT
pagesNoRequired markdown-document page topology
rulesNoValidation and inference-enforcement settings

Template-Binding Shape

templateBinding contains ownerSpaceRef and target. The target must have resourceKind: "template" and a selector of either:

  • exact, with revisionId and contentHash; or
  • release-channel, with the authored channel name.

The release plane resolves channel intent to an immutable exact closure before runtime. Clients should persist and display the owner-qualified target rather than reducing it to a slug.

Validation

MARKDOWN_DOCUMENT validation checks document WHAT: required output, declared page topology, and other acceptance rules. Template resolution and rendering validate HOW at the Template boundary. A spec never becomes a second renderer or content authority.


Previous: ← Overlays