-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
195 lines (195 loc) · 4.63 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
swagger: '2.0'
info:
title: HelpMeOut API
description: API for recording and managing videos
version: 1.0.0
basePath: /api
schemes:
- https
produces:
- application/json
consumes:
- application/json
paths:
/start-recording:
post:
summary: Start a new recording
parameters:
- name: user_id
in: body
required: true
schema:
type: string
responses:
201:
description: Recording started successfully
schema:
type: object
properties:
message:
type: string
recording_id:
type: string
recording_url:
type: string
/recording/{id}:
post:
summary: Add video chunks
parameters:
- name: id
in: path
required: true
type: string
- name: video
in: formData
type: file
required: true
responses:
200:
description: Recording stopped successfully
get:
summary: Get the video of a recording
parameters:
- name: id
in: path
required: true
type: string
responses:
200:
description: Video retrieved successfully
content:
video/mp4:
schema:
type: string
put:
summary: Update the title of a recording
parameters:
- name: id
in: path
required: true
type: string
- name: title
in: body
required: true
schema:
type: string
responses:
200:
description: Title updated successfully
delete:
summary: Delete a recording
parameters:
- name: id
in: path
required: true
type: string
responses:
200:
description: Recording deleted successfully
/stop-recording/{id}:
post:
summary: Stop a recording
parameters:
- name: id
in: path
required: true
type: string
- name: video
in: formData
type: file
required: true
responses:
200:
description: Recording stopped successfully
/recording/transcript/{id}:
get:
summary: Get the transcript of a recording
parameters:
- name: id
in: path
required: true
type: string
responses:
200:
description: Transcript retrieved successfully
content:
text/plain:
schema:
type: string
/recording/details/{id}:
get:
summary: Get details of a recording
parameters:
- name: id
in: path
required: true
type: string
responses:
200:
description: Recording details retrieved successfully
schema:
type: object
properties:
title:
type: string
recording_id:
type: string
recording_url:
type: string
creator_id:
type: string
time:
type: string
transcript_url:
type: string
/recording/user/{user_id}:
get:
summary: Get all recordings of a user
parameters:
- name: user_id
in: path
required: true
type: string
responses:
200:
description: User recordings retrieved successfully
schema:
type: array
items:
type: object
properties:
title:
type: string
recording_id:
type: string
recording_url:
type: string
creator_id:
type: string
time:
type: string
transcript_url:
type: string
/recording:
get:
summary: Get all recordings
responses:
200:
description: All recordings retrieved successfully
schema:
type: array
items:
type: object
properties:
title:
type: string
recording_id:
type: string
recording_url:
type: string
creator_id:
type: string
time:
type: string
transcript_url:
type: string