Tearleads
Open app

DocumentSyncRequest

A document sync: uploads encrypted updates and asks for the ones the client is missing, one page at a time.

Shape

object

13 fields
  • authorizingContainerPathRefsContainerManifestRefArrayArrayoptional

    Container paths that authorize a write; reads may omit them.

  • containerRekeyslist of objectoptional
    • at most 16 items

    Container rekeys to commit first in the same transaction.

    16 fields
    • bodyany JSON valuerequired
    • containerManifestHistoryRefslist of ContainerManifestRefoptional
      • at most 4,096 items
    • destinationParentContainerPathRefslist of ContainerManifestRefoptional
      • at most 100 items
    • eventobject with any fieldsrequired
    • expectedManifestHashstringrequired
      • not empty
    • keyEpochobject with any fieldsrequired
    • keyringobject with any fieldsrequirednullable
    • manifestobject with any fieldsrequired
    • parentContainerPathRefslist of ContainerManifestRefoptional
      • at most 100 items
    • parentKekRefobjectoptionalnullable
      3 fields
      • containerIdstringrequired
        • not empty
      • containerKeyEpochIdstringrequired
        • not empty
      • keyEpochHashstringrequired
        • exactly 64 characters
        • lowercase hexadecimal

      Other fields are allowed.

    • predecessorBridgeobject with any fieldsrequirednullable
    • previousContainerPathRefslist of ContainerManifestRefoptional
      • at most 100 items
    • previousManifestRefContainerManifestRefoptionalnullable
    • principalPolicyRefsPrincipalPolicyRefListrequired
    • userRecipientKeyslist of object with any fieldsoptional
    • wrapslist of object with any fieldsrequired

    Other fields are allowed.

  • contentKeyBundleDocumentContentKeyBundleRequestoptional

    A new content-key bundle, when the write advances the content-key epoch.

  • contentKeyEpochintegerrequired
    • greater than 0

    Content-key epoch the client is writing and reading at.

  • expectedLinkSetManifestHashstringrequired
    • not empty

    The document link-set manifest head the client planned against; a different current head is refused as stale.

  • expectedTargetHashstringrequired
    • not empty

    The key target hash the client planned against.

  • historyModestringoptional
    • always raw

    raw asks for every retained update missing from the frontier, bypassing rotation baselines; read-only.

  • inlineRekeyCommitIdstringoptional
    • exactly 64 characters
    • lowercase hexadecimal

    Marker that makes carried rekeys and the write replay-safe as one transaction; present exactly when containerRekeys is non-empty.

  • localVersionVectorstringrequirednullable
    • at most 16,777,216 characters

    The client's current version vector; the response returns updates it does not cover.

  • minLsnstringoptional
    • pattern ^[0-9A-Fa-f]{1,8}\/[0-9A-Fa-f]{1,8}$

    Commit LSN the server must have reached before answering, for read-after-write consistency.

  • outgoingUpdateslist of objectrequired
    • at most 64 items

    Encrypted updates to upload.

    9 fields
    • checkpointKindstringoptional
      • always rotate_baseline
    • checkpointPayloadKindstringoptional
      • always full_history_snapshot
    • encryptedDatastringrequired
      • 1 to 16,777,216 characters
    • idstringrequired
      • lowercase UUID v4
    • partialEndVersionVectorstringrequired
      • 1 to 16,777,216 characters
    • partialStartVersionVectorstringrequired
      • 1 to 16,777,216 characters
    • plaintextHashstringrequired
      • not empty
    • sourceVersionVectorstringoptional
      • 1 to 16,777,216 characters
    • writeHeaderobject with any fieldsrequired

    Other fields are allowed.

  • pullCursorstringoptional
    • 1 to 512 characters

    Continuation cursor from the previous page; a continuation is read-only.

  • supportsPullPaginationbooleanrequired
    • always true

    Always true; every response is paged.

Other fields are allowed.

Used by

Schemas