town.muni.arbiter.setSpaceConfig

zicklag.dev

Documentation

Configure a space on the arbiter.

main procedure

Configure a space on the arbiter.

Input

Encodingapplication/json
arbiterDid stringdid Required

The DID of the arbiter that the space is in.

config union Required

The new space configuration.

resolverDepth integer Optional

The maximum depth to allow when doing remote resolutions. Because spaces are allowed to have members resolved from remote spaces, all of the arbiter endpoints have an optional resolution depth parameter that can be used to limit how many chained remote calls can be resolved. This applies both to queries and procedures. Queries may need to resolve external members to complete the member list, and procedures may need to resolve external members if the requesting member is not in the local member list, to see if the member has access through a remote list.

spaceKey string Required

The key of the space to configure.

maxLength: 1024 bytes
spaceType stringnsid Required

The new type of the space.

Output

Encodingapplication/json

Errors

ErrArbiterNotExists The specified arbiter does not exist on this server.
ErrSpaceNotExists The specified space does not exist on this arbiter.
ErrPermissionDenied The requesting user is not allowed to make the request.
ErrRaceCondition The config was changed by another request during the execution of this request. The action should be retried if still applicable.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "arbiterDid",
        "spaceKey",
        "spaceType",
        "config"
      ],
      "properties": {
        "config": {
          "refs": [],
          "type": "union",
          "description": "The new space configuration."
        },
        "spaceKey": {
          "type": "string",
          "maxLength": 1024,
          "description": "The key of the space to configure."
        },
        "spaceType": {
          "type": "string",
          "format": "nsid",
          "description": "The new type of the space."
        },
        "arbiterDid": {
          "type": "string",
          "format": "did",
          "description": "The DID of the arbiter that the space is in."
        },
        "resolverDepth": {
          "type": "integer",
          "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."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "ErrArbiterNotExists",
      "description": "The specified arbiter does not exist on this server."
    },
    {
      "name": "ErrSpaceNotExists",
      "description": "The specified space does not exist on this arbiter."
    },
    {
      "name": "ErrPermissionDenied",
      "description": "The requesting user is not allowed to make the request."
    },
    {
      "name": "ErrRaceCondition",
      "description": "The config was changed by another request during the execution of this request.\n\nThe action should be retried if still applicable."
    }
  ],
  "output": {
    "schema": {
      "refs": [],
      "type": "union"
    },
    "encoding": "application/json"
  },
  "description": "Configure a space on the arbiter."
}

Lexicon Garden

@