-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yaml
428 lines (417 loc) · 12.2 KB
/
swagger.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
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
openapi: 3.0.3
info:
title: 滞在ウォッチ
description: |-
滞在ウォッチのAPIをまとめたものです。
termsOfService: https://stay-watch-go.kajilab.tk/
contact:
email: [email protected]
version: 1.0.0
externalDocs:
description: Find out more about Swagger
url: http://swagger.io
servers:
- url: http://localhost:8082/api/v1
tags:
- name: stayers
description: 在室者についての操作
- name: logs
description: 在室履歴についての操作
- name: logsGantt
description: 1週間の在室履歴についての操作
- name: users
description: ユーザ情報についての操作
- name: extendedUsers
description: 詳細なユーザ情報についての操作
- name: check
description: ファイアベース関連の操作
- name: rooms
description: 部屋についての操作
- name: buildings
description: 建物についての操作
- name: updateroom
description: 部屋情報を更新する
paths:
/stayers:
get:
tags:
- stayers
summary: 現在の在室者の取得
operationId: Stayer
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: kaji
room:
type: string
example: 学生部屋
roomId:
type: integer
example: 1
tags:
type: array
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 梶研
'500':
description:
Internal Server Error
post:
tags:
- stayers
summary: 現在の在室者の追加、削除
operationId: Beacon
requestBody:
description: OK
content:
application/json:
schema:
type: object
properties:
beacons:
type: array
items:
type: object
properties:
uuid:
type: string
example: "e7d61ea3f8dd49c88f2ff2484c07ac15"
rssi:
type: integer
example: -50
roomId:
type: integer
example: 1
responses:
'200':
description: OK
/logs:
get:
tags:
- logs
summary: 在室履歴の取得
operationId: controller.Log
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
example: 312
startAt:
type: string
example: "2023-01-25 17:50:15"
endAt:
type: string
example: "2023-01-25 18:40:28"
room:
type: string
example: "学生部屋"
name:
type: string
example: "togawa"
'300':
description:
Internet Server Error
/logs/gantt:
get:
tags:
- logsGantt
summary: 直近1週間の在室履歴の取得
operationId: controller.LogGantt
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
example: 0
date:
type: string
example: "2023-03-24"
rooms:
type: array
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: "学生部屋"
stayTimes:
type: array
items:
type: object
properties:
id:
type: integer
example: 312
userName:
type: string
example: "togawa"
startAt:
type: integer
example: 1679633411000
endAt:
type: integer
example: 1679633452000
color:
type: string
example: "green"
/users:
get:
tags:
- users
summary: ユーザ情報の取得
operationId: controller.UserList
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: "togawa"
tags:
type: array
items:
type: object
properties:
id:
type: integer
example: 7
name:
type: string
example: "B3"
post:
tags:
- users
summary: ユーザの新規登録, 更新
operationId: controller.CreateUser
requestBody:
description: IDがない(0)なら新規登録、ある(0以外)なら更新
content:
application/json:
schema:
type: object
properties:
id:
type: integer
example: 0
email:
type: string
example: "[email protected]"
name:
type: string
example: "tarou"
role:
type: integer
example: 1
responses:
'200':
description: OK
/users/extended:
get:
tags:
- extendedUsers
summary: 詳細なユーザ情報の取得
operationId: controller.ExtendedUserList
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: "togawa"
tags:
type: array
items:
type: object
properties:
id:
type: integer
example: 7
name:
type: string
example: "B3"
uuid:
type: string
example: "e7d61ea3f8dd49c88f2ff2484c07ac15"
email:
type: string
example: "[email protected]"
role:
type: integer
example: 1
/check:
get:
tags:
- check
summary: 利用者自身のユーザ情報の取得
operationId: controller.Check
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: integer
example: 200
statusText:
type: string
example: "OK"
data:
type: object
properties:
id:
type: integer
example: 22
role:
type: integer
example: 1
'401':
description: invalid token
/rooms/{community_id}:
get:
tags:
- rooms
summary: コミュニティIDからユーザ情報の取得
operationId: controller.GetRoomsByCommunityID
parameters:
- name: community_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
roomId:
type: integer
example: 4
roomName:
type: string
example: "学生部屋"
communityName:
type: string
example: "梶研究室"
buildingName:
type: string
example: "4号館"
polygon:
type: string
example: "121,311-144,342"
buildingId:
type: integer
example: 1
/buildings/editor:
get:
tags:
- buildings
summary: 建物の取得
operationId: controller.GetBuildingsEditor
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
buildingId:
type: integer
example: 1
buildingName:
type: string
example: "4号館別館"
buildingImagePath:
type: string
example: "/4goukan.jpg"
/updateroom:
post:
tags:
- updateroom
summary: 部屋情報の更新
operationId: controller.UpdateRoom
requestBody:
content:
application/json:
schema:
type: object
properties:
roomID:
type: integer
example: 1
room_name:
type: string
example: "学生部屋"
polygon:
type: string
example: "1100,921-111,241"
buildingID:
type: integer
example: 2
responses:
'200':
description: OK