town.muni.arbiter.getSpaceConfig
Schema Diff
+24 -27
Compatibility Analysis
Breaking Changes Detected
9 breaking changes, 3 non-breaking changes.
Breaking Changes (9)
- RemovedVertex RemovedVertex { vertex_id: "town.muni.arbiter.getSpaceConfig:input" }
- RemovedVertex RemovedVertex { vertex_id: "town.muni.arbiter.getSpaceConfig:input.arbiterDid" }
- RemovedVertex RemovedVertex { vertex_id: "town.muni.arbiter.getSpaceConfig:input.resolverDepth" }
- RemovedVertex RemovedVertex { vertex_id: "town.muni.arbiter.getSpaceConfig:input.spaceKey" }
- RemovedEdge RemovedEdge { src: "town.muni.arbiter.getSpaceConfig", tgt: "town.muni.arbiter.getSpaceConfig:input", kind: "prop", name: Some("input") }
- RemovedEdge RemovedEdge { src: "town.muni.arbiter.getSpaceConfig:input", tgt: "town.muni.arbiter.getSpaceConfig:input.arbiterDid", kind: "prop", name: Some("arbiterDid") }
- RemovedEdge RemovedEdge { src: "town.muni.arbiter.getSpaceConfig:input", tgt: "town.muni.arbiter.getSpaceConfig:input.resolverDepth", kind: "prop", name: Some("resolverDepth") }
- RemovedEdge RemovedEdge { src: "town.muni.arbiter.getSpaceConfig:input", tgt: "town.muni.arbiter.getSpaceConfig:input.spaceKey", kind: "prop", name: Some("spaceKey") }
- KindChanged KindChanged { vertex_id: "town.muni.arbiter.getSpaceConfig", old_kind: "procedure", new_kind: "query" }
Non-Breaking Changes (3)
- AddedVertex AddedVertex { vertex_id: "town.muni.arbiter.getSpaceConfig:params" }
- AddedEdge AddedEdge { src: "town.muni.arbiter.getSpaceConfig", tgt: "town.muni.arbiter.getSpaceConfig:params", kind: "prop", name: Some("parameters") }
- ConstraintRemoved ConstraintRemoved { vertex_id: "town.muni.arbiter.getSpaceConfig:input.resolverDepth", sort: "minimum" }
Migration Guidance
Removed Elements
RemovedVertex { vertex_id: "town.muni.arbiter.getSpaceConfig:input" }RemovedVertex { vertex_id: "town.muni.arbiter.getSpaceConfig:input.arbiterDid" }RemovedVertex { vertex_id: "town.muni.arbiter.getSpaceConfig:input.resolverDepth" }RemovedVertex { vertex_id: "town.muni.arbiter.getSpaceConfig:input.spaceKey" }
Added Elements
AddedVertex { vertex_id: "town.muni.arbiter.getSpaceConfig:params" }
Constraint Changes
- ConstraintRemoved ConstraintRemoved { vertex_id: "town.muni.arbiter.getSpaceConfig:input.resolverDepth", sort: "minimum" }
Additional Notes
- Breaking: RemovedEdge { src: "town.muni.arbiter.getSpaceConfig", tgt: "town.muni.arbiter.getSpaceConfig:input", kind: "prop", name: Some("input") }
- Breaking: RemovedEdge { src: "town.muni.arbiter.getSpaceConfig:input", tgt: "town.muni.arbiter.getSpaceConfig:input.arbiterDid", kind: "prop", name: Some("arbiterDid") }
- Breaking: RemovedEdge { src: "town.muni.arbiter.getSpaceConfig:input", tgt: "town.muni.arbiter.getSpaceConfig:input.resolverDepth", kind: "prop", name: Some("resolverDepth") }
- Breaking: RemovedEdge { src: "town.muni.arbiter.getSpaceConfig:input", tgt: "town.muni.arbiter.getSpaceConfig:input.spaceKey", kind: "prop", name: Some("spaceKey") }
- Breaking: KindChanged { vertex_id: "town.muni.arbiter.getSpaceConfig", old_kind: "procedure", new_kind: "query" }
- Non-breaking: AddedEdge { src: "town.muni.arbiter.getSpaceConfig", tgt: "town.muni.arbiter.getSpaceConfig:params", kind: "prop", name: Some("parameters") }
1
1
{
2
2
"id": "town.muni.arbiter.getSpaceConfig",
3
3
"defs": {
4
4
"main": {
5
-
"type": "procedure",
6
-
"input": {
7
-
"schema": {
8
-
"type": "object",
9
-
"required": [
10
-
"arbiterDid",
11
-
"spaceKey"
12
-
],
13
-
"properties": {
14
-
"spaceKey": {
15
-
"type": "string",
16
-
"description": "The key of the space to configure."
17
-
},
18
-
"arbiterDid": {
19
-
"type": "string",
20
-
"format": "did",
21
-
"description": "The DID of the arbiter that the space is in."
22
-
},
23
-
"resolverDepth": {
24
-
"type": "integer",
25
-
"minimum": 0,
26
-
"description": "The maximum depth to allow when doing remote resolutions needed to evaluate the\naccess of the requesting user."
27
-
}
28
-
}
29
-
},
30
-
"encoding": "application/json"
31
-
},
5
+
"type": "query",
32
6
"errors": [
33
7
{
34
8
"name": "ErrArbiterNotExists",
35
9
"description": "The specified arbiter does not exist on this server."
36
10
},
37
11
{
38
12
"name": "ErrSpaceNotExists",
39
13
"description": "The specified space does not exist on this arbiter."
40
14
},
41
15
{
42
16
"name": "ErrPermissionDenied",
43
17
"description": "The requesting user is not allowed to make the request."
44
18
}
45
19
],
46
20
"output": {
47
21
"schema": {
48
22
"type": "object",
49
23
"required": [
50
24
"spaceType",
51
25
"config"
52
26
],
53
27
"properties": {
54
28
"config": {
55
29
"refs": [],
56
30
"type": "union",
57
31
"description": "The space configuration object."
58
32
},
59
33
"spaceType": {
60
34
"type": "string",
61
35
"format": "nsid",
62
36
"description": "The type of the space."
63
37
}
64
38
}
65
39
},
66
40
"encoding": "application/json"
67
41
},
42
+
"parameters": {
43
+
"type": "params",
44
+
"required": [
45
+
"arbiterDid",
46
+
"spaceKey"
47
+
],
48
+
"properties": {
49
+
"spaceKey": {
50
+
"type": "string",
51
+
"maxLength": 1024,
52
+
"description": "The key of the space to configure."
53
+
},
54
+
"arbiterDid": {
55
+
"type": "string",
56
+
"format": "did",
57
+
"description": "The DID of the arbiter that the space is in."
58
+
},
59
+
"resolverDepth": {
60
+
"type": "integer",
61
+
"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."
62
+
}
63
+
}
64
+
},
68
65
"description": "Get the configuration of a space on the arbiter."
69
66
}
70
67
},
71
68
"$type": "com.atproto.lexicon.schema",
72
69
"lexicon": 1
73
70
}