town.muni.arbiter.setSpaceMemberAccess
Schema Diff
+1 -1
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"id": "town.muni.arbiter.setSpaceMemberAccess",
3
3
"defs": {
4
4
"main": {
5
5
"type": "procedure",
6
6
"input": {
7
7
"schema": {
8
8
"type": "object",
9
9
"required": [
10
10
"arbiterDid",
11
11
"spaceKey",
12
12
"member",
13
13
"access"
14
14
],
15
15
"properties": {
16
16
"access": {
17
17
"refs": [],
18
18
"type": "union",
19
19
"description": "The updated access configuration for the member."
20
20
},
21
21
"member": {
22
22
"refs": [
23
23
"town.muni.arbiter.defs#memberDid",
24
24
"town.muni.arbiter.defs#memberLocalSpace",
25
25
"town.muni.arbiter.defs#memberRemoteSpace"
26
26
],
27
27
"type": "union",
28
28
"description": "The member to set the access of."
29
29
},
30
30
"spaceKey": {
31
31
"type": "string",
32
32
"maxLength": 1024,
33
33
"description": "The key of the space to configure."
34
34
},
35
35
"arbiterDid": {
36
36
"type": "string",
37
37
"format": "did",
38
38
"description": "The DID of the arbiter that the space is in."
39
39
},
40
40
"resolverDepth": {
41
41
"type": "integer",
42
-
"description": "The maximum depth to allow when doing remote resolutions needed to evaluate the\naccess of the requesting user."
42
+
"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."
43
43
}
44
44
}
45
45
},
46
46
"encoding": "application/json"
47
47
},
48
48
"errors": [
49
49
{
50
50
"name": "ErrArbiterNotExists",
51
51
"description": "The specified arbiter does not exist on this server."
52
52
},
53
53
{
54
54
"name": "ErrSpaceNotExists",
55
55
"description": "The specified space does not exist on this arbiter."
56
56
},
57
57
{
58
58
"name": "ErrPermissionDenied",
59
59
"description": "The requesting user is not allowed to make the request."
60
60
},
61
61
{
62
62
"name": "ErrRaceCondition",
63
63
"description": "The config was changed by another request during the execution of this request.\n\nThe action should be retried if still applicable."
64
64
},
65
65
{
66
66
"name": "ErrMemberNotInSpace",
67
67
"description": "The specified member is not in the space."
68
68
},
69
69
{
70
70
"name": "ErrInvalidConfig",
71
71
"description": "The config provided is invalid for some reason other than it being an unsupported\nlexicon."
72
72
}
73
73
],
74
74
"output": {
75
75
"schema": {
76
76
"refs": [],
77
77
"type": "union"
78
78
},
79
79
"encoding": "application/json"
80
80
},
81
81
"description": "Set the access of a member in a space.\n\nThis is also how you add a new member to the space."
82
82
}
83
83
},
84
84
"$type": "com.atproto.lexicon.schema",
85
85
"lexicon": 1
86
86
}