org.cairnsproto.draft.listNotifications

Events for a DID, oldest first, after a cursor. Each names the records it was derived from. Read state stays with the client.

Repository @cairnsproto.org did:plc:np7ezqujtsry4bkogisaabul namespace authority
Details · query
Kindquery
Authoritydraft.cairnsproto.org
Indexed

Showing version bafyreigoaunhab4upn2svu2ly4fndmibau3oo2bhc7uc7trfmss2ohtxcm. Show the latest

cid bafyreigoaunhab4upn2svu2ly4fndmibau3oo2bhc7uc7trfmss2ohtxcm

Checks

Valid Lint pass
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Events for a DID, oldest first, after a cursor. Each names the records it was derived from. Read state stays with the client.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "description": "Where the next page starts. Present when more notifications follow.",
              "maxLength": 1024,
              "type": "string"
            },
            "notifications": {
              "items": {
                "ref": "#notification",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "notifications"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "maxLength": 1024,
            "type": "string"
          },
          "did": {
            "format": "did",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "did"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "notification": {
      "properties": {
        "cursor": {
          "description": "The cursor that lists the events after this one.",
          "maxLength": 1024,
          "type": "string"
        },
        "kind": {
          "knownValues": [
            "contested",
            "hollow",
            "lostLead",
            "issueComment",
            "issueState",
            "diverges",
            "drawClosing",
            "versionWaiting",
            "versionActive",
            "dormancyAging",
            "dormant",
            "followedStone",
            "exported",
            "corrected"
          ],
          "maxLength": 64,
          "type": "string"
        },
        "project": {
          "ref": "com.atproto.repo.strongRef",
          "type": "ref"
        },
        "records": {
          "description": "The records the event was derived from: the snapshot and the one it names as previous, the comment or issueState, the import result, the project version, the pending work's record, the stone, or the export and any earlier export it corrects. Empty for drawClosing, which the beacon raises.",
          "items": {
            "ref": "com.atproto.repo.strongRef",
            "type": "ref"
          },
          "type": "array"
        },
        "seenRound": {
          "description": "When the indexer saw the record that raised the event, or for an event the round raises (drawClosing, versionActive, dormancyAging, dormant), the round it came due.",
          "minimum": 1,
          "type": "integer"
        },
        "site": {
          "description": "The key (hex) of the site the event is about.",
          "maxLength": 64,
          "minLength": 64,
          "type": "string"
        },
        "subject": {
          "description": "The recipient's stone (contested, hollow, lostLead, diverges), the issue, the followed sponsor's stone, the export, the waiting project version, the pending maintainer work's record, or for drawClosing the project.",
          "ref": "com.atproto.repo.strongRef",
          "type": "ref"
        }
      },
      "required": [
        "kind",
        "seenRound",
        "project",
        "subject",
        "records",
        "cursor"
      ],
      "type": "object"
    }
  },
  "id": "org.cairnsproto.draft.listNotifications",
  "lexicon": 1
}