-
Notifications
You must be signed in to change notification settings - Fork 0
/
header.schema.json
338 lines (338 loc) · 13.9 KB
/
header.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
{
"$schema": "http://json-schema.org/schema",
"description": "Describes metadata for given channel.",
"definitions": {
"misc": {
"description": "Miscallaneous unrecognized properties of the object. Generally, any additional fetched property that is not known to be (un)useable ends up here.",
"type": "object"
}
},
"required": [
"version",
"channel"
],
"properties": {
"version": {
"description": "Version of the format.",
"type": "string"
},
"channel": {
"description": "Channel's metadata.",
"type": "object",
"required": [
"id",
"internalName",
"createTime",
"type",
"messageCount"
],
"properties": {
"id": {
"description": "Channel's unique ID.",
"type": "string"
},
"name": {
"description": "Channel's displayed name. May be ommited for unnamed channels (such as direct ones).",
"type": "string"
},
"internalName": {
"description": "Channel's internal name in the system.",
"type": "string"
},
"creatorUserId": {
"description": "User ID of the channel's author.",
"type": "string"
},
"createTime": {
"description": "Time at which channel was created, in miliseconds since 1970-01-01.",
"type": "integer"
},
"updateTime": {
"description": "Time at which channel was last updated, in miliseconds since 1970-01-01.",
"type": "integer"
},
"deleteTime": {
"description": "Time at which channel was marked as deleted, in miliseconds since 1970-01-01.",
"type": "integer"
},
"type": {
"description": "Channel's category",
"type": "string",
"enum": [
"Open",
"Private",
"Group",
"Direct"
]
},
"messageCount": {
"description": "Approximate total number of channel's posts.",
"type": "integer",
"minimum": 0
},
"header": {
"description": "Channel's header. Always shown on the screen and often used for shortcuts.",
"type": "string"
},
"purpose": {
"description": "Short synopsis of channel's purpose.",
"type": "string"
},
"rootMessageCount": {
"description": "How many messages in the channel are root messages, i.e. not replies to other posts.",
"type": "integer",
"minimum": 0
},
"lastMessageTime": {
"description": "Time of the creation for the latest post, in miliseconds sinde 1970-01-01.",
"type": "integer"
},
"members": {
"description": "Contains full list of member users.",
"type": "array",
"items": {
"$ref": "#/properties/users/items"
}
},
"misc": {
"$ref": "#/definitions/misc"
}
}
},
"storage": {
"description": "Information about the message storage's contents.",
"type": "object",
"required": [
"byteSize",
"count",
"organization"
],
"properties": {
"count": {
"description": "Amount of messages in the store.",
"type": "integer",
"minimum": 0
},
"organization": {
"description": "In what order are the messages sorted (from beggining of the storage toward the end). Continuous variants additionally contain all messages available in the time span from first post in storge to the last.",
"type": "string",
"enum": [
"Unsorted",
"Ascending",
"Descending",
"AscendingContinuous",
"DescendingContinuous"
]
},
"byteSize": {
"description": "Size of the data file in bytes, useful for detecting file desync and rollback of append-only modification.",
"type": "integer",
"minimum": 0
},
"beginTime": {
"description": "Start of the time range covered by the storage, in miliseconds since 1970-01-01. For example, in AscendingContinuous organization, begin time of 2000-01-01T00:00:00 would mean any posts after that time point are covered.",
"type": "integer"
},
"endTime": {
"description": "End of the time range covered by the storage, in miliseconds since 1970-01-01. See beginTime for explanation.",
"type": "integer"
},
"firstPostId": {
"description": "Post ID of the first post in storage.",
"type": "string"
},
"lastPostId": {
"description": "Post ID of the last post in storage.",
"type": "string"
},
"postIdBeforeFirst": {
"description": "Post ID of the post that would be fetched if we extend the current storage organization beyond the starting point. Ommited if there is no (known) post before first one.",
"type": "string"
},
"postIdAfterLast": {
"description": "Post ID of the post that would be fetched if we extend the current storage organization beyond the last post. Ommited if there is no (known) post after last one.",
"type": "string"
}
}
},
"team": {
"description": "Description of Team, a channel collection this channel is part of.",
"type": "object",
"required": [
"id",
"name",
"internalName",
"type",
"createTime"
],
"properties": {
"id": {
"description": "Unique identifier of this Team.",
"type": "string"
},
"name": {
"description": "Displayed name of the Team.",
"type": "string"
},
"internalName": {
"description": "Team's internal name in the system.",
"type": "string"
},
"type": {
"description": "Team's category.",
"type": "string",
"enum": [
"Open",
"InviteOnly"
]
},
"createTime": {
"description": "Time at which this team was created, in miliseconds since 1970-01-01.",
"type": "integer"
},
"updateTime": {
"description": "Time at which this team was last updated, in miliseconds since 1970-01-01.",
"type": "integer"
},
"deleteTime": {
"description": "Time at which this team was marked as deleted, in miliseconds since 1970-01-01.",
"type": "integer"
},
"description": {
"description": "Team's description text.",
"type": "string"
},
"updateAvatarTime": {
"description": "Time of latest update of this Team's icon, if any, represented as number of miliseconds since 1970-01-01.",
"type": "integer"
},
"inviteId": {
"description": "Invitation ID required to join this Team.",
"type": "string"
},
"misc": {
"$ref": "#/definitions/misc"
}
}
},
"users": {
"description": "List of users participating in the channel.",
"type": "array",
"items": {
"description": "Definition of a user.",
"type": "object",
"required": [
"id",
"name",
"createTime"
],
"properties": {
"id": {
"description": "Unique identifier of the user.",
"type": "string"
},
"name": {
"description": "User's displayed name.",
"type": "string"
},
"nickname": {
"description": "User's customized nickname.",
"type": "string"
},
"firstName": {
"description": "User's first name, if known.",
"type": "string"
},
"lastName": {
"description": "User's last name, if known.",
"type": "string"
},
"position": {
"description": "User's occupation.",
"type": "string"
},
"roles": {
"description": "List of roles (privileges) user has. The most common situation where user is just common user is not considered notable for inclusion.",
"type": "array",
"items": {
"type": "string"
}
},
"createTime": {
"description": "Time at which user was created, in miliseconds since 1970-01-01.",
"type": "integer"
},
"updateTime": {
"description": "Time at which user was last updated, in miliseconds since 1970-01-01.",
"type": "integer"
},
"deleteTime": {
"description": "Time at which user was marked as deleted, in miliseconds since 1970-01-01.",
"type": "integer"
},
"updateAvatarTime": {
"description": "Last time user's icon was updated since account's addition, in miliseconds since 1970-01-01.",
"type": "integer"
},
"avatarFileName": {
"description": "File name of the picture serving as user's avatar.",
"type": "string"
},
"misc": {
"$ref": "#/definitions/misc"
}
}
}
},
"emojis": {
"description": "List of emojis used in the channel.",
"type": "array",
"items": {
"description": "Definition of non-unicode emoji.",
"type": "object",
"required": [
"id",
"name",
"createTime"
],
"properties": {
"id": {
"description": "Unique identifier on an emoji.",
"type": "string"
},
"name": {
"description": "Emoji's name, used to invoke it in messages.",
"type": "string"
},
"creatorId": {
"description": "Identifier of the user who added this emoji.",
"type": "string"
},
"creatorName": {
"description": "Name of the user who added this emoji.",
"type": "string"
},
"createTime": {
"description": "Time at which this emoji was created, in miliseconds since 1970-01-01.",
"type": "integer"
},
"updateTime": {
"description": "Time at which this emoji was last updated, in miliseconds since 1970-01-01.",
"type": "integer"
},
"deleteTime": {
"description": "Time at which this emoji was marked as deleted, in miliseconds since 1970-01-01.",
"type": "integer"
},
"imageFileName": {
"description": "File name of the image representing this emoji.",
"type": "string"
},
"misc": {
"$ref": "#/definitions/misc"
}
}
}
}
}
}