social.colibri.beta.community.listMigratable

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Lists the repo-backed communities the requesting user belongs to that have not been migrated onto spaces yet, so a client can offer them as a choice rather than asking for a handle. The AppView reads this live from the user's own public repo and each candidate's public repo, because nothing about an unmigrated community is indexed. Only a community that holds its own DID is listed: an older community that lived in its owner's repo cannot be migrated.",
      "errors": [
        {
          "description": "The request is missing, malformed, or unverifiable service auth.",
          "name": "AuthRequired"
        },
        {
          "description": "The requesting user's own PDS could not be read, so no candidate list could be built at all.",
          "name": "UpstreamFailure"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "communities": {
              "description": "Unmigrated legacy communities, in the user's preferred sidebar order where the legacy repo recorded one. This is not paginated: a user's community list is small and every entry costs a live read.",
              "items": {
                "description": "An unmigrated legacy community.",
                "ref": "social.colibri.beta.community.defs#legacyCommunityView",
                "type": "ref"
              },
              "type": "array"
            },
            "unreadable": {
              "description": "Communities named by the user's repo whose own repo could not be read, so the client can say so instead of silently dropping them.",
              "items": {
                "description": "A community DID whose repo could not be read.",
                "format": "did",
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "communities"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "includeUnadministered": {
            "default": false,
            "description": "Whether to include communities the user belongs to but cannot migrate. They come back with viewerIsAdmin false.",
            "type": "boolean"
          }
        },
        "required": [],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "social.colibri.beta.community.listMigratable",
  "lexicon": 1
}