]>
Commit | Line | Data |
---|---|---|
5e1c08eb C |
1 | <!doctype html> |
2 | <html class="no-js" lang="en"> | |
3 | <head> | |
4 | <meta charset="utf-8" /> | |
5 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
6 | <title>PeerTube | API Reference</title> | |
7 | <link rel="stylesheet" href="stylesheets/foundation.min.css" /> | |
8 | <link rel="stylesheet" href="stylesheets/spectacle.min.css" /> | |
9 | <script src="https://code.jquery.com/jquery-2.1.4.min.js"></script> | |
10 | <!-- <script src="javascripts/foundation.js"></script> --> | |
11 | <script src="javascripts/spectacle.min.js"></script> | |
12 | </head> | |
13 | <body id="spectacle"> | |
14 | <div id="page" class="drawer-layout drawer-slide-right-large"> | |
15 | <div id="sidebar"> | |
16 | <button class="close-button" aria-label="Close menu" type="button" data-drawer-close> | |
17 | <span aria-hidden="true">×</span> | |
18 | </button> | |
19 | <nav id="nav" role="navigation"> | |
20 | <h5>API Reference</h5> | |
21 | <a href="#introduction">Introduction</a> | |
22 | <h5>Operations</h5> | |
23 | <section> | |
24 | <a href="#tag-Accounts">Accounts</a> | |
25 | <ul> | |
26 | <li> | |
27 | <a href="#operation--accounts--id--get"> GET /accounts/{id} </a> | |
28 | </li> | |
29 | <li> | |
30 | <a href="#operation--accounts-get"> GET /accounts </a> | |
31 | </li> | |
32 | </ul> | |
33 | </section> | |
34 | <section> | |
35 | <a href="#tag-Config">Config</a> | |
36 | <ul> | |
37 | <li> | |
38 | <a href="#operation--config-get"> GET /config </a> | |
39 | </li> | |
40 | </ul> | |
41 | </section> | |
42 | <section> | |
43 | <a href="#tag-Job">Job</a> | |
44 | <ul> | |
45 | <li> | |
46 | <a href="#operation--jobs-get"> GET /jobs </a> | |
47 | </li> | |
48 | </ul> | |
49 | </section> | |
50 | <section> | |
51 | <a href="#tag-ServerFollowing">ServerFollowing</a> | |
52 | <ul> | |
53 | <li> | |
54 | <a href="#operation--server-following--host--delete"> DELETE /server/following/{host} </a> | |
55 | </li> | |
56 | <li> | |
57 | <a href="#operation--server-followers-get"> GET /server/followers </a> | |
58 | </li> | |
59 | <li> | |
60 | <a href="#operation--server-following-get"> GET /server/following </a> | |
61 | </li> | |
62 | <li> | |
63 | <a href="#operation--server-following-post"> POST /server/following </a> | |
64 | </li> | |
65 | </ul> | |
66 | </section> | |
67 | <section> | |
68 | <a href="#tag-User">User</a> | |
69 | <ul> | |
70 | <li> | |
71 | <a href="#operation--users-post"> POST /users </a> | |
72 | </li> | |
73 | <li> | |
74 | <a href="#operation--users-get"> GET /users </a> | |
75 | </li> | |
76 | <li> | |
77 | <a href="#operation--users--id--delete"> DELETE /users/{id} </a> | |
78 | </li> | |
79 | <li> | |
80 | <a href="#operation--users--id--get"> GET /users/{id} </a> | |
81 | </li> | |
82 | <li> | |
83 | <a href="#operation--users--id--put"> PUT /users/{id} </a> | |
84 | </li> | |
85 | <li> | |
86 | <a href="#operation--users-me-get"> GET /users/me </a> | |
87 | </li> | |
88 | <li> | |
89 | <a href="#operation--users-me-put"> PUT /users/me </a> | |
90 | </li> | |
91 | <li> | |
92 | <a href="#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used </a> | |
93 | </li> | |
94 | <li> | |
95 | <a href="#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating </a> | |
96 | </li> | |
97 | <li> | |
98 | <a href="#operation--users-me-videos-get"> GET /users/me/videos </a> | |
99 | </li> | |
100 | <li> | |
101 | <a href="#operation--users-register-post"> POST /users/register </a> | |
102 | </li> | |
103 | <li> | |
104 | <a href="#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick </a> | |
105 | </li> | |
106 | </ul> | |
107 | </section> | |
108 | <section> | |
109 | <a href="#tag-Video">Video</a> | |
110 | <ul> | |
111 | <li> | |
ab0ee6a1 | 112 | <a href="#operation--videos-get"> GET /videos </a> |
5e1c08eb C |
113 | </li> |
114 | <li> | |
ab0ee6a1 | 115 | <a href="#operation--videos-categories-get"> GET /videos/categories </a> |
5e1c08eb C |
116 | </li> |
117 | <li> | |
ab0ee6a1 | 118 | <a href="#operation--videos-licences-get"> GET /videos/licences </a> |
5e1c08eb C |
119 | </li> |
120 | <li> | |
ab0ee6a1 | 121 | <a href="#operation--videos-languages-get"> GET /videos/languages </a> |
5e1c08eb C |
122 | </li> |
123 | <li> | |
ab0ee6a1 | 124 | <a href="#operation--videos-privacies-get"> GET /videos/privacies </a> |
5e1c08eb C |
125 | </li> |
126 | <li> | |
ab0ee6a1 | 127 | <a href="#operation--videos-search-get"> GET /videos/search </a> |
5e1c08eb C |
128 | </li> |
129 | <li> | |
ab0ee6a1 | 130 | <a href="#operation--videos--id--put"> PUT /videos/{id} </a> |
5e1c08eb C |
131 | </li> |
132 | <li> | |
ab0ee6a1 | 133 | <a href="#operation--videos--id--get"> GET /videos/{id} </a> |
5e1c08eb C |
134 | </li> |
135 | <li> | |
ab0ee6a1 | 136 | <a href="#operation--videos--id--delete"> DELETE /videos/{id} </a> |
5e1c08eb C |
137 | </li> |
138 | <li> | |
ab0ee6a1 | 139 | <a href="#operation--videos--id--description-get"> GET /videos/{id}/description </a> |
5e1c08eb C |
140 | </li> |
141 | <li> | |
ab0ee6a1 | 142 | <a href="#operation--videos--id--views-post"> POST /videos/{id}/views </a> |
5e1c08eb C |
143 | </li> |
144 | <li> | |
ab0ee6a1 | 145 | <a href="#operation--videos-upload-post"> POST /videos/upload </a> |
5e1c08eb C |
146 | </li> |
147 | </ul> | |
148 | </section> | |
149 | <section> | |
150 | <a href="#tag-VideoAbuse">VideoAbuse</a> | |
151 | <ul> | |
152 | <li> | |
ab0ee6a1 | 153 | <a href="#operation--videos-abuse-get"> GET /videos/abuse </a> |
5e1c08eb C |
154 | </li> |
155 | <li> | |
ab0ee6a1 | 156 | <a href="#operation--videos--id--abuse-post"> POST /videos/{id}/abuse </a> |
5e1c08eb C |
157 | </li> |
158 | </ul> | |
159 | </section> | |
160 | <section> | |
161 | <a href="#tag-VideoBlacklist">VideoBlacklist</a> | |
162 | <ul> | |
163 | <li> | |
ab0ee6a1 | 164 | <a href="#operation--videos--videoId--blacklist-post"> POST /videos/{videoId}/blacklist </a> |
5e1c08eb C |
165 | </li> |
166 | <li> | |
ab0ee6a1 | 167 | <a href="#operation--videos--videoId--blacklist-delete"> DELETE /videos/{videoId}/blacklist </a> |
5e1c08eb C |
168 | </li> |
169 | <li> | |
ab0ee6a1 | 170 | <a href="#operation--videos-blacklist-get"> GET /videos/blacklist </a> |
5e1c08eb C |
171 | </li> |
172 | </ul> | |
173 | </section> | |
174 | <section> | |
175 | <a href="#tag-VideoChannel">VideoChannel</a> | |
176 | <ul> | |
177 | <li> | |
ab0ee6a1 | 178 | <a href="#operation--videos-channels-get"> GET /videos/channels </a> |
5e1c08eb C |
179 | </li> |
180 | <li> | |
ab0ee6a1 | 181 | <a href="#operation--videos-channels-post"> POST /videos/channels </a> |
5e1c08eb C |
182 | </li> |
183 | <li> | |
ab0ee6a1 | 184 | <a href="#operation--videos-channels--id--get"> GET /videos/channels/{id} </a> |
5e1c08eb C |
185 | </li> |
186 | <li> | |
ab0ee6a1 | 187 | <a href="#operation--videos-channels--id--put"> PUT /videos/channels/{id} </a> |
5e1c08eb C |
188 | </li> |
189 | <li> | |
ab0ee6a1 | 190 | <a href="#operation--videos-channels--id--delete"> DELETE /videos/channels/{id} </a> |
5e1c08eb C |
191 | </li> |
192 | <li> | |
ab0ee6a1 | 193 | <a href="#operation--videos-accounts--accountId--channels-get"> GET /videos/accounts/{accountId}/channels </a> |
5e1c08eb C |
194 | </li> |
195 | </ul> | |
196 | </section> | |
197 | <section> | |
198 | <a href="#tag-VideoComment">VideoComment</a> | |
199 | <ul> | |
200 | <li> | |
ab0ee6a1 | 201 | <a href="#operation--videos--videoId--comment-threads-get"> GET /videos/{videoId}/comment-threads </a> |
5e1c08eb C |
202 | </li> |
203 | <li> | |
ab0ee6a1 | 204 | <a href="#operation--videos--videoId--comment-threads-post"> POST /videos/{videoId}/comment-threads </a> |
5e1c08eb C |
205 | </li> |
206 | <li> | |
ab0ee6a1 | 207 | <a href="#operation--videos--videoId--comment-threads--threadId--get"> GET /videos/{videoId}/comment-threads/{threadId} </a> |
5e1c08eb C |
208 | </li> |
209 | <li> | |
ab0ee6a1 | 210 | <a href="#operation--videos--videoId--comments--commentId--post"> POST /videos/{videoId}/comments/{commentId} </a> |
5e1c08eb C |
211 | </li> |
212 | <li> | |
ab0ee6a1 | 213 | <a href="#operation--videos--videoId--comments--commentId--delete"> DELETE /videos/{videoId}/comments/{commentId} </a> |
5e1c08eb C |
214 | </li> |
215 | </ul> | |
216 | </section> | |
217 | <section> | |
218 | <a href="#tag-VideoRate">VideoRate</a> | |
219 | <ul> | |
220 | <li> | |
ab0ee6a1 | 221 | <a href="#operation--videos--id--rate-put"> PUT /videos/{id}/rate </a> |
5e1c08eb C |
222 | </li> |
223 | </ul> | |
224 | </section> | |
225 | <h5>Schema Definitions</h5> | |
5d00a3d7 | 226 | <a href="#definition-VideoConstant"> VideoConstant </a> |
5e1c08eb C |
227 | <a href="#definition-Video"> Video </a> |
228 | <a href="#definition-VideoAbuse"> VideoAbuse </a> | |
229 | <a href="#definition-VideoBlacklist"> VideoBlacklist </a> | |
230 | <a href="#definition-VideoChannel"> VideoChannel </a> | |
231 | <a href="#definition-VideoComment"> VideoComment </a> | |
232 | <a href="#definition-VideoCommentThreadTree"> VideoCommentThreadTree </a> | |
233 | <a href="#definition-Avatar"> Avatar </a> | |
234 | <a href="#definition-Actor"> Actor </a> | |
235 | <a href="#definition-Account"> Account </a> | |
236 | <a href="#definition-User"> User </a> | |
237 | <a href="#definition-ServerConfig"> ServerConfig </a> | |
238 | <a href="#definition-Follow"> Follow </a> | |
239 | <a href="#definition-Job"> Job </a> | |
240 | <a href="#definition-AddUserResponse"> AddUserResponse </a> | |
241 | <a href="#definition-VideoUploadResponse"> VideoUploadResponse </a> | |
ab0ee6a1 C |
242 | <a href="#definition-CommentThreadResponse"> CommentThreadResponse </a> |
243 | <a href="#definition-CommentThreadPostResponse"> CommentThreadPostResponse </a> | |
5e1c08eb C |
244 | <a href="#definition-AddUser"> AddUser </a> |
245 | <a href="#definition-UpdateUser"> UpdateUser </a> | |
246 | <a href="#definition-UpdateMe"> UpdateMe </a> | |
247 | <a href="#definition-GetMeVideoRating"> GetMeVideoRating </a> | |
248 | <a href="#definition-RegisterUser"> RegisterUser </a> | |
249 | <a href="#definition-VideoChannelInput"> VideoChannelInput </a> | |
250 | </nav> | |
251 | </div> | |
252 | <div id="docs" class="row collapse expanded drawer" data-drawer> | |
253 | <button class="floating-menu-icon" type="button" data-drawer-slide="right"> | |
254 | <span class="hamburger"></span> | |
255 | </button> | |
256 | <div class="example-box doc-content"></div> | |
257 | <article> | |
258 | <div id="introduction" data-traverse-target="introduction"> | |
259 | <h1 class="doc-title">PeerTube | |
260 | <span>API Reference</span> | |
261 | </h1> | |
262 | <div class="doc-row"> | |
263 | <div class="doc-copy"> | |
264 | <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.</p> | |
265 | </div> | |
266 | <div class="doc-examples"> | |
267 | <section> | |
ea65a476 C |
268 | <h5>API Endpoint</h5> |
269 | <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre> | |
270 | <!-- </div> --> | |
271 | <h5>Schemes: | |
272 | <span>https</span> | |
273 | </h5> | |
5e1c08eb | 274 | <h5>Version: |
164e6c87 | 275 | <span>1.0.0-beta</span> |
5e1c08eb C |
276 | </h5> |
277 | </section> | |
278 | </div> | |
279 | </div> | |
280 | </div> | |
281 | <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1> | |
282 | <div id="operation--accounts--id--get" class="operation panel" data-traverse-target="operation--accounts--id--get"> | |
283 | <!-- <section class="operation-tags row"> --> | |
284 | <!-- <div class="doc-copy"> --> | |
285 | <div class="operation-tags"> | |
286 | <a class="label" href="#tag-Accounts">Accounts</a> | |
287 | <!----> | |
288 | </div> | |
289 | <!-- </div> --> | |
290 | <!-- </section> --> | |
291 | <h2 class="operation-title"> | |
292 | <span class="operation-name"> | |
293 | <span class="operation-name">GET</span> | |
294 | <span class="operation-path">/accounts/{id}</span> | |
295 | </span> | |
296 | </h2> | |
297 | <div class="doc-row"> | |
298 | <div class="doc-copy"> | |
299 | <section class="swagger-request-params"> | |
300 | <div class="prop-row prop-group"> | |
301 | <div class="prop-name"> | |
302 | <div class="prop-title">id</div> | |
303 | <span class="json-property-required"></span> | |
304 | </div> | |
305 | <div class="prop-value"> | |
306 | <p>The id of the account</p> | |
307 | </div> | |
308 | </div> | |
309 | <div class="prop-row prop-inner"> | |
310 | <div class="prop-name param-label">type</div> | |
311 | <div class="prop-value"> | |
312 | <span class="json-property-type">string</span> | |
313 | <span class="json-property-range" title="Value limits"></span> | |
314 | </div> | |
315 | </div> | |
316 | <div class="prop-row prop-inner"> | |
317 | <div class="prop-name param-label">in</div> | |
318 | <div class="prop-value">path</div> | |
319 | </div> | |
ab0ee6a1 C |
320 | <div class="prop-row prop-group"> |
321 | <div class="prop-name"> | |
322 | <div class="prop-title">start</div> | |
323 | </div> | |
324 | <div class="prop-value"> | |
325 | <p>starting page</p> | |
326 | </div> | |
327 | </div> | |
328 | <div class="prop-row prop-inner"> | |
329 | <div class="prop-name param-label">type</div> | |
330 | <div class="prop-value"> | |
331 | <span class="json-property-type">number</span> | |
332 | <span class="json-property-range" title="Value limits"></span> | |
333 | </div> | |
334 | </div> | |
335 | <div class="prop-row prop-inner"> | |
336 | <div class="prop-name param-label">in</div> | |
337 | <div class="prop-value">query</div> | |
338 | </div> | |
339 | <div class="prop-row prop-group"> | |
340 | <div class="prop-name"> | |
341 | <div class="prop-title">stop</div> | |
342 | </div> | |
343 | <div class="prop-value"> | |
f209b32a | 344 | <p>stopping page</p> |
ab0ee6a1 C |
345 | </div> |
346 | </div> | |
347 | <div class="prop-row prop-inner"> | |
348 | <div class="prop-name param-label">type</div> | |
349 | <div class="prop-value"> | |
350 | <span class="json-property-type">number</span> | |
351 | <span class="json-property-range" title="Value limits"></span> | |
352 | </div> | |
353 | </div> | |
354 | <div class="prop-row prop-inner"> | |
355 | <div class="prop-name param-label">in</div> | |
356 | <div class="prop-value">query</div> | |
357 | </div> | |
358 | <div class="prop-row prop-group"> | |
359 | <div class="prop-name"> | |
360 | <div class="prop-title">sort</div> | |
361 | </div> | |
362 | <div class="prop-value"> | |
363 | <p>sorting</p> | |
364 | </div> | |
365 | </div> | |
366 | <div class="prop-row prop-inner"> | |
367 | <div class="prop-name param-label">type</div> | |
368 | <div class="prop-value"> | |
369 | <span class="json-property-type">number</span> | |
370 | <span class="json-property-range" title="Value limits"></span> | |
371 | </div> | |
372 | </div> | |
373 | <div class="prop-row prop-inner"> | |
374 | <div class="prop-name param-label">in</div> | |
375 | <div class="prop-value">query</div> | |
376 | </div> | |
5e1c08eb C |
377 | </section> |
378 | </div> | |
379 | <div class="doc-examples"></div> | |
380 | </div> | |
381 | <div class="doc-row"> | |
382 | <div class="doc-copy"> | |
383 | <section class="swagger-responses"> | |
384 | <div class="prop-row prop-group"> | |
385 | <div class="prop-name"> | |
386 | <div class="prop-title">200 OK</div> | |
387 | <div class="prop-ref"> | |
388 | <span class=""> | |
389 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
390 | </span> | |
391 | </div> | |
392 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
393 | </div> | |
394 | <div class="prop-value"> | |
395 | <p>successful operation</p> | |
396 | </div> | |
397 | </div> | |
398 | </section> | |
399 | </div> | |
400 | <div class="doc-examples"> | |
401 | <h5>Response Content-Types: | |
402 | <span>application/json</span> | |
403 | </h5> | |
404 | <section> | |
405 | <h5>Response Example | |
406 | <span>(200 OK)</span> | |
407 | </h5> | |
408 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
409 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
410 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
411 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
412 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
413 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
414 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
415 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
416 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
417 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
418 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
419 | <span class="hljs-attr">"avatar"</span>: { | |
420 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
421 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
422 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
423 | } | |
424 | } | |
425 | </code></pre> | |
426 | <!-- </div> --> | |
427 | </section> | |
428 | </div> | |
429 | </div> | |
430 | </div> | |
431 | <div id="operation--accounts-get" class="operation panel" data-traverse-target="operation--accounts-get"> | |
432 | <!-- <section class="operation-tags row"> --> | |
433 | <!-- <div class="doc-copy"> --> | |
434 | <div class="operation-tags"> | |
435 | <a class="label" href="#tag-Accounts">Accounts</a> | |
436 | <!----> | |
437 | </div> | |
438 | <!-- </div> --> | |
439 | <!-- </section> --> | |
440 | <h2 class="operation-title"> | |
441 | <span class="operation-name"> | |
442 | <span class="operation-name">GET</span> | |
443 | <span class="operation-path">/accounts</span> | |
444 | </span> | |
445 | </h2> | |
446 | <div class="doc-row"> | |
447 | <div class="doc-copy"> </div> | |
448 | <div class="doc-examples"></div> | |
449 | </div> | |
450 | <div class="doc-row"> | |
451 | <div class="doc-copy"> | |
452 | <section class="swagger-responses"> | |
453 | <div class="prop-row prop-group"> | |
454 | <div class="prop-name"> | |
455 | <div class="prop-title">200 OK</div> | |
456 | <div class="prop-ref"> | |
457 | <span class="json-schema-ref-array"> | |
458 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
459 | </span> | |
460 | </div> | |
461 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
462 | </div> | |
463 | <div class="prop-value"> | |
464 | <p>successful operation</p> | |
465 | </div> | |
466 | </div> | |
467 | </section> | |
468 | </div> | |
469 | <div class="doc-examples"> | |
470 | <h5>Response Content-Types: | |
471 | <span>application/json</span> | |
472 | </h5> | |
473 | <section> | |
474 | <h5>Response Example | |
475 | <span>(200 OK)</span> | |
476 | </h5> | |
477 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
478 | { | |
479 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
480 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
481 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
482 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
483 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
484 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
485 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
486 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
487 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
488 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
489 | <span class="hljs-attr">"avatar"</span>: { | |
490 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
491 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
492 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
493 | } | |
494 | } | |
495 | ] | |
496 | </code></pre> | |
497 | <!-- </div> --> | |
498 | </section> | |
499 | </div> | |
500 | </div> | |
501 | </div> | |
502 | <h1 id="tag-Config" class="swagger-summary-tag" data-traverse-target="tag-Config">Config</h1> | |
503 | <div id="operation--config-get" class="operation panel" data-traverse-target="operation--config-get"> | |
504 | <!-- <section class="operation-tags row"> --> | |
505 | <!-- <div class="doc-copy"> --> | |
506 | <div class="operation-tags"> | |
507 | <a class="label" href="#tag-Config">Config</a> | |
508 | <!----> | |
509 | </div> | |
510 | <!-- </div> --> | |
511 | <!-- </section> --> | |
512 | <h2 class="operation-title"> | |
513 | <span class="operation-name"> | |
514 | <span class="operation-name">GET</span> | |
515 | <span class="operation-path">/config</span> | |
516 | </span> | |
517 | </h2> | |
518 | <div class="doc-row"> | |
519 | <div class="doc-copy"> </div> | |
520 | <div class="doc-examples"></div> | |
521 | </div> | |
522 | <div class="doc-row"> | |
523 | <div class="doc-copy"> | |
524 | <section class="swagger-responses"> | |
525 | <div class="prop-row prop-group"> | |
526 | <div class="prop-name"> | |
527 | <div class="prop-title">200 OK</div> | |
528 | <div class="prop-ref"> | |
529 | <span class=""> | |
530 | <a class="json-schema-ref" href="#/definitions/ServerConfig">ServerConfig</a> | |
531 | </span> | |
532 | </div> | |
533 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
534 | </div> | |
535 | <div class="prop-value"> | |
536 | <p>successful operation</p> | |
537 | </div> | |
538 | </div> | |
539 | </section> | |
540 | </div> | |
541 | <div class="doc-examples"> | |
542 | <h5>Response Content-Types: | |
543 | <span>application/json</span> | |
544 | </h5> | |
545 | <section> | |
546 | <h5>Response Example | |
547 | <span>(200 OK)</span> | |
548 | </h5> | |
549 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
550 | <span class="hljs-attr">"signup"</span>: { | |
551 | <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span> | |
552 | }, | |
553 | <span class="hljs-attr">"transcoding"</span>: { | |
554 | <span class="hljs-attr">"enabledResolutions"</span>: [ | |
555 | <span class="hljs-string">"number"</span> | |
556 | ] | |
557 | }, | |
558 | <span class="hljs-attr">"avatar"</span>: { | |
559 | <span class="hljs-attr">"file"</span>: { | |
560 | <span class="hljs-attr">"size"</span>: { | |
561 | <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span> | |
562 | } | |
563 | }, | |
564 | <span class="hljs-attr">"extensions"</span>: [ | |
565 | <span class="hljs-string">"string"</span> | |
566 | ] | |
567 | }, | |
568 | <span class="hljs-attr">"video"</span>: { | |
569 | <span class="hljs-attr">"file"</span>: { | |
570 | <span class="hljs-attr">"extensions"</span>: [ | |
571 | <span class="hljs-string">"string"</span> | |
572 | ] | |
573 | } | |
574 | } | |
575 | } | |
576 | </code></pre> | |
577 | <!-- </div> --> | |
578 | </section> | |
579 | </div> | |
580 | </div> | |
581 | </div> | |
582 | <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1> | |
583 | <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get"> | |
584 | <!-- <section class="operation-tags row"> --> | |
585 | <!-- <div class="doc-copy"> --> | |
586 | <div class="operation-tags"> | |
587 | <a class="label" href="#tag-Job">Job</a> | |
588 | <!----> | |
589 | </div> | |
590 | <!-- </div> --> | |
591 | <!-- </section> --> | |
592 | <h2 class="operation-title"> | |
593 | <span class="operation-name"> | |
594 | <span class="operation-name">GET</span> | |
595 | <span class="operation-path">/jobs</span> | |
596 | </span> | |
597 | </h2> | |
598 | <div class="doc-row"> | |
ab0ee6a1 C |
599 | <div class="doc-copy"> |
600 | <section class="swagger-request-params"> | |
601 | <div class="prop-row prop-group"> | |
602 | <div class="prop-name"> | |
603 | <div class="prop-title">state</div> | |
604 | <span class="json-property-required"></span> | |
605 | </div> | |
606 | <div class="prop-value"> | |
607 | <p>The id of the account</p> | |
608 | </div> | |
609 | </div> | |
610 | <div class="prop-row prop-inner"> | |
611 | <div class="prop-name param-label">type</div> | |
612 | <div class="prop-value"> | |
613 | <span class="json-property-type">string</span> | |
614 | <span class="json-property-range" title="Value limits"></span> | |
615 | </div> | |
616 | </div> | |
617 | <div class="prop-row prop-inner"> | |
618 | <div class="prop-name param-label">in</div> | |
619 | <div class="prop-value">path</div> | |
620 | </div> | |
621 | <div class="prop-row prop-group"> | |
622 | <div class="prop-name"> | |
623 | <div class="prop-title">start</div> | |
624 | </div> | |
625 | <div class="prop-value"> | |
626 | <p>starting page</p> | |
627 | </div> | |
628 | </div> | |
629 | <div class="prop-row prop-inner"> | |
630 | <div class="prop-name param-label">type</div> | |
631 | <div class="prop-value"> | |
632 | <span class="json-property-type">number</span> | |
633 | <span class="json-property-range" title="Value limits"></span> | |
634 | </div> | |
635 | </div> | |
636 | <div class="prop-row prop-inner"> | |
637 | <div class="prop-name param-label">in</div> | |
638 | <div class="prop-value">query</div> | |
639 | </div> | |
640 | <div class="prop-row prop-group"> | |
641 | <div class="prop-name"> | |
642 | <div class="prop-title">count</div> | |
643 | </div> | |
644 | <div class="prop-value"> | |
645 | <p class="no-description">(no description)</p> | |
646 | </div> | |
647 | </div> | |
648 | <div class="prop-row prop-inner"> | |
649 | <div class="prop-name param-label">type</div> | |
650 | <div class="prop-value"> | |
651 | <span class="json-property-type">number</span> | |
652 | <span class="json-property-range" title="Value limits"></span> | |
653 | </div> | |
654 | </div> | |
655 | <div class="prop-row prop-inner"> | |
656 | <div class="prop-name param-label">in</div> | |
657 | <div class="prop-value">query</div> | |
658 | </div> | |
659 | <div class="prop-row prop-group"> | |
660 | <div class="prop-name"> | |
661 | <div class="prop-title">sort</div> | |
662 | </div> | |
663 | <div class="prop-value"> | |
664 | <p>sorting</p> | |
665 | </div> | |
666 | </div> | |
667 | <div class="prop-row prop-inner"> | |
668 | <div class="prop-name param-label">type</div> | |
669 | <div class="prop-value"> | |
670 | <span class="json-property-type">number</span> | |
671 | <span class="json-property-range" title="Value limits"></span> | |
672 | </div> | |
673 | </div> | |
674 | <div class="prop-row prop-inner"> | |
675 | <div class="prop-name param-label">in</div> | |
676 | <div class="prop-value">query</div> | |
677 | </div> | |
678 | </section> | |
679 | </div> | |
5e1c08eb C |
680 | <div class="doc-examples"></div> |
681 | </div> | |
682 | <div class="doc-row"> | |
683 | <div class="doc-copy"> | |
684 | <section class="swagger-responses"> | |
685 | <div class="prop-row prop-group"> | |
686 | <div class="prop-name"> | |
687 | <div class="prop-title">200 OK</div> | |
688 | <div class="prop-ref"> | |
689 | <span class="json-schema-ref-array"> | |
690 | <a class="json-schema-ref" href="#/definitions/Job">Job</a> | |
691 | </span> | |
692 | </div> | |
693 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
694 | </div> | |
695 | <div class="prop-value"> | |
696 | <p>successful operation</p> | |
697 | </div> | |
698 | </div> | |
699 | </section> | |
700 | </div> | |
701 | <div class="doc-examples"> | |
702 | <h5>Response Content-Types: | |
703 | <span>application/json</span> | |
704 | </h5> | |
705 | <section> | |
706 | <h5>Response Example | |
707 | <span>(200 OK)</span> | |
708 | </h5> | |
709 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
710 | { | |
711 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
712 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
713 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>, | |
714 | <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>, | |
715 | <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>, | |
716 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
717 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
718 | } | |
719 | ] | |
720 | </code></pre> | |
721 | <!-- </div> --> | |
722 | </section> | |
723 | </div> | |
724 | </div> | |
725 | </div> | |
726 | <h1 id="tag-ServerFollowing" class="swagger-summary-tag" data-traverse-target="tag-ServerFollowing">ServerFollowing</h1> | |
727 | <div id="operation--server-following--host--delete" class="operation panel" data-traverse-target="operation--server-following--host--delete"> | |
728 | <!-- <section class="operation-tags row"> --> | |
729 | <!-- <div class="doc-copy"> --> | |
730 | <div class="operation-tags"> | |
731 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
732 | <!----> | |
733 | </div> | |
734 | <!-- </div> --> | |
735 | <!-- </section> --> | |
736 | <h2 class="operation-title"> | |
737 | <span class="operation-name"> | |
738 | <span class="operation-name">DELETE</span> | |
739 | <span class="operation-path">/server/following/{host}</span> | |
740 | </span> | |
741 | </h2> | |
742 | <div class="doc-row"> | |
743 | <div class="doc-copy"> | |
744 | <section class="swagger-request-params"> | |
745 | <div class="prop-row prop-group"> | |
746 | <div class="prop-name"> | |
747 | <div class="prop-title">host</div> | |
748 | <span class="json-property-required"></span> | |
749 | </div> | |
750 | <div class="prop-value"> | |
751 | <p>The host to unfollow </p> | |
752 | </div> | |
753 | </div> | |
754 | <div class="prop-row prop-inner"> | |
755 | <div class="prop-name param-label">type</div> | |
756 | <div class="prop-value"> | |
757 | <span class="json-property-type">string</span> | |
758 | <span class="json-property-range" title="Value limits"></span> | |
759 | </div> | |
760 | </div> | |
761 | <div class="prop-row prop-inner"> | |
762 | <div class="prop-name param-label">in</div> | |
763 | <div class="prop-value">path</div> | |
764 | </div> | |
765 | </section> | |
766 | </div> | |
767 | <div class="doc-examples"></div> | |
768 | </div> | |
769 | <div class="doc-row"> | |
770 | <div class="doc-copy"> | |
771 | <section class="swagger-responses"> | |
772 | <div class="prop-row prop-group"> | |
773 | <div class="prop-name"> | |
774 | <div class="prop-title">201 Created</div> | |
775 | </div> | |
776 | <div class="prop-value"> | |
777 | <p>successful operation</p> | |
778 | </div> | |
779 | </div> | |
780 | </section> | |
781 | </div> | |
782 | <div class="doc-examples"> | |
783 | <h5>Response Content-Types: | |
784 | <span>application/json</span> | |
785 | </h5> | |
786 | </div> | |
787 | </div> | |
788 | </div> | |
789 | <div id="operation--server-followers-get" class="operation panel" data-traverse-target="operation--server-followers-get"> | |
790 | <!-- <section class="operation-tags row"> --> | |
791 | <!-- <div class="doc-copy"> --> | |
792 | <div class="operation-tags"> | |
793 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
794 | <!----> | |
795 | </div> | |
796 | <!-- </div> --> | |
797 | <!-- </section> --> | |
798 | <h2 class="operation-title"> | |
799 | <span class="operation-name"> | |
800 | <span class="operation-name">GET</span> | |
801 | <span class="operation-path">/server/followers</span> | |
802 | </span> | |
803 | </h2> | |
804 | <div class="doc-row"> | |
ab0ee6a1 C |
805 | <div class="doc-copy"> |
806 | <section class="swagger-request-params"> | |
807 | <div class="prop-row prop-group"> | |
808 | <div class="prop-name"> | |
809 | <div class="prop-title">start</div> | |
810 | </div> | |
811 | <div class="prop-value"> | |
812 | <p>starting page</p> | |
813 | </div> | |
814 | </div> | |
815 | <div class="prop-row prop-inner"> | |
816 | <div class="prop-name param-label">type</div> | |
817 | <div class="prop-value"> | |
818 | <span class="json-property-type">number</span> | |
819 | <span class="json-property-range" title="Value limits"></span> | |
820 | </div> | |
821 | </div> | |
822 | <div class="prop-row prop-inner"> | |
823 | <div class="prop-name param-label">in</div> | |
824 | <div class="prop-value">query</div> | |
825 | </div> | |
826 | <div class="prop-row prop-group"> | |
827 | <div class="prop-name"> | |
828 | <div class="prop-title">stop</div> | |
829 | </div> | |
830 | <div class="prop-value"> | |
f209b32a | 831 | <p>stopping page</p> |
ab0ee6a1 C |
832 | </div> |
833 | </div> | |
834 | <div class="prop-row prop-inner"> | |
835 | <div class="prop-name param-label">type</div> | |
836 | <div class="prop-value"> | |
837 | <span class="json-property-type">number</span> | |
838 | <span class="json-property-range" title="Value limits"></span> | |
839 | </div> | |
840 | </div> | |
841 | <div class="prop-row prop-inner"> | |
842 | <div class="prop-name param-label">in</div> | |
843 | <div class="prop-value">query</div> | |
844 | </div> | |
845 | <div class="prop-row prop-group"> | |
846 | <div class="prop-name"> | |
847 | <div class="prop-title">sort</div> | |
848 | </div> | |
849 | <div class="prop-value"> | |
850 | <p>sorting</p> | |
851 | </div> | |
852 | </div> | |
853 | <div class="prop-row prop-inner"> | |
854 | <div class="prop-name param-label">type</div> | |
855 | <div class="prop-value"> | |
856 | <span class="json-property-type">number</span> | |
857 | <span class="json-property-range" title="Value limits"></span> | |
858 | </div> | |
859 | </div> | |
860 | <div class="prop-row prop-inner"> | |
861 | <div class="prop-name param-label">in</div> | |
862 | <div class="prop-value">query</div> | |
863 | </div> | |
864 | </section> | |
865 | </div> | |
5e1c08eb C |
866 | <div class="doc-examples"></div> |
867 | </div> | |
868 | <div class="doc-row"> | |
869 | <div class="doc-copy"> | |
870 | <section class="swagger-responses"> | |
871 | <div class="prop-row prop-group"> | |
872 | <div class="prop-name"> | |
873 | <div class="prop-title">200 OK</div> | |
874 | <div class="prop-ref"> | |
875 | <span class="json-schema-ref-array"> | |
876 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
877 | </span> | |
878 | </div> | |
879 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
880 | </div> | |
881 | <div class="prop-value"> | |
882 | <p>successful operation</p> | |
883 | </div> | |
884 | </div> | |
885 | </section> | |
886 | </div> | |
887 | <div class="doc-examples"> | |
888 | <h5>Response Content-Types: | |
889 | <span>application/json</span> | |
890 | </h5> | |
891 | <section> | |
892 | <h5>Response Example | |
893 | <span>(200 OK)</span> | |
894 | </h5> | |
895 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
896 | { | |
897 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
898 | <span class="hljs-attr">"follower"</span>: { | |
899 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
900 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
901 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
902 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
903 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
904 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
905 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
906 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
907 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
908 | <span class="hljs-attr">"avatar"</span>: { | |
909 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
910 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
911 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
912 | } | |
913 | }, | |
914 | <span class="hljs-attr">"following"</span>: { | |
915 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
916 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
917 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
918 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
919 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
920 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
921 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
922 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
923 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
924 | <span class="hljs-attr">"avatar"</span>: { | |
925 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
926 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
927 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
928 | } | |
929 | }, | |
930 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
931 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
932 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
933 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
934 | } | |
935 | ] | |
936 | </code></pre> | |
937 | <!-- </div> --> | |
938 | </section> | |
939 | </div> | |
940 | </div> | |
941 | </div> | |
942 | <div id="operation--server-following-get" class="operation panel" data-traverse-target="operation--server-following-get"> | |
943 | <!-- <section class="operation-tags row"> --> | |
944 | <!-- <div class="doc-copy"> --> | |
945 | <div class="operation-tags"> | |
946 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
947 | <!----> | |
948 | </div> | |
949 | <!-- </div> --> | |
950 | <!-- </section> --> | |
951 | <h2 class="operation-title"> | |
952 | <span class="operation-name"> | |
953 | <span class="operation-name">GET</span> | |
954 | <span class="operation-path">/server/following</span> | |
955 | </span> | |
956 | </h2> | |
957 | <div class="doc-row"> | |
ab0ee6a1 C |
958 | <div class="doc-copy"> |
959 | <section class="swagger-request-params"> | |
960 | <div class="prop-row prop-group"> | |
961 | <div class="prop-name"> | |
962 | <div class="prop-title">start</div> | |
963 | </div> | |
964 | <div class="prop-value"> | |
965 | <p>starting page</p> | |
966 | </div> | |
967 | </div> | |
968 | <div class="prop-row prop-inner"> | |
969 | <div class="prop-name param-label">type</div> | |
970 | <div class="prop-value"> | |
971 | <span class="json-property-type">number</span> | |
972 | <span class="json-property-range" title="Value limits"></span> | |
973 | </div> | |
974 | </div> | |
975 | <div class="prop-row prop-inner"> | |
976 | <div class="prop-name param-label">in</div> | |
977 | <div class="prop-value">query</div> | |
978 | </div> | |
979 | <div class="prop-row prop-group"> | |
980 | <div class="prop-name"> | |
981 | <div class="prop-title">stop</div> | |
982 | </div> | |
983 | <div class="prop-value"> | |
f209b32a | 984 | <p>stopping page</p> |
ab0ee6a1 C |
985 | </div> |
986 | </div> | |
987 | <div class="prop-row prop-inner"> | |
988 | <div class="prop-name param-label">type</div> | |
989 | <div class="prop-value"> | |
990 | <span class="json-property-type">number</span> | |
991 | <span class="json-property-range" title="Value limits"></span> | |
992 | </div> | |
993 | </div> | |
994 | <div class="prop-row prop-inner"> | |
995 | <div class="prop-name param-label">in</div> | |
996 | <div class="prop-value">query</div> | |
997 | </div> | |
998 | <div class="prop-row prop-group"> | |
999 | <div class="prop-name"> | |
1000 | <div class="prop-title">sort</div> | |
1001 | </div> | |
1002 | <div class="prop-value"> | |
1003 | <p>sorting</p> | |
1004 | </div> | |
1005 | </div> | |
1006 | <div class="prop-row prop-inner"> | |
1007 | <div class="prop-name param-label">type</div> | |
1008 | <div class="prop-value"> | |
1009 | <span class="json-property-type">number</span> | |
1010 | <span class="json-property-range" title="Value limits"></span> | |
1011 | </div> | |
1012 | </div> | |
1013 | <div class="prop-row prop-inner"> | |
1014 | <div class="prop-name param-label">in</div> | |
1015 | <div class="prop-value">query</div> | |
1016 | </div> | |
1017 | </section> | |
1018 | </div> | |
5e1c08eb C |
1019 | <div class="doc-examples"></div> |
1020 | </div> | |
1021 | <div class="doc-row"> | |
1022 | <div class="doc-copy"> | |
1023 | <section class="swagger-responses"> | |
1024 | <div class="prop-row prop-group"> | |
1025 | <div class="prop-name"> | |
1026 | <div class="prop-title">200 OK</div> | |
1027 | <div class="prop-ref"> | |
1028 | <span class="json-schema-ref-array"> | |
1029 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
1030 | </span> | |
1031 | </div> | |
1032 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1033 | </div> | |
1034 | <div class="prop-value"> | |
1035 | <p>successful operation</p> | |
1036 | </div> | |
1037 | </div> | |
1038 | </section> | |
1039 | </div> | |
1040 | <div class="doc-examples"> | |
1041 | <h5>Response Content-Types: | |
1042 | <span>application/json</span> | |
1043 | </h5> | |
1044 | <section> | |
1045 | <h5>Response Example | |
1046 | <span>(200 OK)</span> | |
1047 | </h5> | |
1048 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
1049 | { | |
1050 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1051 | <span class="hljs-attr">"follower"</span>: { | |
1052 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1053 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1054 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1055 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1056 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1057 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1058 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1059 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1060 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1061 | <span class="hljs-attr">"avatar"</span>: { | |
1062 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1063 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1064 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1065 | } | |
1066 | }, | |
1067 | <span class="hljs-attr">"following"</span>: { | |
1068 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1069 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1070 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1071 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1072 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1073 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1074 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1075 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1076 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1077 | <span class="hljs-attr">"avatar"</span>: { | |
1078 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1079 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1080 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1081 | } | |
1082 | }, | |
1083 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
1084 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
1085 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1086 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1087 | } | |
1088 | ] | |
1089 | </code></pre> | |
1090 | <!-- </div> --> | |
1091 | </section> | |
1092 | </div> | |
1093 | </div> | |
1094 | </div> | |
1095 | <div id="operation--server-following-post" class="operation panel" data-traverse-target="operation--server-following-post"> | |
1096 | <!-- <section class="operation-tags row"> --> | |
1097 | <!-- <div class="doc-copy"> --> | |
1098 | <div class="operation-tags"> | |
1099 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
1100 | <!----> | |
1101 | </div> | |
1102 | <!-- </div> --> | |
1103 | <!-- </section> --> | |
1104 | <h2 class="operation-title"> | |
1105 | <span class="operation-name"> | |
1106 | <span class="operation-name">POST</span> | |
1107 | <span class="operation-path">/server/following</span> | |
1108 | </span> | |
1109 | </h2> | |
1110 | <div class="doc-row"> | |
1111 | <div class="doc-copy"> | |
1112 | <section class="swagger-request-body"> | |
1113 | <div class="prop-row"> | |
1114 | <div class="prop-name"> | |
1115 | <div class="swagger-request-model"> | |
1116 | <span class=""> | |
1117 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
1118 | </span> | |
1119 | </div> | |
1120 | </div> | |
1121 | <div class="prop-value columns small-6"> | |
1122 | <!-- <div class="swagger-request-description"> -->undefined | |
1123 | <!-- </div> --> | |
1124 | </div> | |
1125 | </div> | |
1126 | </section> | |
1127 | </div> | |
1128 | <div class="doc-examples"> | |
1129 | <section> | |
1130 | <h5>Request Content-Types: | |
1131 | <span>application/json</span> | |
1132 | </h5> | |
1133 | <h5>Request Example</h5> | |
1134 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1135 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1136 | <span class="hljs-attr">"follower"</span>: { | |
1137 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1138 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1139 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1140 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1141 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1142 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1143 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1144 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1145 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1146 | <span class="hljs-attr">"avatar"</span>: { | |
1147 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1148 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1149 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1150 | } | |
1151 | }, | |
1152 | <span class="hljs-attr">"following"</span>: { | |
1153 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1154 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1155 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1156 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1157 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1158 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1159 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1160 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1161 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1162 | <span class="hljs-attr">"avatar"</span>: { | |
1163 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1164 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1165 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1166 | } | |
1167 | }, | |
1168 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
1169 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
1170 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1171 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1172 | } | |
1173 | </code></pre> | |
1174 | <!-- </div> --> | |
1175 | </section> | |
1176 | </div> | |
1177 | </div> | |
1178 | <div class="doc-row"> | |
1179 | <div class="doc-copy"> | |
1180 | <section class="swagger-responses"> | |
1181 | <div class="prop-row prop-group"> | |
1182 | <div class="prop-name"> | |
1183 | <div class="prop-title">204 No Content</div> | |
1184 | </div> | |
1185 | <div class="prop-value"> | |
1186 | <p>successful operation</p> | |
1187 | </div> | |
1188 | </div> | |
1189 | </section> | |
1190 | </div> | |
1191 | <div class="doc-examples"> | |
1192 | <h5>Response Content-Types: | |
1193 | <span>application/json</span> | |
1194 | </h5> | |
1195 | </div> | |
1196 | </div> | |
1197 | </div> | |
1198 | <h1 id="tag-User" class="swagger-summary-tag" data-traverse-target="tag-User">User</h1> | |
1199 | <div id="operation--users-post" class="operation panel" data-traverse-target="operation--users-post"> | |
1200 | <!-- <section class="operation-tags row"> --> | |
1201 | <!-- <div class="doc-copy"> --> | |
1202 | <div class="operation-tags"> | |
1203 | <a class="label" href="#tag-User">User</a> | |
1204 | <!----> | |
1205 | </div> | |
1206 | <!-- </div> --> | |
1207 | <!-- </section> --> | |
1208 | <h2 class="operation-title"> | |
1209 | <span class="operation-name"> | |
1210 | <span class="operation-name">POST</span> | |
1211 | <span class="operation-path">/users</span> | |
1212 | </span> | |
1213 | </h2> | |
1214 | <div class="doc-row"> | |
1215 | <div class="doc-copy"> | |
1216 | <section class="swagger-request-body"> | |
1217 | <div class="prop-row"> | |
1218 | <div class="prop-name"> | |
1219 | <div class="swagger-request-model"> | |
1220 | <span class=""> | |
1221 | <a class="json-schema-ref" href="#/definitions/AddUser">AddUser</a> | |
1222 | </span> | |
1223 | </div> | |
1224 | </div> | |
1225 | <div class="prop-value columns small-6"> | |
1226 | <!-- <div class="swagger-request-description"> -->undefined | |
1227 | <!-- </div> --> | |
1228 | </div> | |
1229 | </div> | |
1230 | </section> | |
1231 | </div> | |
1232 | <div class="doc-examples"> | |
1233 | <section> | |
1234 | <h5>Request Content-Types: | |
1235 | <span>application/json</span> | |
1236 | </h5> | |
1237 | <h5>Request Example</h5> | |
1238 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1239 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
1240 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
1241 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1242 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
1243 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
1244 | } | |
1245 | </code></pre> | |
1246 | <!-- </div> --> | |
1247 | </section> | |
1248 | </div> | |
1249 | </div> | |
1250 | <div class="doc-row"> | |
1251 | <div class="doc-copy"> | |
1252 | <section class="swagger-responses"> | |
1253 | <div class="prop-row prop-group"> | |
1254 | <div class="prop-name"> | |
1255 | <div class="prop-title">200 OK</div> | |
1256 | <div class="prop-ref"> | |
1257 | <span class=""> | |
1258 | <a class="json-schema-ref" href="#/definitions/AddUserResponse">AddUserResponse</a> | |
1259 | </span> | |
1260 | </div> | |
1261 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1262 | </div> | |
1263 | <div class="prop-value"> | |
1264 | <p>successful operation</p> | |
1265 | </div> | |
1266 | </div> | |
1267 | </section> | |
1268 | </div> | |
1269 | <div class="doc-examples"> | |
1270 | <h5>Response Content-Types: | |
1271 | <span>application/json</span> | |
1272 | </h5> | |
1273 | <section> | |
1274 | <h5>Response Example | |
1275 | <span>(200 OK)</span> | |
1276 | </h5> | |
1277 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1278 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1279 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
1280 | } | |
1281 | </code></pre> | |
1282 | <!-- </div> --> | |
1283 | </section> | |
1284 | </div> | |
1285 | </div> | |
1286 | </div> | |
1287 | <div id="operation--users-get" class="operation panel" data-traverse-target="operation--users-get"> | |
1288 | <!-- <section class="operation-tags row"> --> | |
1289 | <!-- <div class="doc-copy"> --> | |
1290 | <div class="operation-tags"> | |
1291 | <a class="label" href="#tag-User">User</a> | |
1292 | <!----> | |
1293 | </div> | |
1294 | <!-- </div> --> | |
1295 | <!-- </section> --> | |
1296 | <h2 class="operation-title"> | |
1297 | <span class="operation-name"> | |
1298 | <span class="operation-name">GET</span> | |
1299 | <span class="operation-path">/users</span> | |
1300 | </span> | |
1301 | </h2> | |
1302 | <div class="doc-row"> | |
ab0ee6a1 C |
1303 | <div class="doc-copy"> |
1304 | <section class="swagger-request-params"> | |
1305 | <div class="prop-row prop-group"> | |
1306 | <div class="prop-name"> | |
1307 | <div class="prop-title">start</div> | |
1308 | </div> | |
1309 | <div class="prop-value"> | |
1310 | <p>starting page</p> | |
1311 | </div> | |
1312 | </div> | |
1313 | <div class="prop-row prop-inner"> | |
1314 | <div class="prop-name param-label">type</div> | |
1315 | <div class="prop-value"> | |
1316 | <span class="json-property-type">number</span> | |
1317 | <span class="json-property-range" title="Value limits"></span> | |
1318 | </div> | |
1319 | </div> | |
1320 | <div class="prop-row prop-inner"> | |
1321 | <div class="prop-name param-label">in</div> | |
1322 | <div class="prop-value">query</div> | |
1323 | </div> | |
1324 | <div class="prop-row prop-group"> | |
1325 | <div class="prop-name"> | |
1326 | <div class="prop-title">stop</div> | |
1327 | </div> | |
1328 | <div class="prop-value"> | |
f209b32a | 1329 | <p>stopping page</p> |
ab0ee6a1 C |
1330 | </div> |
1331 | </div> | |
1332 | <div class="prop-row prop-inner"> | |
1333 | <div class="prop-name param-label">type</div> | |
1334 | <div class="prop-value"> | |
1335 | <span class="json-property-type">number</span> | |
1336 | <span class="json-property-range" title="Value limits"></span> | |
1337 | </div> | |
1338 | </div> | |
1339 | <div class="prop-row prop-inner"> | |
1340 | <div class="prop-name param-label">in</div> | |
1341 | <div class="prop-value">query</div> | |
1342 | </div> | |
1343 | <div class="prop-row prop-group"> | |
1344 | <div class="prop-name"> | |
1345 | <div class="prop-title">sort</div> | |
1346 | </div> | |
1347 | <div class="prop-value"> | |
1348 | <p>sorting</p> | |
1349 | </div> | |
1350 | </div> | |
1351 | <div class="prop-row prop-inner"> | |
1352 | <div class="prop-name param-label">type</div> | |
1353 | <div class="prop-value"> | |
1354 | <span class="json-property-type">number</span> | |
1355 | <span class="json-property-range" title="Value limits"></span> | |
1356 | </div> | |
1357 | </div> | |
1358 | <div class="prop-row prop-inner"> | |
1359 | <div class="prop-name param-label">in</div> | |
1360 | <div class="prop-value">query</div> | |
1361 | </div> | |
1362 | </section> | |
1363 | </div> | |
5e1c08eb C |
1364 | <div class="doc-examples"></div> |
1365 | </div> | |
1366 | <div class="doc-row"> | |
1367 | <div class="doc-copy"> | |
1368 | <section class="swagger-responses"> | |
1369 | <div class="prop-row prop-group"> | |
1370 | <div class="prop-name"> | |
1371 | <div class="prop-title">200 OK</div> | |
1372 | <div class="prop-ref"> | |
1373 | <span class="json-schema-ref-array"> | |
1374 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
1375 | </span> | |
1376 | </div> | |
1377 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1378 | </div> | |
1379 | <div class="prop-value"> | |
1380 | <p>successful operation</p> | |
1381 | </div> | |
1382 | </div> | |
1383 | </section> | |
1384 | </div> | |
1385 | <div class="doc-examples"> | |
1386 | <h5>Response Content-Types: | |
1387 | <span>application/json</span> | |
1388 | </h5> | |
1389 | <section> | |
1390 | <h5>Response Example | |
1391 | <span>(200 OK)</span> | |
1392 | </h5> | |
1393 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
1394 | { | |
1395 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1396 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
1397 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1398 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
1399 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
1400 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
1401 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
1402 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1403 | <span class="hljs-attr">"account"</span>: { | |
1404 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1405 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1406 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1407 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1408 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1409 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1410 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1411 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1412 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1413 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1414 | <span class="hljs-attr">"avatar"</span>: { | |
1415 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1416 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1417 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1418 | } | |
1419 | }, | |
1420 | <span class="hljs-attr">"videoChannels"</span>: [ | |
1421 | { | |
1422 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1423 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
1424 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1425 | <span class="hljs-attr">"owner"</span>: { | |
1426 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1427 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
1428 | }, | |
1429 | <span class="hljs-attr">"videos"</span>: [ | |
1430 | { | |
1431 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1432 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
1433 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
1434 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
1435 | <span class="hljs-attr">"category"</span>: { |
1436 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1437 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
1438 | }, | |
1439 | <span class="hljs-attr">"licence"</span>: { | |
1440 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1441 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
1442 | }, | |
1443 | <span class="hljs-attr">"language"</span>: { | |
1444 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1445 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
1446 | }, | |
5e1c08eb C |
1447 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
1448 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
1449 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1450 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
1451 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
1452 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
1453 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
1454 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
1455 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
1456 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
1457 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
1458 | } | |
1459 | ] | |
1460 | } | |
1461 | ] | |
1462 | } | |
1463 | ] | |
1464 | </code></pre> | |
1465 | <!-- </div> --> | |
1466 | </section> | |
1467 | </div> | |
1468 | </div> | |
1469 | </div> | |
1470 | <div id="operation--users--id--delete" class="operation panel" data-traverse-target="operation--users--id--delete"> | |
1471 | <!-- <section class="operation-tags row"> --> | |
1472 | <!-- <div class="doc-copy"> --> | |
1473 | <div class="operation-tags"> | |
1474 | <a class="label" href="#tag-User">User</a> | |
1475 | <!----> | |
1476 | </div> | |
1477 | <!-- </div> --> | |
1478 | <!-- </section> --> | |
1479 | <h2 class="operation-title"> | |
1480 | <span class="operation-name"> | |
1481 | <span class="operation-name">DELETE</span> | |
1482 | <span class="operation-path">/users/{id}</span> | |
1483 | </span> | |
1484 | </h2> | |
1485 | <div class="doc-row"> | |
1486 | <div class="doc-copy"> | |
1487 | <section class="swagger-request-params"> | |
1488 | <div class="prop-row prop-group"> | |
1489 | <div class="prop-name"> | |
1490 | <div class="prop-title">id</div> | |
1491 | <span class="json-property-required"></span> | |
1492 | </div> | |
1493 | <div class="prop-value"> | |
1494 | <p>The user id </p> | |
1495 | </div> | |
1496 | </div> | |
1497 | <div class="prop-row prop-inner"> | |
1498 | <div class="prop-name param-label">type</div> | |
1499 | <div class="prop-value"> | |
1500 | <span class="json-property-type">string</span> | |
1501 | <span class="json-property-range" title="Value limits"></span> | |
1502 | </div> | |
1503 | </div> | |
1504 | <div class="prop-row prop-inner"> | |
1505 | <div class="prop-name param-label">in</div> | |
1506 | <div class="prop-value">path</div> | |
1507 | </div> | |
1508 | </section> | |
1509 | </div> | |
1510 | <div class="doc-examples"></div> | |
1511 | </div> | |
1512 | <div class="doc-row"> | |
1513 | <div class="doc-copy"> | |
1514 | <section class="swagger-responses"> | |
1515 | <div class="prop-row prop-group"> | |
1516 | <div class="prop-name"> | |
1517 | <div class="prop-title">204 No Content</div> | |
1518 | </div> | |
1519 | <div class="prop-value"> | |
1520 | <p>successful operation</p> | |
1521 | </div> | |
1522 | </div> | |
1523 | </section> | |
1524 | </div> | |
1525 | <div class="doc-examples"> | |
1526 | <h5>Response Content-Types: | |
1527 | <span>application/json</span> | |
1528 | </h5> | |
1529 | </div> | |
1530 | </div> | |
1531 | </div> | |
1532 | <div id="operation--users--id--get" class="operation panel" data-traverse-target="operation--users--id--get"> | |
1533 | <!-- <section class="operation-tags row"> --> | |
1534 | <!-- <div class="doc-copy"> --> | |
1535 | <div class="operation-tags"> | |
1536 | <a class="label" href="#tag-User">User</a> | |
1537 | <!----> | |
1538 | </div> | |
1539 | <!-- </div> --> | |
1540 | <!-- </section> --> | |
1541 | <h2 class="operation-title"> | |
1542 | <span class="operation-name"> | |
1543 | <span class="operation-name">GET</span> | |
1544 | <span class="operation-path">/users/{id}</span> | |
1545 | </span> | |
1546 | </h2> | |
1547 | <div class="doc-row"> | |
1548 | <div class="doc-copy"> | |
1549 | <section class="swagger-request-params"> | |
1550 | <div class="prop-row prop-group"> | |
1551 | <div class="prop-name"> | |
1552 | <div class="prop-title">id</div> | |
1553 | <span class="json-property-required"></span> | |
1554 | </div> | |
1555 | <div class="prop-value"> | |
1556 | <p>The user id </p> | |
1557 | </div> | |
1558 | </div> | |
1559 | <div class="prop-row prop-inner"> | |
1560 | <div class="prop-name param-label">type</div> | |
1561 | <div class="prop-value"> | |
1562 | <span class="json-property-type">string</span> | |
1563 | <span class="json-property-range" title="Value limits"></span> | |
1564 | </div> | |
1565 | </div> | |
1566 | <div class="prop-row prop-inner"> | |
1567 | <div class="prop-name param-label">in</div> | |
1568 | <div class="prop-value">path</div> | |
1569 | </div> | |
1570 | </section> | |
1571 | </div> | |
1572 | <div class="doc-examples"></div> | |
1573 | </div> | |
1574 | <div class="doc-row"> | |
1575 | <div class="doc-copy"> | |
1576 | <section class="swagger-responses"> | |
1577 | <div class="prop-row prop-group"> | |
1578 | <div class="prop-name"> | |
1579 | <div class="prop-title">200 OK</div> | |
1580 | <div class="prop-ref"> | |
1581 | <span class=""> | |
1582 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
1583 | </span> | |
1584 | </div> | |
1585 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1586 | </div> | |
1587 | <div class="prop-value"> | |
1588 | <p>successful operation</p> | |
1589 | </div> | |
1590 | </div> | |
1591 | </section> | |
1592 | </div> | |
1593 | <div class="doc-examples"> | |
1594 | <h5>Response Content-Types: | |
1595 | <span>application/json</span> | |
1596 | </h5> | |
1597 | <section> | |
1598 | <h5>Response Example | |
1599 | <span>(200 OK)</span> | |
1600 | </h5> | |
1601 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1602 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1603 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
1604 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1605 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
1606 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
1607 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
1608 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
1609 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1610 | <span class="hljs-attr">"account"</span>: { | |
1611 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1612 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1613 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1614 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1615 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1616 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1617 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1618 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1619 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1620 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1621 | <span class="hljs-attr">"avatar"</span>: { | |
1622 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1623 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1624 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1625 | } | |
1626 | }, | |
1627 | <span class="hljs-attr">"videoChannels"</span>: [ | |
1628 | { | |
1629 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1630 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
1631 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1632 | <span class="hljs-attr">"owner"</span>: { | |
1633 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1634 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
1635 | }, | |
1636 | <span class="hljs-attr">"videos"</span>: [ | |
1637 | { | |
1638 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1639 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
1640 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
1641 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
1642 | <span class="hljs-attr">"category"</span>: { |
1643 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1644 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
1645 | }, | |
1646 | <span class="hljs-attr">"licence"</span>: { | |
1647 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1648 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
1649 | }, | |
1650 | <span class="hljs-attr">"language"</span>: { | |
1651 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1652 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
1653 | }, | |
5e1c08eb C |
1654 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
1655 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
1656 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1657 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
1658 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
1659 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
1660 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
1661 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
1662 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
1663 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
1664 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
1665 | } | |
1666 | ] | |
1667 | } | |
1668 | ] | |
1669 | } | |
1670 | </code></pre> | |
1671 | <!-- </div> --> | |
1672 | </section> | |
1673 | </div> | |
1674 | </div> | |
1675 | </div> | |
1676 | <div id="operation--users--id--put" class="operation panel" data-traverse-target="operation--users--id--put"> | |
1677 | <!-- <section class="operation-tags row"> --> | |
1678 | <!-- <div class="doc-copy"> --> | |
1679 | <div class="operation-tags"> | |
1680 | <a class="label" href="#tag-User">User</a> | |
1681 | <!----> | |
1682 | </div> | |
1683 | <!-- </div> --> | |
1684 | <!-- </section> --> | |
1685 | <h2 class="operation-title"> | |
1686 | <span class="operation-name"> | |
1687 | <span class="operation-name">PUT</span> | |
1688 | <span class="operation-path">/users/{id}</span> | |
1689 | </span> | |
1690 | </h2> | |
1691 | <div class="doc-row"> | |
1692 | <div class="doc-copy"> | |
1693 | <section class="swagger-request-body"> | |
1694 | <div class="prop-row"> | |
1695 | <div class="prop-name"> | |
1696 | <div class="swagger-request-model"> | |
1697 | <span class=""> | |
1698 | <a class="json-schema-ref" href="#/definitions/UpdateUser">UpdateUser</a> | |
1699 | </span> | |
1700 | </div> | |
1701 | </div> | |
1702 | <div class="prop-value columns small-6"> | |
1703 | <!-- <div class="swagger-request-description"> -->undefined | |
1704 | <!-- </div> --> | |
1705 | </div> | |
1706 | </div> | |
1707 | </section> | |
1708 | <section class="swagger-request-params"> | |
1709 | <div class="prop-row prop-group"> | |
1710 | <div class="prop-name"> | |
1711 | <div class="prop-title">id</div> | |
1712 | <span class="json-property-required"></span> | |
1713 | </div> | |
1714 | <div class="prop-value"> | |
1715 | <p>The user id </p> | |
1716 | </div> | |
1717 | </div> | |
1718 | <div class="prop-row prop-inner"> | |
1719 | <div class="prop-name param-label">type</div> | |
1720 | <div class="prop-value"> | |
1721 | <span class="json-property-type">string</span> | |
1722 | <span class="json-property-range" title="Value limits"></span> | |
1723 | </div> | |
1724 | </div> | |
1725 | <div class="prop-row prop-inner"> | |
1726 | <div class="prop-name param-label">in</div> | |
1727 | <div class="prop-value">path</div> | |
1728 | </div> | |
1729 | </section> | |
1730 | </div> | |
1731 | <div class="doc-examples"> | |
1732 | <section> | |
1733 | <h5>Request Content-Types: | |
1734 | <span>application/json</span> | |
1735 | </h5> | |
1736 | <h5>Request Example</h5> | |
1737 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1738 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
1739 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1740 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
1741 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
1742 | } | |
1743 | </code></pre> | |
1744 | <!-- </div> --> | |
1745 | </section> | |
1746 | </div> | |
1747 | </div> | |
1748 | <div class="doc-row"> | |
1749 | <div class="doc-copy"> | |
1750 | <section class="swagger-responses"> | |
1751 | <div class="prop-row prop-group"> | |
1752 | <div class="prop-name"> | |
1753 | <div class="prop-title">204 No Content</div> | |
1754 | </div> | |
1755 | <div class="prop-value"> | |
1756 | <p>successful operation</p> | |
1757 | </div> | |
1758 | </div> | |
1759 | </section> | |
1760 | </div> | |
1761 | <div class="doc-examples"> | |
1762 | <h5>Response Content-Types: | |
1763 | <span>application/json</span> | |
1764 | </h5> | |
1765 | </div> | |
1766 | </div> | |
1767 | </div> | |
1768 | <div id="operation--users-me-get" class="operation panel" data-traverse-target="operation--users-me-get"> | |
1769 | <!-- <section class="operation-tags row"> --> | |
1770 | <!-- <div class="doc-copy"> --> | |
1771 | <div class="operation-tags"> | |
1772 | <a class="label" href="#tag-User">User</a> | |
1773 | <!----> | |
1774 | </div> | |
1775 | <!-- </div> --> | |
1776 | <!-- </section> --> | |
1777 | <h2 class="operation-title"> | |
1778 | <span class="operation-name"> | |
1779 | <span class="operation-name">GET</span> | |
1780 | <span class="operation-path">/users/me</span> | |
1781 | </span> | |
1782 | </h2> | |
1783 | <div class="doc-row"> | |
1784 | <div class="doc-copy"> </div> | |
1785 | <div class="doc-examples"></div> | |
1786 | </div> | |
1787 | <div class="doc-row"> | |
1788 | <div class="doc-copy"> | |
1789 | <section class="swagger-responses"> | |
1790 | <div class="prop-row prop-group"> | |
1791 | <div class="prop-name"> | |
1792 | <div class="prop-title">200 OK</div> | |
1793 | <div class="prop-ref"> | |
1794 | <span class="json-schema-ref-array"> | |
1795 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
1796 | </span> | |
1797 | </div> | |
1798 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1799 | </div> | |
1800 | <div class="prop-value"> | |
1801 | <p>successful operation</p> | |
1802 | </div> | |
1803 | </div> | |
1804 | </section> | |
1805 | </div> | |
1806 | <div class="doc-examples"> | |
1807 | <h5>Response Content-Types: | |
1808 | <span>application/json</span> | |
1809 | </h5> | |
1810 | <section> | |
1811 | <h5>Response Example | |
1812 | <span>(200 OK)</span> | |
1813 | </h5> | |
1814 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
1815 | { | |
1816 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1817 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
1818 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1819 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
1820 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
1821 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
1822 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
1823 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1824 | <span class="hljs-attr">"account"</span>: { | |
1825 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1826 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1827 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1828 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1829 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1830 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1831 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1832 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1833 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1834 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1835 | <span class="hljs-attr">"avatar"</span>: { | |
1836 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1837 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1838 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1839 | } | |
1840 | }, | |
1841 | <span class="hljs-attr">"videoChannels"</span>: [ | |
1842 | { | |
1843 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1844 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
1845 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1846 | <span class="hljs-attr">"owner"</span>: { | |
1847 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1848 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
1849 | }, | |
1850 | <span class="hljs-attr">"videos"</span>: [ | |
1851 | { | |
1852 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1853 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
1854 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
1855 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
1856 | <span class="hljs-attr">"category"</span>: { |
1857 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1858 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
1859 | }, | |
1860 | <span class="hljs-attr">"licence"</span>: { | |
1861 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1862 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
1863 | }, | |
1864 | <span class="hljs-attr">"language"</span>: { | |
1865 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1866 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
1867 | }, | |
5e1c08eb C |
1868 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
1869 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
1870 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1871 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
1872 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
1873 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
1874 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
1875 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
1876 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
1877 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
1878 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
1879 | } | |
1880 | ] | |
1881 | } | |
1882 | ] | |
1883 | } | |
1884 | ] | |
1885 | </code></pre> | |
1886 | <!-- </div> --> | |
1887 | </section> | |
1888 | </div> | |
1889 | </div> | |
1890 | </div> | |
1891 | <div id="operation--users-me-put" class="operation panel" data-traverse-target="operation--users-me-put"> | |
1892 | <!-- <section class="operation-tags row"> --> | |
1893 | <!-- <div class="doc-copy"> --> | |
1894 | <div class="operation-tags"> | |
1895 | <a class="label" href="#tag-User">User</a> | |
1896 | <!----> | |
1897 | </div> | |
1898 | <!-- </div> --> | |
1899 | <!-- </section> --> | |
1900 | <h2 class="operation-title"> | |
1901 | <span class="operation-name"> | |
1902 | <span class="operation-name">PUT</span> | |
1903 | <span class="operation-path">/users/me</span> | |
1904 | </span> | |
1905 | </h2> | |
1906 | <div class="doc-row"> | |
1907 | <div class="doc-copy"> | |
1908 | <section class="swagger-request-body"> | |
1909 | <div class="prop-row"> | |
1910 | <div class="prop-name"> | |
1911 | <div class="swagger-request-model"> | |
1912 | <span class=""> | |
1913 | <a class="json-schema-ref" href="#/definitions/UpdateMe">UpdateMe</a> | |
1914 | </span> | |
1915 | </div> | |
1916 | </div> | |
1917 | <div class="prop-value columns small-6"> | |
1918 | <!-- <div class="swagger-request-description"> -->undefined | |
1919 | <!-- </div> --> | |
1920 | </div> | |
1921 | </div> | |
1922 | </section> | |
1923 | </div> | |
1924 | <div class="doc-examples"> | |
1925 | <section> | |
1926 | <h5>Request Content-Types: | |
1927 | <span>application/json</span> | |
1928 | </h5> | |
1929 | <h5>Request Example</h5> | |
1930 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1931 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
1932 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1933 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>, | |
1934 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span> | |
1935 | } | |
1936 | </code></pre> | |
1937 | <!-- </div> --> | |
1938 | </section> | |
1939 | </div> | |
1940 | </div> | |
1941 | <div class="doc-row"> | |
1942 | <div class="doc-copy"> | |
1943 | <section class="swagger-responses"> | |
1944 | <div class="prop-row prop-group"> | |
1945 | <div class="prop-name"> | |
1946 | <div class="prop-title">204 No Content</div> | |
1947 | </div> | |
1948 | <div class="prop-value"> | |
1949 | <p>successful operation</p> | |
1950 | </div> | |
1951 | </div> | |
1952 | </section> | |
1953 | </div> | |
1954 | <div class="doc-examples"> | |
1955 | <h5>Response Content-Types: | |
1956 | <span>application/json</span> | |
1957 | </h5> | |
1958 | </div> | |
1959 | </div> | |
1960 | </div> | |
1961 | <div id="operation--users-me-video-quota-used-get" class="operation panel" data-traverse-target="operation--users-me-video-quota-used-get"> | |
1962 | <!-- <section class="operation-tags row"> --> | |
1963 | <!-- <div class="doc-copy"> --> | |
1964 | <div class="operation-tags"> | |
1965 | <a class="label" href="#tag-User">User</a> | |
1966 | <!----> | |
1967 | </div> | |
1968 | <!-- </div> --> | |
1969 | <!-- </section> --> | |
1970 | <h2 class="operation-title"> | |
1971 | <span class="operation-name"> | |
1972 | <span class="operation-name">GET</span> | |
1973 | <span class="operation-path">/users/me/video-quota-used</span> | |
1974 | </span> | |
1975 | </h2> | |
1976 | <div class="doc-row"> | |
1977 | <div class="doc-copy"> </div> | |
1978 | <div class="doc-examples"></div> | |
1979 | </div> | |
1980 | <div class="doc-row"> | |
1981 | <div class="doc-copy"> | |
1982 | <section class="swagger-responses"> | |
1983 | <div class="prop-row prop-group"> | |
1984 | <div class="prop-name"> | |
1985 | <div class="prop-title">200 OK</div> | |
1986 | <div class="prop-ref"></div> | |
1987 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1988 | </div> | |
1989 | <div class="prop-value"> | |
1990 | <p>successful operation</p> | |
1991 | </div> | |
1992 | </div> | |
1993 | </section> | |
1994 | </div> | |
1995 | <div class="doc-examples"> | |
1996 | <h5>Response Content-Types: | |
1997 | <span>application/json</span> | |
1998 | </h5> | |
1999 | <section> | |
2000 | <h5>Response Example | |
2001 | <span>(200 OK)</span> | |
2002 | </h5> | |
2003 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"number"</span> | |
2004 | </code></pre> | |
2005 | <!-- </div> --> | |
2006 | </section> | |
2007 | </div> | |
2008 | </div> | |
2009 | </div> | |
2010 | <div id="operation--users-me-videos--videoId--rating-get" class="operation panel" data-traverse-target="operation--users-me-videos--videoId--rating-get"> | |
2011 | <!-- <section class="operation-tags row"> --> | |
2012 | <!-- <div class="doc-copy"> --> | |
2013 | <div class="operation-tags"> | |
2014 | <a class="label" href="#tag-User">User</a> | |
2015 | <!----> | |
2016 | </div> | |
2017 | <!-- </div> --> | |
2018 | <!-- </section> --> | |
2019 | <h2 class="operation-title"> | |
2020 | <span class="operation-name"> | |
2021 | <span class="operation-name">GET</span> | |
2022 | <span class="operation-path">/users/me/videos/{videoId}/rating</span> | |
2023 | </span> | |
2024 | </h2> | |
2025 | <div class="doc-row"> | |
2026 | <div class="doc-copy"> | |
2027 | <section class="swagger-request-params"> | |
2028 | <div class="prop-row prop-group"> | |
2029 | <div class="prop-name"> | |
2030 | <div class="prop-title">videoId</div> | |
2031 | <span class="json-property-required"></span> | |
2032 | </div> | |
2033 | <div class="prop-value"> | |
2034 | <p>The video id </p> | |
2035 | </div> | |
2036 | </div> | |
2037 | <div class="prop-row prop-inner"> | |
2038 | <div class="prop-name param-label">type</div> | |
2039 | <div class="prop-value"> | |
2040 | <span class="json-property-type">string</span> | |
2041 | <span class="json-property-range" title="Value limits"></span> | |
2042 | </div> | |
2043 | </div> | |
2044 | <div class="prop-row prop-inner"> | |
2045 | <div class="prop-name param-label">in</div> | |
2046 | <div class="prop-value">path</div> | |
2047 | </div> | |
2048 | </section> | |
2049 | </div> | |
2050 | <div class="doc-examples"></div> | |
2051 | </div> | |
2052 | <div class="doc-row"> | |
2053 | <div class="doc-copy"> | |
2054 | <section class="swagger-responses"> | |
2055 | <div class="prop-row prop-group"> | |
2056 | <div class="prop-name"> | |
2057 | <div class="prop-title">200 OK</div> | |
2058 | <div class="prop-ref"> | |
2059 | <span class=""> | |
2060 | <a class="json-schema-ref" href="#/definitions/GetMeVideoRating">GetMeVideoRating</a> | |
2061 | </span> | |
2062 | </div> | |
2063 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2064 | </div> | |
2065 | <div class="prop-value"> | |
2066 | <p>successful operation</p> | |
2067 | </div> | |
2068 | </div> | |
2069 | </section> | |
2070 | </div> | |
2071 | <div class="doc-examples"> | |
2072 | <h5>Response Content-Types: | |
2073 | <span>application/json</span> | |
2074 | </h5> | |
2075 | <section> | |
2076 | <h5>Response Example | |
2077 | <span>(200 OK)</span> | |
2078 | </h5> | |
2079 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
2080 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
2081 | <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span> | |
2082 | } | |
2083 | </code></pre> | |
2084 | <!-- </div> --> | |
2085 | </section> | |
2086 | </div> | |
2087 | </div> | |
2088 | </div> | |
2089 | <div id="operation--users-me-videos-get" class="operation panel" data-traverse-target="operation--users-me-videos-get"> | |
2090 | <!-- <section class="operation-tags row"> --> | |
2091 | <!-- <div class="doc-copy"> --> | |
2092 | <div class="operation-tags"> | |
2093 | <a class="label" href="#tag-User">User</a> | |
2094 | <!----> | |
2095 | </div> | |
2096 | <!-- </div> --> | |
2097 | <!-- </section> --> | |
2098 | <h2 class="operation-title"> | |
2099 | <span class="operation-name"> | |
2100 | <span class="operation-name">GET</span> | |
2101 | <span class="operation-path">/users/me/videos</span> | |
2102 | </span> | |
2103 | </h2> | |
2104 | <div class="doc-row"> | |
ab0ee6a1 C |
2105 | <div class="doc-copy"> |
2106 | <section class="swagger-request-params"> | |
2107 | <div class="prop-row prop-group"> | |
2108 | <div class="prop-name"> | |
2109 | <div class="prop-title">start</div> | |
2110 | </div> | |
2111 | <div class="prop-value"> | |
2112 | <p>starting page</p> | |
2113 | </div> | |
2114 | </div> | |
2115 | <div class="prop-row prop-inner"> | |
2116 | <div class="prop-name param-label">type</div> | |
2117 | <div class="prop-value"> | |
2118 | <span class="json-property-type">number</span> | |
2119 | <span class="json-property-range" title="Value limits"></span> | |
2120 | </div> | |
2121 | </div> | |
2122 | <div class="prop-row prop-inner"> | |
2123 | <div class="prop-name param-label">in</div> | |
2124 | <div class="prop-value">query</div> | |
2125 | </div> | |
2126 | <div class="prop-row prop-group"> | |
2127 | <div class="prop-name"> | |
2128 | <div class="prop-title">stop</div> | |
2129 | </div> | |
2130 | <div class="prop-value"> | |
f209b32a | 2131 | <p>stopping page</p> |
ab0ee6a1 C |
2132 | </div> |
2133 | </div> | |
2134 | <div class="prop-row prop-inner"> | |
2135 | <div class="prop-name param-label">type</div> | |
2136 | <div class="prop-value"> | |
2137 | <span class="json-property-type">number</span> | |
2138 | <span class="json-property-range" title="Value limits"></span> | |
2139 | </div> | |
2140 | </div> | |
2141 | <div class="prop-row prop-inner"> | |
2142 | <div class="prop-name param-label">in</div> | |
2143 | <div class="prop-value">query</div> | |
2144 | </div> | |
2145 | <div class="prop-row prop-group"> | |
2146 | <div class="prop-name"> | |
2147 | <div class="prop-title">sort</div> | |
2148 | </div> | |
2149 | <div class="prop-value"> | |
2150 | <p>sorting</p> | |
2151 | </div> | |
2152 | </div> | |
2153 | <div class="prop-row prop-inner"> | |
2154 | <div class="prop-name param-label">type</div> | |
2155 | <div class="prop-value"> | |
2156 | <span class="json-property-type">number</span> | |
2157 | <span class="json-property-range" title="Value limits"></span> | |
2158 | </div> | |
2159 | </div> | |
2160 | <div class="prop-row prop-inner"> | |
2161 | <div class="prop-name param-label">in</div> | |
2162 | <div class="prop-value">query</div> | |
2163 | </div> | |
2164 | </section> | |
2165 | </div> | |
5e1c08eb C |
2166 | <div class="doc-examples"></div> |
2167 | </div> | |
2168 | <div class="doc-row"> | |
2169 | <div class="doc-copy"> | |
2170 | <section class="swagger-responses"> | |
2171 | <div class="prop-row prop-group"> | |
2172 | <div class="prop-name"> | |
2173 | <div class="prop-title">200 OK</div> | |
2174 | <div class="prop-ref"> | |
2175 | <span class="json-schema-ref-array"> | |
2176 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
2177 | </span> | |
2178 | </div> | |
2179 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2180 | </div> | |
2181 | <div class="prop-value"> | |
2182 | <p>successful operation</p> | |
2183 | </div> | |
2184 | </div> | |
2185 | </section> | |
2186 | </div> | |
2187 | <div class="doc-examples"> | |
2188 | <h5>Response Content-Types: | |
2189 | <span>application/json</span> | |
2190 | </h5> | |
2191 | <section> | |
2192 | <h5>Response Example | |
2193 | <span>(200 OK)</span> | |
2194 | </h5> | |
2195 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2196 | { | |
2197 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2198 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
2199 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
2200 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
2201 | <span class="hljs-attr">"category"</span>: { |
2202 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2203 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2204 | }, | |
2205 | <span class="hljs-attr">"licence"</span>: { | |
2206 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2207 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2208 | }, | |
2209 | <span class="hljs-attr">"language"</span>: { | |
2210 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2211 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2212 | }, | |
5e1c08eb C |
2213 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
2214 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
2215 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
2216 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
2217 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
2218 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
2219 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
2220 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
2221 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
2222 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
2223 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
2224 | } | |
2225 | ] | |
2226 | </code></pre> | |
2227 | <!-- </div> --> | |
2228 | </section> | |
2229 | </div> | |
2230 | </div> | |
2231 | </div> | |
2232 | <div id="operation--users-register-post" class="operation panel" data-traverse-target="operation--users-register-post"> | |
2233 | <!-- <section class="operation-tags row"> --> | |
2234 | <!-- <div class="doc-copy"> --> | |
2235 | <div class="operation-tags"> | |
2236 | <a class="label" href="#tag-User">User</a> | |
2237 | <!----> | |
2238 | </div> | |
2239 | <!-- </div> --> | |
2240 | <!-- </section> --> | |
2241 | <h2 class="operation-title"> | |
2242 | <span class="operation-name"> | |
2243 | <span class="operation-name">POST</span> | |
2244 | <span class="operation-path">/users/register</span> | |
2245 | </span> | |
2246 | </h2> | |
2247 | <div class="doc-row"> | |
2248 | <div class="doc-copy"> | |
2249 | <section class="swagger-request-body"> | |
2250 | <div class="prop-row"> | |
2251 | <div class="prop-name"> | |
2252 | <div class="swagger-request-model"> | |
2253 | <span class=""> | |
2254 | <a class="json-schema-ref" href="#/definitions/RegisterUser">RegisterUser</a> | |
2255 | </span> | |
2256 | </div> | |
2257 | </div> | |
2258 | <div class="prop-value columns small-6"> | |
2259 | <!-- <div class="swagger-request-description"> -->undefined | |
2260 | <!-- </div> --> | |
2261 | </div> | |
2262 | </div> | |
2263 | </section> | |
2264 | </div> | |
2265 | <div class="doc-examples"> | |
2266 | <section> | |
2267 | <h5>Request Content-Types: | |
2268 | <span>application/json</span> | |
2269 | </h5> | |
2270 | <h5>Request Example</h5> | |
2271 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
2272 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
2273 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
2274 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span> | |
2275 | } | |
2276 | </code></pre> | |
2277 | <!-- </div> --> | |
2278 | </section> | |
2279 | </div> | |
2280 | </div> | |
2281 | <div class="doc-row"> | |
2282 | <div class="doc-copy"> | |
2283 | <section class="swagger-responses"> | |
2284 | <div class="prop-row prop-group"> | |
2285 | <div class="prop-name"> | |
2286 | <div class="prop-title">204 No Content</div> | |
2287 | </div> | |
2288 | <div class="prop-value"> | |
2289 | <p>successful operation</p> | |
2290 | </div> | |
2291 | </div> | |
2292 | </section> | |
2293 | </div> | |
2294 | <div class="doc-examples"> | |
2295 | <h5>Response Content-Types: | |
2296 | <span>application/json</span> | |
2297 | </h5> | |
2298 | </div> | |
2299 | </div> | |
2300 | </div> | |
2301 | <div id="operation--users-me-avatar-pick-post" class="operation panel" data-traverse-target="operation--users-me-avatar-pick-post"> | |
2302 | <!-- <section class="operation-tags row"> --> | |
2303 | <!-- <div class="doc-copy"> --> | |
2304 | <div class="operation-tags"> | |
2305 | <a class="label" href="#tag-User">User</a> | |
2306 | <!----> | |
2307 | </div> | |
2308 | <!-- </div> --> | |
2309 | <!-- </section> --> | |
2310 | <h2 class="operation-title"> | |
2311 | <span class="operation-name"> | |
2312 | <span class="operation-name">POST</span> | |
2313 | <span class="operation-path">/users/me/avatar/pick</span> | |
2314 | </span> | |
2315 | </h2> | |
2316 | <div class="doc-row"> | |
2317 | <div class="doc-copy"> | |
2318 | <section class="swagger-request-params"> | |
2319 | <div class="prop-row prop-group"> | |
2320 | <div class="prop-name"> | |
2321 | <div class="prop-title">avatarfile</div> | |
2322 | </div> | |
2323 | <div class="prop-value"> | |
2324 | <p>The file to upload.</p> | |
2325 | </div> | |
2326 | </div> | |
2327 | <div class="prop-row prop-inner"> | |
2328 | <div class="prop-name param-label">type</div> | |
2329 | <div class="prop-value"> | |
2330 | <span class="json-property-type">file</span> | |
2331 | <span class="json-property-range" title="Value limits"></span> | |
2332 | </div> | |
2333 | </div> | |
2334 | <div class="prop-row prop-inner"> | |
2335 | <div class="prop-name param-label">in</div> | |
2336 | <div class="prop-value">formData</div> | |
2337 | </div> | |
2338 | </section> | |
2339 | </div> | |
2340 | <div class="doc-examples"></div> | |
2341 | </div> | |
2342 | <div class="doc-row"> | |
2343 | <div class="doc-copy"> | |
2344 | <section class="swagger-responses"> | |
2345 | <div class="prop-row prop-group"> | |
2346 | <div class="prop-name"> | |
2347 | <div class="prop-title">200 OK</div> | |
2348 | <div class="prop-ref"> | |
2349 | <span class=""> | |
2350 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | |
2351 | </span> | |
2352 | </div> | |
2353 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2354 | </div> | |
2355 | <div class="prop-value"> | |
2356 | <p>successful operation</p> | |
2357 | </div> | |
2358 | </div> | |
2359 | </section> | |
2360 | </div> | |
2361 | <div class="doc-examples"> | |
2362 | <h5>Response Content-Types: | |
2363 | <span>application/json</span> | |
2364 | </h5> | |
2365 | <section> | |
2366 | <h5>Response Example | |
2367 | <span>(200 OK)</span> | |
2368 | </h5> | |
2369 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
2370 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
2371 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
2372 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
2373 | } | |
2374 | </code></pre> | |
2375 | <!-- </div> --> | |
2376 | </section> | |
2377 | </div> | |
ab0ee6a1 C |
2378 | </div> |
2379 | </div> | |
2380 | <h1 id="tag-Video" class="swagger-summary-tag" data-traverse-target="tag-Video">Video</h1> | |
2381 | <div id="operation--videos-get" class="operation panel" data-traverse-target="operation--videos-get"> | |
2382 | <!-- <section class="operation-tags row"> --> | |
2383 | <!-- <div class="doc-copy"> --> | |
2384 | <div class="operation-tags"> | |
2385 | <a class="label" href="#tag-Video">Video</a> | |
2386 | <!----> | |
2387 | </div> | |
2388 | <!-- </div> --> | |
2389 | <!-- </section> --> | |
2390 | <h2 class="operation-title"> | |
2391 | <span class="operation-name"> | |
2392 | <span class="operation-name">GET</span> | |
2393 | <span class="operation-path">/videos</span> | |
2394 | </span> | |
2395 | </h2> | |
2396 | <div class="doc-row"> | |
2397 | <div class="doc-copy"> | |
2398 | <section class="swagger-request-params"> | |
2399 | <div class="prop-row prop-group"> | |
2400 | <div class="prop-name"> | |
2401 | <div class="prop-title">start</div> | |
2402 | </div> | |
2403 | <div class="prop-value"> | |
2404 | <p>starting page</p> | |
2405 | </div> | |
2406 | </div> | |
2407 | <div class="prop-row prop-inner"> | |
2408 | <div class="prop-name param-label">type</div> | |
2409 | <div class="prop-value"> | |
2410 | <span class="json-property-type">number</span> | |
2411 | <span class="json-property-range" title="Value limits"></span> | |
2412 | </div> | |
2413 | </div> | |
2414 | <div class="prop-row prop-inner"> | |
2415 | <div class="prop-name param-label">in</div> | |
2416 | <div class="prop-value">query</div> | |
2417 | </div> | |
2418 | <div class="prop-row prop-group"> | |
2419 | <div class="prop-name"> | |
2420 | <div class="prop-title">stop</div> | |
2421 | </div> | |
2422 | <div class="prop-value"> | |
f209b32a | 2423 | <p>stopping page</p> |
ab0ee6a1 C |
2424 | </div> |
2425 | </div> | |
2426 | <div class="prop-row prop-inner"> | |
2427 | <div class="prop-name param-label">type</div> | |
2428 | <div class="prop-value"> | |
2429 | <span class="json-property-type">number</span> | |
2430 | <span class="json-property-range" title="Value limits"></span> | |
2431 | </div> | |
2432 | </div> | |
2433 | <div class="prop-row prop-inner"> | |
2434 | <div class="prop-name param-label">in</div> | |
2435 | <div class="prop-value">query</div> | |
2436 | </div> | |
2437 | <div class="prop-row prop-group"> | |
2438 | <div class="prop-name"> | |
2439 | <div class="prop-title">sort</div> | |
2440 | </div> | |
2441 | <div class="prop-value"> | |
2442 | <p>sorting</p> | |
2443 | </div> | |
2444 | </div> | |
2445 | <div class="prop-row prop-inner"> | |
2446 | <div class="prop-name param-label">type</div> | |
2447 | <div class="prop-value"> | |
2448 | <span class="json-property-type">number</span> | |
2449 | <span class="json-property-range" title="Value limits"></span> | |
2450 | </div> | |
2451 | </div> | |
2452 | <div class="prop-row prop-inner"> | |
2453 | <div class="prop-name param-label">in</div> | |
2454 | <div class="prop-value">query</div> | |
2455 | </div> | |
2456 | </section> | |
2457 | </div> | |
5e1c08eb C |
2458 | <div class="doc-examples"></div> |
2459 | </div> | |
2460 | <div class="doc-row"> | |
2461 | <div class="doc-copy"> | |
2462 | <section class="swagger-responses"> | |
2463 | <div class="prop-row prop-group"> | |
2464 | <div class="prop-name"> | |
2465 | <div class="prop-title">200 OK</div> | |
2466 | <div class="prop-ref"> | |
2467 | <span class="json-schema-ref-array"> | |
2468 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
2469 | </span> | |
2470 | </div> | |
2471 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2472 | </div> | |
2473 | <div class="prop-value"> | |
2474 | <p>successful operation</p> | |
2475 | </div> | |
2476 | </div> | |
2477 | </section> | |
2478 | </div> | |
2479 | <div class="doc-examples"> | |
2480 | <h5>Response Content-Types: | |
2481 | <span>application/json</span> | |
2482 | </h5> | |
2483 | <section> | |
2484 | <h5>Response Example | |
2485 | <span>(200 OK)</span> | |
2486 | </h5> | |
2487 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2488 | { | |
2489 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2490 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
2491 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
2492 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
2493 | <span class="hljs-attr">"category"</span>: { |
2494 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2495 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2496 | }, | |
2497 | <span class="hljs-attr">"licence"</span>: { | |
2498 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2499 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2500 | }, | |
2501 | <span class="hljs-attr">"language"</span>: { | |
2502 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2503 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2504 | }, | |
5e1c08eb C |
2505 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
2506 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
2507 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
2508 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
2509 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
2510 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
2511 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
2512 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
2513 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
2514 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
2515 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
2516 | } | |
2517 | ] | |
2518 | </code></pre> | |
2519 | <!-- </div> --> | |
2520 | </section> | |
2521 | </div> | |
2522 | </div> | |
2523 | </div> | |
ab0ee6a1 | 2524 | <div id="operation--videos-categories-get" class="operation panel" data-traverse-target="operation--videos-categories-get"> |
5e1c08eb C |
2525 | <!-- <section class="operation-tags row"> --> |
2526 | <!-- <div class="doc-copy"> --> | |
2527 | <div class="operation-tags"> | |
2528 | <a class="label" href="#tag-Video">Video</a> | |
2529 | <!----> | |
2530 | </div> | |
2531 | <!-- </div> --> | |
2532 | <!-- </section> --> | |
2533 | <h2 class="operation-title"> | |
2534 | <span class="operation-name"> | |
2535 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 2536 | <span class="operation-path">/videos/categories</span> |
5e1c08eb C |
2537 | </span> |
2538 | </h2> | |
2539 | <div class="doc-row"> | |
2540 | <div class="doc-copy"> </div> | |
2541 | <div class="doc-examples"></div> | |
2542 | </div> | |
2543 | <div class="doc-row"> | |
2544 | <div class="doc-copy"> | |
2545 | <section class="swagger-responses"> | |
2546 | <div class="prop-row prop-group"> | |
2547 | <div class="prop-name"> | |
2548 | <div class="prop-title">200 OK</div> | |
2549 | <div class="prop-ref"></div> | |
2550 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2551 | </div> | |
2552 | <div class="prop-value"> | |
2553 | <p>successful operation</p> | |
2554 | </div> | |
2555 | </div> | |
2556 | </section> | |
2557 | </div> | |
2558 | <div class="doc-examples"> | |
2559 | <h5>Response Content-Types: | |
2560 | <span>application/json</span> | |
2561 | </h5> | |
2562 | <section> | |
2563 | <h5>Response Example | |
2564 | <span>(200 OK)</span> | |
2565 | </h5> | |
2566 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2567 | <span class="hljs-string">"string"</span> | |
2568 | ] | |
2569 | </code></pre> | |
2570 | <!-- </div> --> | |
2571 | </section> | |
2572 | </div> | |
2573 | </div> | |
2574 | </div> | |
ab0ee6a1 | 2575 | <div id="operation--videos-licences-get" class="operation panel" data-traverse-target="operation--videos-licences-get"> |
5e1c08eb C |
2576 | <!-- <section class="operation-tags row"> --> |
2577 | <!-- <div class="doc-copy"> --> | |
2578 | <div class="operation-tags"> | |
2579 | <a class="label" href="#tag-Video">Video</a> | |
2580 | <!----> | |
2581 | </div> | |
2582 | <!-- </div> --> | |
2583 | <!-- </section> --> | |
2584 | <h2 class="operation-title"> | |
2585 | <span class="operation-name"> | |
2586 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 2587 | <span class="operation-path">/videos/licences</span> |
5e1c08eb C |
2588 | </span> |
2589 | </h2> | |
2590 | <div class="doc-row"> | |
2591 | <div class="doc-copy"> </div> | |
2592 | <div class="doc-examples"></div> | |
2593 | </div> | |
2594 | <div class="doc-row"> | |
2595 | <div class="doc-copy"> | |
2596 | <section class="swagger-responses"> | |
2597 | <div class="prop-row prop-group"> | |
2598 | <div class="prop-name"> | |
2599 | <div class="prop-title">200 OK</div> | |
2600 | <div class="prop-ref"></div> | |
2601 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2602 | </div> | |
2603 | <div class="prop-value"> | |
2604 | <p>successful operation</p> | |
2605 | </div> | |
2606 | </div> | |
2607 | </section> | |
2608 | </div> | |
2609 | <div class="doc-examples"> | |
2610 | <h5>Response Content-Types: | |
2611 | <span>application/json</span> | |
2612 | </h5> | |
2613 | <section> | |
2614 | <h5>Response Example | |
2615 | <span>(200 OK)</span> | |
2616 | </h5> | |
2617 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2618 | <span class="hljs-string">"string"</span> | |
2619 | ] | |
2620 | </code></pre> | |
2621 | <!-- </div> --> | |
2622 | </section> | |
2623 | </div> | |
2624 | </div> | |
2625 | </div> | |
ab0ee6a1 | 2626 | <div id="operation--videos-languages-get" class="operation panel" data-traverse-target="operation--videos-languages-get"> |
5e1c08eb C |
2627 | <!-- <section class="operation-tags row"> --> |
2628 | <!-- <div class="doc-copy"> --> | |
2629 | <div class="operation-tags"> | |
2630 | <a class="label" href="#tag-Video">Video</a> | |
2631 | <!----> | |
2632 | </div> | |
2633 | <!-- </div> --> | |
2634 | <!-- </section> --> | |
2635 | <h2 class="operation-title"> | |
2636 | <span class="operation-name"> | |
2637 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 2638 | <span class="operation-path">/videos/languages</span> |
5e1c08eb C |
2639 | </span> |
2640 | </h2> | |
2641 | <div class="doc-row"> | |
2642 | <div class="doc-copy"> </div> | |
2643 | <div class="doc-examples"></div> | |
2644 | </div> | |
2645 | <div class="doc-row"> | |
2646 | <div class="doc-copy"> | |
2647 | <section class="swagger-responses"> | |
2648 | <div class="prop-row prop-group"> | |
2649 | <div class="prop-name"> | |
2650 | <div class="prop-title">200 OK</div> | |
2651 | <div class="prop-ref"></div> | |
2652 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2653 | </div> | |
2654 | <div class="prop-value"> | |
2655 | <p>successful operation</p> | |
2656 | </div> | |
2657 | </div> | |
2658 | </section> | |
2659 | </div> | |
2660 | <div class="doc-examples"> | |
2661 | <h5>Response Content-Types: | |
2662 | <span>application/json</span> | |
2663 | </h5> | |
2664 | <section> | |
2665 | <h5>Response Example | |
2666 | <span>(200 OK)</span> | |
2667 | </h5> | |
2668 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2669 | <span class="hljs-string">"string"</span> | |
2670 | ] | |
2671 | </code></pre> | |
2672 | <!-- </div> --> | |
2673 | </section> | |
2674 | </div> | |
2675 | </div> | |
2676 | </div> | |
ab0ee6a1 | 2677 | <div id="operation--videos-privacies-get" class="operation panel" data-traverse-target="operation--videos-privacies-get"> |
5e1c08eb C |
2678 | <!-- <section class="operation-tags row"> --> |
2679 | <!-- <div class="doc-copy"> --> | |
2680 | <div class="operation-tags"> | |
2681 | <a class="label" href="#tag-Video">Video</a> | |
2682 | <!----> | |
2683 | </div> | |
2684 | <!-- </div> --> | |
2685 | <!-- </section> --> | |
2686 | <h2 class="operation-title"> | |
2687 | <span class="operation-name"> | |
2688 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 2689 | <span class="operation-path">/videos/privacies</span> |
5e1c08eb C |
2690 | </span> |
2691 | </h2> | |
2692 | <div class="doc-row"> | |
2693 | <div class="doc-copy"> </div> | |
2694 | <div class="doc-examples"></div> | |
2695 | </div> | |
2696 | <div class="doc-row"> | |
2697 | <div class="doc-copy"> | |
2698 | <section class="swagger-responses"> | |
2699 | <div class="prop-row prop-group"> | |
2700 | <div class="prop-name"> | |
2701 | <div class="prop-title">200 OK</div> | |
2702 | <div class="prop-ref"></div> | |
2703 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2704 | </div> | |
2705 | <div class="prop-value"> | |
2706 | <p>successful operation</p> | |
2707 | </div> | |
2708 | </div> | |
2709 | </section> | |
2710 | </div> | |
2711 | <div class="doc-examples"> | |
2712 | <h5>Response Content-Types: | |
2713 | <span>application/json</span> | |
2714 | </h5> | |
2715 | <section> | |
2716 | <h5>Response Example | |
2717 | <span>(200 OK)</span> | |
2718 | </h5> | |
2719 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2720 | <span class="hljs-string">"string"</span> | |
2721 | ] | |
2722 | </code></pre> | |
2723 | <!-- </div> --> | |
2724 | </section> | |
2725 | </div> | |
2726 | </div> | |
2727 | </div> | |
ab0ee6a1 | 2728 | <div id="operation--videos-search-get" class="operation panel" data-traverse-target="operation--videos-search-get"> |
5e1c08eb C |
2729 | <!-- <section class="operation-tags row"> --> |
2730 | <!-- <div class="doc-copy"> --> | |
2731 | <div class="operation-tags"> | |
2732 | <a class="label" href="#tag-Video">Video</a> | |
2733 | <!----> | |
2734 | </div> | |
2735 | <!-- </div> --> | |
2736 | <!-- </section> --> | |
2737 | <h2 class="operation-title"> | |
2738 | <span class="operation-name"> | |
2739 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 2740 | <span class="operation-path">/videos/search</span> |
5e1c08eb C |
2741 | </span> |
2742 | </h2> | |
2743 | <div class="doc-row"> | |
ab0ee6a1 C |
2744 | <div class="doc-copy"> |
2745 | <section class="swagger-request-params"> | |
2746 | <div class="prop-row prop-group"> | |
2747 | <div class="prop-name"> | |
2748 | <div class="prop-title">start</div> | |
2749 | </div> | |
2750 | <div class="prop-value"> | |
2751 | <p>starting page</p> | |
2752 | </div> | |
2753 | </div> | |
2754 | <div class="prop-row prop-inner"> | |
2755 | <div class="prop-name param-label">type</div> | |
2756 | <div class="prop-value"> | |
2757 | <span class="json-property-type">number</span> | |
2758 | <span class="json-property-range" title="Value limits"></span> | |
2759 | </div> | |
2760 | </div> | |
2761 | <div class="prop-row prop-inner"> | |
2762 | <div class="prop-name param-label">in</div> | |
2763 | <div class="prop-value">query</div> | |
2764 | </div> | |
2765 | <div class="prop-row prop-group"> | |
2766 | <div class="prop-name"> | |
2767 | <div class="prop-title">stop</div> | |
2768 | </div> | |
2769 | <div class="prop-value"> | |
f209b32a | 2770 | <p>stopping page</p> |
ab0ee6a1 C |
2771 | </div> |
2772 | </div> | |
2773 | <div class="prop-row prop-inner"> | |
2774 | <div class="prop-name param-label">type</div> | |
2775 | <div class="prop-value"> | |
2776 | <span class="json-property-type">number</span> | |
2777 | <span class="json-property-range" title="Value limits"></span> | |
2778 | </div> | |
2779 | </div> | |
2780 | <div class="prop-row prop-inner"> | |
2781 | <div class="prop-name param-label">in</div> | |
2782 | <div class="prop-value">query</div> | |
2783 | </div> | |
2784 | <div class="prop-row prop-group"> | |
2785 | <div class="prop-name"> | |
2786 | <div class="prop-title">sort</div> | |
2787 | </div> | |
2788 | <div class="prop-value"> | |
2789 | <p>sorting</p> | |
2790 | </div> | |
2791 | </div> | |
2792 | <div class="prop-row prop-inner"> | |
2793 | <div class="prop-name param-label">type</div> | |
2794 | <div class="prop-value"> | |
2795 | <span class="json-property-type">number</span> | |
2796 | <span class="json-property-range" title="Value limits"></span> | |
2797 | </div> | |
2798 | </div> | |
2799 | <div class="prop-row prop-inner"> | |
2800 | <div class="prop-name param-label">in</div> | |
2801 | <div class="prop-value">query</div> | |
2802 | </div> | |
2803 | </section> | |
2804 | </div> | |
5e1c08eb C |
2805 | <div class="doc-examples"></div> |
2806 | </div> | |
2807 | <div class="doc-row"> | |
2808 | <div class="doc-copy"> | |
2809 | <section class="swagger-responses"> | |
2810 | <div class="prop-row prop-group"> | |
2811 | <div class="prop-name"> | |
2812 | <div class="prop-title">200 OK</div> | |
2813 | <div class="prop-ref"> | |
2814 | <span class="json-schema-ref-array"> | |
2815 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
2816 | </span> | |
2817 | </div> | |
2818 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2819 | </div> | |
2820 | <div class="prop-value"> | |
2821 | <p>successful operation</p> | |
2822 | </div> | |
2823 | </div> | |
2824 | </section> | |
2825 | </div> | |
2826 | <div class="doc-examples"> | |
2827 | <h5>Response Content-Types: | |
2828 | <span>application/json</span> | |
2829 | </h5> | |
2830 | <section> | |
2831 | <h5>Response Example | |
2832 | <span>(200 OK)</span> | |
2833 | </h5> | |
2834 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2835 | { | |
2836 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2837 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
2838 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
2839 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
2840 | <span class="hljs-attr">"category"</span>: { |
2841 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2842 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2843 | }, | |
2844 | <span class="hljs-attr">"licence"</span>: { | |
2845 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2846 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2847 | }, | |
2848 | <span class="hljs-attr">"language"</span>: { | |
2849 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2850 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2851 | }, | |
5e1c08eb C |
2852 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
2853 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
2854 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
2855 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
2856 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
2857 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
2858 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
2859 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
2860 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
2861 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
2862 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
2863 | } | |
2864 | ] | |
2865 | </code></pre> | |
2866 | <!-- </div> --> | |
2867 | </section> | |
2868 | </div> | |
2869 | </div> | |
2870 | </div> | |
ab0ee6a1 | 2871 | <div id="operation--videos--id--put" class="operation panel" data-traverse-target="operation--videos--id--put"> |
5e1c08eb C |
2872 | <!-- <section class="operation-tags row"> --> |
2873 | <!-- <div class="doc-copy"> --> | |
2874 | <div class="operation-tags"> | |
2875 | <a class="label" href="#tag-Video">Video</a> | |
2876 | <!----> | |
2877 | </div> | |
2878 | <!-- </div> --> | |
2879 | <!-- </section> --> | |
2880 | <h2 class="operation-title"> | |
2881 | <span class="operation-name"> | |
2882 | <span class="operation-name">PUT</span> | |
ab0ee6a1 | 2883 | <span class="operation-path">/videos/{id}</span> |
5e1c08eb C |
2884 | </span> |
2885 | </h2> | |
2886 | <div class="doc-row"> | |
2887 | <div class="doc-copy"> | |
2888 | <section class="swagger-request-params"> | |
2889 | <div class="prop-row prop-group"> | |
2890 | <div class="prop-name"> | |
2891 | <div class="prop-title">id</div> | |
2892 | <span class="json-property-required"></span> | |
2893 | </div> | |
2894 | <div class="prop-value"> | |
2895 | <p>The video id </p> | |
2896 | </div> | |
2897 | </div> | |
2898 | <div class="prop-row prop-inner"> | |
2899 | <div class="prop-name param-label">type</div> | |
2900 | <div class="prop-value"> | |
2901 | <span class="json-property-type">string</span> | |
2902 | <span class="json-property-range" title="Value limits"></span> | |
2903 | </div> | |
2904 | </div> | |
2905 | <div class="prop-row prop-inner"> | |
2906 | <div class="prop-name param-label">in</div> | |
2907 | <div class="prop-value">path</div> | |
2908 | </div> | |
2909 | </section> | |
2910 | </div> | |
2911 | <div class="doc-examples"></div> | |
2912 | </div> | |
2913 | <div class="doc-row"> | |
2914 | <div class="doc-copy"> | |
2915 | <section class="swagger-responses"> | |
2916 | <div class="prop-row prop-group"> | |
2917 | <div class="prop-name"> | |
2918 | <div class="prop-title">200 OK</div> | |
2919 | <div class="prop-ref"> | |
2920 | <span class=""> | |
2921 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
2922 | </span> | |
2923 | </div> | |
2924 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2925 | </div> | |
2926 | <div class="prop-value"> | |
2927 | <p>successful operation</p> | |
2928 | </div> | |
2929 | </div> | |
2930 | </section> | |
2931 | </div> | |
2932 | <div class="doc-examples"> | |
2933 | <h5>Response Content-Types: | |
2934 | <span>application/json</span> | |
2935 | </h5> | |
2936 | <section> | |
2937 | <h5>Response Example | |
2938 | <span>(200 OK)</span> | |
2939 | </h5> | |
2940 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
2941 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2942 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
2943 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
2944 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
2945 | <span class="hljs-attr">"category"</span>: { |
2946 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2947 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2948 | }, | |
2949 | <span class="hljs-attr">"licence"</span>: { | |
2950 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2951 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2952 | }, | |
2953 | <span class="hljs-attr">"language"</span>: { | |
2954 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2955 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2956 | }, | |
5e1c08eb C |
2957 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
2958 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
2959 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
2960 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
2961 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
2962 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
2963 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
2964 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
2965 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
2966 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
2967 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
2968 | } | |
2969 | </code></pre> | |
2970 | <!-- </div> --> | |
2971 | </section> | |
2972 | </div> | |
2973 | </div> | |
2974 | </div> | |
ab0ee6a1 | 2975 | <div id="operation--videos--id--get" class="operation panel" data-traverse-target="operation--videos--id--get"> |
5e1c08eb C |
2976 | <!-- <section class="operation-tags row"> --> |
2977 | <!-- <div class="doc-copy"> --> | |
2978 | <div class="operation-tags"> | |
2979 | <a class="label" href="#tag-Video">Video</a> | |
2980 | <!----> | |
2981 | </div> | |
2982 | <!-- </div> --> | |
2983 | <!-- </section> --> | |
2984 | <h2 class="operation-title"> | |
2985 | <span class="operation-name"> | |
2986 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 2987 | <span class="operation-path">/videos/{id}</span> |
5e1c08eb C |
2988 | </span> |
2989 | </h2> | |
2990 | <div class="doc-row"> | |
2991 | <div class="doc-copy"> | |
2992 | <section class="swagger-request-params"> | |
2993 | <div class="prop-row prop-group"> | |
2994 | <div class="prop-name"> | |
2995 | <div class="prop-title">id</div> | |
2996 | <span class="json-property-required"></span> | |
2997 | </div> | |
2998 | <div class="prop-value"> | |
2999 | <p>The video id </p> | |
3000 | </div> | |
3001 | </div> | |
3002 | <div class="prop-row prop-inner"> | |
3003 | <div class="prop-name param-label">type</div> | |
3004 | <div class="prop-value"> | |
3005 | <span class="json-property-type">string</span> | |
3006 | <span class="json-property-range" title="Value limits"></span> | |
3007 | </div> | |
3008 | </div> | |
3009 | <div class="prop-row prop-inner"> | |
3010 | <div class="prop-name param-label">in</div> | |
3011 | <div class="prop-value">path</div> | |
3012 | </div> | |
3013 | </section> | |
3014 | </div> | |
3015 | <div class="doc-examples"></div> | |
3016 | </div> | |
3017 | <div class="doc-row"> | |
3018 | <div class="doc-copy"> | |
3019 | <section class="swagger-responses"> | |
3020 | <div class="prop-row prop-group"> | |
3021 | <div class="prop-name"> | |
3022 | <div class="prop-title">200 OK</div> | |
3023 | <div class="prop-ref"> | |
3024 | <span class=""> | |
3025 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
3026 | </span> | |
3027 | </div> | |
3028 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3029 | </div> | |
3030 | <div class="prop-value"> | |
3031 | <p>successful operation</p> | |
3032 | </div> | |
3033 | </div> | |
3034 | </section> | |
3035 | </div> | |
3036 | <div class="doc-examples"> | |
3037 | <h5>Response Content-Types: | |
3038 | <span>application/json</span> | |
3039 | </h5> | |
3040 | <section> | |
3041 | <h5>Response Example | |
3042 | <span>(200 OK)</span> | |
3043 | </h5> | |
3044 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
3045 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3046 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
3047 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
3048 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
3049 | <span class="hljs-attr">"category"</span>: { |
3050 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3051 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
3052 | }, | |
3053 | <span class="hljs-attr">"licence"</span>: { | |
3054 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3055 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
3056 | }, | |
3057 | <span class="hljs-attr">"language"</span>: { | |
3058 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3059 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
3060 | }, | |
5e1c08eb C |
3061 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
3062 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
3063 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
3064 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
3065 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
3066 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
3067 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
3068 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
3069 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
3070 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
3071 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
3072 | } | |
3073 | </code></pre> | |
3074 | <!-- </div> --> | |
3075 | </section> | |
3076 | </div> | |
3077 | </div> | |
3078 | </div> | |
ab0ee6a1 | 3079 | <div id="operation--videos--id--delete" class="operation panel" data-traverse-target="operation--videos--id--delete"> |
5e1c08eb C |
3080 | <!-- <section class="operation-tags row"> --> |
3081 | <!-- <div class="doc-copy"> --> | |
3082 | <div class="operation-tags"> | |
3083 | <a class="label" href="#tag-Video">Video</a> | |
3084 | <!----> | |
3085 | </div> | |
3086 | <!-- </div> --> | |
3087 | <!-- </section> --> | |
3088 | <h2 class="operation-title"> | |
3089 | <span class="operation-name"> | |
3090 | <span class="operation-name">DELETE</span> | |
ab0ee6a1 | 3091 | <span class="operation-path">/videos/{id}</span> |
5e1c08eb C |
3092 | </span> |
3093 | </h2> | |
3094 | <div class="doc-row"> | |
3095 | <div class="doc-copy"> | |
3096 | <section class="swagger-request-params"> | |
3097 | <div class="prop-row prop-group"> | |
3098 | <div class="prop-name"> | |
3099 | <div class="prop-title">id</div> | |
3100 | <span class="json-property-required"></span> | |
3101 | </div> | |
3102 | <div class="prop-value"> | |
3103 | <p>The video id </p> | |
3104 | </div> | |
3105 | </div> | |
3106 | <div class="prop-row prop-inner"> | |
3107 | <div class="prop-name param-label">type</div> | |
3108 | <div class="prop-value"> | |
3109 | <span class="json-property-type">string</span> | |
3110 | <span class="json-property-range" title="Value limits"></span> | |
3111 | </div> | |
3112 | </div> | |
3113 | <div class="prop-row prop-inner"> | |
3114 | <div class="prop-name param-label">in</div> | |
3115 | <div class="prop-value">path</div> | |
3116 | </div> | |
3117 | </section> | |
3118 | </div> | |
3119 | <div class="doc-examples"></div> | |
3120 | </div> | |
3121 | <div class="doc-row"> | |
3122 | <div class="doc-copy"> | |
3123 | <section class="swagger-responses"> | |
3124 | <div class="prop-row prop-group"> | |
3125 | <div class="prop-name"> | |
3126 | <div class="prop-title">204 No Content</div> | |
3127 | </div> | |
3128 | <div class="prop-value"> | |
3129 | <p>successful operation</p> | |
3130 | </div> | |
3131 | </div> | |
3132 | </section> | |
3133 | </div> | |
3134 | <div class="doc-examples"> | |
3135 | <h5>Response Content-Types: | |
3136 | <span>application/json</span> | |
3137 | </h5> | |
3138 | </div> | |
3139 | </div> | |
3140 | </div> | |
ab0ee6a1 | 3141 | <div id="operation--videos--id--description-get" class="operation panel" data-traverse-target="operation--videos--id--description-get"> |
5e1c08eb C |
3142 | <!-- <section class="operation-tags row"> --> |
3143 | <!-- <div class="doc-copy"> --> | |
3144 | <div class="operation-tags"> | |
3145 | <a class="label" href="#tag-Video">Video</a> | |
3146 | <!----> | |
3147 | </div> | |
3148 | <!-- </div> --> | |
3149 | <!-- </section> --> | |
3150 | <h2 class="operation-title"> | |
3151 | <span class="operation-name"> | |
3152 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 3153 | <span class="operation-path">/videos/{id}/description</span> |
5e1c08eb C |
3154 | </span> |
3155 | </h2> | |
3156 | <div class="doc-row"> | |
3157 | <div class="doc-copy"> | |
3158 | <section class="swagger-request-params"> | |
3159 | <div class="prop-row prop-group"> | |
3160 | <div class="prop-name"> | |
3161 | <div class="prop-title">id</div> | |
3162 | <span class="json-property-required"></span> | |
3163 | </div> | |
3164 | <div class="prop-value"> | |
3165 | <p>The video id </p> | |
3166 | </div> | |
3167 | </div> | |
3168 | <div class="prop-row prop-inner"> | |
3169 | <div class="prop-name param-label">type</div> | |
3170 | <div class="prop-value"> | |
3171 | <span class="json-property-type">string</span> | |
3172 | <span class="json-property-range" title="Value limits"></span> | |
3173 | </div> | |
3174 | </div> | |
3175 | <div class="prop-row prop-inner"> | |
3176 | <div class="prop-name param-label">in</div> | |
3177 | <div class="prop-value">path</div> | |
3178 | </div> | |
3179 | </section> | |
3180 | </div> | |
3181 | <div class="doc-examples"></div> | |
3182 | </div> | |
3183 | <div class="doc-row"> | |
3184 | <div class="doc-copy"> | |
3185 | <section class="swagger-responses"> | |
3186 | <div class="prop-row prop-group"> | |
3187 | <div class="prop-name"> | |
3188 | <div class="prop-title">200 OK</div> | |
3189 | <div class="prop-ref"></div> | |
3190 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3191 | </div> | |
3192 | <div class="prop-value"> | |
3193 | <p>successful operation</p> | |
3194 | </div> | |
3195 | </div> | |
3196 | </section> | |
3197 | </div> | |
3198 | <div class="doc-examples"> | |
3199 | <h5>Response Content-Types: | |
3200 | <span>application/json</span> | |
3201 | </h5> | |
3202 | <section> | |
3203 | <h5>Response Example | |
3204 | <span>(200 OK)</span> | |
3205 | </h5> | |
3206 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"string"</span> | |
3207 | </code></pre> | |
3208 | <!-- </div> --> | |
3209 | </section> | |
3210 | </div> | |
3211 | </div> | |
3212 | </div> | |
ab0ee6a1 | 3213 | <div id="operation--videos--id--views-post" class="operation panel" data-traverse-target="operation--videos--id--views-post"> |
5e1c08eb C |
3214 | <!-- <section class="operation-tags row"> --> |
3215 | <!-- <div class="doc-copy"> --> | |
3216 | <div class="operation-tags"> | |
3217 | <a class="label" href="#tag-Video">Video</a> | |
3218 | <!----> | |
3219 | </div> | |
3220 | <!-- </div> --> | |
3221 | <!-- </section> --> | |
3222 | <h2 class="operation-title"> | |
3223 | <span class="operation-name"> | |
3224 | <span class="operation-name">POST</span> | |
ab0ee6a1 | 3225 | <span class="operation-path">/videos/{id}/views</span> |
5e1c08eb C |
3226 | </span> |
3227 | </h2> | |
3228 | <div class="doc-row"> | |
3229 | <div class="doc-copy"> | |
3230 | <section class="swagger-request-params"> | |
3231 | <div class="prop-row prop-group"> | |
3232 | <div class="prop-name"> | |
3233 | <div class="prop-title">id</div> | |
3234 | <span class="json-property-required"></span> | |
3235 | </div> | |
3236 | <div class="prop-value"> | |
3237 | <p>The video id </p> | |
3238 | </div> | |
3239 | </div> | |
3240 | <div class="prop-row prop-inner"> | |
3241 | <div class="prop-name param-label">type</div> | |
3242 | <div class="prop-value"> | |
3243 | <span class="json-property-type">string</span> | |
3244 | <span class="json-property-range" title="Value limits"></span> | |
3245 | </div> | |
3246 | </div> | |
3247 | <div class="prop-row prop-inner"> | |
3248 | <div class="prop-name param-label">in</div> | |
3249 | <div class="prop-value">path</div> | |
3250 | </div> | |
3251 | </section> | |
3252 | </div> | |
3253 | <div class="doc-examples"></div> | |
3254 | </div> | |
3255 | <div class="doc-row"> | |
3256 | <div class="doc-copy"> | |
3257 | <section class="swagger-responses"> | |
3258 | <div class="prop-row prop-group"> | |
3259 | <div class="prop-name"> | |
3260 | <div class="prop-title">204 No Content</div> | |
3261 | </div> | |
3262 | <div class="prop-value"> | |
3263 | <p>successful operation</p> | |
3264 | </div> | |
3265 | </div> | |
3266 | </section> | |
3267 | </div> | |
3268 | <div class="doc-examples"> | |
3269 | <h5>Response Content-Types: | |
3270 | <span>application/json</span> | |
3271 | </h5> | |
3272 | </div> | |
3273 | </div> | |
3274 | </div> | |
ab0ee6a1 | 3275 | <div id="operation--videos-upload-post" class="operation panel" data-traverse-target="operation--videos-upload-post"> |
5e1c08eb C |
3276 | <!-- <section class="operation-tags row"> --> |
3277 | <!-- <div class="doc-copy"> --> | |
3278 | <div class="operation-tags"> | |
3279 | <a class="label" href="#tag-Video">Video</a> | |
3280 | <!----> | |
3281 | </div> | |
3282 | <!-- </div> --> | |
3283 | <!-- </section> --> | |
3284 | <h2 class="operation-title"> | |
3285 | <span class="operation-name"> | |
3286 | <span class="operation-name">POST</span> | |
ab0ee6a1 | 3287 | <span class="operation-path">/videos/upload</span> |
5e1c08eb C |
3288 | </span> |
3289 | </h2> | |
3290 | <div class="doc-row"> | |
3291 | <div class="doc-copy"> | |
3292 | <section class="swagger-request-params"> | |
3293 | <div class="prop-row prop-group"> | |
3294 | <div class="prop-name"> | |
3295 | <div class="prop-title">videofile</div> | |
3296 | </div> | |
3297 | <div class="prop-value"> | |
3298 | <p>The file to upload.</p> | |
3299 | </div> | |
3300 | </div> | |
3301 | <div class="prop-row prop-inner"> | |
3302 | <div class="prop-name param-label">type</div> | |
3303 | <div class="prop-value"> | |
3304 | <span class="json-property-type">file</span> | |
3305 | <span class="json-property-range" title="Value limits"></span> | |
3306 | </div> | |
3307 | </div> | |
3308 | <div class="prop-row prop-inner"> | |
3309 | <div class="prop-name param-label">in</div> | |
3310 | <div class="prop-value">formData</div> | |
3311 | </div> | |
3312 | </section> | |
3313 | </div> | |
3314 | <div class="doc-examples"></div> | |
3315 | </div> | |
3316 | <div class="doc-row"> | |
3317 | <div class="doc-copy"> | |
3318 | <section class="swagger-responses"> | |
3319 | <div class="prop-row prop-group"> | |
3320 | <div class="prop-name"> | |
3321 | <div class="prop-title">200 OK</div> | |
3322 | <div class="prop-ref"> | |
3323 | <span class=""> | |
3324 | <a class="json-schema-ref" href="#/definitions/VideoUploadResponse">VideoUploadResponse</a> | |
3325 | </span> | |
3326 | </div> | |
3327 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3328 | </div> | |
3329 | <div class="prop-value"> | |
3330 | <p>successful operation</p> | |
3331 | </div> | |
3332 | </div> | |
3333 | </section> | |
3334 | </div> | |
3335 | <div class="doc-examples"> | |
3336 | <h5>Response Content-Types: | |
3337 | <span>application/json</span> | |
3338 | </h5> | |
3339 | <section> | |
3340 | <h5>Response Example | |
3341 | <span>(200 OK)</span> | |
3342 | </h5> | |
3343 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
3344 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3345 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
3346 | } | |
3347 | </code></pre> | |
3348 | <!-- </div> --> | |
3349 | </section> | |
3350 | </div> | |
3351 | </div> | |
3352 | </div> | |
3353 | <h1 id="tag-VideoAbuse" class="swagger-summary-tag" data-traverse-target="tag-VideoAbuse">VideoAbuse</h1> | |
ab0ee6a1 | 3354 | <div id="operation--videos-abuse-get" class="operation panel" data-traverse-target="operation--videos-abuse-get"> |
5e1c08eb C |
3355 | <!-- <section class="operation-tags row"> --> |
3356 | <!-- <div class="doc-copy"> --> | |
3357 | <div class="operation-tags"> | |
3358 | <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> | |
3359 | <!----> | |
3360 | </div> | |
3361 | <!-- </div> --> | |
3362 | <!-- </section> --> | |
3363 | <h2 class="operation-title"> | |
3364 | <span class="operation-name"> | |
3365 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 3366 | <span class="operation-path">/videos/abuse</span> |
5e1c08eb C |
3367 | </span> |
3368 | </h2> | |
3369 | <div class="doc-row"> | |
ab0ee6a1 C |
3370 | <div class="doc-copy"> |
3371 | <section class="swagger-request-params"> | |
3372 | <div class="prop-row prop-group"> | |
3373 | <div class="prop-name"> | |
3374 | <div class="prop-title">start</div> | |
3375 | </div> | |
3376 | <div class="prop-value"> | |
3377 | <p>starting page</p> | |
3378 | </div> | |
3379 | </div> | |
3380 | <div class="prop-row prop-inner"> | |
3381 | <div class="prop-name param-label">type</div> | |
3382 | <div class="prop-value"> | |
3383 | <span class="json-property-type">number</span> | |
3384 | <span class="json-property-range" title="Value limits"></span> | |
3385 | </div> | |
3386 | </div> | |
3387 | <div class="prop-row prop-inner"> | |
3388 | <div class="prop-name param-label">in</div> | |
3389 | <div class="prop-value">query</div> | |
3390 | </div> | |
3391 | <div class="prop-row prop-group"> | |
3392 | <div class="prop-name"> | |
3393 | <div class="prop-title">stop</div> | |
3394 | </div> | |
3395 | <div class="prop-value"> | |
f209b32a | 3396 | <p>stopping page</p> |
ab0ee6a1 C |
3397 | </div> |
3398 | </div> | |
3399 | <div class="prop-row prop-inner"> | |
3400 | <div class="prop-name param-label">type</div> | |
3401 | <div class="prop-value"> | |
3402 | <span class="json-property-type">number</span> | |
3403 | <span class="json-property-range" title="Value limits"></span> | |
3404 | </div> | |
3405 | </div> | |
3406 | <div class="prop-row prop-inner"> | |
3407 | <div class="prop-name param-label">in</div> | |
3408 | <div class="prop-value">query</div> | |
3409 | </div> | |
3410 | <div class="prop-row prop-group"> | |
3411 | <div class="prop-name"> | |
3412 | <div class="prop-title">sort</div> | |
3413 | </div> | |
3414 | <div class="prop-value"> | |
3415 | <p>sorting</p> | |
3416 | </div> | |
3417 | </div> | |
3418 | <div class="prop-row prop-inner"> | |
3419 | <div class="prop-name param-label">type</div> | |
3420 | <div class="prop-value"> | |
3421 | <span class="json-property-type">number</span> | |
3422 | <span class="json-property-range" title="Value limits"></span> | |
3423 | </div> | |
3424 | </div> | |
3425 | <div class="prop-row prop-inner"> | |
3426 | <div class="prop-name param-label">in</div> | |
3427 | <div class="prop-value">query</div> | |
3428 | </div> | |
3429 | </section> | |
3430 | </div> | |
5e1c08eb C |
3431 | <div class="doc-examples"></div> |
3432 | </div> | |
3433 | <div class="doc-row"> | |
3434 | <div class="doc-copy"> | |
3435 | <section class="swagger-responses"> | |
3436 | <div class="prop-row prop-group"> | |
3437 | <div class="prop-name"> | |
3438 | <div class="prop-title">200 OK</div> | |
3439 | <div class="prop-ref"> | |
3440 | <span class="json-schema-ref-array"> | |
3441 | <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a> | |
3442 | </span> | |
3443 | </div> | |
3444 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3445 | </div> | |
3446 | <div class="prop-value"> | |
3447 | <p>successful operation</p> | |
3448 | </div> | |
3449 | </div> | |
3450 | </section> | |
3451 | </div> | |
3452 | <div class="doc-examples"> | |
3453 | <h5>Response Content-Types: | |
3454 | <span>application/json</span> | |
3455 | </h5> | |
3456 | <section> | |
3457 | <h5>Response Example | |
3458 | <span>(200 OK)</span> | |
3459 | </h5> | |
3460 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
3461 | { | |
3462 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3463 | <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
3464 | <span class="hljs-attr">"reporterAccount"</span>: { |
3465 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
3466 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3467 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
3468 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
3469 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3470 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
3471 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
3472 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
3473 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3474 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3475 | <span class="hljs-attr">"avatar"</span>: { | |
3476 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
3477 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3478 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
3479 | } | |
3480 | }, | |
5e1c08eb C |
3481 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span> |
3482 | } | |
3483 | ] | |
3484 | </code></pre> | |
3485 | <!-- </div> --> | |
3486 | </section> | |
3487 | </div> | |
3488 | </div> | |
3489 | </div> | |
ab0ee6a1 | 3490 | <div id="operation--videos--id--abuse-post" class="operation panel" data-traverse-target="operation--videos--id--abuse-post"> |
5e1c08eb C |
3491 | <!-- <section class="operation-tags row"> --> |
3492 | <!-- <div class="doc-copy"> --> | |
3493 | <div class="operation-tags"> | |
3494 | <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> | |
3495 | <!----> | |
3496 | </div> | |
3497 | <!-- </div> --> | |
3498 | <!-- </section> --> | |
3499 | <h2 class="operation-title"> | |
3500 | <span class="operation-name"> | |
3501 | <span class="operation-name">POST</span> | |
ab0ee6a1 | 3502 | <span class="operation-path">/videos/{id}/abuse</span> |
5e1c08eb C |
3503 | </span> |
3504 | </h2> | |
3505 | <div class="doc-row"> | |
3506 | <div class="doc-copy"> | |
3507 | <section class="swagger-request-params"> | |
3508 | <div class="prop-row prop-group"> | |
3509 | <div class="prop-name"> | |
3510 | <div class="prop-title">id</div> | |
3511 | <span class="json-property-required"></span> | |
3512 | </div> | |
3513 | <div class="prop-value"> | |
3514 | <p>The video id </p> | |
3515 | </div> | |
3516 | </div> | |
3517 | <div class="prop-row prop-inner"> | |
3518 | <div class="prop-name param-label">type</div> | |
3519 | <div class="prop-value"> | |
3520 | <span class="json-property-type">string</span> | |
3521 | <span class="json-property-range" title="Value limits"></span> | |
3522 | </div> | |
3523 | </div> | |
3524 | <div class="prop-row prop-inner"> | |
3525 | <div class="prop-name param-label">in</div> | |
3526 | <div class="prop-value">path</div> | |
3527 | </div> | |
3528 | </section> | |
3529 | </div> | |
3530 | <div class="doc-examples"></div> | |
3531 | </div> | |
3532 | <div class="doc-row"> | |
3533 | <div class="doc-copy"> | |
3534 | <section class="swagger-responses"> | |
3535 | <div class="prop-row prop-group"> | |
3536 | <div class="prop-name"> | |
3537 | <div class="prop-title">204 No Content</div> | |
3538 | </div> | |
3539 | <div class="prop-value"> | |
3540 | <p>successful operation</p> | |
3541 | </div> | |
3542 | </div> | |
3543 | </section> | |
3544 | </div> | |
3545 | <div class="doc-examples"> | |
3546 | <h5>Response Content-Types: | |
3547 | <span>application/json</span> | |
3548 | </h5> | |
3549 | </div> | |
3550 | </div> | |
3551 | </div> | |
3552 | <h1 id="tag-VideoBlacklist" class="swagger-summary-tag" data-traverse-target="tag-VideoBlacklist">VideoBlacklist</h1> | |
ab0ee6a1 | 3553 | <div id="operation--videos--videoId--blacklist-post" class="operation panel" data-traverse-target="operation--videos--videoId--blacklist-post"> |
5e1c08eb C |
3554 | <!-- <section class="operation-tags row"> --> |
3555 | <!-- <div class="doc-copy"> --> | |
3556 | <div class="operation-tags"> | |
3557 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | |
3558 | <!----> | |
3559 | </div> | |
3560 | <!-- </div> --> | |
3561 | <!-- </section> --> | |
3562 | <h2 class="operation-title"> | |
3563 | <span class="operation-name"> | |
3564 | <span class="operation-name">POST</span> | |
ab0ee6a1 | 3565 | <span class="operation-path">/videos/{videoId}/blacklist</span> |
5e1c08eb C |
3566 | </span> |
3567 | </h2> | |
3568 | <div class="doc-row"> | |
3569 | <div class="doc-copy"> | |
3570 | <section class="swagger-request-params"> | |
3571 | <div class="prop-row prop-group"> | |
3572 | <div class="prop-name"> | |
3573 | <div class="prop-title">videoId</div> | |
3574 | <span class="json-property-required"></span> | |
3575 | </div> | |
3576 | <div class="prop-value"> | |
3577 | <p>The video id </p> | |
3578 | </div> | |
3579 | </div> | |
3580 | <div class="prop-row prop-inner"> | |
3581 | <div class="prop-name param-label">type</div> | |
3582 | <div class="prop-value"> | |
3583 | <span class="json-property-type">string</span> | |
3584 | <span class="json-property-range" title="Value limits"></span> | |
3585 | </div> | |
3586 | </div> | |
3587 | <div class="prop-row prop-inner"> | |
3588 | <div class="prop-name param-label">in</div> | |
3589 | <div class="prop-value">path</div> | |
3590 | </div> | |
3591 | </section> | |
3592 | </div> | |
3593 | <div class="doc-examples"></div> | |
3594 | </div> | |
3595 | <div class="doc-row"> | |
3596 | <div class="doc-copy"> | |
3597 | <section class="swagger-responses"> | |
3598 | <div class="prop-row prop-group"> | |
3599 | <div class="prop-name"> | |
3600 | <div class="prop-title">204 No Content</div> | |
3601 | </div> | |
3602 | <div class="prop-value"> | |
3603 | <p>successful operation</p> | |
3604 | </div> | |
3605 | </div> | |
3606 | </section> | |
3607 | </div> | |
3608 | <div class="doc-examples"> | |
3609 | <h5>Response Content-Types: | |
3610 | <span>application/json</span> | |
3611 | </h5> | |
3612 | </div> | |
3613 | </div> | |
3614 | </div> | |
ab0ee6a1 | 3615 | <div id="operation--videos--videoId--blacklist-delete" class="operation panel" data-traverse-target="operation--videos--videoId--blacklist-delete"> |
5e1c08eb C |
3616 | <!-- <section class="operation-tags row"> --> |
3617 | <!-- <div class="doc-copy"> --> | |
3618 | <div class="operation-tags"> | |
3619 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | |
3620 | <!----> | |
3621 | </div> | |
3622 | <!-- </div> --> | |
3623 | <!-- </section> --> | |
3624 | <h2 class="operation-title"> | |
3625 | <span class="operation-name"> | |
3626 | <span class="operation-name">DELETE</span> | |
ab0ee6a1 | 3627 | <span class="operation-path">/videos/{videoId}/blacklist</span> |
5e1c08eb C |
3628 | </span> |
3629 | </h2> | |
3630 | <div class="doc-row"> | |
3631 | <div class="doc-copy"> | |
3632 | <section class="swagger-request-params"> | |
3633 | <div class="prop-row prop-group"> | |
3634 | <div class="prop-name"> | |
3635 | <div class="prop-title">videoId</div> | |
3636 | <span class="json-property-required"></span> | |
3637 | </div> | |
3638 | <div class="prop-value"> | |
3639 | <p>The video id </p> | |
3640 | </div> | |
3641 | </div> | |
3642 | <div class="prop-row prop-inner"> | |
3643 | <div class="prop-name param-label">type</div> | |
3644 | <div class="prop-value"> | |
3645 | <span class="json-property-type">string</span> | |
3646 | <span class="json-property-range" title="Value limits"></span> | |
3647 | </div> | |
3648 | </div> | |
3649 | <div class="prop-row prop-inner"> | |
3650 | <div class="prop-name param-label">in</div> | |
3651 | <div class="prop-value">path</div> | |
3652 | </div> | |
3653 | </section> | |
3654 | </div> | |
3655 | <div class="doc-examples"></div> | |
3656 | </div> | |
3657 | <div class="doc-row"> | |
3658 | <div class="doc-copy"> | |
3659 | <section class="swagger-responses"> | |
3660 | <div class="prop-row prop-group"> | |
3661 | <div class="prop-name"> | |
3662 | <div class="prop-title">204 No Content</div> | |
3663 | </div> | |
3664 | <div class="prop-value"> | |
3665 | <p>successful operation</p> | |
3666 | </div> | |
3667 | </div> | |
3668 | </section> | |
3669 | </div> | |
3670 | <div class="doc-examples"> | |
3671 | <h5>Response Content-Types: | |
3672 | <span>application/json</span> | |
3673 | </h5> | |
3674 | </div> | |
3675 | </div> | |
3676 | </div> | |
ab0ee6a1 | 3677 | <div id="operation--videos-blacklist-get" class="operation panel" data-traverse-target="operation--videos-blacklist-get"> |
5e1c08eb C |
3678 | <!-- <section class="operation-tags row"> --> |
3679 | <!-- <div class="doc-copy"> --> | |
3680 | <div class="operation-tags"> | |
3681 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | |
3682 | <!----> | |
3683 | </div> | |
3684 | <!-- </div> --> | |
3685 | <!-- </section> --> | |
3686 | <h2 class="operation-title"> | |
3687 | <span class="operation-name"> | |
3688 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 3689 | <span class="operation-path">/videos/blacklist</span> |
5e1c08eb C |
3690 | </span> |
3691 | </h2> | |
3692 | <div class="doc-row"> | |
ab0ee6a1 C |
3693 | <div class="doc-copy"> |
3694 | <section class="swagger-request-params"> | |
3695 | <div class="prop-row prop-group"> | |
3696 | <div class="prop-name"> | |
3697 | <div class="prop-title">start</div> | |
3698 | </div> | |
3699 | <div class="prop-value"> | |
3700 | <p>starting page</p> | |
3701 | </div> | |
3702 | </div> | |
3703 | <div class="prop-row prop-inner"> | |
3704 | <div class="prop-name param-label">type</div> | |
3705 | <div class="prop-value"> | |
3706 | <span class="json-property-type">number</span> | |
3707 | <span class="json-property-range" title="Value limits"></span> | |
3708 | </div> | |
3709 | </div> | |
3710 | <div class="prop-row prop-inner"> | |
3711 | <div class="prop-name param-label">in</div> | |
3712 | <div class="prop-value">query</div> | |
3713 | </div> | |
3714 | <div class="prop-row prop-group"> | |
3715 | <div class="prop-name"> | |
3716 | <div class="prop-title">stop</div> | |
3717 | </div> | |
3718 | <div class="prop-value"> | |
f209b32a | 3719 | <p>stopping page</p> |
ab0ee6a1 C |
3720 | </div> |
3721 | </div> | |
3722 | <div class="prop-row prop-inner"> | |
3723 | <div class="prop-name param-label">type</div> | |
3724 | <div class="prop-value"> | |
3725 | <span class="json-property-type">number</span> | |
3726 | <span class="json-property-range" title="Value limits"></span> | |
3727 | </div> | |
3728 | </div> | |
3729 | <div class="prop-row prop-inner"> | |
3730 | <div class="prop-name param-label">in</div> | |
3731 | <div class="prop-value">query</div> | |
3732 | </div> | |
3733 | <div class="prop-row prop-group"> | |
3734 | <div class="prop-name"> | |
3735 | <div class="prop-title">sort</div> | |
3736 | </div> | |
3737 | <div class="prop-value"> | |
3738 | <p>sorting</p> | |
3739 | </div> | |
3740 | </div> | |
3741 | <div class="prop-row prop-inner"> | |
3742 | <div class="prop-name param-label">type</div> | |
3743 | <div class="prop-value"> | |
3744 | <span class="json-property-type">number</span> | |
3745 | <span class="json-property-range" title="Value limits"></span> | |
3746 | </div> | |
3747 | </div> | |
3748 | <div class="prop-row prop-inner"> | |
3749 | <div class="prop-name param-label">in</div> | |
3750 | <div class="prop-value">query</div> | |
3751 | </div> | |
3752 | </section> | |
3753 | </div> | |
5e1c08eb C |
3754 | <div class="doc-examples"></div> |
3755 | </div> | |
3756 | <div class="doc-row"> | |
3757 | <div class="doc-copy"> | |
3758 | <section class="swagger-responses"> | |
3759 | <div class="prop-row prop-group"> | |
3760 | <div class="prop-name"> | |
3761 | <div class="prop-title">200 OK</div> | |
3762 | <div class="prop-ref"> | |
3763 | <span class="json-schema-ref-array"> | |
3764 | <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a> | |
3765 | </span> | |
3766 | </div> | |
3767 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3768 | </div> | |
3769 | <div class="prop-value"> | |
3770 | <p>successful operation</p> | |
3771 | </div> | |
3772 | </div> | |
3773 | </section> | |
3774 | </div> | |
3775 | <div class="doc-examples"> | |
3776 | <h5>Response Content-Types: | |
3777 | <span>application/json</span> | |
3778 | </h5> | |
3779 | <section> | |
3780 | <h5>Response Example | |
3781 | <span>(200 OK)</span> | |
3782 | </h5> | |
3783 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
3784 | { | |
3785 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3786 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
3787 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3788 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3789 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3790 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
3791 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
3792 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
3793 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
3794 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
3795 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
3796 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
3797 | } | |
3798 | ] | |
3799 | </code></pre> | |
3800 | <!-- </div> --> | |
3801 | </section> | |
3802 | </div> | |
3803 | </div> | |
3804 | </div> | |
3805 | <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1> | |
ab0ee6a1 | 3806 | <div id="operation--videos-channels-get" class="operation panel" data-traverse-target="operation--videos-channels-get"> |
5e1c08eb C |
3807 | <!-- <section class="operation-tags row"> --> |
3808 | <!-- <div class="doc-copy"> --> | |
3809 | <div class="operation-tags"> | |
3810 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
3811 | <!----> | |
3812 | </div> | |
3813 | <!-- </div> --> | |
3814 | <!-- </section> --> | |
3815 | <h2 class="operation-title"> | |
3816 | <span class="operation-name"> | |
3817 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 3818 | <span class="operation-path">/videos/channels</span> |
5e1c08eb C |
3819 | </span> |
3820 | </h2> | |
3821 | <div class="doc-row"> | |
ab0ee6a1 C |
3822 | <div class="doc-copy"> |
3823 | <section class="swagger-request-params"> | |
3824 | <div class="prop-row prop-group"> | |
3825 | <div class="prop-name"> | |
3826 | <div class="prop-title">start</div> | |
3827 | </div> | |
3828 | <div class="prop-value"> | |
3829 | <p>starting page</p> | |
3830 | </div> | |
3831 | </div> | |
3832 | <div class="prop-row prop-inner"> | |
3833 | <div class="prop-name param-label">type</div> | |
3834 | <div class="prop-value"> | |
3835 | <span class="json-property-type">number</span> | |
3836 | <span class="json-property-range" title="Value limits"></span> | |
3837 | </div> | |
3838 | </div> | |
3839 | <div class="prop-row prop-inner"> | |
3840 | <div class="prop-name param-label">in</div> | |
3841 | <div class="prop-value">query</div> | |
3842 | </div> | |
3843 | <div class="prop-row prop-group"> | |
3844 | <div class="prop-name"> | |
3845 | <div class="prop-title">stop</div> | |
3846 | </div> | |
3847 | <div class="prop-value"> | |
f209b32a | 3848 | <p>stopping page</p> |
ab0ee6a1 C |
3849 | </div> |
3850 | </div> | |
3851 | <div class="prop-row prop-inner"> | |
3852 | <div class="prop-name param-label">type</div> | |
3853 | <div class="prop-value"> | |
3854 | <span class="json-property-type">number</span> | |
3855 | <span class="json-property-range" title="Value limits"></span> | |
3856 | </div> | |
3857 | </div> | |
3858 | <div class="prop-row prop-inner"> | |
3859 | <div class="prop-name param-label">in</div> | |
3860 | <div class="prop-value">query</div> | |
3861 | </div> | |
3862 | <div class="prop-row prop-group"> | |
3863 | <div class="prop-name"> | |
3864 | <div class="prop-title">sort</div> | |
3865 | </div> | |
3866 | <div class="prop-value"> | |
3867 | <p>sorting</p> | |
3868 | </div> | |
3869 | </div> | |
3870 | <div class="prop-row prop-inner"> | |
3871 | <div class="prop-name param-label">type</div> | |
3872 | <div class="prop-value"> | |
3873 | <span class="json-property-type">number</span> | |
3874 | <span class="json-property-range" title="Value limits"></span> | |
3875 | </div> | |
3876 | </div> | |
3877 | <div class="prop-row prop-inner"> | |
3878 | <div class="prop-name param-label">in</div> | |
3879 | <div class="prop-value">query</div> | |
3880 | </div> | |
3881 | </section> | |
3882 | </div> | |
5e1c08eb C |
3883 | <div class="doc-examples"></div> |
3884 | </div> | |
3885 | <div class="doc-row"> | |
3886 | <div class="doc-copy"> | |
3887 | <section class="swagger-responses"> | |
3888 | <div class="prop-row prop-group"> | |
3889 | <div class="prop-name"> | |
3890 | <div class="prop-title">200 OK</div> | |
3891 | <div class="prop-ref"> | |
3892 | <span class="json-schema-ref-array"> | |
3893 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
3894 | </span> | |
3895 | </div> | |
3896 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3897 | </div> | |
3898 | <div class="prop-value"> | |
3899 | <p>successful operation</p> | |
3900 | </div> | |
3901 | </div> | |
3902 | </section> | |
3903 | </div> | |
3904 | <div class="doc-examples"> | |
3905 | <h5>Response Content-Types: | |
3906 | <span>application/json</span> | |
3907 | </h5> | |
3908 | <section> | |
3909 | <h5>Response Example | |
3910 | <span>(200 OK)</span> | |
3911 | </h5> | |
3912 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
3913 | { | |
3914 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
3915 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
3916 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
3917 | <span class="hljs-attr">"owner"</span>: { | |
3918 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3919 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
3920 | }, | |
3921 | <span class="hljs-attr">"videos"</span>: [ | |
3922 | { | |
3923 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3924 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
3925 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
3926 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
3927 | <span class="hljs-attr">"category"</span>: { |
3928 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3929 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
3930 | }, | |
3931 | <span class="hljs-attr">"licence"</span>: { | |
3932 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3933 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
3934 | }, | |
3935 | <span class="hljs-attr">"language"</span>: { | |
3936 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3937 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
3938 | }, | |
5e1c08eb C |
3939 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
3940 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
3941 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
3942 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
3943 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
3944 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
3945 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
3946 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
3947 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
3948 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
3949 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
3950 | } | |
3951 | ] | |
3952 | } | |
3953 | ] | |
3954 | </code></pre> | |
3955 | <!-- </div> --> | |
3956 | </section> | |
3957 | </div> | |
3958 | </div> | |
3959 | </div> | |
ab0ee6a1 | 3960 | <div id="operation--videos-channels-post" class="operation panel" data-traverse-target="operation--videos-channels-post"> |
5e1c08eb C |
3961 | <!-- <section class="operation-tags row"> --> |
3962 | <!-- <div class="doc-copy"> --> | |
3963 | <div class="operation-tags"> | |
3964 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
3965 | <!----> | |
3966 | </div> | |
3967 | <!-- </div> --> | |
3968 | <!-- </section> --> | |
3969 | <h2 class="operation-title"> | |
3970 | <span class="operation-name"> | |
3971 | <span class="operation-name">POST</span> | |
ab0ee6a1 | 3972 | <span class="operation-path">/videos/channels</span> |
5e1c08eb C |
3973 | </span> |
3974 | </h2> | |
3975 | <div class="doc-row"> | |
3976 | <div class="doc-copy"> | |
3977 | <section class="swagger-request-body"> | |
3978 | <div class="prop-row"> | |
3979 | <div class="prop-name"> | |
3980 | <div class="swagger-request-model"> | |
3981 | <span class=""> | |
3982 | <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a> | |
3983 | </span> | |
3984 | </div> | |
3985 | </div> | |
3986 | <div class="prop-value columns small-6"> | |
3987 | <!-- <div class="swagger-request-description"> -->undefined | |
3988 | <!-- </div> --> | |
3989 | </div> | |
3990 | </div> | |
3991 | </section> | |
3992 | </div> | |
3993 | <div class="doc-examples"> | |
3994 | <section> | |
3995 | <h5>Request Content-Types: | |
3996 | <span>application/json</span> | |
3997 | </h5> | |
3998 | <h5>Request Example</h5> | |
3999 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4000 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4001 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
4002 | } | |
4003 | </code></pre> | |
4004 | <!-- </div> --> | |
4005 | </section> | |
4006 | </div> | |
4007 | </div> | |
4008 | <div class="doc-row"> | |
4009 | <div class="doc-copy"> | |
4010 | <section class="swagger-responses"> | |
4011 | <div class="prop-row prop-group"> | |
4012 | <div class="prop-name"> | |
4013 | <div class="prop-title">204 No Content</div> | |
4014 | </div> | |
4015 | <div class="prop-value"> | |
4016 | <p>successful operation</p> | |
4017 | </div> | |
4018 | </div> | |
4019 | </section> | |
4020 | </div> | |
4021 | <div class="doc-examples"> | |
4022 | <h5>Response Content-Types: | |
4023 | <span>application/json</span> | |
4024 | </h5> | |
4025 | </div> | |
4026 | </div> | |
4027 | </div> | |
ab0ee6a1 | 4028 | <div id="operation--videos-channels--id--get" class="operation panel" data-traverse-target="operation--videos-channels--id--get"> |
5e1c08eb C |
4029 | <!-- <section class="operation-tags row"> --> |
4030 | <!-- <div class="doc-copy"> --> | |
4031 | <div class="operation-tags"> | |
4032 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
4033 | <!----> | |
4034 | </div> | |
4035 | <!-- </div> --> | |
4036 | <!-- </section> --> | |
4037 | <h2 class="operation-title"> | |
4038 | <span class="operation-name"> | |
4039 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 4040 | <span class="operation-path">/videos/channels/{id}</span> |
5e1c08eb C |
4041 | </span> |
4042 | </h2> | |
4043 | <div class="doc-row"> | |
4044 | <div class="doc-copy"> | |
4045 | <section class="swagger-request-params"> | |
4046 | <div class="prop-row prop-group"> | |
4047 | <div class="prop-name"> | |
4048 | <div class="prop-title">id</div> | |
4049 | <span class="json-property-required"></span> | |
4050 | </div> | |
4051 | <div class="prop-value"> | |
4052 | <p>The video id </p> | |
4053 | </div> | |
4054 | </div> | |
4055 | <div class="prop-row prop-inner"> | |
4056 | <div class="prop-name param-label">type</div> | |
4057 | <div class="prop-value"> | |
4058 | <span class="json-property-type">string</span> | |
4059 | <span class="json-property-range" title="Value limits"></span> | |
4060 | </div> | |
4061 | </div> | |
4062 | <div class="prop-row prop-inner"> | |
4063 | <div class="prop-name param-label">in</div> | |
4064 | <div class="prop-value">path</div> | |
4065 | </div> | |
4066 | </section> | |
4067 | </div> | |
4068 | <div class="doc-examples"></div> | |
4069 | </div> | |
4070 | <div class="doc-row"> | |
4071 | <div class="doc-copy"> | |
4072 | <section class="swagger-responses"> | |
4073 | <div class="prop-row prop-group"> | |
4074 | <div class="prop-name"> | |
4075 | <div class="prop-title">200 OK</div> | |
4076 | <div class="prop-ref"> | |
4077 | <span class=""> | |
4078 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
4079 | </span> | |
4080 | </div> | |
4081 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
4082 | </div> | |
4083 | <div class="prop-value"> | |
4084 | <p>successful operation</p> | |
4085 | </div> | |
4086 | </div> | |
4087 | </section> | |
4088 | </div> | |
4089 | <div class="doc-examples"> | |
4090 | <h5>Response Content-Types: | |
4091 | <span>application/json</span> | |
4092 | </h5> | |
4093 | <section> | |
4094 | <h5>Response Example | |
4095 | <span>(200 OK)</span> | |
4096 | </h5> | |
4097 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4098 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4099 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
4100 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
4101 | <span class="hljs-attr">"owner"</span>: { | |
4102 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4103 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
4104 | }, | |
4105 | <span class="hljs-attr">"videos"</span>: [ | |
4106 | { | |
4107 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4108 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
4109 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
4110 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
4111 | <span class="hljs-attr">"category"</span>: { |
4112 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4113 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
4114 | }, | |
4115 | <span class="hljs-attr">"licence"</span>: { | |
4116 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4117 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
4118 | }, | |
4119 | <span class="hljs-attr">"language"</span>: { | |
4120 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4121 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
4122 | }, | |
5e1c08eb C |
4123 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
4124 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
4125 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
4126 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
4127 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
4128 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
4129 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
4130 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
4131 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
4132 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
4133 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
4134 | } | |
4135 | ] | |
4136 | } | |
4137 | </code></pre> | |
4138 | <!-- </div> --> | |
4139 | </section> | |
4140 | </div> | |
4141 | </div> | |
4142 | </div> | |
ab0ee6a1 | 4143 | <div id="operation--videos-channels--id--put" class="operation panel" data-traverse-target="operation--videos-channels--id--put"> |
5e1c08eb C |
4144 | <!-- <section class="operation-tags row"> --> |
4145 | <!-- <div class="doc-copy"> --> | |
4146 | <div class="operation-tags"> | |
4147 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
4148 | <!----> | |
4149 | </div> | |
4150 | <!-- </div> --> | |
4151 | <!-- </section> --> | |
4152 | <h2 class="operation-title"> | |
4153 | <span class="operation-name"> | |
4154 | <span class="operation-name">PUT</span> | |
ab0ee6a1 | 4155 | <span class="operation-path">/videos/channels/{id}</span> |
5e1c08eb C |
4156 | </span> |
4157 | </h2> | |
4158 | <div class="doc-row"> | |
4159 | <div class="doc-copy"> | |
4160 | <section class="swagger-request-body"> | |
4161 | <div class="prop-row"> | |
4162 | <div class="prop-name"> | |
4163 | <div class="swagger-request-model"> | |
4164 | <span class=""> | |
4165 | <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a> | |
4166 | </span> | |
4167 | </div> | |
4168 | </div> | |
4169 | <div class="prop-value columns small-6"> | |
4170 | <!-- <div class="swagger-request-description"> -->undefined | |
4171 | <!-- </div> --> | |
4172 | </div> | |
4173 | </div> | |
4174 | </section> | |
4175 | <section class="swagger-request-params"> | |
4176 | <div class="prop-row prop-group"> | |
4177 | <div class="prop-name"> | |
4178 | <div class="prop-title">id</div> | |
4179 | <span class="json-property-required"></span> | |
4180 | </div> | |
4181 | <div class="prop-value"> | |
4182 | <p>The video id </p> | |
4183 | </div> | |
4184 | </div> | |
4185 | <div class="prop-row prop-inner"> | |
4186 | <div class="prop-name param-label">type</div> | |
4187 | <div class="prop-value"> | |
4188 | <span class="json-property-type">string</span> | |
4189 | <span class="json-property-range" title="Value limits"></span> | |
4190 | </div> | |
4191 | </div> | |
4192 | <div class="prop-row prop-inner"> | |
4193 | <div class="prop-name param-label">in</div> | |
4194 | <div class="prop-value">path</div> | |
4195 | </div> | |
4196 | </section> | |
4197 | </div> | |
4198 | <div class="doc-examples"> | |
4199 | <section> | |
4200 | <h5>Request Content-Types: | |
4201 | <span>application/json</span> | |
4202 | </h5> | |
4203 | <h5>Request Example</h5> | |
4204 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4205 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4206 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
4207 | } | |
4208 | </code></pre> | |
4209 | <!-- </div> --> | |
4210 | </section> | |
4211 | </div> | |
4212 | </div> | |
4213 | <div class="doc-row"> | |
4214 | <div class="doc-copy"> | |
4215 | <section class="swagger-responses"> | |
4216 | <div class="prop-row prop-group"> | |
4217 | <div class="prop-name"> | |
4218 | <div class="prop-title">204 No Content</div> | |
4219 | </div> | |
4220 | <div class="prop-value"> | |
4221 | <p>successful operation</p> | |
4222 | </div> | |
4223 | </div> | |
4224 | </section> | |
4225 | </div> | |
4226 | <div class="doc-examples"> | |
4227 | <h5>Response Content-Types: | |
4228 | <span>application/json</span> | |
4229 | </h5> | |
4230 | </div> | |
4231 | </div> | |
4232 | </div> | |
ab0ee6a1 | 4233 | <div id="operation--videos-channels--id--delete" class="operation panel" data-traverse-target="operation--videos-channels--id--delete"> |
5e1c08eb C |
4234 | <!-- <section class="operation-tags row"> --> |
4235 | <!-- <div class="doc-copy"> --> | |
4236 | <div class="operation-tags"> | |
4237 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
4238 | <!----> | |
4239 | </div> | |
4240 | <!-- </div> --> | |
4241 | <!-- </section> --> | |
4242 | <h2 class="operation-title"> | |
4243 | <span class="operation-name"> | |
4244 | <span class="operation-name">DELETE</span> | |
ab0ee6a1 | 4245 | <span class="operation-path">/videos/channels/{id}</span> |
5e1c08eb C |
4246 | </span> |
4247 | </h2> | |
4248 | <div class="doc-row"> | |
4249 | <div class="doc-copy"> | |
4250 | <section class="swagger-request-params"> | |
4251 | <div class="prop-row prop-group"> | |
4252 | <div class="prop-name"> | |
4253 | <div class="prop-title">id</div> | |
4254 | <span class="json-property-required"></span> | |
4255 | </div> | |
4256 | <div class="prop-value"> | |
4257 | <p>The video id </p> | |
4258 | </div> | |
4259 | </div> | |
4260 | <div class="prop-row prop-inner"> | |
4261 | <div class="prop-name param-label">type</div> | |
4262 | <div class="prop-value"> | |
4263 | <span class="json-property-type">string</span> | |
4264 | <span class="json-property-range" title="Value limits"></span> | |
4265 | </div> | |
4266 | </div> | |
4267 | <div class="prop-row prop-inner"> | |
4268 | <div class="prop-name param-label">in</div> | |
4269 | <div class="prop-value">path</div> | |
4270 | </div> | |
4271 | </section> | |
4272 | </div> | |
4273 | <div class="doc-examples"></div> | |
4274 | </div> | |
4275 | <div class="doc-row"> | |
4276 | <div class="doc-copy"> | |
4277 | <section class="swagger-responses"> | |
4278 | <div class="prop-row prop-group"> | |
4279 | <div class="prop-name"> | |
4280 | <div class="prop-title">204 No Content</div> | |
4281 | </div> | |
4282 | <div class="prop-value"> | |
4283 | <p>successful operation</p> | |
4284 | </div> | |
4285 | </div> | |
4286 | </section> | |
4287 | </div> | |
4288 | <div class="doc-examples"> | |
4289 | <h5>Response Content-Types: | |
4290 | <span>application/json</span> | |
4291 | </h5> | |
4292 | </div> | |
4293 | </div> | |
4294 | </div> | |
ab0ee6a1 | 4295 | <div id="operation--videos-accounts--accountId--channels-get" class="operation panel" data-traverse-target="operation--videos-accounts--accountId--channels-get"> |
5e1c08eb C |
4296 | <!-- <section class="operation-tags row"> --> |
4297 | <!-- <div class="doc-copy"> --> | |
4298 | <div class="operation-tags"> | |
4299 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
4300 | <!----> | |
4301 | </div> | |
4302 | <!-- </div> --> | |
4303 | <!-- </section> --> | |
4304 | <h2 class="operation-title"> | |
4305 | <span class="operation-name"> | |
4306 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 4307 | <span class="operation-path">/videos/accounts/{accountId}/channels</span> |
5e1c08eb C |
4308 | </span> |
4309 | </h2> | |
4310 | <div class="doc-row"> | |
4311 | <div class="doc-copy"> | |
4312 | <section class="swagger-request-params"> | |
4313 | <div class="prop-row prop-group"> | |
4314 | <div class="prop-name"> | |
4315 | <div class="prop-title">accountId</div> | |
4316 | <span class="json-property-required"></span> | |
4317 | </div> | |
4318 | <div class="prop-value"> | |
4319 | <p>The account id </p> | |
4320 | </div> | |
4321 | </div> | |
4322 | <div class="prop-row prop-inner"> | |
4323 | <div class="prop-name param-label">type</div> | |
4324 | <div class="prop-value"> | |
4325 | <span class="json-property-type">string</span> | |
4326 | <span class="json-property-range" title="Value limits"></span> | |
4327 | </div> | |
4328 | </div> | |
4329 | <div class="prop-row prop-inner"> | |
4330 | <div class="prop-name param-label">in</div> | |
4331 | <div class="prop-value">path</div> | |
4332 | </div> | |
4333 | </section> | |
4334 | </div> | |
4335 | <div class="doc-examples"></div> | |
4336 | </div> | |
4337 | <div class="doc-row"> | |
4338 | <div class="doc-copy"> | |
4339 | <section class="swagger-responses"> | |
4340 | <div class="prop-row prop-group"> | |
4341 | <div class="prop-name"> | |
4342 | <div class="prop-title">200 OK</div> | |
4343 | <div class="prop-ref"> | |
4344 | <span class="json-schema-ref-array"> | |
4345 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
4346 | </span> | |
4347 | </div> | |
4348 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
4349 | </div> | |
4350 | <div class="prop-value"> | |
4351 | <p>successful operation</p> | |
4352 | </div> | |
4353 | </div> | |
4354 | </section> | |
4355 | </div> | |
4356 | <div class="doc-examples"> | |
4357 | <h5>Response Content-Types: | |
4358 | <span>application/json</span> | |
4359 | </h5> | |
4360 | <section> | |
4361 | <h5>Response Example | |
4362 | <span>(200 OK)</span> | |
4363 | </h5> | |
4364 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
4365 | { | |
4366 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4367 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
4368 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
4369 | <span class="hljs-attr">"owner"</span>: { | |
4370 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4371 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
4372 | }, | |
4373 | <span class="hljs-attr">"videos"</span>: [ | |
4374 | { | |
4375 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4376 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
4377 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
4378 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
4379 | <span class="hljs-attr">"category"</span>: { |
4380 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4381 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
4382 | }, | |
4383 | <span class="hljs-attr">"licence"</span>: { | |
4384 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4385 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
4386 | }, | |
4387 | <span class="hljs-attr">"language"</span>: { | |
4388 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4389 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
4390 | }, | |
5e1c08eb C |
4391 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
4392 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
4393 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
4394 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
4395 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
4396 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
4397 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
4398 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
4399 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
4400 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
4401 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
4402 | } | |
4403 | ] | |
4404 | } | |
4405 | ] | |
4406 | </code></pre> | |
4407 | <!-- </div> --> | |
4408 | </section> | |
4409 | </div> | |
4410 | </div> | |
4411 | </div> | |
4412 | <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1> | |
ab0ee6a1 | 4413 | <div id="operation--videos--videoId--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-get"> |
5e1c08eb C |
4414 | <!-- <section class="operation-tags row"> --> |
4415 | <!-- <div class="doc-copy"> --> | |
4416 | <div class="operation-tags"> | |
4417 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
4418 | <!----> | |
4419 | </div> | |
4420 | <!-- </div> --> | |
4421 | <!-- </section> --> | |
4422 | <h2 class="operation-title"> | |
4423 | <span class="operation-name"> | |
4424 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 4425 | <span class="operation-path">/videos/{videoId}/comment-threads</span> |
5e1c08eb C |
4426 | </span> |
4427 | </h2> | |
4428 | <div class="doc-row"> | |
4429 | <div class="doc-copy"> | |
4430 | <section class="swagger-request-params"> | |
4431 | <div class="prop-row prop-group"> | |
4432 | <div class="prop-name"> | |
ab0ee6a1 C |
4433 | <div class="prop-title">videoId</div> |
4434 | <span class="json-property-required"></span> | |
4435 | </div> | |
4436 | <div class="prop-value"> | |
4437 | <p>The video id </p> | |
4438 | </div> | |
4439 | </div> | |
4440 | <div class="prop-row prop-inner"> | |
4441 | <div class="prop-name param-label">type</div> | |
4442 | <div class="prop-value"> | |
4443 | <span class="json-property-type">string</span> | |
4444 | <span class="json-property-range" title="Value limits"></span> | |
4445 | </div> | |
4446 | </div> | |
4447 | <div class="prop-row prop-inner"> | |
4448 | <div class="prop-name param-label">in</div> | |
4449 | <div class="prop-value">path</div> | |
4450 | </div> | |
4451 | <div class="prop-row prop-group"> | |
4452 | <div class="prop-name"> | |
4453 | <div class="prop-title">start</div> | |
4454 | </div> | |
4455 | <div class="prop-value"> | |
4456 | <p>starting page</p> | |
4457 | </div> | |
4458 | </div> | |
4459 | <div class="prop-row prop-inner"> | |
4460 | <div class="prop-name param-label">type</div> | |
4461 | <div class="prop-value"> | |
4462 | <span class="json-property-type">number</span> | |
4463 | <span class="json-property-range" title="Value limits"></span> | |
4464 | </div> | |
4465 | </div> | |
4466 | <div class="prop-row prop-inner"> | |
4467 | <div class="prop-name param-label">in</div> | |
4468 | <div class="prop-value">query</div> | |
4469 | </div> | |
4470 | <div class="prop-row prop-group"> | |
4471 | <div class="prop-name"> | |
4472 | <div class="prop-title">stop</div> | |
5e1c08eb C |
4473 | </div> |
4474 | <div class="prop-value"> | |
f209b32a | 4475 | <p>stopping page</p> |
5e1c08eb C |
4476 | </div> |
4477 | </div> | |
4478 | <div class="prop-row prop-inner"> | |
4479 | <div class="prop-name param-label">type</div> | |
4480 | <div class="prop-value"> | |
ab0ee6a1 | 4481 | <span class="json-property-type">number</span> |
5e1c08eb C |
4482 | <span class="json-property-range" title="Value limits"></span> |
4483 | </div> | |
4484 | </div> | |
4485 | <div class="prop-row prop-inner"> | |
4486 | <div class="prop-name param-label">in</div> | |
ab0ee6a1 C |
4487 | <div class="prop-value">query</div> |
4488 | </div> | |
4489 | <div class="prop-row prop-group"> | |
4490 | <div class="prop-name"> | |
4491 | <div class="prop-title">sort</div> | |
4492 | </div> | |
4493 | <div class="prop-value"> | |
4494 | <p>sorting</p> | |
4495 | </div> | |
4496 | </div> | |
4497 | <div class="prop-row prop-inner"> | |
4498 | <div class="prop-name param-label">type</div> | |
4499 | <div class="prop-value"> | |
4500 | <span class="json-property-type">number</span> | |
4501 | <span class="json-property-range" title="Value limits"></span> | |
4502 | </div> | |
4503 | </div> | |
4504 | <div class="prop-row prop-inner"> | |
4505 | <div class="prop-name param-label">in</div> | |
4506 | <div class="prop-value">query</div> | |
5e1c08eb C |
4507 | </div> |
4508 | </section> | |
4509 | </div> | |
4510 | <div class="doc-examples"></div> | |
4511 | </div> | |
4512 | <div class="doc-row"> | |
4513 | <div class="doc-copy"> | |
4514 | <section class="swagger-responses"> | |
4515 | <div class="prop-row prop-group"> | |
4516 | <div class="prop-name"> | |
4517 | <div class="prop-title">200 OK</div> | |
4518 | <div class="prop-ref"> | |
4519 | <span class=""> | |
ab0ee6a1 | 4520 | <a class="json-schema-ref" href="#/definitions/CommentThreadResponse">CommentThreadResponse</a> |
5e1c08eb C |
4521 | </span> |
4522 | </div> | |
4523 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
4524 | </div> | |
4525 | <div class="prop-value"> | |
4526 | <p>successful operation</p> | |
4527 | </div> | |
4528 | </div> | |
4529 | </section> | |
4530 | </div> | |
4531 | <div class="doc-examples"> | |
4532 | <h5>Response Content-Types: | |
4533 | <span>application/json</span> | |
4534 | </h5> | |
4535 | <section> | |
4536 | <h5>Response Example | |
4537 | <span>(200 OK)</span> | |
4538 | </h5> | |
ab0ee6a1 C |
4539 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ |
4540 | <span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>, | |
4541 | <span class="hljs-attr">"data"</span>: [ | |
4542 | { | |
4543 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4544 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4545 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
4546 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
4547 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
4548 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4549 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4550 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4551 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
4552 | <span class="hljs-attr">"account"</span>: { | |
4553 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4554 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4555 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4556 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4557 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4558 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
4559 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
4560 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
4561 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4562 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4563 | <span class="hljs-attr">"avatar"</span>: { | |
4564 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
4565 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4566 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
4567 | } | |
4568 | } | |
4569 | } | |
4570 | ] | |
4571 | } | |
4572 | </code></pre> | |
5e1c08eb C |
4573 | <!-- </div> --> |
4574 | </section> | |
4575 | </div> | |
4576 | </div> | |
4577 | </div> | |
ab0ee6a1 | 4578 | <div id="operation--videos--videoId--comment-threads-post" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-post"> |
5e1c08eb C |
4579 | <!-- <section class="operation-tags row"> --> |
4580 | <!-- <div class="doc-copy"> --> | |
4581 | <div class="operation-tags"> | |
4582 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
4583 | <!----> | |
4584 | </div> | |
4585 | <!-- </div> --> | |
4586 | <!-- </section> --> | |
4587 | <h2 class="operation-title"> | |
4588 | <span class="operation-name"> | |
4589 | <span class="operation-name">POST</span> | |
ab0ee6a1 | 4590 | <span class="operation-path">/videos/{videoId}/comment-threads</span> |
5e1c08eb C |
4591 | </span> |
4592 | </h2> | |
4593 | <div class="doc-row"> | |
4594 | <div class="doc-copy"> | |
4595 | <section class="swagger-request-params"> | |
4596 | <div class="prop-row prop-group"> | |
4597 | <div class="prop-name"> | |
4598 | <div class="prop-title">videoId</div> | |
4599 | <span class="json-property-required"></span> | |
4600 | </div> | |
4601 | <div class="prop-value"> | |
4602 | <p>The video id </p> | |
4603 | </div> | |
4604 | </div> | |
4605 | <div class="prop-row prop-inner"> | |
4606 | <div class="prop-name param-label">type</div> | |
4607 | <div class="prop-value"> | |
4608 | <span class="json-property-type">string</span> | |
4609 | <span class="json-property-range" title="Value limits"></span> | |
4610 | </div> | |
4611 | </div> | |
4612 | <div class="prop-row prop-inner"> | |
4613 | <div class="prop-name param-label">in</div> | |
4614 | <div class="prop-value">path</div> | |
4615 | </div> | |
4616 | </section> | |
4617 | </div> | |
4618 | <div class="doc-examples"></div> | |
4619 | </div> | |
4620 | <div class="doc-row"> | |
4621 | <div class="doc-copy"> | |
4622 | <section class="swagger-responses"> | |
4623 | <div class="prop-row prop-group"> | |
4624 | <div class="prop-name"> | |
4625 | <div class="prop-title">200 OK</div> | |
ab0ee6a1 C |
4626 | <div class="prop-ref"> |
4627 | <span class=""> | |
4628 | <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a> | |
4629 | </span> | |
4630 | </div> | |
4631 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
5e1c08eb C |
4632 | </div> |
4633 | <div class="prop-value"> | |
4634 | <p>successful operation</p> | |
4635 | </div> | |
4636 | </div> | |
4637 | </section> | |
4638 | </div> | |
4639 | <div class="doc-examples"> | |
4640 | <h5>Response Content-Types: | |
4641 | <span>application/json</span> | |
4642 | </h5> | |
ab0ee6a1 C |
4643 | <section> |
4644 | <h5>Response Example | |
4645 | <span>(200 OK)</span> | |
4646 | </h5> | |
4647 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4648 | <span class="hljs-attr">"comment"</span>: { | |
4649 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4650 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4651 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
4652 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
4653 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
4654 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4655 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4656 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4657 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
4658 | <span class="hljs-attr">"account"</span>: { | |
4659 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4660 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4661 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4662 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4663 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4664 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
4665 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
4666 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
4667 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4668 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4669 | <span class="hljs-attr">"avatar"</span>: { | |
4670 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
4671 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4672 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
4673 | } | |
4674 | } | |
4675 | } | |
4676 | } | |
4677 | </code></pre> | |
4678 | <!-- </div> --> | |
4679 | </section> | |
5e1c08eb C |
4680 | </div> |
4681 | </div> | |
4682 | </div> | |
ab0ee6a1 | 4683 | <div id="operation--videos--videoId--comment-threads--threadId--get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads--threadId--get"> |
5e1c08eb C |
4684 | <!-- <section class="operation-tags row"> --> |
4685 | <!-- <div class="doc-copy"> --> | |
4686 | <div class="operation-tags"> | |
4687 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
4688 | <!----> | |
4689 | </div> | |
4690 | <!-- </div> --> | |
4691 | <!-- </section> --> | |
4692 | <h2 class="operation-title"> | |
4693 | <span class="operation-name"> | |
4694 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 4695 | <span class="operation-path">/videos/{videoId}/comment-threads/{threadId}</span> |
5e1c08eb C |
4696 | </span> |
4697 | </h2> | |
4698 | <div class="doc-row"> | |
4699 | <div class="doc-copy"> | |
4700 | <section class="swagger-request-params"> | |
4701 | <div class="prop-row prop-group"> | |
4702 | <div class="prop-name"> | |
4703 | <div class="prop-title">videoId</div> | |
4704 | <span class="json-property-required"></span> | |
4705 | </div> | |
4706 | <div class="prop-value"> | |
4707 | <p>The video id </p> | |
4708 | </div> | |
4709 | </div> | |
4710 | <div class="prop-row prop-inner"> | |
4711 | <div class="prop-name param-label">type</div> | |
4712 | <div class="prop-value"> | |
4713 | <span class="json-property-type">string</span> | |
4714 | <span class="json-property-range" title="Value limits"></span> | |
4715 | </div> | |
4716 | </div> | |
4717 | <div class="prop-row prop-inner"> | |
4718 | <div class="prop-name param-label">in</div> | |
4719 | <div class="prop-value">path</div> | |
4720 | </div> | |
4721 | <div class="prop-row prop-group"> | |
4722 | <div class="prop-name"> | |
4723 | <div class="prop-title">threadId</div> | |
4724 | <span class="json-property-required"></span> | |
4725 | </div> | |
4726 | <div class="prop-value"> | |
4727 | <p>The thread id </p> | |
4728 | </div> | |
4729 | </div> | |
4730 | <div class="prop-row prop-inner"> | |
4731 | <div class="prop-name param-label">type</div> | |
4732 | <div class="prop-value"> | |
4733 | <span class="json-property-type">string</span> | |
4734 | <span class="json-property-range" title="Value limits"></span> | |
4735 | </div> | |
4736 | </div> | |
4737 | <div class="prop-row prop-inner"> | |
4738 | <div class="prop-name param-label">in</div> | |
4739 | <div class="prop-value">path</div> | |
4740 | </div> | |
4741 | </section> | |
4742 | </div> | |
4743 | <div class="doc-examples"></div> | |
4744 | </div> | |
4745 | <div class="doc-row"> | |
4746 | <div class="doc-copy"> | |
4747 | <section class="swagger-responses"> | |
4748 | <div class="prop-row prop-group"> | |
4749 | <div class="prop-name"> | |
4750 | <div class="prop-title">200 OK</div> | |
4751 | <div class="prop-ref"> | |
4752 | <span class=""> | |
4753 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
4754 | </span> | |
4755 | </div> | |
4756 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
4757 | </div> | |
4758 | <div class="prop-value"> | |
4759 | <p>successful operation</p> | |
4760 | </div> | |
4761 | </div> | |
4762 | </section> | |
4763 | </div> | |
4764 | <div class="doc-examples"> | |
4765 | <h5>Response Content-Types: | |
4766 | <span>application/json</span> | |
4767 | </h5> | |
4768 | <section> | |
4769 | <h5>Response Example | |
4770 | <span>(200 OK)</span> | |
4771 | </h5> | |
4772 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4773 | <span class="hljs-attr">"comment"</span>: { | |
4774 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4775 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4776 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
4777 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
4778 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
4779 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4780 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4781 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4782 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
4783 | <span class="hljs-attr">"account"</span>: { | |
4784 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4785 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4786 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4787 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4788 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4789 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
4790 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
4791 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
4792 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4793 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4794 | <span class="hljs-attr">"avatar"</span>: { | |
4795 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
4796 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4797 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
4798 | } | |
4799 | } | |
4800 | }, | |
4801 | <span class="hljs-attr">"children"</span>: [ | |
4802 | { | |
4803 | <span class="hljs-attr">"comment"</span>: { | |
4804 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4805 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4806 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
4807 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
4808 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
4809 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4810 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4811 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4812 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
4813 | <span class="hljs-attr">"account"</span>: { | |
4814 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4815 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4816 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4817 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4818 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4819 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
4820 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
4821 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
4822 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4823 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4824 | <span class="hljs-attr">"avatar"</span>: { | |
4825 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
4826 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4827 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
4828 | } | |
4829 | } | |
4830 | }, | |
4831 | <span class="hljs-attr">"children"</span>: [ | |
4832 | { | |
4833 | <span class="hljs-attr">"comment"</span>: { | |
4834 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4835 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4836 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
4837 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
4838 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
4839 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4840 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4841 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4842 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
4843 | <span class="hljs-attr">"account"</span>: { | |
4844 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4845 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4846 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4847 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4848 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
4849 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
4850 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
4851 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4852 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4853 | <span class="hljs-attr">"avatar"</span>: { | |
4854 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
4855 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4856 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
4857 | } | |
4858 | } | |
4859 | } | |
4860 | } | |
4861 | ] | |
4862 | } | |
4863 | ] | |
4864 | } | |
4865 | </code></pre> | |
4866 | <!-- </div> --> | |
4867 | </section> | |
4868 | </div> | |
4869 | </div> | |
4870 | </div> | |
ab0ee6a1 | 4871 | <div id="operation--videos--videoId--comments--commentId--post" class="operation panel" data-traverse-target="operation--videos--videoId--comments--commentId--post"> |
5e1c08eb C |
4872 | <!-- <section class="operation-tags row"> --> |
4873 | <!-- <div class="doc-copy"> --> | |
4874 | <div class="operation-tags"> | |
4875 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
4876 | <!----> | |
4877 | </div> | |
4878 | <!-- </div> --> | |
4879 | <!-- </section> --> | |
4880 | <h2 class="operation-title"> | |
4881 | <span class="operation-name"> | |
4882 | <span class="operation-name">POST</span> | |
ab0ee6a1 | 4883 | <span class="operation-path">/videos/{videoId}/comments/{commentId}</span> |
5e1c08eb C |
4884 | </span> |
4885 | </h2> | |
4886 | <div class="doc-row"> | |
4887 | <div class="doc-copy"> | |
4888 | <section class="swagger-request-params"> | |
4889 | <div class="prop-row prop-group"> | |
4890 | <div class="prop-name"> | |
4891 | <div class="prop-title">videoId</div> | |
4892 | <span class="json-property-required"></span> | |
4893 | </div> | |
4894 | <div class="prop-value"> | |
4895 | <p>The video id </p> | |
4896 | </div> | |
4897 | </div> | |
4898 | <div class="prop-row prop-inner"> | |
4899 | <div class="prop-name param-label">type</div> | |
4900 | <div class="prop-value"> | |
4901 | <span class="json-property-type">string</span> | |
4902 | <span class="json-property-range" title="Value limits"></span> | |
4903 | </div> | |
4904 | </div> | |
4905 | <div class="prop-row prop-inner"> | |
4906 | <div class="prop-name param-label">in</div> | |
4907 | <div class="prop-value">path</div> | |
4908 | </div> | |
4909 | <div class="prop-row prop-group"> | |
4910 | <div class="prop-name"> | |
4911 | <div class="prop-title">commentId</div> | |
4912 | <span class="json-property-required"></span> | |
4913 | </div> | |
4914 | <div class="prop-value"> | |
4915 | <p>The comment id </p> | |
4916 | </div> | |
4917 | </div> | |
4918 | <div class="prop-row prop-inner"> | |
4919 | <div class="prop-name param-label">type</div> | |
4920 | <div class="prop-value"> | |
4921 | <span class="json-property-type">string</span> | |
4922 | <span class="json-property-range" title="Value limits"></span> | |
4923 | </div> | |
4924 | </div> | |
4925 | <div class="prop-row prop-inner"> | |
4926 | <div class="prop-name param-label">in</div> | |
4927 | <div class="prop-value">path</div> | |
4928 | </div> | |
4929 | </section> | |
4930 | </div> | |
4931 | <div class="doc-examples"></div> | |
4932 | </div> | |
4933 | <div class="doc-row"> | |
4934 | <div class="doc-copy"> | |
4935 | <section class="swagger-responses"> | |
4936 | <div class="prop-row prop-group"> | |
4937 | <div class="prop-name"> | |
4938 | <div class="prop-title">200 OK</div> | |
ab0ee6a1 C |
4939 | <div class="prop-ref"> |
4940 | <span class=""> | |
4941 | <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a> | |
4942 | </span> | |
4943 | </div> | |
4944 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
5e1c08eb C |
4945 | </div> |
4946 | <div class="prop-value"> | |
4947 | <p>successful operation</p> | |
4948 | </div> | |
4949 | </div> | |
4950 | </section> | |
4951 | </div> | |
4952 | <div class="doc-examples"> | |
4953 | <h5>Response Content-Types: | |
4954 | <span>application/json</span> | |
4955 | </h5> | |
ab0ee6a1 C |
4956 | <section> |
4957 | <h5>Response Example | |
4958 | <span>(200 OK)</span> | |
4959 | </h5> | |
4960 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4961 | <span class="hljs-attr">"comment"</span>: { | |
4962 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4963 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4964 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
4965 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
4966 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
4967 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4968 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4969 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4970 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
4971 | <span class="hljs-attr">"account"</span>: { | |
4972 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4973 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4974 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4975 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4976 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4977 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
4978 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
4979 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
4980 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4981 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4982 | <span class="hljs-attr">"avatar"</span>: { | |
4983 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
4984 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4985 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
4986 | } | |
4987 | } | |
4988 | } | |
4989 | } | |
4990 | </code></pre> | |
4991 | <!-- </div> --> | |
4992 | </section> | |
5e1c08eb C |
4993 | </div> |
4994 | </div> | |
4995 | </div> | |
ab0ee6a1 | 4996 | <div id="operation--videos--videoId--comments--commentId--delete" class="operation panel" data-traverse-target="operation--videos--videoId--comments--commentId--delete"> |
5e1c08eb C |
4997 | <!-- <section class="operation-tags row"> --> |
4998 | <!-- <div class="doc-copy"> --> | |
4999 | <div class="operation-tags"> | |
5000 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
5001 | <!----> | |
5002 | </div> | |
5003 | <!-- </div> --> | |
5004 | <!-- </section> --> | |
5005 | <h2 class="operation-title"> | |
5006 | <span class="operation-name"> | |
5007 | <span class="operation-name">DELETE</span> | |
ab0ee6a1 | 5008 | <span class="operation-path">/videos/{videoId}/comments/{commentId}</span> |
5e1c08eb C |
5009 | </span> |
5010 | </h2> | |
5011 | <div class="doc-row"> | |
5012 | <div class="doc-copy"> | |
5013 | <section class="swagger-request-params"> | |
5014 | <div class="prop-row prop-group"> | |
5015 | <div class="prop-name"> | |
5016 | <div class="prop-title">videoId</div> | |
5017 | <span class="json-property-required"></span> | |
5018 | </div> | |
5019 | <div class="prop-value"> | |
5020 | <p>The video id </p> | |
5021 | </div> | |
5022 | </div> | |
5023 | <div class="prop-row prop-inner"> | |
5024 | <div class="prop-name param-label">type</div> | |
5025 | <div class="prop-value"> | |
5026 | <span class="json-property-type">string</span> | |
5027 | <span class="json-property-range" title="Value limits"></span> | |
5028 | </div> | |
5029 | </div> | |
5030 | <div class="prop-row prop-inner"> | |
5031 | <div class="prop-name param-label">in</div> | |
5032 | <div class="prop-value">path</div> | |
5033 | </div> | |
5034 | <div class="prop-row prop-group"> | |
5035 | <div class="prop-name"> | |
5036 | <div class="prop-title">commentId</div> | |
5037 | <span class="json-property-required"></span> | |
5038 | </div> | |
5039 | <div class="prop-value"> | |
5040 | <p>The comment id </p> | |
5041 | </div> | |
5042 | </div> | |
5043 | <div class="prop-row prop-inner"> | |
5044 | <div class="prop-name param-label">type</div> | |
5045 | <div class="prop-value"> | |
5046 | <span class="json-property-type">string</span> | |
5047 | <span class="json-property-range" title="Value limits"></span> | |
5048 | </div> | |
5049 | </div> | |
5050 | <div class="prop-row prop-inner"> | |
5051 | <div class="prop-name param-label">in</div> | |
5052 | <div class="prop-value">path</div> | |
5053 | </div> | |
5054 | </section> | |
5055 | </div> | |
5056 | <div class="doc-examples"></div> | |
5057 | </div> | |
5058 | <div class="doc-row"> | |
5059 | <div class="doc-copy"> | |
5060 | <section class="swagger-responses"> | |
5061 | <div class="prop-row prop-group"> | |
5062 | <div class="prop-name"> | |
5063 | <div class="prop-title">204 No Content</div> | |
5064 | </div> | |
5065 | <div class="prop-value"> | |
5066 | <p>successful operation</p> | |
5067 | </div> | |
5068 | </div> | |
5069 | </section> | |
5070 | </div> | |
5071 | <div class="doc-examples"> | |
5072 | <h5>Response Content-Types: | |
5073 | <span>application/json</span> | |
5074 | </h5> | |
5075 | </div> | |
5076 | </div> | |
5077 | </div> | |
5078 | <h1 id="tag-VideoRate" class="swagger-summary-tag" data-traverse-target="tag-VideoRate">VideoRate</h1> | |
ab0ee6a1 | 5079 | <div id="operation--videos--id--rate-put" class="operation panel" data-traverse-target="operation--videos--id--rate-put"> |
5e1c08eb C |
5080 | <!-- <section class="operation-tags row"> --> |
5081 | <!-- <div class="doc-copy"> --> | |
5082 | <div class="operation-tags"> | |
5083 | <a class="label" href="#tag-VideoRate">VideoRate</a> | |
5084 | <!----> | |
5085 | </div> | |
5086 | <!-- </div> --> | |
5087 | <!-- </section> --> | |
5088 | <h2 class="operation-title"> | |
5089 | <span class="operation-name"> | |
5090 | <span class="operation-name">PUT</span> | |
ab0ee6a1 | 5091 | <span class="operation-path">/videos/{id}/rate</span> |
5e1c08eb C |
5092 | </span> |
5093 | </h2> | |
5094 | <div class="doc-row"> | |
5095 | <div class="doc-copy"> | |
5096 | <section class="swagger-request-params"> | |
5097 | <div class="prop-row prop-group"> | |
5098 | <div class="prop-name"> | |
5099 | <div class="prop-title">id</div> | |
5100 | <span class="json-property-required"></span> | |
5101 | </div> | |
5102 | <div class="prop-value"> | |
5103 | <p>The video id </p> | |
5104 | </div> | |
5105 | </div> | |
5106 | <div class="prop-row prop-inner"> | |
5107 | <div class="prop-name param-label">type</div> | |
5108 | <div class="prop-value"> | |
5109 | <span class="json-property-type">string</span> | |
5110 | <span class="json-property-range" title="Value limits"></span> | |
5111 | </div> | |
5112 | </div> | |
5113 | <div class="prop-row prop-inner"> | |
5114 | <div class="prop-name param-label">in</div> | |
5115 | <div class="prop-value">path</div> | |
5116 | </div> | |
5117 | </section> | |
5118 | </div> | |
5119 | <div class="doc-examples"></div> | |
5120 | </div> | |
5121 | <div class="doc-row"> | |
5122 | <div class="doc-copy"> | |
5123 | <section class="swagger-responses"> | |
5124 | <div class="prop-row prop-group"> | |
5125 | <div class="prop-name"> | |
5126 | <div class="prop-title">204 No Content</div> | |
5127 | </div> | |
5128 | <div class="prop-value"> | |
5129 | <p>successful operation</p> | |
5130 | </div> | |
5131 | </div> | |
5132 | </section> | |
5133 | </div> | |
5134 | <div class="doc-examples"> | |
5135 | <h5>Response Content-Types: | |
5136 | <span>application/json</span> | |
5137 | </h5> | |
5138 | </div> | |
5139 | </div> | |
5140 | </div> | |
5141 | <h1>Schema Definitions</h1> | |
5d00a3d7 C |
5142 | <div id="definition-VideoConstant" class="definition panel" data-traverse-target="definition-VideoConstant"> |
5143 | <h2 class="panel-title"> | |
5144 | <a name="/definitions/VideoConstant"></a>VideoConstant: | |
5145 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5146 | <span class="json-property-range" title="Value limits"></span> | |
5147 | ||
5148 | ||
5149 | </span> --> | |
5150 | </h2> | |
5151 | <div class="doc-row"> | |
5152 | <div class="doc-copy"> | |
5153 | <section class="json-schema-properties"> | |
5154 | <dl> | |
5155 | <dt data-property-name="id"> | |
5156 | <span class="json-property-name">id:</span> | |
5157 | <span class="json-property-type">number</span> | |
5158 | <span class="json-property-range" title="Value limits"></span> | |
5159 | </dt> | |
5160 | <dt data-property-name="label"> | |
5161 | <span class="json-property-name">label:</span> | |
5162 | <span class="json-property-type">string</span> | |
5163 | <span class="json-property-range" title="Value limits"></span> | |
5164 | </dt> | |
5165 | </dl> | |
5166 | </section> | |
5167 | </div> | |
5168 | <div class="doc-examples"> | |
5169 | <section> | |
5170 | <h5>Example</h5> | |
5171 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5172 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5173 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
5174 | } | |
5175 | </code></pre> | |
5176 | <!-- </div> --> | |
5177 | </section> | |
5178 | </div> | |
5179 | </div> | |
5180 | </div> | |
5e1c08eb C |
5181 | <div id="definition-Video" class="definition panel" data-traverse-target="definition-Video"> |
5182 | <h2 class="panel-title"> | |
5183 | <a name="/definitions/Video"></a>Video: | |
5184 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5185 | <span class="json-property-range" title="Value limits"></span> | |
5186 | ||
5187 | ||
5188 | </span> --> | |
5189 | </h2> | |
5190 | <div class="doc-row"> | |
5191 | <div class="doc-copy"> | |
5192 | <section class="json-schema-properties"> | |
5193 | <dl> | |
5194 | <dt data-property-name="id"> | |
5195 | <span class="json-property-name">id:</span> | |
5196 | <span class="json-property-type">number</span> | |
5197 | <span class="json-property-range" title="Value limits"></span> | |
5198 | </dt> | |
5199 | <dt data-property-name="uuid"> | |
5200 | <span class="json-property-name">uuid:</span> | |
5201 | <span class="json-property-type">string</span> | |
5202 | <span class="json-property-range" title="Value limits"></span> | |
5203 | </dt> | |
5e1c08eb C |
5204 | <dt data-property-name="createdAt"> |
5205 | <span class="json-property-name">createdAt:</span> | |
5206 | <span class="json-property-type">string</span> | |
5207 | <span class="json-property-range" title="Value limits"></span> | |
5208 | </dt> | |
5209 | <dt data-property-name="updatedAt"> | |
5210 | <span class="json-property-name">updatedAt:</span> | |
5211 | <span class="json-property-type">string</span> | |
5212 | <span class="json-property-range" title="Value limits"></span> | |
5213 | </dt> | |
5e1c08eb C |
5214 | <dt data-property-name="category"> |
5215 | <span class="json-property-name">category:</span> | |
5d00a3d7 C |
5216 | <span class="json-property-type"> |
5217 | <span class=""> | |
5218 | <a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a> | |
5219 | </span> | |
5220 | </span> | |
5e1c08eb C |
5221 | <span class="json-property-range" title="Value limits"></span> |
5222 | </dt> | |
5223 | <dt data-property-name="licence"> | |
5224 | <span class="json-property-name">licence:</span> | |
5d00a3d7 C |
5225 | <span class="json-property-type"> |
5226 | <span class=""> | |
5227 | <a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a> | |
5228 | </span> | |
5229 | </span> | |
5e1c08eb C |
5230 | <span class="json-property-range" title="Value limits"></span> |
5231 | </dt> | |
5232 | <dt data-property-name="language"> | |
5233 | <span class="json-property-name">language:</span> | |
5d00a3d7 C |
5234 | <span class="json-property-type"> |
5235 | <span class=""> | |
5236 | <a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a> | |
5237 | </span> | |
5238 | </span> | |
5e1c08eb C |
5239 | <span class="json-property-range" title="Value limits"></span> |
5240 | </dt> | |
5241 | <dt data-property-name="description"> | |
5242 | <span class="json-property-name">description:</span> | |
5243 | <span class="json-property-type">string</span> | |
5244 | <span class="json-property-range" title="Value limits"></span> | |
5245 | </dt> | |
5246 | <dt data-property-name="duration"> | |
5247 | <span class="json-property-name">duration:</span> | |
5248 | <span class="json-property-type">number</span> | |
5249 | <span class="json-property-range" title="Value limits"></span> | |
5250 | </dt> | |
5251 | <dt data-property-name="isLocal"> | |
5252 | <span class="json-property-name">isLocal:</span> | |
5253 | <span class="json-property-type">boolean</span> | |
5254 | <span class="json-property-range" title="Value limits"></span> | |
5255 | </dt> | |
5256 | <dt data-property-name="name"> | |
5257 | <span class="json-property-name">name:</span> | |
5258 | <span class="json-property-type">string</span> | |
5259 | <span class="json-property-range" title="Value limits"></span> | |
5260 | </dt> | |
5e1c08eb C |
5261 | <dt data-property-name="thumbnailPath"> |
5262 | <span class="json-property-name">thumbnailPath:</span> | |
5263 | <span class="json-property-type">string</span> | |
5264 | <span class="json-property-range" title="Value limits"></span> | |
5265 | </dt> | |
5266 | <dt data-property-name="previewPath"> | |
5267 | <span class="json-property-name">previewPath:</span> | |
5268 | <span class="json-property-type">string</span> | |
5269 | <span class="json-property-range" title="Value limits"></span> | |
5270 | </dt> | |
5271 | <dt data-property-name="embedPath"> | |
5272 | <span class="json-property-name">embedPath:</span> | |
5273 | <span class="json-property-type">string</span> | |
5274 | <span class="json-property-range" title="Value limits"></span> | |
5275 | </dt> | |
5276 | <dt data-property-name="views"> | |
5277 | <span class="json-property-name">views:</span> | |
5278 | <span class="json-property-type">number</span> | |
5279 | <span class="json-property-range" title="Value limits"></span> | |
5280 | </dt> | |
5281 | <dt data-property-name="likes"> | |
5282 | <span class="json-property-name">likes:</span> | |
5283 | <span class="json-property-type">number</span> | |
5284 | <span class="json-property-range" title="Value limits"></span> | |
5285 | </dt> | |
5286 | <dt data-property-name="dislikes"> | |
5287 | <span class="json-property-name">dislikes:</span> | |
5288 | <span class="json-property-type">number</span> | |
5289 | <span class="json-property-range" title="Value limits"></span> | |
5290 | </dt> | |
5291 | <dt data-property-name="nsfw"> | |
5292 | <span class="json-property-name">nsfw:</span> | |
5293 | <span class="json-property-type">boolean</span> | |
5294 | <span class="json-property-range" title="Value limits"></span> | |
5295 | </dt> | |
5d00a3d7 C |
5296 | <dt data-property-name="account"> |
5297 | <span class="json-property-name">account:</span> | |
5298 | <span class="json-property-type">object</span> | |
5299 | <span class="json-property-range" title="Value limits"></span> | |
5300 | </dt> | |
5e1c08eb C |
5301 | </dl> |
5302 | </section> | |
5303 | </div> | |
5304 | <div class="doc-examples"> | |
5305 | <section> | |
5306 | <h5>Example</h5> | |
5307 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5308 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5309 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
5310 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
5311 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
5312 | <span class="hljs-attr">"category"</span>: { |
5313 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5314 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
5315 | }, | |
5316 | <span class="hljs-attr">"licence"</span>: { | |
5317 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5318 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
5319 | }, | |
5320 | <span class="hljs-attr">"language"</span>: { | |
5321 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5322 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
5323 | }, | |
5e1c08eb C |
5324 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
5325 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
5326 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
5327 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
5328 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
5329 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
5330 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
5331 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
5332 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
5333 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
5334 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
5335 | } | |
5336 | </code></pre> | |
5337 | <!-- </div> --> | |
5338 | </section> | |
5339 | </div> | |
5340 | </div> | |
5341 | </div> | |
5342 | <div id="definition-VideoAbuse" class="definition panel" data-traverse-target="definition-VideoAbuse"> | |
5343 | <h2 class="panel-title"> | |
5344 | <a name="/definitions/VideoAbuse"></a>VideoAbuse: | |
5345 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5346 | <span class="json-property-range" title="Value limits"></span> | |
5347 | ||
5348 | ||
5349 | </span> --> | |
5350 | </h2> | |
5351 | <div class="doc-row"> | |
5352 | <div class="doc-copy"> | |
5353 | <section class="json-schema-properties"> | |
5354 | <dl> | |
5355 | <dt data-property-name="id"> | |
5356 | <span class="json-property-name">id:</span> | |
5357 | <span class="json-property-type">number</span> | |
5358 | <span class="json-property-range" title="Value limits"></span> | |
5359 | </dt> | |
5360 | <dt data-property-name="reason"> | |
5361 | <span class="json-property-name">reason:</span> | |
5362 | <span class="json-property-type">string</span> | |
5363 | <span class="json-property-range" title="Value limits"></span> | |
5364 | </dt> | |
5d00a3d7 C |
5365 | <dt data-property-name="reporterAccount"> |
5366 | <span class="json-property-name">reporterAccount:</span> | |
5367 | <span class="json-property-type"> | |
5368 | <span class=""> | |
5369 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
5370 | </span> | |
5371 | </span> | |
5e1c08eb C |
5372 | <span class="json-property-range" title="Value limits"></span> |
5373 | </dt> | |
5d00a3d7 C |
5374 | <dt data-property-name="video"> |
5375 | <span class="json-property-name">video:</span> | |
5376 | <span class="json-property-type">object</span> | |
5e1c08eb C |
5377 | <span class="json-property-range" title="Value limits"></span> |
5378 | </dt> | |
5379 | <dt data-property-name="createdAt"> | |
5380 | <span class="json-property-name">createdAt:</span> | |
5381 | <span class="json-property-type">string</span> | |
5382 | <span class="json-property-range" title="Value limits"></span> | |
5383 | </dt> | |
5384 | </dl> | |
5385 | </section> | |
5386 | </div> | |
5387 | <div class="doc-examples"> | |
5388 | <section> | |
5389 | <h5>Example</h5> | |
5390 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5391 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5392 | <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
5393 | <span class="hljs-attr">"reporterAccount"</span>: { |
5394 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5395 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5396 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5397 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5398 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5399 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5400 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5401 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5402 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5403 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5404 | <span class="hljs-attr">"avatar"</span>: { | |
5405 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5406 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5407 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5408 | } | |
5409 | }, | |
5e1c08eb C |
5410 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span> |
5411 | } | |
5412 | </code></pre> | |
5413 | <!-- </div> --> | |
5414 | </section> | |
5415 | </div> | |
5416 | </div> | |
5417 | </div> | |
5418 | <div id="definition-VideoBlacklist" class="definition panel" data-traverse-target="definition-VideoBlacklist"> | |
5419 | <h2 class="panel-title"> | |
5420 | <a name="/definitions/VideoBlacklist"></a>VideoBlacklist: | |
5421 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5422 | <span class="json-property-range" title="Value limits"></span> | |
5423 | ||
5424 | ||
5425 | </span> --> | |
5426 | </h2> | |
5427 | <div class="doc-row"> | |
5428 | <div class="doc-copy"> | |
5429 | <section class="json-schema-properties"> | |
5430 | <dl> | |
5431 | <dt data-property-name="id"> | |
5432 | <span class="json-property-name">id:</span> | |
5433 | <span class="json-property-type">number</span> | |
5434 | <span class="json-property-range" title="Value limits"></span> | |
5435 | </dt> | |
5436 | <dt data-property-name="videoId"> | |
5437 | <span class="json-property-name">videoId:</span> | |
5438 | <span class="json-property-type">number</span> | |
5439 | <span class="json-property-range" title="Value limits"></span> | |
5440 | </dt> | |
5441 | <dt data-property-name="createdAt"> | |
5442 | <span class="json-property-name">createdAt:</span> | |
5443 | <span class="json-property-type">string</span> | |
5444 | <span class="json-property-range" title="Value limits"></span> | |
5445 | </dt> | |
5446 | <dt data-property-name="updatedAt"> | |
5447 | <span class="json-property-name">updatedAt:</span> | |
5448 | <span class="json-property-type">string</span> | |
5449 | <span class="json-property-range" title="Value limits"></span> | |
5450 | </dt> | |
5451 | <dt data-property-name="name"> | |
5452 | <span class="json-property-name">name:</span> | |
5453 | <span class="json-property-type">string</span> | |
5454 | <span class="json-property-range" title="Value limits"></span> | |
5455 | </dt> | |
5456 | <dt data-property-name="uuid"> | |
5457 | <span class="json-property-name">uuid:</span> | |
5458 | <span class="json-property-type">string</span> | |
5459 | <span class="json-property-range" title="Value limits"></span> | |
5460 | </dt> | |
5461 | <dt data-property-name="description"> | |
5462 | <span class="json-property-name">description:</span> | |
5463 | <span class="json-property-type">string</span> | |
5464 | <span class="json-property-range" title="Value limits"></span> | |
5465 | </dt> | |
5466 | <dt data-property-name="duration"> | |
5467 | <span class="json-property-name">duration:</span> | |
5468 | <span class="json-property-type">number</span> | |
5469 | <span class="json-property-range" title="Value limits"></span> | |
5470 | </dt> | |
5471 | <dt data-property-name="views"> | |
5472 | <span class="json-property-name">views:</span> | |
5473 | <span class="json-property-type">number</span> | |
5474 | <span class="json-property-range" title="Value limits"></span> | |
5475 | </dt> | |
5476 | <dt data-property-name="likes"> | |
5477 | <span class="json-property-name">likes:</span> | |
5478 | <span class="json-property-type">number</span> | |
5479 | <span class="json-property-range" title="Value limits"></span> | |
5480 | </dt> | |
5481 | <dt data-property-name="dislikes"> | |
5482 | <span class="json-property-name">dislikes:</span> | |
5483 | <span class="json-property-type">number</span> | |
5484 | <span class="json-property-range" title="Value limits"></span> | |
5485 | </dt> | |
5486 | <dt data-property-name="nsfw"> | |
5487 | <span class="json-property-name">nsfw:</span> | |
5488 | <span class="json-property-type">boolean</span> | |
5489 | <span class="json-property-range" title="Value limits"></span> | |
5490 | </dt> | |
5491 | </dl> | |
5492 | </section> | |
5493 | </div> | |
5494 | <div class="doc-examples"> | |
5495 | <section> | |
5496 | <h5>Example</h5> | |
5497 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5498 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5499 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
5500 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5501 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5502 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5503 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5504 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
5505 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
5506 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
5507 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
5508 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
5509 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
5510 | } | |
5511 | </code></pre> | |
5512 | <!-- </div> --> | |
5513 | </section> | |
5514 | </div> | |
5515 | </div> | |
5516 | </div> | |
5517 | <div id="definition-VideoChannel" class="definition panel" data-traverse-target="definition-VideoChannel"> | |
5518 | <h2 class="panel-title"> | |
5519 | <a name="/definitions/VideoChannel"></a>VideoChannel: | |
5520 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5521 | <span class="json-property-range" title="Value limits"></span> | |
5522 | ||
5523 | ||
5524 | </span> --> | |
5525 | </h2> | |
5526 | <div class="doc-row"> | |
5527 | <div class="doc-copy"> | |
5528 | <section class="json-schema-properties"> | |
5529 | <dl> | |
5530 | <dt data-property-name="displayName"> | |
5531 | <span class="json-property-name">displayName:</span> | |
5532 | <span class="json-property-type">string</span> | |
5533 | <span class="json-property-range" title="Value limits"></span> | |
5534 | </dt> | |
5535 | <dt data-property-name="description"> | |
5536 | <span class="json-property-name">description:</span> | |
5537 | <span class="json-property-type">string</span> | |
5538 | <span class="json-property-range" title="Value limits"></span> | |
5539 | </dt> | |
5540 | <dt data-property-name="isLocal"> | |
5541 | <span class="json-property-name">isLocal:</span> | |
5542 | <span class="json-property-type">boolean</span> | |
5543 | <span class="json-property-range" title="Value limits"></span> | |
5544 | </dt> | |
5545 | <dt data-property-name="owner"> | |
5546 | <span class="json-property-name">owner:</span> | |
5547 | <span class="json-property-type">object</span> | |
5548 | <span class="json-property-range" title="Value limits"></span> | |
5549 | </dt> | |
5550 | <dt data-property-name="videos"> | |
5551 | <span class="json-property-name">videos:</span> | |
5552 | <span class="json-property-type"> | |
5553 | <span class="json-schema-ref-array"> | |
5554 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
5555 | </span> | |
5556 | </span> | |
5557 | <span class="json-property-range" title="Value limits"></span> | |
5558 | </dt> | |
5559 | </dl> | |
5560 | </section> | |
5561 | </div> | |
5562 | <div class="doc-examples"> | |
5563 | <section> | |
5564 | <h5>Example</h5> | |
5565 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5566 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5567 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
5568 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
5569 | <span class="hljs-attr">"owner"</span>: { | |
5570 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5571 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
5572 | }, | |
5573 | <span class="hljs-attr">"videos"</span>: [ | |
5574 | { | |
5575 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5576 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
5577 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
5578 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
5579 | <span class="hljs-attr">"category"</span>: { |
5580 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5581 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
5582 | }, | |
5583 | <span class="hljs-attr">"licence"</span>: { | |
5584 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5585 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
5586 | }, | |
5587 | <span class="hljs-attr">"language"</span>: { | |
5588 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5589 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
5590 | }, | |
5e1c08eb C |
5591 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
5592 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
5593 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
5594 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
5595 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
5596 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
5597 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
5598 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
5599 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
5600 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
5601 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
5602 | } | |
5603 | ] | |
5604 | } | |
5605 | </code></pre> | |
5606 | <!-- </div> --> | |
5607 | </section> | |
5608 | </div> | |
5609 | </div> | |
5610 | </div> | |
5611 | <div id="definition-VideoComment" class="definition panel" data-traverse-target="definition-VideoComment"> | |
5612 | <h2 class="panel-title"> | |
5613 | <a name="/definitions/VideoComment"></a>VideoComment: | |
5614 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5615 | <span class="json-property-range" title="Value limits"></span> | |
5616 | ||
5617 | ||
5618 | </span> --> | |
5619 | </h2> | |
5620 | <div class="doc-row"> | |
5621 | <div class="doc-copy"> | |
5622 | <section class="json-schema-properties"> | |
5623 | <dl> | |
5624 | <dt data-property-name="id"> | |
5625 | <span class="json-property-name">id:</span> | |
5626 | <span class="json-property-type">number</span> | |
5627 | <span class="json-property-range" title="Value limits"></span> | |
5628 | </dt> | |
5629 | <dt data-property-name="url"> | |
5630 | <span class="json-property-name">url:</span> | |
5631 | <span class="json-property-type">string</span> | |
5632 | <span class="json-property-range" title="Value limits"></span> | |
5633 | </dt> | |
5634 | <dt data-property-name="text"> | |
5635 | <span class="json-property-name">text:</span> | |
5636 | <span class="json-property-type">string</span> | |
5637 | <span class="json-property-range" title="Value limits"></span> | |
5638 | </dt> | |
5639 | <dt data-property-name="threadId"> | |
5640 | <span class="json-property-name">threadId:</span> | |
5641 | <span class="json-property-type">number</span> | |
5642 | <span class="json-property-range" title="Value limits"></span> | |
5643 | </dt> | |
5644 | <dt data-property-name="inReplyToCommentId"> | |
5645 | <span class="json-property-name">inReplyToCommentId:</span> | |
5646 | <span class="json-property-type">number</span> | |
5647 | <span class="json-property-range" title="Value limits"></span> | |
5648 | </dt> | |
5649 | <dt data-property-name="videoId"> | |
5650 | <span class="json-property-name">videoId:</span> | |
5651 | <span class="json-property-type">number</span> | |
5652 | <span class="json-property-range" title="Value limits"></span> | |
5653 | </dt> | |
5654 | <dt data-property-name="createdAt"> | |
5655 | <span class="json-property-name">createdAt:</span> | |
5656 | <span class="json-property-type">string</span> | |
5657 | <span class="json-property-range" title="Value limits"></span> | |
5658 | </dt> | |
5659 | <dt data-property-name="updatedAt"> | |
5660 | <span class="json-property-name">updatedAt:</span> | |
5661 | <span class="json-property-type">string</span> | |
5662 | <span class="json-property-range" title="Value limits"></span> | |
5663 | </dt> | |
5664 | <dt data-property-name="totalReplies"> | |
5665 | <span class="json-property-name">totalReplies:</span> | |
5666 | <span class="json-property-type">number</span> | |
5667 | <span class="json-property-range" title="Value limits"></span> | |
5668 | </dt> | |
5669 | <dt data-property-name="account"> | |
5670 | <span class="json-property-name">account:</span> | |
5671 | <span class="json-property-type"> | |
5672 | <span class=""> | |
5673 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
5674 | </span> | |
5675 | </span> | |
5676 | <span class="json-property-range" title="Value limits"></span> | |
5677 | </dt> | |
5678 | </dl> | |
5679 | </section> | |
5680 | </div> | |
5681 | <div class="doc-examples"> | |
5682 | <section> | |
5683 | <h5>Example</h5> | |
5684 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5685 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5686 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5687 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
5688 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
5689 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
5690 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
5691 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5692 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5693 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
5694 | <span class="hljs-attr">"account"</span>: { | |
5695 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5696 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5697 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5698 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5699 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5700 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5701 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5702 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5703 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5704 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5705 | <span class="hljs-attr">"avatar"</span>: { | |
5706 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5707 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5708 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5709 | } | |
5710 | } | |
5711 | } | |
5712 | </code></pre> | |
5713 | <!-- </div> --> | |
5714 | </section> | |
5715 | </div> | |
5716 | </div> | |
5717 | </div> | |
5718 | <div id="definition-VideoCommentThreadTree" class="definition panel" data-traverse-target="definition-VideoCommentThreadTree"> | |
5719 | <h2 class="panel-title"> | |
5720 | <a name="/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree: | |
5721 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5722 | <span class="json-property-range" title="Value limits"></span> | |
5723 | ||
5724 | ||
5725 | </span> --> | |
5726 | </h2> | |
5727 | <div class="doc-row"> | |
5728 | <div class="doc-copy"> | |
5729 | <section class="json-schema-properties"> | |
5730 | <dl> | |
5731 | <dt data-property-name="comment"> | |
5732 | <span class="json-property-name">comment:</span> | |
5733 | <span class="json-property-type"> | |
5734 | <span class=""> | |
5735 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
5736 | </span> | |
5737 | </span> | |
5738 | <span class="json-property-range" title="Value limits"></span> | |
5739 | </dt> | |
5740 | <dt data-property-name="children"> | |
5741 | <span class="json-property-name">children:</span> | |
5742 | <span class="json-property-type"> | |
5743 | <span class="json-schema-ref-array"> | |
5744 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
5745 | </span> | |
5746 | </span> | |
5747 | <span class="json-property-range" title="Value limits"></span> | |
5748 | </dt> | |
5749 | </dl> | |
5750 | </section> | |
5751 | </div> | |
5752 | <div class="doc-examples"> | |
5753 | <section> | |
5754 | <h5>Example</h5> | |
5755 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5756 | <span class="hljs-attr">"comment"</span>: { | |
5757 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5758 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5759 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
5760 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
5761 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
5762 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
5763 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5764 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5765 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
5766 | <span class="hljs-attr">"account"</span>: { | |
5767 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5768 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5769 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5770 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5771 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5772 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5773 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5774 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5775 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5776 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5777 | <span class="hljs-attr">"avatar"</span>: { | |
5778 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5779 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5780 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5781 | } | |
5782 | } | |
5783 | }, | |
5784 | <span class="hljs-attr">"children"</span>: [ | |
5785 | { | |
5786 | <span class="hljs-attr">"comment"</span>: { | |
5787 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5788 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5789 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
5790 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
5791 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
5792 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
5793 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5794 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5795 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
5796 | <span class="hljs-attr">"account"</span>: { | |
5797 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5798 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5799 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5800 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5801 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5802 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5803 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5804 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5805 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5806 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5807 | <span class="hljs-attr">"avatar"</span>: { | |
5808 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5809 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5810 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5811 | } | |
5812 | } | |
5813 | }, | |
5814 | <span class="hljs-attr">"children"</span>: [ | |
5815 | { | |
5816 | <span class="hljs-attr">"comment"</span>: { | |
5817 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5818 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5819 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
5820 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
5821 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
5822 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
5823 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5824 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5825 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
5826 | <span class="hljs-attr">"account"</span>: { | |
5827 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5828 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5829 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5830 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5831 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5832 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5833 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5834 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5835 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5836 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5837 | <span class="hljs-attr">"avatar"</span>: { | |
5838 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5839 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5840 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5841 | } | |
5842 | } | |
5843 | } | |
5844 | } | |
5845 | ] | |
5846 | } | |
5847 | ] | |
5848 | } | |
5849 | </code></pre> | |
5850 | <!-- </div> --> | |
5851 | </section> | |
5852 | </div> | |
5853 | </div> | |
5854 | </div> | |
5855 | <div id="definition-Avatar" class="definition panel" data-traverse-target="definition-Avatar"> | |
5856 | <h2 class="panel-title"> | |
5857 | <a name="/definitions/Avatar"></a>Avatar: | |
5858 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5859 | <span class="json-property-range" title="Value limits"></span> | |
5860 | ||
5861 | ||
5862 | </span> --> | |
5863 | </h2> | |
5864 | <div class="doc-row"> | |
5865 | <div class="doc-copy"> | |
5866 | <section class="json-schema-properties"> | |
5867 | <dl> | |
5868 | <dt data-property-name="path"> | |
5869 | <span class="json-property-name">path:</span> | |
5870 | <span class="json-property-type">string</span> | |
5871 | <span class="json-property-range" title="Value limits"></span> | |
5872 | </dt> | |
5873 | <dt data-property-name="createdAt"> | |
5874 | <span class="json-property-name">createdAt:</span> | |
5875 | <span class="json-property-type">string</span> | |
5876 | <span class="json-property-range" title="Value limits"></span> | |
5877 | </dt> | |
5878 | <dt data-property-name="updatedAt"> | |
5879 | <span class="json-property-name">updatedAt:</span> | |
5880 | <span class="json-property-type">string</span> | |
5881 | <span class="json-property-range" title="Value limits"></span> | |
5882 | </dt> | |
5883 | </dl> | |
5884 | </section> | |
5885 | </div> | |
5886 | <div class="doc-examples"> | |
5887 | <section> | |
5888 | <h5>Example</h5> | |
5889 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5890 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5891 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5892 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5893 | } | |
5894 | </code></pre> | |
5895 | <!-- </div> --> | |
5896 | </section> | |
5897 | </div> | |
5898 | </div> | |
5899 | </div> | |
5900 | <div id="definition-Actor" class="definition panel" data-traverse-target="definition-Actor"> | |
5901 | <h2 class="panel-title"> | |
5902 | <a name="/definitions/Actor"></a>Actor: | |
5903 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5904 | <span class="json-property-range" title="Value limits"></span> | |
5905 | ||
5906 | ||
5907 | </span> --> | |
5908 | </h2> | |
5909 | <div class="doc-row"> | |
5910 | <div class="doc-copy"> | |
5911 | <section class="json-schema-properties"> | |
5912 | <dl> | |
5913 | <dt data-property-name="id"> | |
5914 | <span class="json-property-name">id:</span> | |
5915 | <span class="json-property-type">number</span> | |
5916 | <span class="json-property-range" title="Value limits"></span> | |
5917 | </dt> | |
5918 | <dt data-property-name="uuid"> | |
5919 | <span class="json-property-name">uuid:</span> | |
5920 | <span class="json-property-type">string</span> | |
5921 | <span class="json-property-range" title="Value limits"></span> | |
5922 | </dt> | |
5923 | <dt data-property-name="url"> | |
5924 | <span class="json-property-name">url:</span> | |
5925 | <span class="json-property-type">string</span> | |
5926 | <span class="json-property-range" title="Value limits"></span> | |
5927 | </dt> | |
5928 | <dt data-property-name="name"> | |
5929 | <span class="json-property-name">name:</span> | |
5930 | <span class="json-property-type">string</span> | |
5931 | <span class="json-property-range" title="Value limits"></span> | |
5932 | </dt> | |
5933 | <dt data-property-name="host"> | |
5934 | <span class="json-property-name">host:</span> | |
5935 | <span class="json-property-type">string</span> | |
5936 | <span class="json-property-range" title="Value limits"></span> | |
5937 | </dt> | |
5938 | <dt data-property-name="followingCount"> | |
5939 | <span class="json-property-name">followingCount:</span> | |
5940 | <span class="json-property-type">number</span> | |
5941 | <span class="json-property-range" title="Value limits"></span> | |
5942 | </dt> | |
5943 | <dt data-property-name="followersCount"> | |
5944 | <span class="json-property-name">followersCount:</span> | |
5945 | <span class="json-property-type">number</span> | |
5946 | <span class="json-property-range" title="Value limits"></span> | |
5947 | </dt> | |
5948 | <dt data-property-name="createdAt"> | |
5949 | <span class="json-property-name">createdAt:</span> | |
5950 | <span class="json-property-type">string</span> | |
5951 | <span class="json-property-range" title="Value limits"></span> | |
5952 | </dt> | |
5953 | <dt data-property-name="updatedAt"> | |
5954 | <span class="json-property-name">updatedAt:</span> | |
5955 | <span class="json-property-type">string</span> | |
5956 | <span class="json-property-range" title="Value limits"></span> | |
5957 | </dt> | |
5958 | <dt data-property-name="avatar"> | |
5959 | <span class="json-property-name">avatar:</span> | |
5960 | <span class="json-property-type"> | |
5961 | <span class=""> | |
5962 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | |
5963 | </span> | |
5964 | </span> | |
5965 | <span class="json-property-range" title="Value limits"></span> | |
5966 | </dt> | |
5967 | </dl> | |
5968 | </section> | |
5969 | </div> | |
5970 | <div class="doc-examples"> | |
5971 | <section> | |
5972 | <h5>Example</h5> | |
5973 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5974 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5975 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5976 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5977 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5978 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5979 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5980 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5981 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5982 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5983 | <span class="hljs-attr">"avatar"</span>: { | |
5984 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5985 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5986 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5987 | } | |
5988 | } | |
5989 | </code></pre> | |
5990 | <!-- </div> --> | |
5991 | </section> | |
5992 | </div> | |
5993 | </div> | |
5994 | </div> | |
5995 | <div id="definition-Account" class="definition panel" data-traverse-target="definition-Account"> | |
5996 | <h2 class="panel-title"> | |
5997 | <a name="/definitions/Account"></a>Account: | |
5998 | <!-- <span class="json-property-type"><span class="json-property-type"></span> | |
5999 | <span class="json-property-range" title="Value limits"></span> | |
6000 | ||
6001 | ||
6002 | </span> --> | |
6003 | </h2> | |
6004 | <div class="doc-row"> | |
6005 | <div class="doc-copy"> | |
6006 | <section class="json-schema-allOf"> | |
6007 | <section class="json-schema-allOf-inherited"> | |
6008 | <ul> | |
6009 | <span class=""> | |
6010 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
6011 | </span> | |
6012 | </ul> | |
6013 | </section> | |
6014 | <section class="json-schema-allOf-additional"> | |
6015 | <section class="json-schema-properties"> | |
6016 | <dl> | |
6017 | <dt data-property-name="displayName"> | |
6018 | <span class="json-property-name">displayName:</span> | |
6019 | <span class="json-property-type">string</span> | |
6020 | <span class="json-property-range" title="Value limits"></span> | |
6021 | </dt> | |
6022 | </dl> | |
6023 | </section> | |
6024 | </section> | |
6025 | </section> | |
6026 | </div> | |
6027 | <div class="doc-examples"> | |
6028 | <section> | |
6029 | <h5>Example</h5> | |
6030 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6031 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
6032 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6033 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
6034 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6035 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6036 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
6037 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
6038 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
6039 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6040 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6041 | <span class="hljs-attr">"avatar"</span>: { | |
6042 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
6043 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6044 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
6045 | } | |
6046 | } | |
6047 | </code></pre> | |
6048 | <!-- </div> --> | |
6049 | </section> | |
6050 | </div> | |
6051 | </div> | |
6052 | </div> | |
6053 | <div id="definition-User" class="definition panel" data-traverse-target="definition-User"> | |
6054 | <h2 class="panel-title"> | |
6055 | <a name="/definitions/User"></a>User: | |
6056 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6057 | <span class="json-property-range" title="Value limits"></span> | |
6058 | ||
6059 | ||
6060 | </span> --> | |
6061 | </h2> | |
6062 | <div class="doc-row"> | |
6063 | <div class="doc-copy"> | |
6064 | <section class="json-schema-properties"> | |
6065 | <dl> | |
6066 | <dt data-property-name="id"> | |
6067 | <span class="json-property-name">id:</span> | |
6068 | <span class="json-property-type">number</span> | |
6069 | <span class="json-property-range" title="Value limits"></span> | |
6070 | </dt> | |
6071 | <dt data-property-name="username"> | |
6072 | <span class="json-property-name">username:</span> | |
6073 | <span class="json-property-type">string</span> | |
6074 | <span class="json-property-range" title="Value limits"></span> | |
6075 | </dt> | |
6076 | <dt data-property-name="email"> | |
6077 | <span class="json-property-name">email:</span> | |
6078 | <span class="json-property-type">string</span> | |
6079 | <span class="json-property-range" title="Value limits"></span> | |
6080 | </dt> | |
6081 | <dt data-property-name="displayNSFW"> | |
6082 | <span class="json-property-name">displayNSFW:</span> | |
6083 | <span class="json-property-type">boolean</span> | |
6084 | <span class="json-property-range" title="Value limits"></span> | |
6085 | </dt> | |
6086 | <dt data-property-name="autoPlayVideo"> | |
6087 | <span class="json-property-name">autoPlayVideo:</span> | |
6088 | <span class="json-property-type">boolean</span> | |
6089 | <span class="json-property-range" title="Value limits"></span> | |
6090 | </dt> | |
6091 | <dt data-property-name="role"> | |
6092 | <span class="json-property-name">role:</span> | |
6093 | <span class="json-property-type">string</span> | |
6094 | <span class="json-property-enum" title="Possible values"> | |
6095 | <span class="json-property-enum-item">User</span>, | |
6096 | <span class="json-property-enum-item">Moderator</span>, | |
6097 | <span class="json-property-enum-item">Administrator</span> | |
6098 | </span> | |
6099 | <span class="json-property-range" title="Value limits"></span> | |
6100 | </dt> | |
6101 | <dt data-property-name="videoQuota"> | |
6102 | <span class="json-property-name">videoQuota:</span> | |
6103 | <span class="json-property-type">number</span> | |
6104 | <span class="json-property-range" title="Value limits"></span> | |
6105 | </dt> | |
6106 | <dt data-property-name="createdAt"> | |
6107 | <span class="json-property-name">createdAt:</span> | |
6108 | <span class="json-property-type">string</span> | |
6109 | <span class="json-property-range" title="Value limits"></span> | |
6110 | </dt> | |
6111 | <dt data-property-name="account"> | |
6112 | <span class="json-property-name">account:</span> | |
6113 | <span class="json-property-type"> | |
6114 | <span class=""> | |
6115 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
6116 | </span> | |
6117 | </span> | |
6118 | <span class="json-property-range" title="Value limits"></span> | |
6119 | </dt> | |
6120 | <dt data-property-name="videoChannels"> | |
6121 | <span class="json-property-name">videoChannels:</span> | |
6122 | <span class="json-property-type"> | |
6123 | <span class="json-schema-ref-array"> | |
6124 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
6125 | </span> | |
6126 | </span> | |
6127 | <span class="json-property-range" title="Value limits"></span> | |
6128 | </dt> | |
6129 | </dl> | |
6130 | </section> | |
6131 | </div> | |
6132 | <div class="doc-examples"> | |
6133 | <section> | |
6134 | <h5>Example</h5> | |
6135 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6136 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6137 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
6138 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
6139 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
6140 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
6141 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
6142 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
6143 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6144 | <span class="hljs-attr">"account"</span>: { | |
6145 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
6146 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6147 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
6148 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6149 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6150 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
6151 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
6152 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
6153 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6154 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6155 | <span class="hljs-attr">"avatar"</span>: { | |
6156 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
6157 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6158 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
6159 | } | |
6160 | }, | |
6161 | <span class="hljs-attr">"videoChannels"</span>: [ | |
6162 | { | |
6163 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
6164 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
6165 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
6166 | <span class="hljs-attr">"owner"</span>: { | |
6167 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6168 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
6169 | }, | |
6170 | <span class="hljs-attr">"videos"</span>: [ | |
6171 | { | |
6172 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6173 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
6174 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
6175 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
6176 | <span class="hljs-attr">"category"</span>: { |
6177 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6178 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
6179 | }, | |
6180 | <span class="hljs-attr">"licence"</span>: { | |
6181 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6182 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
6183 | }, | |
6184 | <span class="hljs-attr">"language"</span>: { | |
6185 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6186 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
6187 | }, | |
5e1c08eb C |
6188 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
6189 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
6190 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
6191 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
6192 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
6193 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
6194 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
6195 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
6196 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
6197 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
6198 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
6199 | } | |
6200 | ] | |
6201 | } | |
6202 | ] | |
6203 | } | |
6204 | </code></pre> | |
6205 | <!-- </div> --> | |
6206 | </section> | |
6207 | </div> | |
6208 | </div> | |
6209 | </div> | |
6210 | <div id="definition-ServerConfig" class="definition panel" data-traverse-target="definition-ServerConfig"> | |
6211 | <h2 class="panel-title"> | |
6212 | <a name="/definitions/ServerConfig"></a>ServerConfig: | |
6213 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6214 | <span class="json-property-range" title="Value limits"></span> | |
6215 | ||
6216 | ||
6217 | </span> --> | |
6218 | </h2> | |
6219 | <div class="doc-row"> | |
6220 | <div class="doc-copy"> | |
6221 | <section class="json-schema-properties"> | |
6222 | <dl> | |
6223 | <dt data-property-name="signup"> | |
6224 | <span class="json-property-name">signup:</span> | |
6225 | <span class="json-property-type">object</span> | |
6226 | <span class="json-property-range" title="Value limits"></span> | |
6227 | </dt> | |
6228 | <dt data-property-name="transcoding"> | |
6229 | <span class="json-property-name">transcoding:</span> | |
6230 | <span class="json-property-type">object</span> | |
6231 | <span class="json-property-range" title="Value limits"></span> | |
6232 | </dt> | |
6233 | <dt data-property-name="avatar"> | |
6234 | <span class="json-property-name">avatar:</span> | |
6235 | <span class="json-property-type">object</span> | |
6236 | <span class="json-property-range" title="Value limits"></span> | |
6237 | </dt> | |
6238 | <dt data-property-name="video"> | |
6239 | <span class="json-property-name">video:</span> | |
6240 | <span class="json-property-type">object</span> | |
6241 | <span class="json-property-range" title="Value limits"></span> | |
6242 | </dt> | |
6243 | </dl> | |
6244 | </section> | |
6245 | </div> | |
6246 | <div class="doc-examples"> | |
6247 | <section> | |
6248 | <h5>Example</h5> | |
6249 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6250 | <span class="hljs-attr">"signup"</span>: { | |
6251 | <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span> | |
6252 | }, | |
6253 | <span class="hljs-attr">"transcoding"</span>: { | |
6254 | <span class="hljs-attr">"enabledResolutions"</span>: [ | |
6255 | <span class="hljs-string">"number"</span> | |
6256 | ] | |
6257 | }, | |
6258 | <span class="hljs-attr">"avatar"</span>: { | |
6259 | <span class="hljs-attr">"file"</span>: { | |
6260 | <span class="hljs-attr">"size"</span>: { | |
6261 | <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span> | |
6262 | } | |
6263 | }, | |
6264 | <span class="hljs-attr">"extensions"</span>: [ | |
6265 | <span class="hljs-string">"string"</span> | |
6266 | ] | |
6267 | }, | |
6268 | <span class="hljs-attr">"video"</span>: { | |
6269 | <span class="hljs-attr">"file"</span>: { | |
6270 | <span class="hljs-attr">"extensions"</span>: [ | |
6271 | <span class="hljs-string">"string"</span> | |
6272 | ] | |
6273 | } | |
6274 | } | |
6275 | } | |
6276 | </code></pre> | |
6277 | <!-- </div> --> | |
6278 | </section> | |
6279 | </div> | |
6280 | </div> | |
6281 | </div> | |
6282 | <div id="definition-Follow" class="definition panel" data-traverse-target="definition-Follow"> | |
6283 | <h2 class="panel-title"> | |
6284 | <a name="/definitions/Follow"></a>Follow: | |
6285 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6286 | <span class="json-property-range" title="Value limits"></span> | |
6287 | ||
6288 | ||
6289 | </span> --> | |
6290 | </h2> | |
6291 | <div class="doc-row"> | |
6292 | <div class="doc-copy"> | |
6293 | <section class="json-schema-properties"> | |
6294 | <dl> | |
6295 | <dt data-property-name="id"> | |
6296 | <span class="json-property-name">id:</span> | |
6297 | <span class="json-property-type">number</span> | |
6298 | <span class="json-property-range" title="Value limits"></span> | |
6299 | </dt> | |
6300 | <dt data-property-name="follower"> | |
6301 | <span class="json-property-name">follower:</span> | |
6302 | <span class="json-property-type"> | |
6303 | <span class=""> | |
6304 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
6305 | </span> | |
6306 | </span> | |
6307 | <span class="json-property-range" title="Value limits"></span> | |
6308 | </dt> | |
6309 | <dt data-property-name="following"> | |
6310 | <span class="json-property-name">following:</span> | |
6311 | <span class="json-property-type"> | |
6312 | <span class=""> | |
6313 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
6314 | </span> | |
6315 | </span> | |
6316 | <span class="json-property-range" title="Value limits"></span> | |
6317 | </dt> | |
6318 | <dt data-property-name="score"> | |
6319 | <span class="json-property-name">score:</span> | |
6320 | <span class="json-property-type">number</span> | |
6321 | <span class="json-property-range" title="Value limits"></span> | |
6322 | </dt> | |
6323 | <dt data-property-name="state"> | |
6324 | <span class="json-property-name">state:</span> | |
6325 | <span class="json-property-type">string</span> | |
6326 | <span class="json-property-enum" title="Possible values"> | |
6327 | <span class="json-property-enum-item">pending</span>, | |
6328 | <span class="json-property-enum-item">accepted</span> | |
6329 | </span> | |
6330 | <span class="json-property-range" title="Value limits"></span> | |
6331 | </dt> | |
6332 | <dt data-property-name="createdAt"> | |
6333 | <span class="json-property-name">createdAt:</span> | |
6334 | <span class="json-property-type">string</span> | |
6335 | <span class="json-property-range" title="Value limits"></span> | |
6336 | </dt> | |
6337 | <dt data-property-name="updatedAt"> | |
6338 | <span class="json-property-name">updatedAt:</span> | |
6339 | <span class="json-property-type">string</span> | |
6340 | <span class="json-property-range" title="Value limits"></span> | |
6341 | </dt> | |
6342 | </dl> | |
6343 | </section> | |
6344 | </div> | |
6345 | <div class="doc-examples"> | |
6346 | <section> | |
6347 | <h5>Example</h5> | |
6348 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6349 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6350 | <span class="hljs-attr">"follower"</span>: { | |
6351 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6352 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
6353 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6354 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6355 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
6356 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
6357 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
6358 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6359 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6360 | <span class="hljs-attr">"avatar"</span>: { | |
6361 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
6362 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6363 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
6364 | } | |
6365 | }, | |
6366 | <span class="hljs-attr">"following"</span>: { | |
6367 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6368 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
6369 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6370 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6371 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
6372 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
6373 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
6374 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6375 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6376 | <span class="hljs-attr">"avatar"</span>: { | |
6377 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
6378 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6379 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
6380 | } | |
6381 | }, | |
6382 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
6383 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
6384 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6385 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
6386 | } | |
6387 | </code></pre> | |
6388 | <!-- </div> --> | |
6389 | </section> | |
6390 | </div> | |
6391 | </div> | |
6392 | </div> | |
6393 | <div id="definition-Job" class="definition panel" data-traverse-target="definition-Job"> | |
6394 | <h2 class="panel-title"> | |
6395 | <a name="/definitions/Job"></a>Job: | |
6396 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6397 | <span class="json-property-range" title="Value limits"></span> | |
6398 | ||
6399 | ||
6400 | </span> --> | |
6401 | </h2> | |
6402 | <div class="doc-row"> | |
6403 | <div class="doc-copy"> | |
6404 | <section class="json-schema-properties"> | |
6405 | <dl> | |
6406 | <dt data-property-name="id"> | |
6407 | <span class="json-property-name">id:</span> | |
6408 | <span class="json-property-type">number</span> | |
6409 | <span class="json-property-range" title="Value limits"></span> | |
6410 | </dt> | |
6411 | <dt data-property-name="state"> | |
6412 | <span class="json-property-name">state:</span> | |
6413 | <span class="json-property-type">string</span> | |
6414 | <span class="json-property-enum" title="Possible values"> | |
6415 | <span class="json-property-enum-item">pending</span>, | |
6416 | <span class="json-property-enum-item">processing</span>, | |
6417 | <span class="json-property-enum-item">error</span>, | |
6418 | <span class="json-property-enum-item">success</span> | |
6419 | </span> | |
6420 | <span class="json-property-range" title="Value limits"></span> | |
6421 | </dt> | |
6422 | <dt data-property-name="category"> | |
6423 | <span class="json-property-name">category:</span> | |
6424 | <span class="json-property-type">string</span> | |
6425 | <span class="json-property-enum" title="Possible values"> | |
6426 | <span class="json-property-enum-item">transcoding</span>, | |
6427 | <span class="json-property-enum-item">activitypub-http</span> | |
6428 | </span> | |
6429 | <span class="json-property-range" title="Value limits"></span> | |
6430 | </dt> | |
6431 | <dt data-property-name="handlerName"> | |
6432 | <span class="json-property-name">handlerName:</span> | |
6433 | <span class="json-property-type">string</span> | |
6434 | <span class="json-property-range" title="Value limits"></span> | |
6435 | </dt> | |
6436 | <dt data-property-name="handlerInputData"> | |
6437 | <span class="json-property-name">handlerInputData:</span> | |
6438 | <span class="json-property-type">string</span> | |
6439 | <span class="json-property-range" title="Value limits"></span> | |
6440 | </dt> | |
6441 | <dt data-property-name="createdAt"> | |
6442 | <span class="json-property-name">createdAt:</span> | |
6443 | <span class="json-property-type">string</span> | |
6444 | <span class="json-property-range" title="Value limits"></span> | |
6445 | </dt> | |
6446 | <dt data-property-name="updatedAt"> | |
6447 | <span class="json-property-name">updatedAt:</span> | |
6448 | <span class="json-property-type">string</span> | |
6449 | <span class="json-property-range" title="Value limits"></span> | |
6450 | </dt> | |
6451 | </dl> | |
6452 | </section> | |
6453 | </div> | |
6454 | <div class="doc-examples"> | |
6455 | <section> | |
6456 | <h5>Example</h5> | |
6457 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6458 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6459 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
6460 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>, | |
6461 | <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>, | |
6462 | <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>, | |
6463 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6464 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
6465 | } | |
6466 | </code></pre> | |
6467 | <!-- </div> --> | |
6468 | </section> | |
6469 | </div> | |
6470 | </div> | |
6471 | </div> | |
6472 | <div id="definition-AddUserResponse" class="definition panel" data-traverse-target="definition-AddUserResponse"> | |
6473 | <h2 class="panel-title"> | |
6474 | <a name="/definitions/AddUserResponse"></a>AddUserResponse: | |
6475 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6476 | <span class="json-property-range" title="Value limits"></span> | |
6477 | ||
6478 | ||
6479 | </span> --> | |
6480 | </h2> | |
6481 | <div class="doc-row"> | |
6482 | <div class="doc-copy"> | |
6483 | <section class="json-schema-properties"> | |
6484 | <dl> | |
6485 | <dt data-property-name="id"> | |
6486 | <span class="json-property-name">id:</span> | |
6487 | <span class="json-property-type">number</span> | |
6488 | <span class="json-property-range" title="Value limits"></span> | |
6489 | </dt> | |
6490 | <dt data-property-name="uuid"> | |
6491 | <span class="json-property-name">uuid:</span> | |
6492 | <span class="json-property-type">string</span> | |
6493 | <span class="json-property-range" title="Value limits"></span> | |
6494 | </dt> | |
6495 | </dl> | |
6496 | </section> | |
6497 | </div> | |
6498 | <div class="doc-examples"> | |
6499 | <section> | |
6500 | <h5>Example</h5> | |
6501 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6502 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6503 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
6504 | } | |
6505 | </code></pre> | |
6506 | <!-- </div> --> | |
6507 | </section> | |
6508 | </div> | |
6509 | </div> | |
6510 | </div> | |
6511 | <div id="definition-VideoUploadResponse" class="definition panel" data-traverse-target="definition-VideoUploadResponse"> | |
6512 | <h2 class="panel-title"> | |
6513 | <a name="/definitions/VideoUploadResponse"></a>VideoUploadResponse: | |
6514 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6515 | <span class="json-property-range" title="Value limits"></span> | |
6516 | ||
6517 | ||
6518 | </span> --> | |
6519 | </h2> | |
6520 | <div class="doc-row"> | |
6521 | <div class="doc-copy"> | |
6522 | <section class="json-schema-properties"> | |
6523 | <dl> | |
6524 | <dt data-property-name="id"> | |
6525 | <span class="json-property-name">id:</span> | |
6526 | <span class="json-property-type">number</span> | |
6527 | <span class="json-property-range" title="Value limits"></span> | |
6528 | </dt> | |
6529 | <dt data-property-name="uuid"> | |
6530 | <span class="json-property-name">uuid:</span> | |
6531 | <span class="json-property-type">string</span> | |
6532 | <span class="json-property-range" title="Value limits"></span> | |
6533 | </dt> | |
6534 | </dl> | |
6535 | </section> | |
6536 | </div> | |
6537 | <div class="doc-examples"> | |
6538 | <section> | |
6539 | <h5>Example</h5> | |
6540 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6541 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6542 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
6543 | } | |
ab0ee6a1 C |
6544 | </code></pre> |
6545 | <!-- </div> --> | |
6546 | </section> | |
6547 | </div> | |
6548 | </div> | |
6549 | </div> | |
6550 | <div id="definition-CommentThreadResponse" class="definition panel" data-traverse-target="definition-CommentThreadResponse"> | |
6551 | <h2 class="panel-title"> | |
6552 | <a name="/definitions/CommentThreadResponse"></a>CommentThreadResponse: | |
6553 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6554 | <span class="json-property-range" title="Value limits"></span> | |
6555 | ||
6556 | ||
6557 | </span> --> | |
6558 | </h2> | |
6559 | <div class="doc-row"> | |
6560 | <div class="doc-copy"> | |
6561 | <section class="json-schema-properties"> | |
6562 | <dl> | |
6563 | <dt data-property-name="total"> | |
6564 | <span class="json-property-name">total:</span> | |
6565 | <span class="json-property-type">number</span> | |
6566 | <span class="json-property-range" title="Value limits"></span> | |
6567 | </dt> | |
6568 | <dt data-property-name="data"> | |
6569 | <span class="json-property-name">data:</span> | |
6570 | <span class="json-property-type"> | |
6571 | <span class="json-schema-ref-array"> | |
6572 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
6573 | </span> | |
6574 | </span> | |
6575 | <span class="json-property-range" title="Value limits"></span> | |
6576 | </dt> | |
6577 | </dl> | |
6578 | </section> | |
6579 | </div> | |
6580 | <div class="doc-examples"> | |
6581 | <section> | |
6582 | <h5>Example</h5> | |
6583 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6584 | <span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>, | |
6585 | <span class="hljs-attr">"data"</span>: [ | |
6586 | { | |
6587 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6588 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6589 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
6590 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
6591 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
6592 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
6593 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6594 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6595 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
6596 | <span class="hljs-attr">"account"</span>: { | |
6597 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
6598 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6599 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
6600 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6601 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6602 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
6603 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
6604 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
6605 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6606 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6607 | <span class="hljs-attr">"avatar"</span>: { | |
6608 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
6609 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6610 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
6611 | } | |
6612 | } | |
6613 | } | |
6614 | ] | |
6615 | } | |
6616 | </code></pre> | |
6617 | <!-- </div> --> | |
6618 | </section> | |
6619 | </div> | |
6620 | </div> | |
6621 | </div> | |
6622 | <div id="definition-CommentThreadPostResponse" class="definition panel" data-traverse-target="definition-CommentThreadPostResponse"> | |
6623 | <h2 class="panel-title"> | |
6624 | <a name="/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse: | |
6625 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6626 | <span class="json-property-range" title="Value limits"></span> | |
6627 | ||
6628 | ||
6629 | </span> --> | |
6630 | </h2> | |
6631 | <div class="doc-row"> | |
6632 | <div class="doc-copy"> | |
6633 | <section class="json-schema-properties"> | |
6634 | <dl> | |
6635 | <dt data-property-name="comment"> | |
6636 | <span class="json-property-name">comment:</span> | |
6637 | <span class="json-property-type"> | |
6638 | <span class=""> | |
6639 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
6640 | </span> | |
6641 | </span> | |
6642 | <span class="json-property-range" title="Value limits"></span> | |
6643 | </dt> | |
6644 | </dl> | |
6645 | </section> | |
6646 | </div> | |
6647 | <div class="doc-examples"> | |
6648 | <section> | |
6649 | <h5>Example</h5> | |
6650 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6651 | <span class="hljs-attr">"comment"</span>: { | |
6652 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6653 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6654 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
6655 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
6656 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
6657 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
6658 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6659 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6660 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
6661 | <span class="hljs-attr">"account"</span>: { | |
6662 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
6663 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6664 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
6665 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6666 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6667 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
6668 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
6669 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
6670 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6671 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6672 | <span class="hljs-attr">"avatar"</span>: { | |
6673 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
6674 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6675 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
6676 | } | |
6677 | } | |
6678 | } | |
6679 | } | |
5e1c08eb C |
6680 | </code></pre> |
6681 | <!-- </div> --> | |
6682 | </section> | |
6683 | </div> | |
6684 | </div> | |
6685 | </div> | |
6686 | <div id="definition-AddUser" class="definition panel" data-traverse-target="definition-AddUser"> | |
6687 | <h2 class="panel-title"> | |
6688 | <a name="/definitions/AddUser"></a>AddUser: | |
6689 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6690 | <span class="json-property-range" title="Value limits"></span> | |
6691 | ||
6692 | ||
6693 | </span> --> | |
6694 | </h2> | |
6695 | <div class="doc-row"> | |
6696 | <div class="doc-copy"> | |
6697 | <section class="json-schema-properties"> | |
6698 | <dl> | |
6699 | <dt data-property-name="username" class="has-description"> | |
6700 | <span class="json-property-name">username:</span> | |
6701 | <span class="json-property-type">string</span> | |
6702 | <span class="json-property-range" title="Value limits"></span> | |
6703 | <span class="json-property-required"></span> | |
6704 | </dt> | |
6705 | <dd> | |
6706 | <p>The user username </p> | |
6707 | </dd> | |
6708 | <dt data-property-name="password" class="has-description"> | |
6709 | <span class="json-property-name">password:</span> | |
6710 | <span class="json-property-type">string</span> | |
6711 | <span class="json-property-range" title="Value limits"></span> | |
6712 | <span class="json-property-required"></span> | |
6713 | </dt> | |
6714 | <dd> | |
6715 | <p>The user password </p> | |
6716 | </dd> | |
6717 | <dt data-property-name="email" class="has-description"> | |
6718 | <span class="json-property-name">email:</span> | |
6719 | <span class="json-property-type">string</span> | |
6720 | <span class="json-property-range" title="Value limits"></span> | |
6721 | <span class="json-property-required"></span> | |
6722 | </dt> | |
6723 | <dd> | |
6724 | <p>The user email </p> | |
6725 | </dd> | |
6726 | <dt data-property-name="videoQuota" class="has-description"> | |
6727 | <span class="json-property-name">videoQuota:</span> | |
6728 | <span class="json-property-type">string</span> | |
6729 | <span class="json-property-range" title="Value limits"></span> | |
6730 | <span class="json-property-required"></span> | |
6731 | </dt> | |
6732 | <dd> | |
6733 | <p>The user videoQuota </p> | |
6734 | </dd> | |
6735 | <dt data-property-name="role" class="has-description"> | |
6736 | <span class="json-property-name">role:</span> | |
6737 | <span class="json-property-type">string</span> | |
6738 | <span class="json-property-range" title="Value limits"></span> | |
6739 | <span class="json-property-required"></span> | |
6740 | </dt> | |
6741 | <dd> | |
6742 | <p>The user role </p> | |
6743 | </dd> | |
6744 | </dl> | |
6745 | </section> | |
6746 | </div> | |
6747 | <div class="doc-examples"> | |
6748 | <section> | |
6749 | <h5>Example</h5> | |
6750 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6751 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
6752 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
6753 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
6754 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
6755 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
6756 | } | |
6757 | </code></pre> | |
6758 | <!-- </div> --> | |
6759 | </section> | |
6760 | </div> | |
6761 | </div> | |
6762 | </div> | |
6763 | <div id="definition-UpdateUser" class="definition panel" data-traverse-target="definition-UpdateUser"> | |
6764 | <h2 class="panel-title"> | |
6765 | <a name="/definitions/UpdateUser"></a>UpdateUser: | |
6766 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6767 | <span class="json-property-range" title="Value limits"></span> | |
6768 | ||
6769 | ||
6770 | </span> --> | |
6771 | </h2> | |
6772 | <div class="doc-row"> | |
6773 | <div class="doc-copy"> | |
6774 | <section class="json-schema-properties"> | |
6775 | <dl> | |
6776 | <dt data-property-name="id" class="has-description"> | |
6777 | <span class="json-property-name">id:</span> | |
6778 | <span class="json-property-type">string</span> | |
6779 | <span class="json-property-range" title="Value limits"></span> | |
6780 | <span class="json-property-required"></span> | |
6781 | </dt> | |
6782 | <dd> | |
6783 | <p>The user id </p> | |
6784 | </dd> | |
6785 | <dt data-property-name="email" class="has-description"> | |
6786 | <span class="json-property-name">email:</span> | |
6787 | <span class="json-property-type">string</span> | |
6788 | <span class="json-property-range" title="Value limits"></span> | |
6789 | <span class="json-property-required"></span> | |
6790 | </dt> | |
6791 | <dd> | |
6792 | <p>The updated email of the user </p> | |
6793 | </dd> | |
6794 | <dt data-property-name="videoQuota" class="has-description"> | |
6795 | <span class="json-property-name">videoQuota:</span> | |
6796 | <span class="json-property-type">string</span> | |
6797 | <span class="json-property-range" title="Value limits"></span> | |
6798 | <span class="json-property-required"></span> | |
6799 | </dt> | |
6800 | <dd> | |
6801 | <p>The updated videoQuota of the user </p> | |
6802 | </dd> | |
6803 | <dt data-property-name="role" class="has-description"> | |
6804 | <span class="json-property-name">role:</span> | |
6805 | <span class="json-property-type">string</span> | |
6806 | <span class="json-property-range" title="Value limits"></span> | |
6807 | <span class="json-property-required"></span> | |
6808 | </dt> | |
6809 | <dd> | |
6810 | <p>The updated role of the user </p> | |
6811 | </dd> | |
6812 | </dl> | |
6813 | </section> | |
6814 | </div> | |
6815 | <div class="doc-examples"> | |
6816 | <section> | |
6817 | <h5>Example</h5> | |
6818 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6819 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
6820 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
6821 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
6822 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
6823 | } | |
6824 | </code></pre> | |
6825 | <!-- </div> --> | |
6826 | </section> | |
6827 | </div> | |
6828 | </div> | |
6829 | </div> | |
6830 | <div id="definition-UpdateMe" class="definition panel" data-traverse-target="definition-UpdateMe"> | |
6831 | <h2 class="panel-title"> | |
6832 | <a name="/definitions/UpdateMe"></a>UpdateMe: | |
6833 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6834 | <span class="json-property-range" title="Value limits"></span> | |
6835 | ||
6836 | ||
6837 | </span> --> | |
6838 | </h2> | |
6839 | <div class="doc-row"> | |
6840 | <div class="doc-copy"> | |
6841 | <section class="json-schema-properties"> | |
6842 | <dl> | |
6843 | <dt data-property-name="password" class="has-description"> | |
6844 | <span class="json-property-name">password:</span> | |
6845 | <span class="json-property-type">string</span> | |
6846 | <span class="json-property-range" title="Value limits"></span> | |
6847 | <span class="json-property-required"></span> | |
6848 | </dt> | |
6849 | <dd> | |
6850 | <p>Your new password </p> | |
6851 | </dd> | |
6852 | <dt data-property-name="email" class="has-description"> | |
6853 | <span class="json-property-name">email:</span> | |
6854 | <span class="json-property-type">string</span> | |
6855 | <span class="json-property-range" title="Value limits"></span> | |
6856 | <span class="json-property-required"></span> | |
6857 | </dt> | |
6858 | <dd> | |
6859 | <p>Your new email </p> | |
6860 | </dd> | |
6861 | <dt data-property-name="displayNSFW" class="has-description"> | |
6862 | <span class="json-property-name">displayNSFW:</span> | |
6863 | <span class="json-property-type">string</span> | |
6864 | <span class="json-property-range" title="Value limits"></span> | |
6865 | <span class="json-property-required"></span> | |
6866 | </dt> | |
6867 | <dd> | |
6868 | <p>Your new displayNSFW </p> | |
6869 | </dd> | |
6870 | <dt data-property-name="autoPlayVideo" class="has-description"> | |
6871 | <span class="json-property-name">autoPlayVideo:</span> | |
6872 | <span class="json-property-type">string</span> | |
6873 | <span class="json-property-range" title="Value limits"></span> | |
6874 | <span class="json-property-required"></span> | |
6875 | </dt> | |
6876 | <dd> | |
6877 | <p>Your new autoPlayVideo </p> | |
6878 | </dd> | |
6879 | </dl> | |
6880 | </section> | |
6881 | </div> | |
6882 | <div class="doc-examples"> | |
6883 | <section> | |
6884 | <h5>Example</h5> | |
6885 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6886 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
6887 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
6888 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>, | |
6889 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span> | |
6890 | } | |
6891 | </code></pre> | |
6892 | <!-- </div> --> | |
6893 | </section> | |
6894 | </div> | |
6895 | </div> | |
6896 | </div> | |
6897 | <div id="definition-GetMeVideoRating" class="definition panel" data-traverse-target="definition-GetMeVideoRating"> | |
6898 | <h2 class="panel-title"> | |
6899 | <a name="/definitions/GetMeVideoRating"></a>GetMeVideoRating: | |
6900 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6901 | <span class="json-property-range" title="Value limits"></span> | |
6902 | ||
6903 | ||
6904 | </span> --> | |
6905 | </h2> | |
6906 | <div class="doc-row"> | |
6907 | <div class="doc-copy"> | |
6908 | <section class="json-schema-properties"> | |
6909 | <dl> | |
6910 | <dt data-property-name="id" class="has-description"> | |
6911 | <span class="json-property-name">id:</span> | |
6912 | <span class="json-property-type">string</span> | |
6913 | <span class="json-property-range" title="Value limits"></span> | |
6914 | <span class="json-property-required"></span> | |
6915 | </dt> | |
6916 | <dd> | |
6917 | <p>Id of the video </p> | |
6918 | </dd> | |
6919 | <dt data-property-name="rating" class="has-description"> | |
6920 | <span class="json-property-name">rating:</span> | |
6921 | <span class="json-property-type">number</span> | |
6922 | <span class="json-property-range" title="Value limits"></span> | |
6923 | <span class="json-property-required"></span> | |
6924 | </dt> | |
6925 | <dd> | |
6926 | <p>Rating of the video </p> | |
6927 | </dd> | |
6928 | </dl> | |
6929 | </section> | |
6930 | </div> | |
6931 | <div class="doc-examples"> | |
6932 | <section> | |
6933 | <h5>Example</h5> | |
6934 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6935 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
6936 | <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span> | |
6937 | } | |
6938 | </code></pre> | |
6939 | <!-- </div> --> | |
6940 | </section> | |
6941 | </div> | |
6942 | </div> | |
6943 | </div> | |
6944 | <div id="definition-RegisterUser" class="definition panel" data-traverse-target="definition-RegisterUser"> | |
6945 | <h2 class="panel-title"> | |
6946 | <a name="/definitions/RegisterUser"></a>RegisterUser: | |
6947 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6948 | <span class="json-property-range" title="Value limits"></span> | |
6949 | ||
6950 | ||
6951 | </span> --> | |
6952 | </h2> | |
6953 | <div class="doc-row"> | |
6954 | <div class="doc-copy"> | |
6955 | <section class="json-schema-properties"> | |
6956 | <dl> | |
6957 | <dt data-property-name="username" class="has-description"> | |
6958 | <span class="json-property-name">username:</span> | |
6959 | <span class="json-property-type">string</span> | |
6960 | <span class="json-property-range" title="Value limits"></span> | |
6961 | <span class="json-property-required"></span> | |
6962 | </dt> | |
6963 | <dd> | |
6964 | <p>The username of the user </p> | |
6965 | </dd> | |
6966 | <dt data-property-name="password" class="has-description"> | |
6967 | <span class="json-property-name">password:</span> | |
6968 | <span class="json-property-type">string</span> | |
6969 | <span class="json-property-range" title="Value limits"></span> | |
6970 | <span class="json-property-required"></span> | |
6971 | </dt> | |
6972 | <dd> | |
6973 | <p>The password of the user </p> | |
6974 | </dd> | |
6975 | <dt data-property-name="email" class="has-description"> | |
6976 | <span class="json-property-name">email:</span> | |
6977 | <span class="json-property-type">string</span> | |
6978 | <span class="json-property-range" title="Value limits"></span> | |
6979 | <span class="json-property-required"></span> | |
6980 | </dt> | |
6981 | <dd> | |
6982 | <p>The email of the user </p> | |
6983 | </dd> | |
6984 | </dl> | |
6985 | </section> | |
6986 | </div> | |
6987 | <div class="doc-examples"> | |
6988 | <section> | |
6989 | <h5>Example</h5> | |
6990 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6991 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
6992 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
6993 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span> | |
6994 | } | |
6995 | </code></pre> | |
6996 | <!-- </div> --> | |
6997 | </section> | |
6998 | </div> | |
6999 | </div> | |
7000 | </div> | |
7001 | <div id="definition-VideoChannelInput" class="definition panel" data-traverse-target="definition-VideoChannelInput"> | |
7002 | <h2 class="panel-title"> | |
7003 | <a name="/definitions/VideoChannelInput"></a>VideoChannelInput: | |
7004 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
7005 | <span class="json-property-range" title="Value limits"></span> | |
7006 | ||
7007 | ||
7008 | </span> --> | |
7009 | </h2> | |
7010 | <div class="doc-row"> | |
7011 | <div class="doc-copy"> | |
7012 | <section class="json-schema-properties"> | |
7013 | <dl> | |
7014 | <dt data-property-name="name"> | |
7015 | <span class="json-property-name">name:</span> | |
7016 | <span class="json-property-type">string</span> | |
7017 | <span class="json-property-range" title="Value limits"></span> | |
7018 | </dt> | |
7019 | <dt data-property-name="description"> | |
7020 | <span class="json-property-name">description:</span> | |
7021 | <span class="json-property-type">string</span> | |
7022 | <span class="json-property-range" title="Value limits"></span> | |
7023 | </dt> | |
7024 | </dl> | |
7025 | </section> | |
7026 | </div> | |
7027 | <div class="doc-examples"> | |
7028 | <section> | |
7029 | <h5>Example</h5> | |
7030 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
7031 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
7032 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
7033 | } | |
7034 | </code></pre> | |
7035 | <!-- </div> --> | |
7036 | </section> | |
7037 | </div> | |
7038 | </div> | |
7039 | </div> | |
7040 | <div class="doc-row no-margin"> | |
7041 | <div class="doc-copy doc-separator"> | |
7042 | <a class="powered-by" href="https://sourcey.com/spectacle">Documentation by | |
7043 | <span>Spectacle</span> | |
7044 | </a> | |
7045 | </div> | |
7046 | </div> | |
7047 | </article> | |
7048 | </div> | |
7049 | </div> | |
7050 | </body> | |
7051 | </html> |