-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yml
516 lines (516 loc) · 12 KB
/
openapi.yml
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
openapi: 3.0.1
info:
title: Sessionize JSON-REST API
description: Sessionize JSON-REST API documentation by XDEV Software
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: '2.0'
externalDocs:
description: Sessionize's API documentation
url: https://sessionize.com/playbook/api
servers:
- url: https://sessionize.com
tags:
- name: all
- name: speakers
- name: sessions
paths:
/api/v2/{endpointId}/view/All:
get:
tags:
- "all"
operationId: getAll
parameters:
- name: endpointId
in: path
required: true
schema:
type: string
example: jl4ktls0
responses:
'200':
description: Returned if the request is successful
content:
application/json:
schema:
$ref: '#/components/schemas/AllResult'
deprecated: false
/api/v2/{endpointId}/view/Speakers:
get:
tags:
- "speakers"
operationId: getAllSpeakers
parameters:
- name: endpointId
in: path
required: true
schema:
type: string
example: jl4ktls0
responses:
'200':
description: Returned if the request is successful
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Speaker'
deprecated: false
/api/v2/{endpointId}/view/SpeakersEmails:
get:
tags:
- "speakers"
operationId: getAllSpeakersEmails
description: 'Undocumented endpoint for retrieving the speakers with emails'
parameters:
- name: endpointId
in: path
required: true
schema:
type: string
example: jl4ktls0
- name: s
in: query
required: true
schema:
type: string
description: 'Special key that is only available/retrievable for unlocked admins (Contacting Sessionize-Support is required)'
responses:
'200':
description: Returned if the request is successful
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SpeakerWithEmail'
deprecated: false
/api/v2/{endpointId}/view/Sessions:
get:
tags:
- "sessions"
operationId: getAllSessions
parameters:
- name: endpointId
in: path
required: true
schema:
type: string
example: jl4ktls0
responses:
'200':
description: Returned if the request is successful
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SessionGroup'
deprecated: false
components:
schemas:
AllResult:
type: object
readOnly: true
properties:
sessions:
type: array
items:
$ref: '#/components/schemas/SessionAll'
speakers:
type: array
items:
$ref: '#/components/schemas/SpeakerAll'
questions:
type: array
items:
$ref: '#/components/schemas/Question'
categories:
type: array
items:
$ref: '#/components/schemas/CategoryAll'
rooms:
type: array
items:
$ref: '#/components/schemas/Room'
required:
- categories
- questions
- rooms
- sessions
- speakers
BaseCategory:
type: object
readOnly: true
properties:
id:
type: integer
sort:
type: integer
required:
- id
- sort
CategorySession:
allOf:
- $ref: '#/components/schemas/BaseCategory'
- type: object
readOnly: true
properties:
name:
type: string
categoryItems:
type: array
items:
$ref: '#/components/schemas/CategoryItem'
required:
- name
- categoryItems
CategoryAll:
allOf:
- $ref: '#/components/schemas/BaseCategory'
- type: object
readOnly: true
properties:
title:
type: string
items:
type: array
items:
$ref: '#/components/schemas/CategoryItemAll'
type:
type: string
required:
- items
- title
- type
CategoryItem:
type: object
readOnly: true
properties:
id:
type: integer
name:
type: string
required:
- id
- name
CategoryItemAll:
allOf:
- $ref: '#/components/schemas/CategoryItem'
- type: object
readOnly: true
properties:
sort:
type: integer
required:
- sort
Link:
type: object
readOnly: true
properties:
title:
type: string
url:
type: string
format: uri
linkType:
type: string
required:
- linkType
- title
- url
Question:
type: object
readOnly: true
properties:
id:
type: integer
question:
type: string
questionType:
type: string
sort:
type: integer
required:
- id
- question
- questionType
- sort
QuestionAnswer:
type: object
readOnly: true
properties:
questionId:
type: integer
answerValue:
type: string
required:
- answerValue
- questionId
QuestionAnswerFull:
type: object
readOnly: true
properties:
id:
type: integer
question:
type: string
questionType:
type: string
answer:
type: string
nullable: true
sort:
type: integer
# answerExtra is always null; ignored
required:
- id
- question
- questionType
- answer
- sort
Room:
type: object
readOnly: true
properties:
id:
type: integer
name:
type: string
sort:
type: integer
required:
- id
- name
- sort
BaseSession:
type: object
readOnly: true
properties:
id:
type: string
title:
type: string
description:
type: string
nullable: true
startsAt:
type: string
format: date-time
nullable: true
endsAt:
type: string
format: date-time
nullable: true
isServiceSession:
type: boolean
isPlenumSession:
type: boolean
categoryItems:
type: array
items:
type: integer
roomId:
type: integer
nullable: true
liveUrl:
type: string
format: uri
nullable: true
recordingUrl:
type: string
format: uri
nullable: true
status:
$ref: '#/components/schemas/Status'
nullable: true
required:
- id
- categoryItems
- endsAt
- isPlenumSession
- isServiceSession
- roomId
- startsAt
- status
- title
Session:
allOf:
- $ref: '#/components/schemas/BaseSession'
- type: object
readOnly: true
properties:
room:
type: string
nullable: true
speakers:
type: array
items:
$ref: '#/components/schemas/SpeakerMinimal'
questionAnswers:
type: array
items:
$ref: '#/components/schemas/QuestionAnswerFull'
categories:
type: array
items:
$ref: '#/components/schemas/CategorySession'
required:
- questionAnswers
- speakers
- categories
SessionAll:
allOf:
- $ref: '#/components/schemas/BaseSession'
- type: object
readOnly: true
properties:
speakers:
type: array
items:
type: string # All Endpoint
questionAnswers:
type: array
items:
$ref: '#/components/schemas/QuestionAnswer' # All Endpoint
required:
- questionAnswers
- speakers
SessionMinimal:
type: object
readOnly: true
properties:
id:
type: integer
name:
type: string
required:
- id
- name
SessionGroup:
type: object
readOnly: true
properties:
groupId:
type: integer
groupName:
type: string
sessions:
type: array
items:
$ref: '#/components/schemas/Session'
isDefault:
type: boolean
BaseSpeakerEssential:
type: object
readOnly: true
properties:
id:
type: string
format: uuid
firstName:
type: string
lastName:
type: string
required:
- firstName
- id
- lastName
BaseSpeaker:
allOf:
- $ref: '#/components/schemas/BaseSpeakerEssential'
- type: object
readOnly: true
properties:
bio:
type: string
nullable: true
tagLine:
type: string
nullable: true
profilePicture:
type: string
format: uri
nullable: true
isTopSpeaker:
type: boolean
links:
type: array
items:
$ref: '#/components/schemas/Link'
fullName:
type: string
# categoryItems - Always empty; ignored
required:
- fullName
- isTopSpeaker
- links
- tagLine
Speaker:
allOf:
- $ref: '#/components/schemas/BaseSpeaker'
- type: object
readOnly: true
properties:
sessions:
type: array
items:
$ref: '#/components/schemas/SessionMinimal'
questionAnswers:
type: array
items:
$ref: '#/components/schemas/QuestionAnswerFull'
required:
- sessions
- questionAnswers
SpeakerAll:
allOf:
- $ref: '#/components/schemas/BaseSpeaker'
- type: object
readOnly: true
properties:
sessions:
type: array
items:
type: integer # All Endpoint
questionAnswers:
type: array
items:
$ref: '#/components/schemas/QuestionAnswer'
required:
- sessions
- questionAnswers
SpeakerWithEmail:
allOf:
- $ref: '#/components/schemas/BaseSpeakerEssential'
- type: object
readOnly: true
properties:
email:
type: string
format: email
required:
- email
SpeakerMinimal:
type: object
readOnly: true
properties:
id:
type: string
format: uuid
name:
type: string
required:
- id
- name
Status:
type: string
readOnly: true
enum:
- Accepted
- Accepted_Queue
- Nominated
- Decline_Queue
- Declined