Data Products

Publish (or refresh) the governed read contract

Freezes the product's currently served shape into the versioned read contract consumers read through — this is what makes a freshly built product consumable by Apps without a human relay. Requires the write scope. Every body property is optional: a schema whose fields carry a record_key, business_key, or unique tag publishes with no body at all. When the identity cannot be derived, declare EITHER record_key_fields OR record_key_anchored: true — never both.

post/v1/data-products/{id}/read-contract/publish

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/data-products/{id}/read-contract/publish
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

record_key_fieldsstring[]

Served, non-restricted field names that identify a record. Mutually exclusive with record_key_anchored.

record_key_anchoredboolean

Identify records by the record anchor instead of by served fields — the only option for a per-document product, where no field is unique per row. Mutually exclusive with record_key_fields.

Response

The published (or already-active) contract — same shape as the GET

Changes

No recorded changes to this operation across all 1 revision of this API.