Tearleads

DocumentSyncUpdateResponse

One stored encrypted update returned by a sync.

Shape

object

14 fields
  • accessEpochintegerrequired
    • greater than 0

    Content-key epoch the update was written at.

  • authorizationTargetslist of objectrequired
    • at least 1 item

    Container KEK targets the write was authorized against.

    4 fields
    • containerIdstringrequired
      • not empty
    • containerKeyEpochintegerrequired
      • greater than 0
    • containerKeyEpochIdstringrequired
      • not empty
    • containerManifestHashstringrequired
      • not empty

    Other fields are allowed.

  • authorFingerprintstringrequired

    Signing key fingerprint of the writer.

  • checkpointKindstringoptional
    • always rotate_baseline

    rotate_baseline when the update is a rotation baseline.

  • checkpointPayloadKindstringoptional
    • always full_history_snapshot

    full_history_snapshot for a rotation baseline.

  • createdAtstringrequired
  • documentIdstringrequired
  • encryptedDatastringrequired

    Base64 ciphertext of the update.

  • idstringrequired
  • partialEndVersionVectorstringrequired

    Version vector the update brings the document to.

  • partialStartVersionVectorstringrequired

    Version vector the update starts from.

  • plaintextHashstringrequired
    • not empty

    Hash of the plaintext update, committed by the write header.

  • sourceVersionVectorstringoptional
    • not empty

    For a rotation baseline, the frontier its snapshot covers.

  • writeHeaderobject with any fieldsrequired

    The update's signed write header.

Other fields are allowed.

Used by

Schemas