dev.tsunagite.getLeaderboard
Schema Diff
+1 -1
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"leaderboard": {
5
5
"description": "A sorted leaderboard of associated scores, with an index for assembling longer leaderboards.",
6
6
"properties": {
7
7
"cursor": {
8
8
"description": "The integer index of the next score after this slice. If not present, no further scores remain.",
9
9
"minimum": 0,
10
10
"type": "integer"
11
11
},
12
12
"scores": {
13
13
"description": "The scores in this slice of leaderboard, sorted in descending order by the specified property.",
14
14
"items": {
15
15
"ref": "dev.tsunagite.defs#associatedScore",
16
16
"type": "ref"
17
17
},
18
18
"type": "array"
19
19
}
20
20
},
21
21
"type": "object"
22
22
},
23
23
"main": {
24
24
"description": "List the leaderboard for a given chart. Does not require auth.",
25
25
"errors": [
26
26
{
27
27
"description": "No chart matching the given URI was found.",
28
28
"name": "chartNotFound"
29
29
},
30
30
{
31
31
"description": "No score component for the game matching the given ID was found.",
32
32
"name": "invalidComponent"
33
33
},
34
34
{
35
35
"description": "There are fewer scores than the requested cursor point.",
36
36
"name": "cursorOutOfBounds"
37
37
}
38
38
],
39
39
"output": {
40
40
"encoding": "application/json",
41
41
"schema": {
42
-
"ref": "dev.tsungaite.getLeaderboard#leaderboard",
42
+
"ref": "dev.tsunagite.getLeaderboard#leaderboard",
43
43
"type": "ref"
44
44
}
45
45
},
46
46
"parameters": {
47
47
"properties": {
48
48
"chart": {
49
49
"description": "Must point to type `dev.tsunagite.chart`",
50
50
"format": "at-uri",
51
51
"type": "string"
52
52
},
53
53
"cursor": {
54
54
"description": "The index of the highest score to query in this slice.",
55
55
"minimum": 0,
56
56
"type": "integer"
57
57
},
58
58
"inputMethod": {
59
59
"type": "string"
60
60
},
61
61
"limit": {
62
62
"default": 50,
63
63
"description": "How many scores to get in this slice.",
64
64
"maximum": 100,
65
65
"minimum": 1,
66
66
"type": "integer"
67
67
},
68
68
"mode": {
69
69
"type": "string"
70
70
},
71
71
"sortBy": {
72
72
"description": "The ID of the score component to sort the leaderboard by. Will default to the game's default component if not present. Set to `timestamp` to sort by newest/oldest.",
73
73
"format": "record-key",
74
74
"type": "string"
75
75
},
76
76
"versions": {
77
77
"description": "The md5 hashes of the chart versions to list scores for. Will default to the chart's current ranked versions if not present.",
78
78
"items": {
79
79
"maxLength": 16,
80
80
"minLength": 16,
81
81
"type": "bytes"
82
82
},
83
83
"type": "array"
84
84
}
85
85
},
86
86
"required": [
87
87
"chart"
88
88
],
89
89
"type": "params"
90
90
},
91
91
"type": "query"
92
92
}
93
93
},
94
94
"description": "Defnitions related to querying leaderboards hosted via Tsunagite.",
95
95
"id": "dev.tsunagite.getLeaderboard",
96
96
"lexicon": 1
97
97
}