Lexicon Garden

dev.jazco.boards.indexBoard

Ask the appview to index a board. Its owner first adds the appview's account as a read-only member; the appview then registers for the board's notifies and syncs it. Owner auth: a space credential issued to the board's owner.

Repository @jaztesting.jazco.dev did:plc:wj2ubhxdhdbmkjq3pzckk7gx namespace authority
Details · procedure
Kindprocedure
Authorityboards.jazco.dev
Indexed
Compare Edit in builder → Fork →
cid bafyreiauzbde7tegyvzzv2xixbechnzfa6vrcwvmkvvxpic4vv6r6nsxyq

Checks

Valid
  • unlimited-string defs.main.output.schema.properties.spaceRevNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Ask the appview to index a board. Its owner first adds the appview's account as a read-only member; the appview then registers for the board's notifies and syncs it. Owner auth: a space credential issued to the board's owner.",
      "errors": [
        {
          "description": "The appview's account can't get a credential for the board.",
          "name": "NotAMember"
        },
        {
          "name": "AuthRequired"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "board": {
              "format": "uri",
              "type": "string"
            }
          },
          "required": [
            "board"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "board": {
              "format": "uri",
              "type": "string"
            },
            "spaceRev": {
              "type": "string"
            }
          },
          "required": [
            "board"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "dev.jazco.boards.indexBoard",
  "lexicon": 1
}