fyi.opensocial.getSuggestedSite

What a new group's site might start with, from its name and what it's for: its channels, their tabs, and looks of its own to choose from. Host-level, for whoever is starting a group. Empty when the host can't say.

Details · query
Kindquery
Authorityopensocial.fyi
Indexed
cid bafyreievbembwif3hk53odekkewvtwv2l3s6xg2ik4ieypsi3m2qhak23i

Checks

Valid
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "channel": {
      "properties": {
        "about": {
          "description": "What it's for, in a line.",
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "tabs": {
          "items": {
            "ref": "#tab",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "name",
        "about",
        "tabs"
      ],
      "type": "object"
    },
    "look": {
      "properties": {
        "name": {
          "description": "The direction it's in: Night, Club colours.",
          "type": "string"
        },
        "theme": {
          "ref": "fyi.opensocial.site#theme",
          "type": "ref"
        }
      },
      "required": [
        "name",
        "theme"
      ],
      "type": "object"
    },
    "main": {
      "description": "What a new group's site might start with, from its name and what it's for: its channels, their tabs, and looks of its own to choose from. Host-level, for whoever is starting a group. Empty when the host can't say.",
      "errors": [
        {
          "name": "RateLimitExceeded"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "channels": {
              "description": "Beside its Welcome channel, which every site has.",
              "items": {
                "ref": "#channel",
                "type": "ref"
              },
              "type": "array"
            },
            "looks": {
              "description": "Up to three, each in a different direction, best first. None when no look held up: the site starts with the host's.",
              "items": {
                "ref": "#look",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "channels",
            "looks"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "description": {
            "maxLength": 300,
            "type": "string"
          },
          "joinPolicy": {
            "description": "Who can join, as the group's profile will say it.",
            "type": "string"
          },
          "name": {
            "maxLength": 64,
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "tab": {
      "properties": {
        "template": {
          "description": "A template the kit bundles, or one of the host's own kinds of tab.",
          "type": "string"
        },
        "title": {
          "type": "string"
        }
      },
      "required": [
        "title",
        "template"
      ],
      "type": "object"
    }
  },
  "id": "fyi.opensocial.getSuggestedSite",
  "lexicon": 1
}