wiki.lichen.getWiki

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get a wiki. Pass viewer to also get what that DID can do with it. Public wikis only. Takes a DID, so resolve a handle to one first with com.atproto.identity.resolveHandle.",
      "errors": [
        {
          "name": "NotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "createdAt": {
              "description": "The wiki record's own timestamp, in UTC. An unreadable or future-dated stamp falls back to our ingest time.",
              "format": "datetime",
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "did": {
              "format": "did",
              "type": "string"
            },
            "homeSlug": {
              "description": "The note shown as the wiki's front page. Each appview sets this itself, so another instance hosting the same wiki may answer differently.",
              "type": "string"
            },
            "language": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "noteCount": {
              "description": "How many notes listNotes returns. A note counts once its first revision is ingested.",
              "type": "integer"
            },
            "slug": {
              "type": "string"
            },
            "updatedAt": {
              "description": "When this appview last saw the wiki or a note in it change. Observed locally, so appviews may legitimately disagree.",
              "format": "datetime",
              "type": "string"
            },
            "uri": {
              "format": "at-uri",
              "type": "string"
            },
            "viewer": {
              "description": "Present only when the viewer parameter was supplied.",
              "ref": "#viewerState",
              "type": "ref"
            }
          },
          "required": [
            "uri",
            "did",
            "slug",
            "name",
            "description",
            "language",
            "noteCount",
            "createdAt",
            "updatedAt"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "did": {
            "description": "Owner of the wiki. Use with slug.",
            "format": "did",
            "type": "string"
          },
          "slug": {
            "description": "The wiki's slug, which is also its record key. Use with did.",
            "format": "record-key",
            "maxLength": 512,
            "type": "string"
          },
          "uri": {
            "description": "AT-URI of the wiki record. Supply this, or did and slug.",
            "format": "at-uri",
            "type": "string"
          },
          "viewer": {
            "description": "Ask what this DID can do with the wiki. Check it before writing, because ingest keeps a revision only from a DID that can edit and drops the rest silently.",
            "format": "did",
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    },
    "viewerState": {
      "properties": {
        "canWrite": {
          "description": "Whether a wiki.lichen.noteRevision written by this DID would be accepted.",
          "type": "boolean"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "role": {
          "description": "Present when the DID owns the wiki or holds a membership.",
          "knownValues": [
            "owner",
            "admin",
            "contributor",
            "viewer"
          ],
          "type": "string"
        }
      },
      "required": [
        "did",
        "canWrite"
      ],
      "type": "object"
    }
  },
  "id": "wiki.lichen.getWiki",
  "lexicon": 1
}