Lexicon Garden

wiki.lichen.getWiki

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.

Repository @lichen.wiki did:plc:xfs42pjf3n7imvgrdrp7xvez namespace authority
Details · query
Kindquery
Authoritylichen.wiki
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

did

string · did

Owner of the wiki. Use with slug.

slug

string · record-key

The wiki's slug, which is also its record key. Use with did.

  • maxLength: 512

uri

string · at-uri

AT-URI of the wiki record. Supply this, or did and slug.

viewer

string · did

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.

Output

application/json

createdAt

requiredstring · datetime

The wiki record's own timestamp, in UTC. An unreadable or future-dated stamp falls back to our ingest time.

description

requiredstring

did

requiredstring · did

homeSlug

string

The note shown as the wiki's front page, as the wiki record's homeSlug names it.

language

requiredstring

name

requiredstring

noteCount

requiredinteger

How many notes listNotes returns. A note counts once its first revision is ingested.

slug

requiredstring

updatedAt

requiredstring · datetime

When this appview last saw the wiki or a note in it change. Observed locally, so appviews may legitimately disagree.

uri

requiredstring · at-uri

viewer

ref

Present only when the viewer parameter was supplied.

Reference

Errors

NotFound

No description in schema.

#viewerState

object

Properties

canWrite

requiredboolean

Whether a wiki.lichen.noteRevision written by this DID would be accepted.

did

requiredstring · did

role

string

Present when the DID owns the wiki or holds a membership.

  • knownValues: owner | admin | contributor | viewer

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • wiki.lichen.listWikis

    query

    List the public wikis a DID owns or belongs to. Returns them all in one response.

  • wiki.lichen.getNote

    query

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

  • wiki.lichen.wiki

    record

    A wiki. The rkey is a permanent slug.

  • wiki.lichen.listNotes

    query

    List a public wiki's notes, each with its head revision. Compare latestRevisionUri with what you hold, then call getNote for the notes that changed.

  • wiki.lichen.membership

    record

    A membership grant for a wiki. The rkey is a TID. The member's DID lives in the record body.