Skip to main content
GET
Check a state's stored records against its schema

Authorizations

x-api-key
string
header
required

Path Parameters

name
string
required

Response

Success.

data
RecordCheckPage · object
required

One keyset page of a state's records checked against its current effective schema.

checked is how many records the page read; items are ONLY the records that do not fit (each a :class:~tai42_contract.states.RecordCheckItem), so a fully-fitting page has an empty items and a non-zero checked. next_cursor is the cursor the next page reads from (None on the last page), paging like list_subjects/search; held names the saves held by a failed pending save whose subjects the page did not read over their uncommitted writes. Beside :class:PruneResult and :class:StateDeclarationSaved: a scan answer that names the held saves it skipped.