fyi.opensocial.getSite

The group's site record. A member gets the whole of it as they may see it: without the channels their roles keep them from, unless they may change the site, when it's every channel, to change and put back with putSite; and the channels for chosen people they're in. Anyone else gets its public part, only when the group's meta space is public. A group that has not published one gets the starter, with no uri.

Details · query
Kindquery
Authorityopensocial.fyi
Indexed
cid bafyreifm6x5g3x3lz6aetkobej3ygnl75z2ctdrl22oljpqecmc7gkkxea

Checks

Valid Lint pass
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The group's site record. A member gets the whole of it as they may see it: without the channels their roles keep them from, unless they may change the site, when it's every channel, to change and put back with putSite; and the channels for chosen people they're in. Anyone else gets its public part, only when the group's meta space is public. A group that has not published one gets the starter, with no uri.",
      "errors": [
        {
          "name": "NotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cid": {
              "format": "cid",
              "type": "string"
            },
            "peopleChannels": {
              "description": "For a member: the channels kept for chosen people they're one of.",
              "items": {
                "ref": "fyi.opensocial.listPeopleChannels#channelView",
                "type": "ref"
              },
              "type": "array"
            },
            "site": {
              "description": "A fyi.opensocial.site record.",
              "type": "unknown"
            },
            "uri": {
              "format": "at-uri",
              "type": "string"
            }
          },
          "required": [
            "site"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "group": {
            "format": "did",
            "type": "string"
          }
        },
        "required": [
          "group"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.getSite",
  "lexicon": 1
}