dev.tsunagite.listCharts
Schema Diff
+21 -0
Compatibility Analysis
Backward Compatible
Backward compatible. 2 non-breaking changes.
Non-Breaking Changes (2)
- AddedVertex AddedVertex { vertex_id: "dev.tsunagite.listCharts:output.cursor" }
- AddedEdge AddedEdge { src: "dev.tsunagite.listCharts:output", tgt: "dev.tsunagite.listCharts:output.cursor", kind: "prop", name: Some("cursor") }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "dev.tsunagite.listCharts:output.cursor" }
Additional Notes
- Non-breaking: AddedEdge { src: "dev.tsunagite.listCharts:output", tgt: "dev.tsunagite.listCharts:output.cursor", kind: "prop", name: Some("cursor") }
1
1
{
2
2
"id": "dev.tsunagite.listCharts",
3
3
"defs": {
4
4
"main": {
5
5
"type": "query",
6
6
"output": {
7
7
"schema": {
8
8
"type": "object",
9
+
"required": [
10
+
"charts"
11
+
],
9
12
"properties": {
10
13
"charts": {
11
14
"type": "array",
12
15
"items": {
13
16
"ref": "dev.tsunagite.chart",
14
17
"type": "ref"
15
18
}
19
+
},
20
+
"cursor": {
21
+
"type": "string",
22
+
"description": "Opaque string - pass back in a future request as the `cursor` value"
16
23
}
17
24
}
18
25
},
19
26
"encoding": "application/json"
20
27
},
21
28
"parameters": {
22
29
"type": "params",
30
+
"required": [
31
+
"game",
32
+
"song"
33
+
],
23
34
"properties": {
24
35
"game": {
25
36
"type": "string",
26
37
"format": "at-uri",
27
38
"description": "The game to find chart records for."
28
39
},
29
40
"song": {
30
41
"type": "string",
31
42
"format": "at-uri",
32
43
"description": "The song to find chart records for."
33
44
},
45
+
"limit": {
46
+
"type": "integer",
47
+
"default": 20,
48
+
"maximum": 100,
49
+
"description": "How many records to return."
50
+
},
34
51
"owner": {
35
52
"type": "string",
36
53
"format": "at-identifier",
37
54
"description": "The handle or DID of the account to filter results to."
55
+
},
56
+
"cursor": {
57
+
"type": "string",
58
+
"description": "Opaque string - receive from a previous request as the `cursor` value"
38
59
}
39
60
}
40
61
},
41
62
"description": "Batch chart fetch"
42
63
}
43
64
},
44
65
"$type": "com.atproto.lexicon.schema",
45
66
"lexicon": 1
46
67
}