fyi.opensocial.createSpace

Create a space under the group with its access record and, unless index is false, an index entry. Requires space.create.

Details · procedure
Kindprocedure
Authorityopensocial.fyi
Indexed
cid bafyreihzqnt6xznl32hvsyoh7herkfdczqaojjznpjm5747kcgdu6wr73u

Checks

Valid Lint pass
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Create a space under the group with its access record and, unless index is false, an index entry. Requires space.create.",
      "errors": [
        {
          "description": "A space with this type and skey already exists.",
          "name": "SpaceAlreadyExists"
        },
        {
          "description": "The meta and members spaces can't be created or deleted.",
          "name": "ReservedSpace"
        },
        {
          "description": "A grant names a role that doesn't exist.",
          "name": "UnknownRole"
        },
        {
          "description": "A grant isn't a space scope.",
          "name": "InvalidScope"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "access": {
              "ref": "fyi.opensocial.defs#accessConfig",
              "type": "ref"
            },
            "group": {
              "description": "The group DID. Every method is served by the group's host and authorized against that group's roles.",
              "format": "did",
              "type": "string"
            },
            "index": {
              "default": true,
              "description": "Add the space to the group's index.",
              "type": "boolean"
            },
            "name": {
              "description": "What the group calls it, kept in its index entry.",
              "maxGraphemes": 64,
              "maxLength": 640,
              "type": "string"
            },
            "skey": {
              "description": "Omit to generate a TID.",
              "format": "record-key",
              "type": "string"
            },
            "type": {
              "format": "nsid",
              "type": "string"
            }
          },
          "required": [
            "group",
            "type",
            "access"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "access": {
              "ref": "com.atproto.repo.strongRef",
              "type": "ref"
            },
            "index": {
              "description": "Present when the space was indexed.",
              "ref": "com.atproto.repo.strongRef",
              "type": "ref"
            },
            "space": {
              "format": "space-ref",
              "type": "string"
            }
          },
          "required": [
            "space",
            "access"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "fyi.opensocial.createSpace",
  "lexicon": 1
}