-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
186 lines (177 loc) · 4.73 KB
/
openapi.yaml
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
openapi: 3.0.0
info:
title: Jitsi reservation
version: 1.0.0
servers:
- url: /api/v1
description: Default deployment path
paths:
/conference:
summary: Conference management
post:
summary: Create conference
tags:
- Conference
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description: Name of the conference
mail_owner:
type: string
description: Mail of the moderator
start_time:
type: string
description: Start time of the meeting in YYYY-MM-DDThh:mm:ss.000Z format
duration:
type: integer
description: Duration of the meeting in seconds
password:
type: string
description: Password for the meeting
responses:
'201':
description: Data returned
content:
application/json:
schema:
$ref: '#/components/schemas/meeting'
'400':
$ref: '#/components/responses/InvalidRequest'
'409':
$ref: '#/components/responses/Conflict'
/conference/{meetingID}:
summary: Meetings
get:
summary: Get meeting details
parameters:
- $ref: '#/components/parameters/meetingID'
tags:
- Conference
responses:
'200':
description: Data returned
content:
application/json:
schema:
$ref: '#/components/schemas/meeting'
'404':
$ref: '#/components/responses/NotFound'
delete:
summary: Delete meeting
parameters:
- $ref: '#/components/parameters/meetingID'
- name: delete
in: query
required: false
schema:
type: boolean
tags:
- Conference
responses:
'200':
description: Meeting successfully deleted
content:
application/json:
schema:
type: object
properties:
message:
type: string
'404':
$ref: '#/components/responses/NotFound'
components:
parameters:
meetingID:
name: meetingID
in: path
required: true
description: ID of the meeting
schema:
type: string
schemas:
meeting:
type: object
properties:
id:
type: number
description: ID of the meeting
duration:
type: number
description: Duration of the meeting
mail_owner:
type: string
description: Mail of the moderator
name:
type: string
description: Name of the meeting
start_time:
type: string
description: Start time of the meeting in ISO-8601 format
password:
type: string
description: Password for the meeting
previd:
type: string
description: Previous ID, used for internal control
responses:
ServerError:
description: An error occured while processing the request
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: String representation of the exception
InvalidRequest:
description: Validation of input parameters failed
content:
application/json:
schema:
type: object
properties:
error:
type: string
errors:
type: array
description: List of errors encountered during validation
items:
type: string
Conflict:
description: Meeting time overlap
content:
application/json:
schema:
type: object
properties:
message:
type: string
DatabaseError:
description: The database query failed
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Description of the error
NotFound:
description: The requested resource could not be found
content:
application/json:
schema:
type: object
properties:
message:
type: string
tags:
- name: Conference
description: Endpoints to view/manage conferences