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