wiki.lichen.getNote

Get a note's current content and the head revision to write against. Public wikis only. A deleted note answers NoteDeleted.

Repository @lichen.wiki did:plc:xfs42pjf3n7imvgrdrp7xvez namespace authority
Details · query
Kindquery
Authoritylichen.wiki
Indexed
cid bafyreictps642ok4y5r5kpox34ojrb5s2ixf5ycsih2m5nx4g6f5ubkwoq

Checks

Valid
  • unlimited-string defs.main.output.schema.properties.contentNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.slugNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.titleNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get a note's current content and the head revision to write against. Public wikis only. A deleted note answers NoteDeleted.",
      "errors": [
        {
          "name": "NotFound"
        },
        {
          "name": "NoteDeleted"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "content": {
              "description": "The note's body as its last revision left it, byte for byte. Frontmatter and wikilinks stay exactly as the author wrote them. Writing this text back unchanged produces an empty revision.",
              "type": "string"
            },
            "createdAt": {
              "description": "The note record's own timestamp, in UTC. An unreadable or future-dated stamp falls back to our ingest time.",
              "format": "datetime",
              "type": "string"
            },
            "did": {
              "description": "The DID that created the note record. Later revisions can come from anyone allowed to edit the wiki.",
              "format": "did",
              "type": "string"
            },
            "latestRevisionUri": {
              "description": "The head revision. Set it as parentRevision on your noteRevision to write against this content. Only a revision parented here moves the note.",
              "format": "at-uri",
              "type": "string"
            },
            "slug": {
              "type": "string"
            },
            "title": {
              "type": "string"
            },
            "updatedAt": {
              "description": "The head revision's own timestamp, so appviews holding the same history agree. Same fallback as createdAt.",
              "format": "datetime",
              "type": "string"
            },
            "uri": {
              "description": "AT-URI of the note record. The rkey is a TID, so read it from here or address the note by wiki and slug.",
              "format": "at-uri",
              "type": "string"
            },
            "wiki": {
              "format": "at-uri",
              "type": "string"
            }
          },
          "required": [
            "uri",
            "wiki",
            "did",
            "slug",
            "title",
            "content",
            "latestRevisionUri",
            "createdAt",
            "updatedAt"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "slug": {
            "description": "The note's slug, unique within its wiki. Use with wiki.",
            "maxGraphemes": 256,
            "maxLength": 2560,
            "type": "string"
          },
          "uri": {
            "description": "AT-URI of the note record. Supply this, or wiki and slug.",
            "format": "at-uri",
            "type": "string"
          },
          "wiki": {
            "description": "AT-URI of the wiki the note belongs to. Use with slug.",
            "format": "at-uri",
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "wiki.lichen.getNote",
  "lexicon": 1
}