games.gamesgamesgamesgames.listGames
Schema Diff
+30 -9
Compatibility Analysis
Breaking Changes Detected
1 breaking change, 0 non-breaking changes.
Breaking Changes (1)
- ConstraintAdded ConstraintAdded { vertex_id: "games.gamesgamesgamesgames.listGames:output.cursor", sort: "maxLength", value: "256" }
Migration Guidance
Constraint Changes
- ConstraintAdded ConstraintAdded { vertex_id: "games.gamesgamesgamesgames.listGames:output.cursor", sort: "maxLength", value: "256" }
1
1
{
2
2
"id": "games.gamesgamesgamesgames.listGames",
3
3
"defs": {
4
4
"main": {
5
5
"type": "query",
6
6
"output": {
7
7
"schema": {
8
8
"type": "object",
9
9
"required": [
10
10
"games"
11
11
],
12
12
"properties": {
13
13
"games": {
14
14
"type": "array",
15
15
"items": {
16
16
"ref": "games.gamesgamesgamesgames.defs#gameSummaryView",
17
17
"type": "ref"
18
18
}
19
19
},
20
20
"cursor": {
21
-
"type": "string"
21
+
"type": "string",
22
+
"maxLength": 256
22
23
}
23
24
}
24
25
},
25
26
"encoding": "application/json"
26
27
},
27
28
"parameters": {
28
29
"type": "params",
29
30
"properties": {
30
31
"did": {
31
32
"type": "string",
32
-
"format": "did"
33
+
"format": "did",
34
+
"description": "Restrict results to games in this DID's repo. Omitting it returns games from every repo — it does NOT default to the authenticated caller. Owner-facing surfaces must pass it explicitly."
33
35
},
34
36
"sort": {
37
+
"enum": [
38
+
"indexed_at",
39
+
"createdAt",
40
+
"name"
41
+
],
35
42
"type": "string",
36
43
"default": "indexed_at",
37
-
"description": "Field to sort by (e.g. name, createdAt, indexed_at)."
44
+
"maxLength": 64,
45
+
"description": "Field to sort by. Constrained because the value reaches an ORDER BY clause, which cannot be parameterised."
38
46
},
39
47
"limit": {
40
48
"type": "integer",
41
49
"default": 20,
42
50
"maximum": 100,
43
51
"minimum": 1
44
52
},
45
53
"modes": {
46
54
"type": "array",
47
55
"items": {
48
-
"type": "string"
56
+
"type": "string",
57
+
"maxLength": 64
49
58
}
50
59
},
51
60
"cursor": {
52
-
"type": "string"
61
+
"type": "string",
62
+
"maxLength": 256
53
63
},
54
64
"genres": {
55
65
"type": "array",
56
66
"items": {
57
-
"type": "string"
67
+
"type": "string",
68
+
"maxLength": 64
58
69
}
59
70
},
60
71
"themes": {
61
72
"type": "array",
62
73
"items": {
63
-
"type": "string"
74
+
"type": "string",
75
+
"maxLength": 64
64
76
}
65
77
},
66
78
"ageRatings": {
67
79
"type": "array",
68
80
"items": {
69
-
"type": "string"
81
+
"type": "string",
82
+
"maxLength": 64
70
83
},
71
84
"description": "Filter by age rating in 'organization:rating' format (e.g. esrb:M, pegi:Eighteen)."
72
85
},
73
86
"sortDirection": {
74
87
"enum": [
75
88
"asc",
76
89
"desc"
77
90
],
78
91
"type": "string",
79
92
"default": "desc",
93
+
"maxLength": 64,
80
94
"description": "Sort direction."
81
95
},
82
96
"includeUnrated": {
83
97
"type": "boolean",
84
98
"default": false,
85
99
"description": "When age rating filters are active, also include games with no age ratings."
86
100
},
87
101
"applicationTypes": {
88
102
"type": "array",
89
103
"items": {
90
104
"type": "string",
105
+
"maxLength": 64,
91
106
"knownValues": [
92
107
"addon",
93
108
"bundle",
94
109
"dlc",
95
110
"episode",
96
111
"expandedGame",
97
112
"expansion",
98
113
"fork",
99
114
"game",
100
115
"mod",
101
116
"pack",
102
117
"port",
103
118
"remake",
104
119
"remaster",
105
120
"season",
106
121
"standaloneExpansion",
107
122
"update"
108
123
]
109
124
},
110
125
"description": "Filter by application type (e.g. game, dlc, bundle)."
111
126
},
112
127
"includeCancelled": {
113
128
"type": "boolean",
114
129
"default": false
115
130
},
131
+
"includeUnpublished": {
132
+
"type": "boolean",
133
+
"default": false,
134
+
"description": "Include the caller's own unpublished drafts. Requires authentication and `did` set to the caller's own DID; the request is rejected otherwise."
135
+
},
116
136
"playerPerspectives": {
117
137
"type": "array",
118
138
"items": {
119
-
"type": "string"
139
+
"type": "string",
140
+
"maxLength": 64
120
141
}
121
142
}
122
143
}
123
144
},
124
145
"description": "Get a list of games on the network."
125
146
}
126
147
},
127
148
"$type": "com.atproto.lexicon.schema",
128
149
"lexicon": 1
129
150
}