Lexicon Garden

social.colibri.beta.community.getInvitation

Resolves an invitation code, so a client can show what it leads to before the user accepts. This is readable without membership.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · query
Kindquery
Authoritycommunity.beta.colibri.social
Indexed
Compare Edit in builder → Fork →
cid bafyreidbzgvw2dgl6x4ns5e6vvmli3a7o6ayjpstgabzih5icjdlshpgwq

Checks

Valid
  • unlimited-string defs.main.parameters.properties.codeNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Resolves an invitation code, so a client can show what it leads to before the user accepts. This is readable without membership.",
      "errors": [
        {
          "description": "No invitation exists with that code.",
          "name": "InvitationNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "community": {
              "description": "The community the invitation leads to.",
              "ref": "social.colibri.beta.community.defs#communityView",
              "type": "ref"
            },
            "invitation": {
              "description": "The resolved invitation.",
              "ref": "social.colibri.beta.community.defs#invitationView",
              "type": "ref"
            }
          },
          "required": [
            "invitation",
            "community"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "code": {
            "description": "The invitation code to resolve.",
            "type": "string"
          }
        },
        "required": [
          "code"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "social.colibri.beta.community.getInvitation",
  "lexicon": 1
}