zone.stratos.sync.listRepoOps

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Incremental pull sync of a repo's operation log (oplog), mirroring com.atproto.space.listRepoOps semantics. Returns record operations after the `since` revision, with current record values inlined by default. Boundary-gated: the caller only observes operations for records within its enrolled boundaries. The response reaches the head of the oplog when `cursor` is absent; the repo's current signed commit is then included (unless the repo has no commits yet), consistent with the operations returned. When a concurrent write is detected, a cursor is returned instead of the commit; that response can carry no operations and repeat the cursor you sent, so poll again while a cursor is present and do not read an unchanged cursor as a stall. A write that commits after the head probe is not detected; it falls outside this snapshot and arrives on a later poll. Callers must authenticate with a signed service JWT via the Authorization: Bearer header. The oplog is a droppable transport optimization; if `since` predates retained history the OplogTruncated error is returned (stricter than upstream, which silently restarts) so the caller falls back to full-state recovery (listRecordPaths).",
      "errors": [
        {
          "description": "The requested `since` revision falls outside retained history: it predates the oldest retained event (compacted), postdates the newest (not a rev this repo issued), or there is no retained log to check it against. Also returned for an unusable `cursor`: malformed, predating retained history (compacted between pages), or beyond the newest retained event. The caller must fall back to full-state recovery. Stricter than upstream, which restarts from the beginning of retained history instead of erroring.",
          "name": "OplogTruncated"
        },
        {
          "description": "The requested repo does not exist.",
          "name": "RepoNotFound"
        },
        {
          "description": "Service authentication is required.",
          "name": "AuthRequired"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "commit": {
              "description": "The repo's current signed MST commit. Included when the response reaches the head of the oplog; omitted on backfill responses and when the repo has no commits yet (no writes) - in that case there is nothing to sign and also no ops to sync.",
              "ref": "#signedCommit",
              "type": "ref"
            },
            "cursor": {
              "description": "Opaque pagination cursor to fetch the next page. Absent once the response reaches the head of the oplog. Can repeat the cursor you sent when a concurrent write was detected.",
              "type": "string"
            },
            "ops": {
              "description": "The operations in this page, in ascending revision order.",
              "items": {
                "ref": "#repoOp",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "ops"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "description": "Opaque pagination cursor from a previous response. Takes precedence over `since` when both are supplied.",
            "type": "string"
          },
          "did": {
            "description": "The DID of the repo to sync.",
            "format": "did",
            "type": "string"
          },
          "excludeValues": {
            "default": false,
            "description": "When true, record values are omitted and only operation metadata is returned.",
            "type": "boolean"
          },
          "limit": {
            "default": 100,
            "description": "Maximum number of operations to return in this page.",
            "maximum": 1000,
            "minimum": 1,
            "type": "integer"
          },
          "since": {
            "description": "A revision (TID): the caller's own sync position. Only operations after this revision are returned. Omit to start from the beginning of retained history. Use `cursor` to continue a paginated response.",
            "format": "tid",
            "type": "string"
          }
        },
        "required": [
          "did"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "repoOp": {
      "description": "A single record operation in the oplog. `cid` null means delete; `prev` null means create.",
      "nullable": [
        "cid",
        "prev"
      ],
      "properties": {
        "cid": {
          "description": "The CID (string form) of the current record value. Null for a delete.",
          "format": "cid",
          "type": "string"
        },
        "collection": {
          "description": "The record collection.",
          "format": "nsid",
          "type": "string"
        },
        "prev": {
          "description": "The CID (string form) of the record value this operation superseded. Null for a create, or when the superseded value predates the returned window.",
          "format": "cid",
          "type": "string"
        },
        "rev": {
          "description": "The revision of the commit that produced this operation. Atomic multi-writes share one rev.",
          "format": "tid",
          "type": "string"
        },
        "rkey": {
          "description": "The record key.",
          "format": "record-key",
          "type": "string"
        },
        "value": {
          "description": "The current record value, inlined by default for create/update ops. Omitted when excludeValues is true, for a delete, or when the value has been superseded by a later operation.",
          "type": "unknown"
        }
      },
      "required": [
        "rev",
        "collection",
        "rkey",
        "cid",
        "prev"
      ],
      "type": "object"
    },
    "signedCommit": {
      "description": "A signed MST v3 commit, as persisted (read verbatim, not re-signed).",
      "properties": {
        "data": {
          "description": "The CID (string form) of the MST root node.",
          "format": "cid",
          "type": "string"
        },
        "did": {
          "description": "The DID of the repo.",
          "format": "did",
          "type": "string"
        },
        "prev": {
          "description": "The CID (string form) of the previous commit. Absent for the first commit.",
          "format": "cid",
          "type": "string"
        },
        "rev": {
          "description": "The commit revision.",
          "format": "tid",
          "type": "string"
        },
        "sig": {
          "description": "The commit signature, base64-encoded (the exact persisted bytes).",
          "type": "string"
        },
        "version": {
          "description": "The commit version (3).",
          "type": "integer"
        }
      },
      "required": [
        "did",
        "version",
        "data",
        "rev",
        "sig"
      ],
      "type": "object"
    }
  },
  "id": "zone.stratos.sync.listRepoOps",
  "lexicon": 1
}