town.muni.arbiter.getSpaceConfig

Get the configuration of a space on the arbiter.

Repository @zicklag.dev did:plc:ulg2bzgrgs7ddjjlmhtegk3v namespace authority
Details · query
Kindquery
Authorityarbiter.muni.town
Indexed
cid bafyreidojle5qjl4gksjhezdnhywhlktxcp3jxgeljld4owugon3bpcimi

Checks

Valid Lint pass
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get the configuration of a space on the arbiter.",
      "errors": [
        {
          "description": "The specified arbiter does not exist on this server.",
          "name": "ErrArbiterNotExists"
        },
        {
          "description": "The specified space does not exist on this arbiter.",
          "name": "ErrSpaceNotExists"
        },
        {
          "description": "The requesting user is not allowed to make the request.",
          "name": "ErrPermissionDenied"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "config": {
              "description": "The space configuration object.",
              "refs": [],
              "type": "union"
            },
            "spaceType": {
              "description": "The type of the space.",
              "format": "nsid",
              "type": "string"
            }
          },
          "required": [
            "spaceType",
            "config"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "arbiterDid": {
            "description": "The DID of the arbiter that the space is in.",
            "format": "did",
            "type": "string"
          },
          "resolverDepth": {
            "description": "The maximum depth to allow when doing remote resolutions.\n\nBecause spaces are allowed to have members resolved from remote spaces,\nall of the arbiter endpoints have an optional resolution depth parameter\nthat can be used to limit how many chained remote calls can be resolved.\n\nThis applies both to queries and procedures. Queries may need to resolve\nexternal members to complete the member list, and procedures may need\nto resolve external members if the requesting member is not in the local\nmember list, to see if the member has access through a remote list.",
            "type": "integer"
          },
          "spaceKey": {
            "description": "The key of the space to configure.",
            "maxLength": 1024,
            "type": "string"
          }
        },
        "required": [
          "arbiterDid",
          "spaceKey"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "town.muni.arbiter.getSpaceConfig",
  "lexicon": 1
}