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