]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blob - support/doc/api/html/index.html
bf9430e799bf49792c56a9ee21a1ccc4ea316bf8
[github/Chocobozzz/PeerTube.git] / support / doc / api / html / index.html
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>Topics</h5>
21 <a href="#introduction">Introduction</a>
22 <a href="#authentication">Authentication</a>
23 <h5>Operations</h5>
24 <section>
25 <a href="#tag-Accounts">Accounts</a>
26 <ul>
27 <li>
28 <a href="#operation--accounts--id--get"> GET /accounts/{id} </a>
29 </li>
30 <li>
31 <a href="#operation--accounts-get"> GET /accounts </a>
32 </li>
33 </ul>
34 </section>
35 <section>
36 <a href="#tag-Config">Config</a>
37 <ul>
38 <li>
39 <a href="#operation--config-get"> GET /config </a>
40 </li>
41 </ul>
42 </section>
43 <section>
44 <a href="#tag-Job">Job</a>
45 <ul>
46 <li>
47 <a href="#operation--jobs-get"> GET /jobs </a>
48 </li>
49 </ul>
50 </section>
51 <section>
52 <a href="#tag-ServerFollowing">ServerFollowing</a>
53 <ul>
54 <li>
55 <a href="#operation--server-following--host--delete"> DELETE /server/following/{host} </a>
56 </li>
57 <li>
58 <a href="#operation--server-followers-get"> GET /server/followers </a>
59 </li>
60 <li>
61 <a href="#operation--server-following-get"> GET /server/following </a>
62 </li>
63 <li>
64 <a href="#operation--server-following-post"> POST /server/following </a>
65 </li>
66 </ul>
67 </section>
68 <section>
69 <a href="#tag-User">User</a>
70 <ul>
71 <li>
72 <a href="#operation--users-post"> POST /users </a>
73 </li>
74 <li>
75 <a href="#operation--users-get"> GET /users </a>
76 </li>
77 <li>
78 <a href="#operation--users--id--delete"> DELETE /users/{id} </a>
79 </li>
80 <li>
81 <a href="#operation--users--id--get"> GET /users/{id} </a>
82 </li>
83 <li>
84 <a href="#operation--users--id--put"> PUT /users/{id} </a>
85 </li>
86 <li>
87 <a href="#operation--users-me-get"> GET /users/me </a>
88 </li>
89 <li>
90 <a href="#operation--users-me-put"> PUT /users/me </a>
91 </li>
92 <li>
93 <a href="#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used </a>
94 </li>
95 <li>
96 <a href="#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating </a>
97 </li>
98 <li>
99 <a href="#operation--users-me-videos-get"> GET /users/me/videos </a>
100 </li>
101 <li>
102 <a href="#operation--users-register-post"> POST /users/register </a>
103 </li>
104 <li>
105 <a href="#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick </a>
106 </li>
107 </ul>
108 </section>
109 <section>
110 <a href="#tag-Video">Video</a>
111 <ul>
112 <li>
113 <a href="#operation--videos-get"> GET /videos </a>
114 </li>
115 <li>
116 <a href="#operation--videos-categories-get"> GET /videos/categories </a>
117 </li>
118 <li>
119 <a href="#operation--videos-licences-get"> GET /videos/licences </a>
120 </li>
121 <li>
122 <a href="#operation--videos-languages-get"> GET /videos/languages </a>
123 </li>
124 <li>
125 <a href="#operation--videos-privacies-get"> GET /videos/privacies </a>
126 </li>
127 <li>
128 <a href="#operation--videos-search-get"> GET /videos/search </a>
129 </li>
130 <li>
131 <a href="#operation--videos--id--put"> PUT /videos/{id} </a>
132 </li>
133 <li>
134 <a href="#operation--videos--id--get"> GET /videos/{id} </a>
135 </li>
136 <li>
137 <a href="#operation--videos--id--delete"> DELETE /videos/{id} </a>
138 </li>
139 <li>
140 <a href="#operation--videos--id--description-get"> GET /videos/{id}/description </a>
141 </li>
142 <li>
143 <a href="#operation--videos--id--views-post"> POST /videos/{id}/views </a>
144 </li>
145 <li>
146 <a href="#operation--videos-upload-post"> POST /videos/upload </a>
147 </li>
148 </ul>
149 </section>
150 <section>
151 <a href="#tag-VideoAbuse">VideoAbuse</a>
152 <ul>
153 <li>
154 <a href="#operation--videos-abuse-get"> GET /videos/abuse </a>
155 </li>
156 <li>
157 <a href="#operation--videos--id--abuse-post"> POST /videos/{id}/abuse </a>
158 </li>
159 </ul>
160 </section>
161 <section>
162 <a href="#tag-VideoBlacklist">VideoBlacklist</a>
163 <ul>
164 <li>
165 <a href="#operation--videos--videoId--blacklist-post"> POST /videos/{videoId}/blacklist </a>
166 </li>
167 <li>
168 <a href="#operation--videos--videoId--blacklist-delete"> DELETE /videos/{videoId}/blacklist </a>
169 </li>
170 <li>
171 <a href="#operation--videos-blacklist-get"> GET /videos/blacklist </a>
172 </li>
173 </ul>
174 </section>
175 <section>
176 <a href="#tag-VideoChannel">VideoChannel</a>
177 <ul>
178 <li>
179 <a href="#operation--videos-channels-get"> GET /videos/channels </a>
180 </li>
181 <li>
182 <a href="#operation--videos-channels-post"> POST /videos/channels </a>
183 </li>
184 <li>
185 <a href="#operation--videos-channels--id--get"> GET /videos/channels/{id} </a>
186 </li>
187 <li>
188 <a href="#operation--videos-channels--id--put"> PUT /videos/channels/{id} </a>
189 </li>
190 <li>
191 <a href="#operation--videos-channels--id--delete"> DELETE /videos/channels/{id} </a>
192 </li>
193 <li>
194 <a href="#operation--videos-accounts--accountId--channels-get"> GET /videos/accounts/{accountId}/channels </a>
195 </li>
196 </ul>
197 </section>
198 <section>
199 <a href="#tag-VideoComment">VideoComment</a>
200 <ul>
201 <li>
202 <a href="#operation--videos--videoId--comment-threads-get"> GET /videos/{videoId}/comment-threads </a>
203 </li>
204 <li>
205 <a href="#operation--videos--videoId--comment-threads-post"> POST /videos/{videoId}/comment-threads </a>
206 </li>
207 <li>
208 <a href="#operation--videos--videoId--comment-threads--threadId--get"> GET /videos/{videoId}/comment-threads/{threadId} </a>
209 </li>
210 <li>
211 <a href="#operation--videos--videoId--comments--commentId--post"> POST /videos/{videoId}/comments/{commentId} </a>
212 </li>
213 <li>
214 <a href="#operation--videos--videoId--comments--commentId--delete"> DELETE /videos/{videoId}/comments/{commentId} </a>
215 </li>
216 </ul>
217 </section>
218 <section>
219 <a href="#tag-VideoRate">VideoRate</a>
220 <ul>
221 <li>
222 <a href="#operation--videos--id--rate-put"> PUT /videos/{id}/rate </a>
223 </li>
224 </ul>
225 </section>
226 <h5>Schema Definitions</h5>
227 <a href="#definition-VideoConstant"> VideoConstant </a>
228 <a href="#definition-VideoPrivacy"> VideoPrivacy </a>
229 <a href="#definition-Video"> Video </a>
230 <a href="#definition-VideoAbuse"> VideoAbuse </a>
231 <a href="#definition-VideoBlacklist"> VideoBlacklist </a>
232 <a href="#definition-VideoChannel"> VideoChannel </a>
233 <a href="#definition-VideoComment"> VideoComment </a>
234 <a href="#definition-VideoCommentThreadTree"> VideoCommentThreadTree </a>
235 <a href="#definition-Avatar"> Avatar </a>
236 <a href="#definition-Actor"> Actor </a>
237 <a href="#definition-Account"> Account </a>
238 <a href="#definition-User"> User </a>
239 <a href="#definition-ServerConfig"> ServerConfig </a>
240 <a href="#definition-Follow"> Follow </a>
241 <a href="#definition-Job"> Job </a>
242 <a href="#definition-AddUserResponse"> AddUserResponse </a>
243 <a href="#definition-VideoUploadResponse"> VideoUploadResponse </a>
244 <a href="#definition-CommentThreadResponse"> CommentThreadResponse </a>
245 <a href="#definition-CommentThreadPostResponse"> CommentThreadPostResponse </a>
246 <a href="#definition-AddUser"> AddUser </a>
247 <a href="#definition-UpdateUser"> UpdateUser </a>
248 <a href="#definition-UpdateMe"> UpdateMe </a>
249 <a href="#definition-GetMeVideoRating"> GetMeVideoRating </a>
250 <a href="#definition-RegisterUser"> RegisterUser </a>
251 <a href="#definition-VideoChannelInput"> VideoChannelInput </a>
252 </nav>
253 </div>
254 <div id="docs" class="row collapse expanded drawer" data-drawer>
255 <button class="floating-menu-icon" type="button" data-drawer-slide="right">
256 <span class="hamburger"></span>
257 </button>
258 <div class="example-box doc-content"></div>
259 <article>
260 <h1 class="doc-title">PeerTube
261 <span>API Reference</span>
262 </h1>
263 <div id="introduction" data-traverse-target="introduction">
264 <div class="doc-row">
265 <div class="doc-copy">
266 <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.</p>
267 </div>
268 <div class="doc-examples">
269 <section>
270 <h5>API Endpoint</h5>
271 <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre>
272 <!-- </div> -->
273 <h5>Schemes:
274 <span>https</span>
275 </h5>
276 <h5>Version:
277 <span>1.0.0-beta</span>
278 </h5>
279 </section>
280 </div>
281 </div>
282 </div>
283 <!-- <h1 id="security" data-traverse-target="security">Security</h1> -->
284 <h1 id="authentication" data-traverse-target="authentication">Authentication</h1>
285 <div id="security-definition-OAuth2" class="panel">
286 <div class="doc-row">
287 <div class="doc-copy">
288 <h3 class="security-definition-title">
289 <span class="security-name">OAuth2</span>
290 <span class="swagger-security-definition-oauth2"></span>
291 </h3>
292 <section class="security-definition-description">
293 <p>In the header:
294 <em>Authorization: Bearer mytoken</em>
295 </p>
296 </section>
297 <section class="swagger-security-definition-properties">
298 <div class="prop-row security-definition-property">
299 <div class="prop-name">
300 <div class="prop-title security-definition-property-name">type</div>
301 </div>
302 <div class="prop-value security-definition-property-type"> oauth2 </div>
303 </div>
304 <div class="prop-row security-definition-property">
305 <div class="prop-name">
306 <div class="prop-title security-definition-property-name">flow</div>
307 </div>
308 <div class="prop-value security-definition-property-type"> password </div>
309 </div>
310 <div class="prop-row security-definition-property">
311 <div class="prop-name">
312 <div class="prop-title security-definition-property-name">tokenUrl</div>
313 </div>
314 <div class="prop-value security-definition-property-type"> https://peertube.example.com/api/v1/users/token </div>
315 </div>
316 </section>
317 </div>
318 </div>
319 </div>
320 <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1>
321 <div id="operation--accounts--id--get" class="operation panel" data-traverse-target="operation--accounts--id--get">
322 <!-- <section class="operation-tags row"> -->
323 <!-- <div class="doc-copy"> -->
324 <div class="operation-tags">
325 <a class="label" href="#tag-Accounts">Accounts</a>
326 <!---->
327 </div>
328 <!-- </div> -->
329 <!-- </section> -->
330 <h2 class="operation-title">
331 <span class="operation-name">
332 <span class="operation-name">GET</span>
333 <span class="operation-path">/accounts/{id}</span>
334 </span>
335 </h2>
336 <div class="doc-row">
337 <div class="doc-copy">
338 <section class="swagger-request-params">
339 <div class="prop-row prop-group">
340 <div class="prop-name">
341 <div class="prop-title">id</div>
342 <span class="json-property-required"></span>
343 <div class="prop-subtitle"> in path </div>
344 <div class="prop-subtitle">
345 <span class="json-property-type">string</span>
346 <span class="json-property-range" title="Value limits"></span>
347 </div>
348 </div>
349 <div class="prop-value">
350 <p>The id of the account</p>
351 </div>
352 </div>
353 <div class="prop-row prop-group">
354 <div class="prop-name">
355 <div class="prop-title">start</div>
356 <div class="prop-subtitle"> in query </div>
357 <div class="prop-subtitle">
358 <span class="json-property-type">number</span>
359 <span class="json-property-range" title="Value limits"></span>
360 </div>
361 </div>
362 <div class="prop-value">
363 <p>starting page</p>
364 </div>
365 </div>
366 <div class="prop-row prop-group">
367 <div class="prop-name">
368 <div class="prop-title">stop</div>
369 <div class="prop-subtitle"> in query </div>
370 <div class="prop-subtitle">
371 <span class="json-property-type">number</span>
372 <span class="json-property-range" title="Value limits"></span>
373 </div>
374 </div>
375 <div class="prop-value">
376 <p>stopping page</p>
377 </div>
378 </div>
379 <div class="prop-row prop-group">
380 <div class="prop-name">
381 <div class="prop-title">sort</div>
382 <div class="prop-subtitle"> in query </div>
383 <div class="prop-subtitle">
384 <span class="json-property-type">number</span>
385 <span class="json-property-range" title="Value limits"></span>
386 </div>
387 </div>
388 <div class="prop-value">
389 <p>sorting</p>
390 </div>
391 </div>
392 </section>
393 </div>
394 <div class="doc-examples"></div>
395 </div>
396 <div class="doc-row">
397 <div class="doc-copy">
398 <section class="swagger-responses">
399 <div class="prop-row prop-group">
400 <div class="prop-name">
401 <div class="prop-title">200 OK</div>
402 <div class="prop-ref">
403 <span class="">
404 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
405 </span>
406 </div>
407 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
408 </div>
409 <div class="prop-value">
410 <p>successful operation</p>
411 </div>
412 </div>
413 </section>
414 </div>
415 <div class="doc-examples">
416 <h5>Response Content-Types:
417 <span>application/json</span>
418 </h5>
419 <section>
420 <h5>Response Example
421 <span>(200 OK)</span>
422 </h5>
423 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
424 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
425 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
426 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
427 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
428 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
429 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
430 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
431 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
432 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
433 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
434 <span class="hljs-attr">&quot;avatar&quot;</span>: {
435 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
436 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
437 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
438 }
439 }
440 </code></pre>
441 <!-- </div> -->
442 </section>
443 </div>
444 </div>
445 </div>
446 <div id="operation--accounts-get" class="operation panel" data-traverse-target="operation--accounts-get">
447 <!-- <section class="operation-tags row"> -->
448 <!-- <div class="doc-copy"> -->
449 <div class="operation-tags">
450 <a class="label" href="#tag-Accounts">Accounts</a>
451 <!---->
452 </div>
453 <!-- </div> -->
454 <!-- </section> -->
455 <h2 class="operation-title">
456 <span class="operation-name">
457 <span class="operation-name">GET</span>
458 <span class="operation-path">/accounts</span>
459 </span>
460 </h2>
461 <div class="doc-row">
462 <div class="doc-copy"> </div>
463 <div class="doc-examples"></div>
464 </div>
465 <div class="doc-row">
466 <div class="doc-copy">
467 <section class="swagger-responses">
468 <div class="prop-row prop-group">
469 <div class="prop-name">
470 <div class="prop-title">200 OK</div>
471 <div class="prop-ref">
472 <span class="json-schema-ref-array">
473 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
474 </span>
475 </div>
476 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
477 </div>
478 <div class="prop-value">
479 <p>successful operation</p>
480 </div>
481 </div>
482 <div class="prop-row prop-inner">
483 <div class="prop-name">type</div>
484 <div class="prop-value">
485 <span class="json-property-type">
486 <span class="json-schema-ref-array">
487 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
488 </span>
489 </span>
490 <span class="json-property-range" title="Value limits"></span>
491 </div>
492 </div>
493 </section>
494 </div>
495 <div class="doc-examples">
496 <h5>Response Content-Types:
497 <span>application/json</span>
498 </h5>
499 <section>
500 <h5>Response Example
501 <span>(200 OK)</span>
502 </h5>
503 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
504 {
505 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
506 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
507 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
508 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
509 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
510 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
511 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
512 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
513 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
514 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
515 <span class="hljs-attr">&quot;avatar&quot;</span>: {
516 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
517 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
518 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
519 }
520 }
521 ]
522 </code></pre>
523 <!-- </div> -->
524 </section>
525 </div>
526 </div>
527 </div>
528 <h1 id="tag-Config" class="swagger-summary-tag" data-traverse-target="tag-Config">Config</h1>
529 <div id="operation--config-get" class="operation panel" data-traverse-target="operation--config-get">
530 <!-- <section class="operation-tags row"> -->
531 <!-- <div class="doc-copy"> -->
532 <div class="operation-tags">
533 <a class="label" href="#tag-Config">Config</a>
534 <!---->
535 </div>
536 <!-- </div> -->
537 <!-- </section> -->
538 <h2 class="operation-title">
539 <span class="operation-name">
540 <span class="operation-name">GET</span>
541 <span class="operation-path">/config</span>
542 </span>
543 </h2>
544 <div class="doc-row">
545 <div class="doc-copy"> </div>
546 <div class="doc-examples"></div>
547 </div>
548 <div class="doc-row">
549 <div class="doc-copy">
550 <section class="swagger-responses">
551 <div class="prop-row prop-group">
552 <div class="prop-name">
553 <div class="prop-title">200 OK</div>
554 <div class="prop-ref">
555 <span class="">
556 <a class="json-schema-ref" href="#/definitions/ServerConfig">ServerConfig</a>
557 </span>
558 </div>
559 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
560 </div>
561 <div class="prop-value">
562 <p>successful operation</p>
563 </div>
564 </div>
565 </section>
566 </div>
567 <div class="doc-examples">
568 <h5>Response Content-Types:
569 <span>application/json</span>
570 </h5>
571 <section>
572 <h5>Response Example
573 <span>(200 OK)</span>
574 </h5>
575 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
576 <span class="hljs-attr">&quot;signup&quot;</span>: {
577 <span class="hljs-attr">&quot;allowed&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>
578 },
579 <span class="hljs-attr">&quot;transcoding&quot;</span>: {
580 <span class="hljs-attr">&quot;enabledResolutions&quot;</span>: [
581 <span class="hljs-string">&quot;number&quot;</span>
582 ]
583 },
584 <span class="hljs-attr">&quot;avatar&quot;</span>: {
585 <span class="hljs-attr">&quot;file&quot;</span>: {
586 <span class="hljs-attr">&quot;size&quot;</span>: {
587 <span class="hljs-attr">&quot;max&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>
588 }
589 },
590 <span class="hljs-attr">&quot;extensions&quot;</span>: [
591 <span class="hljs-string">&quot;string&quot;</span>
592 ]
593 },
594 <span class="hljs-attr">&quot;video&quot;</span>: {
595 <span class="hljs-attr">&quot;file&quot;</span>: {
596 <span class="hljs-attr">&quot;extensions&quot;</span>: [
597 <span class="hljs-string">&quot;string&quot;</span>
598 ]
599 }
600 }
601 }
602 </code></pre>
603 <!-- </div> -->
604 </section>
605 </div>
606 </div>
607 </div>
608 <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1>
609 <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get">
610 <!-- <section class="operation-tags row"> -->
611 <!-- <div class="doc-copy"> -->
612 <div class="operation-tags">
613 <a class="label" href="#tag-Job">Job</a>
614 <!---->
615 </div>
616 <!-- </div> -->
617 <!-- </section> -->
618 <h2 class="operation-title">
619 <span class="operation-name">
620 <span class="operation-name">GET</span>
621 <span class="operation-path">/jobs</span>
622 </span>
623 </h2>
624 <div class="doc-row">
625 <div class="doc-copy">
626 <section class="swagger-request-params">
627 <div class="prop-row prop-group">
628 <div class="prop-name">
629 <div class="prop-title">state</div>
630 <span class="json-property-required"></span>
631 <div class="prop-subtitle"> in path </div>
632 <div class="prop-subtitle">
633 <span class="json-property-type">string</span>
634 <span class="json-property-range" title="Value limits"></span>
635 </div>
636 </div>
637 <div class="prop-value">
638 <p>The id of the account</p>
639 </div>
640 </div>
641 <div class="prop-row prop-group">
642 <div class="prop-name">
643 <div class="prop-title">start</div>
644 <div class="prop-subtitle"> in query </div>
645 <div class="prop-subtitle">
646 <span class="json-property-type">number</span>
647 <span class="json-property-range" title="Value limits"></span>
648 </div>
649 </div>
650 <div class="prop-value">
651 <p>starting page</p>
652 </div>
653 </div>
654 <div class="prop-row prop-group">
655 <div class="prop-name">
656 <div class="prop-title">count</div>
657 <div class="prop-subtitle"> in query </div>
658 <div class="prop-subtitle">
659 <span class="json-property-type">number</span>
660 <span class="json-property-range" title="Value limits"></span>
661 </div>
662 </div>
663 <div class="prop-value">
664 <p class="no-description">(no description)</p>
665 </div>
666 </div>
667 <div class="prop-row prop-group">
668 <div class="prop-name">
669 <div class="prop-title">sort</div>
670 <div class="prop-subtitle"> in query </div>
671 <div class="prop-subtitle">
672 <span class="json-property-type">number</span>
673 <span class="json-property-range" title="Value limits"></span>
674 </div>
675 </div>
676 <div class="prop-value">
677 <p>sorting</p>
678 </div>
679 </div>
680 </section>
681 </div>
682 <div class="doc-examples"></div>
683 </div>
684 <div class="doc-row">
685 <div class="doc-copy">
686 <section class="swagger-responses">
687 <div class="prop-row prop-group">
688 <div class="prop-name">
689 <div class="prop-title">200 OK</div>
690 <div class="prop-ref">
691 <span class="json-schema-ref-array">
692 <a class="json-schema-ref" href="#/definitions/Job">Job</a>
693 </span>
694 </div>
695 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
696 </div>
697 <div class="prop-value">
698 <p>successful operation</p>
699 </div>
700 </div>
701 <div class="prop-row prop-inner">
702 <div class="prop-name">type</div>
703 <div class="prop-value">
704 <span class="json-property-type">
705 <span class="json-schema-ref-array">
706 <a class="json-schema-ref" href="#/definitions/Job">Job</a>
707 </span>
708 </span>
709 <span class="json-property-range" title="Value limits"></span>
710 </div>
711 </div>
712 </section>
713 </div>
714 <div class="doc-examples">
715 <h5>Response Content-Types:
716 <span>application/json</span>
717 </h5>
718 <section>
719 <h5>Response Example
720 <span>(200 OK)</span>
721 </h5>
722 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
723 {
724 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
725 <span class="hljs-attr">&quot;state&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
726 <span class="hljs-attr">&quot;category&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
727 <span class="hljs-attr">&quot;handlerName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
728 <span class="hljs-attr">&quot;handlerInputData&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
729 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
730 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
731 }
732 ]
733 </code></pre>
734 <!-- </div> -->
735 </section>
736 </div>
737 </div>
738 <div class="doc-row">
739 <div class="doc-copy">
740 <section class="swagger-request-security">
741 <table class="table">
742 <thead>
743 <tr>
744 <th class="swagger-request-security-schema"></th>
745 <th class="swagger-request-security-scopes"></th>
746 </tr>
747 </thead>
748 <tbody>
749 <tr>
750 <td>
751 <a href="#security-definition-OAuth2">OAuth2</a>
752 </td>
753 <td> </td>
754 </tr>
755 </tbody>
756 </table>
757 </section>
758 </div>
759 </div>
760 </div>
761 <h1 id="tag-ServerFollowing" class="swagger-summary-tag" data-traverse-target="tag-ServerFollowing">ServerFollowing</h1>
762 <div id="operation--server-following--host--delete" class="operation panel" data-traverse-target="operation--server-following--host--delete">
763 <!-- <section class="operation-tags row"> -->
764 <!-- <div class="doc-copy"> -->
765 <div class="operation-tags">
766 <a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
767 <!---->
768 </div>
769 <!-- </div> -->
770 <!-- </section> -->
771 <h2 class="operation-title">
772 <span class="operation-name">
773 <span class="operation-name">DELETE</span>
774 <span class="operation-path">/server/following/{host}</span>
775 </span>
776 </h2>
777 <div class="doc-row">
778 <div class="doc-copy">
779 <section class="swagger-request-params">
780 <div class="prop-row prop-group">
781 <div class="prop-name">
782 <div class="prop-title">host</div>
783 <span class="json-property-required"></span>
784 <div class="prop-subtitle"> in path </div>
785 <div class="prop-subtitle">
786 <span class="json-property-type">string</span>
787 <span class="json-property-range" title="Value limits"></span>
788 </div>
789 </div>
790 <div class="prop-value">
791 <p>The host to unfollow </p>
792 </div>
793 </div>
794 </section>
795 </div>
796 <div class="doc-examples"></div>
797 </div>
798 <div class="doc-row">
799 <div class="doc-copy">
800 <section class="swagger-responses">
801 <div class="prop-row prop-group">
802 <div class="prop-name">
803 <div class="prop-title">201 Created</div>
804 </div>
805 <div class="prop-value">
806 <p>successful operation</p>
807 </div>
808 </div>
809 </section>
810 </div>
811 <div class="doc-examples">
812 <h5>Response Content-Types:
813 <span>application/json</span>
814 </h5>
815 </div>
816 </div>
817 <div class="doc-row">
818 <div class="doc-copy">
819 <section class="swagger-request-security">
820 <table class="table">
821 <thead>
822 <tr>
823 <th class="swagger-request-security-schema"></th>
824 <th class="swagger-request-security-scopes"></th>
825 </tr>
826 </thead>
827 <tbody>
828 <tr>
829 <td>
830 <a href="#security-definition-OAuth2">OAuth2</a>
831 </td>
832 <td> </td>
833 </tr>
834 </tbody>
835 </table>
836 </section>
837 </div>
838 </div>
839 </div>
840 <div id="operation--server-followers-get" class="operation panel" data-traverse-target="operation--server-followers-get">
841 <!-- <section class="operation-tags row"> -->
842 <!-- <div class="doc-copy"> -->
843 <div class="operation-tags">
844 <a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
845 <!---->
846 </div>
847 <!-- </div> -->
848 <!-- </section> -->
849 <h2 class="operation-title">
850 <span class="operation-name">
851 <span class="operation-name">GET</span>
852 <span class="operation-path">/server/followers</span>
853 </span>
854 </h2>
855 <div class="doc-row">
856 <div class="doc-copy">
857 <section class="swagger-request-params">
858 <div class="prop-row prop-group">
859 <div class="prop-name">
860 <div class="prop-title">start</div>
861 <div class="prop-subtitle"> in query </div>
862 <div class="prop-subtitle">
863 <span class="json-property-type">number</span>
864 <span class="json-property-range" title="Value limits"></span>
865 </div>
866 </div>
867 <div class="prop-value">
868 <p>starting page</p>
869 </div>
870 </div>
871 <div class="prop-row prop-group">
872 <div class="prop-name">
873 <div class="prop-title">stop</div>
874 <div class="prop-subtitle"> in query </div>
875 <div class="prop-subtitle">
876 <span class="json-property-type">number</span>
877 <span class="json-property-range" title="Value limits"></span>
878 </div>
879 </div>
880 <div class="prop-value">
881 <p>stopping page</p>
882 </div>
883 </div>
884 <div class="prop-row prop-group">
885 <div class="prop-name">
886 <div class="prop-title">sort</div>
887 <div class="prop-subtitle"> in query </div>
888 <div class="prop-subtitle">
889 <span class="json-property-type">number</span>
890 <span class="json-property-range" title="Value limits"></span>
891 </div>
892 </div>
893 <div class="prop-value">
894 <p>sorting</p>
895 </div>
896 </div>
897 </section>
898 </div>
899 <div class="doc-examples"></div>
900 </div>
901 <div class="doc-row">
902 <div class="doc-copy">
903 <section class="swagger-responses">
904 <div class="prop-row prop-group">
905 <div class="prop-name">
906 <div class="prop-title">200 OK</div>
907 <div class="prop-ref">
908 <span class="json-schema-ref-array">
909 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
910 </span>
911 </div>
912 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
913 </div>
914 <div class="prop-value">
915 <p>successful operation</p>
916 </div>
917 </div>
918 <div class="prop-row prop-inner">
919 <div class="prop-name">type</div>
920 <div class="prop-value">
921 <span class="json-property-type">
922 <span class="json-schema-ref-array">
923 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
924 </span>
925 </span>
926 <span class="json-property-range" title="Value limits"></span>
927 </div>
928 </div>
929 </section>
930 </div>
931 <div class="doc-examples">
932 <h5>Response Content-Types:
933 <span>application/json</span>
934 </h5>
935 <section>
936 <h5>Response Example
937 <span>(200 OK)</span>
938 </h5>
939 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
940 {
941 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
942 <span class="hljs-attr">&quot;follower&quot;</span>: {
943 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
944 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
945 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
946 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
947 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
948 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
949 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
950 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
951 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
952 <span class="hljs-attr">&quot;avatar&quot;</span>: {
953 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
954 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
955 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
956 }
957 },
958 <span class="hljs-attr">&quot;following&quot;</span>: {
959 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
960 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
961 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
962 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
963 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
964 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
965 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
966 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
967 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
968 <span class="hljs-attr">&quot;avatar&quot;</span>: {
969 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
970 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
971 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
972 }
973 },
974 <span class="hljs-attr">&quot;score&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
975 <span class="hljs-attr">&quot;state&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
976 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
977 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
978 }
979 ]
980 </code></pre>
981 <!-- </div> -->
982 </section>
983 </div>
984 </div>
985 </div>
986 <div id="operation--server-following-get" class="operation panel" data-traverse-target="operation--server-following-get">
987 <!-- <section class="operation-tags row"> -->
988 <!-- <div class="doc-copy"> -->
989 <div class="operation-tags">
990 <a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
991 <!---->
992 </div>
993 <!-- </div> -->
994 <!-- </section> -->
995 <h2 class="operation-title">
996 <span class="operation-name">
997 <span class="operation-name">GET</span>
998 <span class="operation-path">/server/following</span>
999 </span>
1000 </h2>
1001 <div class="doc-row">
1002 <div class="doc-copy">
1003 <section class="swagger-request-params">
1004 <div class="prop-row prop-group">
1005 <div class="prop-name">
1006 <div class="prop-title">start</div>
1007 <div class="prop-subtitle"> in query </div>
1008 <div class="prop-subtitle">
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-value">
1014 <p>starting page</p>
1015 </div>
1016 </div>
1017 <div class="prop-row prop-group">
1018 <div class="prop-name">
1019 <div class="prop-title">stop</div>
1020 <div class="prop-subtitle"> in query </div>
1021 <div class="prop-subtitle">
1022 <span class="json-property-type">number</span>
1023 <span class="json-property-range" title="Value limits"></span>
1024 </div>
1025 </div>
1026 <div class="prop-value">
1027 <p>stopping page</p>
1028 </div>
1029 </div>
1030 <div class="prop-row prop-group">
1031 <div class="prop-name">
1032 <div class="prop-title">sort</div>
1033 <div class="prop-subtitle"> in query </div>
1034 <div class="prop-subtitle">
1035 <span class="json-property-type">number</span>
1036 <span class="json-property-range" title="Value limits"></span>
1037 </div>
1038 </div>
1039 <div class="prop-value">
1040 <p>sorting</p>
1041 </div>
1042 </div>
1043 </section>
1044 </div>
1045 <div class="doc-examples"></div>
1046 </div>
1047 <div class="doc-row">
1048 <div class="doc-copy">
1049 <section class="swagger-responses">
1050 <div class="prop-row prop-group">
1051 <div class="prop-name">
1052 <div class="prop-title">200 OK</div>
1053 <div class="prop-ref">
1054 <span class="json-schema-ref-array">
1055 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1056 </span>
1057 </div>
1058 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1059 </div>
1060 <div class="prop-value">
1061 <p>successful operation</p>
1062 </div>
1063 </div>
1064 <div class="prop-row prop-inner">
1065 <div class="prop-name">type</div>
1066 <div class="prop-value">
1067 <span class="json-property-type">
1068 <span class="json-schema-ref-array">
1069 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1070 </span>
1071 </span>
1072 <span class="json-property-range" title="Value limits"></span>
1073 </div>
1074 </div>
1075 </section>
1076 </div>
1077 <div class="doc-examples">
1078 <h5>Response Content-Types:
1079 <span>application/json</span>
1080 </h5>
1081 <section>
1082 <h5>Response Example
1083 <span>(200 OK)</span>
1084 </h5>
1085 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
1086 {
1087 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1088 <span class="hljs-attr">&quot;follower&quot;</span>: {
1089 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1090 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1091 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1092 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1093 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1094 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1095 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1096 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1097 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1098 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1099 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1100 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1101 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1102 }
1103 },
1104 <span class="hljs-attr">&quot;following&quot;</span>: {
1105 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1106 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1107 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1108 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1109 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1110 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1111 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1112 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1113 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1114 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1115 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1116 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1117 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1118 }
1119 },
1120 <span class="hljs-attr">&quot;score&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1121 <span class="hljs-attr">&quot;state&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1122 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1123 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1124 }
1125 ]
1126 </code></pre>
1127 <!-- </div> -->
1128 </section>
1129 </div>
1130 </div>
1131 </div>
1132 <div id="operation--server-following-post" class="operation panel" data-traverse-target="operation--server-following-post">
1133 <!-- <section class="operation-tags row"> -->
1134 <!-- <div class="doc-copy"> -->
1135 <div class="operation-tags">
1136 <a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
1137 <!---->
1138 </div>
1139 <!-- </div> -->
1140 <!-- </section> -->
1141 <h2 class="operation-title">
1142 <span class="operation-name">
1143 <span class="operation-name">POST</span>
1144 <span class="operation-path">/server/following</span>
1145 </span>
1146 </h2>
1147 <div class="doc-row">
1148 <div class="doc-copy">
1149 <section class="swagger-request-body">
1150 <div class="prop-row">
1151 <div class="prop-name">
1152 <div class="swagger-request-model">
1153 <span class="">
1154 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1155 </span>
1156 </div>
1157 </div>
1158 <div class="prop-value columns small-6">
1159 <!-- <div class="swagger-request-description"> -->
1160 <p>undefined</p>
1161 <!-- </div> -->
1162 </div>
1163 </div>
1164 </section>
1165 </div>
1166 <div class="doc-examples">
1167 <section>
1168 <h5>Request Content-Types:
1169 <span>application/json</span>
1170 </h5>
1171 <h5>Request Example</h5>
1172 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1173 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1174 <span class="hljs-attr">&quot;follower&quot;</span>: {
1175 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1176 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1177 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1178 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1179 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1180 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1181 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1182 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1183 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1184 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1185 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1186 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1187 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1188 }
1189 },
1190 <span class="hljs-attr">&quot;following&quot;</span>: {
1191 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1192 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1193 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1194 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1195 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1196 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1197 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1198 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1199 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1200 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1201 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1202 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1203 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1204 }
1205 },
1206 <span class="hljs-attr">&quot;score&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1207 <span class="hljs-attr">&quot;state&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1208 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1209 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1210 }
1211 </code></pre>
1212 <!-- </div> -->
1213 </section>
1214 </div>
1215 </div>
1216 <div class="doc-row">
1217 <div class="doc-copy">
1218 <section class="swagger-responses">
1219 <div class="prop-row prop-group">
1220 <div class="prop-name">
1221 <div class="prop-title">204 No Content</div>
1222 </div>
1223 <div class="prop-value">
1224 <p>successful operation</p>
1225 </div>
1226 </div>
1227 </section>
1228 </div>
1229 <div class="doc-examples">
1230 <h5>Response Content-Types:
1231 <span>application/json</span>
1232 </h5>
1233 </div>
1234 </div>
1235 <div class="doc-row">
1236 <div class="doc-copy">
1237 <section class="swagger-request-security">
1238 <table class="table">
1239 <thead>
1240 <tr>
1241 <th class="swagger-request-security-schema"></th>
1242 <th class="swagger-request-security-scopes"></th>
1243 </tr>
1244 </thead>
1245 <tbody>
1246 <tr>
1247 <td>
1248 <a href="#security-definition-OAuth2">OAuth2</a>
1249 </td>
1250 <td> </td>
1251 </tr>
1252 </tbody>
1253 </table>
1254 </section>
1255 </div>
1256 </div>
1257 </div>
1258 <h1 id="tag-User" class="swagger-summary-tag" data-traverse-target="tag-User">User</h1>
1259 <div id="operation--users-post" class="operation panel" data-traverse-target="operation--users-post">
1260 <!-- <section class="operation-tags row"> -->
1261 <!-- <div class="doc-copy"> -->
1262 <div class="operation-tags">
1263 <a class="label" href="#tag-User">User</a>
1264 <!---->
1265 </div>
1266 <!-- </div> -->
1267 <!-- </section> -->
1268 <h2 class="operation-title">
1269 <span class="operation-name">
1270 <span class="operation-name">POST</span>
1271 <span class="operation-path">/users</span>
1272 </span>
1273 </h2>
1274 <div class="doc-row">
1275 <div class="doc-copy">
1276 <section class="swagger-request-body">
1277 <div class="prop-row">
1278 <div class="prop-name">
1279 <div class="swagger-request-model">
1280 <span class="">
1281 <a class="json-schema-ref" href="#/definitions/AddUser">AddUser</a>
1282 </span>
1283 </div>
1284 </div>
1285 <div class="prop-value columns small-6">
1286 <!-- <div class="swagger-request-description"> -->
1287 <p>User to create</p>
1288 <!-- </div> -->
1289 </div>
1290 </div>
1291 </section>
1292 </div>
1293 <div class="doc-examples">
1294 <section>
1295 <h5>Request Content-Types:
1296 <span>application/json</span>
1297 </h5>
1298 <h5>Request Example</h5>
1299 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1300 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1301 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1302 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1303 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1304 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1305 }
1306 </code></pre>
1307 <!-- </div> -->
1308 </section>
1309 </div>
1310 </div>
1311 <div class="doc-row">
1312 <div class="doc-copy">
1313 <section class="swagger-responses">
1314 <div class="prop-row prop-group">
1315 <div class="prop-name">
1316 <div class="prop-title">200 OK</div>
1317 <div class="prop-ref">
1318 <span class="">
1319 <a class="json-schema-ref" href="#/definitions/AddUserResponse">AddUserResponse</a>
1320 </span>
1321 </div>
1322 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1323 </div>
1324 <div class="prop-value">
1325 <p>successful operation</p>
1326 </div>
1327 </div>
1328 </section>
1329 </div>
1330 <div class="doc-examples">
1331 <h5>Response Content-Types:
1332 <span>application/json</span>
1333 </h5>
1334 <section>
1335 <h5>Response Example
1336 <span>(200 OK)</span>
1337 </h5>
1338 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1339 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1340 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1341 }
1342 </code></pre>
1343 <!-- </div> -->
1344 </section>
1345 </div>
1346 </div>
1347 <div class="doc-row">
1348 <div class="doc-copy">
1349 <section class="swagger-request-security">
1350 <table class="table">
1351 <thead>
1352 <tr>
1353 <th class="swagger-request-security-schema"></th>
1354 <th class="swagger-request-security-scopes"></th>
1355 </tr>
1356 </thead>
1357 <tbody>
1358 <tr>
1359 <td>
1360 <a href="#security-definition-OAuth2">OAuth2</a>
1361 </td>
1362 <td> </td>
1363 </tr>
1364 </tbody>
1365 </table>
1366 </section>
1367 </div>
1368 </div>
1369 </div>
1370 <div id="operation--users-get" class="operation panel" data-traverse-target="operation--users-get">
1371 <!-- <section class="operation-tags row"> -->
1372 <!-- <div class="doc-copy"> -->
1373 <div class="operation-tags">
1374 <a class="label" href="#tag-User">User</a>
1375 <!---->
1376 </div>
1377 <!-- </div> -->
1378 <!-- </section> -->
1379 <h2 class="operation-title">
1380 <span class="operation-name">
1381 <span class="operation-name">GET</span>
1382 <span class="operation-path">/users</span>
1383 </span>
1384 </h2>
1385 <div class="doc-row">
1386 <div class="doc-copy">
1387 <section class="swagger-request-params">
1388 <div class="prop-row prop-group">
1389 <div class="prop-name">
1390 <div class="prop-title">start</div>
1391 <div class="prop-subtitle"> in query </div>
1392 <div class="prop-subtitle">
1393 <span class="json-property-type">number</span>
1394 <span class="json-property-range" title="Value limits"></span>
1395 </div>
1396 </div>
1397 <div class="prop-value">
1398 <p>starting page</p>
1399 </div>
1400 </div>
1401 <div class="prop-row prop-group">
1402 <div class="prop-name">
1403 <div class="prop-title">stop</div>
1404 <div class="prop-subtitle"> in query </div>
1405 <div class="prop-subtitle">
1406 <span class="json-property-type">number</span>
1407 <span class="json-property-range" title="Value limits"></span>
1408 </div>
1409 </div>
1410 <div class="prop-value">
1411 <p>stopping page</p>
1412 </div>
1413 </div>
1414 <div class="prop-row prop-group">
1415 <div class="prop-name">
1416 <div class="prop-title">sort</div>
1417 <div class="prop-subtitle"> in query </div>
1418 <div class="prop-subtitle">
1419 <span class="json-property-type">number</span>
1420 <span class="json-property-range" title="Value limits"></span>
1421 </div>
1422 </div>
1423 <div class="prop-value">
1424 <p>sorting</p>
1425 </div>
1426 </div>
1427 </section>
1428 </div>
1429 <div class="doc-examples"></div>
1430 </div>
1431 <div class="doc-row">
1432 <div class="doc-copy">
1433 <section class="swagger-responses">
1434 <div class="prop-row prop-group">
1435 <div class="prop-name">
1436 <div class="prop-title">200 OK</div>
1437 <div class="prop-ref">
1438 <span class="json-schema-ref-array">
1439 <a class="json-schema-ref" href="#/definitions/User">User</a>
1440 </span>
1441 </div>
1442 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1443 </div>
1444 <div class="prop-value">
1445 <p>successful operation</p>
1446 </div>
1447 </div>
1448 <div class="prop-row prop-inner">
1449 <div class="prop-name">type</div>
1450 <div class="prop-value">
1451 <span class="json-property-type">
1452 <span class="json-schema-ref-array">
1453 <a class="json-schema-ref" href="#/definitions/User">User</a>
1454 </span>
1455 </span>
1456 <span class="json-property-range" title="Value limits"></span>
1457 </div>
1458 </div>
1459 </section>
1460 </div>
1461 <div class="doc-examples">
1462 <h5>Response Content-Types:
1463 <span>application/json</span>
1464 </h5>
1465 <section>
1466 <h5>Response Example
1467 <span>(200 OK)</span>
1468 </h5>
1469 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
1470 {
1471 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1472 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1473 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1474 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1475 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1476 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1477 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1478 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1479 <span class="hljs-attr">&quot;account&quot;</span>: {
1480 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1481 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1482 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1483 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1484 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1485 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1486 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1487 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1488 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1489 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1490 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1491 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1492 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1493 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1494 }
1495 },
1496 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
1497 {
1498 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1499 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1500 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1501 <span class="hljs-attr">&quot;owner&quot;</span>: {
1502 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1503 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1504 },
1505 <span class="hljs-attr">&quot;videos&quot;</span>: [
1506 {
1507 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1508 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1509 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1510 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1511 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1512 <span class="hljs-attr">&quot;category&quot;</span>: {
1513 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1514 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1515 },
1516 <span class="hljs-attr">&quot;licence&quot;</span>: {
1517 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1518 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1519 },
1520 <span class="hljs-attr">&quot;language&quot;</span>: {
1521 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1522 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1523 },
1524 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1525 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1526 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1527 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1528 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1529 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1530 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1531 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1532 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1533 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1534 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1535 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1536 <span class="hljs-attr">&quot;account&quot;</span>: {
1537 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1538 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1539 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1540 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1541 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1542 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1543 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1544 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1545 }
1546 }
1547 }
1548 ]
1549 }
1550 ]
1551 }
1552 ]
1553 </code></pre>
1554 <!-- </div> -->
1555 </section>
1556 </div>
1557 </div>
1558 <div class="doc-row">
1559 <div class="doc-copy">
1560 <section class="swagger-request-security">
1561 <table class="table">
1562 <thead>
1563 <tr>
1564 <th class="swagger-request-security-schema"></th>
1565 <th class="swagger-request-security-scopes"></th>
1566 </tr>
1567 </thead>
1568 <tbody>
1569 <tr>
1570 <td>
1571 <a href="#security-definition-OAuth2">OAuth2</a>
1572 </td>
1573 <td> </td>
1574 </tr>
1575 </tbody>
1576 </table>
1577 </section>
1578 </div>
1579 </div>
1580 </div>
1581 <div id="operation--users--id--delete" class="operation panel" data-traverse-target="operation--users--id--delete">
1582 <!-- <section class="operation-tags row"> -->
1583 <!-- <div class="doc-copy"> -->
1584 <div class="operation-tags">
1585 <a class="label" href="#tag-User">User</a>
1586 <!---->
1587 </div>
1588 <!-- </div> -->
1589 <!-- </section> -->
1590 <h2 class="operation-title">
1591 <span class="operation-name">
1592 <span class="operation-name">DELETE</span>
1593 <span class="operation-path">/users/{id}</span>
1594 </span>
1595 </h2>
1596 <div class="doc-row">
1597 <div class="doc-copy">
1598 <section class="swagger-request-params">
1599 <div class="prop-row prop-group">
1600 <div class="prop-name">
1601 <div class="prop-title">id</div>
1602 <span class="json-property-required"></span>
1603 <div class="prop-subtitle"> in path </div>
1604 <div class="prop-subtitle">
1605 <span class="json-property-type">string</span>
1606 <span class="json-property-range" title="Value limits"></span>
1607 </div>
1608 </div>
1609 <div class="prop-value">
1610 <p>The user id </p>
1611 </div>
1612 </div>
1613 </section>
1614 </div>
1615 <div class="doc-examples"></div>
1616 </div>
1617 <div class="doc-row">
1618 <div class="doc-copy">
1619 <section class="swagger-responses">
1620 <div class="prop-row prop-group">
1621 <div class="prop-name">
1622 <div class="prop-title">204 No Content</div>
1623 </div>
1624 <div class="prop-value">
1625 <p>successful operation</p>
1626 </div>
1627 </div>
1628 </section>
1629 </div>
1630 <div class="doc-examples">
1631 <h5>Response Content-Types:
1632 <span>application/json</span>
1633 </h5>
1634 </div>
1635 </div>
1636 <div class="doc-row">
1637 <div class="doc-copy">
1638 <section class="swagger-request-security">
1639 <table class="table">
1640 <thead>
1641 <tr>
1642 <th class="swagger-request-security-schema"></th>
1643 <th class="swagger-request-security-scopes"></th>
1644 </tr>
1645 </thead>
1646 <tbody>
1647 <tr>
1648 <td>
1649 <a href="#security-definition-OAuth2">OAuth2</a>
1650 </td>
1651 <td> </td>
1652 </tr>
1653 </tbody>
1654 </table>
1655 </section>
1656 </div>
1657 </div>
1658 </div>
1659 <div id="operation--users--id--get" class="operation panel" data-traverse-target="operation--users--id--get">
1660 <!-- <section class="operation-tags row"> -->
1661 <!-- <div class="doc-copy"> -->
1662 <div class="operation-tags">
1663 <a class="label" href="#tag-User">User</a>
1664 <!---->
1665 </div>
1666 <!-- </div> -->
1667 <!-- </section> -->
1668 <h2 class="operation-title">
1669 <span class="operation-name">
1670 <span class="operation-name">GET</span>
1671 <span class="operation-path">/users/{id}</span>
1672 </span>
1673 </h2>
1674 <div class="doc-row">
1675 <div class="doc-copy">
1676 <section class="swagger-request-params">
1677 <div class="prop-row prop-group">
1678 <div class="prop-name">
1679 <div class="prop-title">id</div>
1680 <span class="json-property-required"></span>
1681 <div class="prop-subtitle"> in path </div>
1682 <div class="prop-subtitle">
1683 <span class="json-property-type">string</span>
1684 <span class="json-property-range" title="Value limits"></span>
1685 </div>
1686 </div>
1687 <div class="prop-value">
1688 <p>The user id </p>
1689 </div>
1690 </div>
1691 </section>
1692 </div>
1693 <div class="doc-examples"></div>
1694 </div>
1695 <div class="doc-row">
1696 <div class="doc-copy">
1697 <section class="swagger-responses">
1698 <div class="prop-row prop-group">
1699 <div class="prop-name">
1700 <div class="prop-title">200 OK</div>
1701 <div class="prop-ref">
1702 <span class="">
1703 <a class="json-schema-ref" href="#/definitions/User">User</a>
1704 </span>
1705 </div>
1706 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1707 </div>
1708 <div class="prop-value">
1709 <p>successful operation</p>
1710 </div>
1711 </div>
1712 </section>
1713 </div>
1714 <div class="doc-examples">
1715 <h5>Response Content-Types:
1716 <span>application/json</span>
1717 </h5>
1718 <section>
1719 <h5>Response Example
1720 <span>(200 OK)</span>
1721 </h5>
1722 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1723 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1724 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1725 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1726 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1727 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1728 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1729 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1730 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1731 <span class="hljs-attr">&quot;account&quot;</span>: {
1732 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1733 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1734 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1735 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1736 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1737 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1738 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1739 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1740 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1741 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1742 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1743 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1744 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1745 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1746 }
1747 },
1748 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
1749 {
1750 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1751 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1752 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1753 <span class="hljs-attr">&quot;owner&quot;</span>: {
1754 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1755 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1756 },
1757 <span class="hljs-attr">&quot;videos&quot;</span>: [
1758 {
1759 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1760 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1761 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1762 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1763 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1764 <span class="hljs-attr">&quot;category&quot;</span>: {
1765 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1766 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1767 },
1768 <span class="hljs-attr">&quot;licence&quot;</span>: {
1769 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1770 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1771 },
1772 <span class="hljs-attr">&quot;language&quot;</span>: {
1773 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1774 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1775 },
1776 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1777 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1778 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1779 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1780 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1781 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1782 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1783 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1784 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1785 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1786 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1787 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1788 <span class="hljs-attr">&quot;account&quot;</span>: {
1789 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1790 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1791 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1792 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1793 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1794 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1795 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1796 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1797 }
1798 }
1799 }
1800 ]
1801 }
1802 ]
1803 }
1804 </code></pre>
1805 <!-- </div> -->
1806 </section>
1807 </div>
1808 </div>
1809 <div class="doc-row">
1810 <div class="doc-copy">
1811 <section class="swagger-request-security">
1812 <table class="table">
1813 <thead>
1814 <tr>
1815 <th class="swagger-request-security-schema"></th>
1816 <th class="swagger-request-security-scopes"></th>
1817 </tr>
1818 </thead>
1819 <tbody>
1820 <tr>
1821 <td>
1822 <a href="#security-definition-OAuth2">OAuth2</a>
1823 </td>
1824 <td> </td>
1825 </tr>
1826 </tbody>
1827 </table>
1828 </section>
1829 </div>
1830 </div>
1831 </div>
1832 <div id="operation--users--id--put" class="operation panel" data-traverse-target="operation--users--id--put">
1833 <!-- <section class="operation-tags row"> -->
1834 <!-- <div class="doc-copy"> -->
1835 <div class="operation-tags">
1836 <a class="label" href="#tag-User">User</a>
1837 <!---->
1838 </div>
1839 <!-- </div> -->
1840 <!-- </section> -->
1841 <h2 class="operation-title">
1842 <span class="operation-name">
1843 <span class="operation-name">PUT</span>
1844 <span class="operation-path">/users/{id}</span>
1845 </span>
1846 </h2>
1847 <div class="doc-row">
1848 <div class="doc-copy">
1849 <section class="swagger-request-body">
1850 <div class="prop-row">
1851 <div class="prop-name">
1852 <div class="swagger-request-model">
1853 <span class="">
1854 <a class="json-schema-ref" href="#/definitions/UpdateUser">UpdateUser</a>
1855 </span>
1856 </div>
1857 </div>
1858 <div class="prop-value columns small-6">
1859 <!-- <div class="swagger-request-description"> -->
1860 <p>undefined</p>
1861 <!-- </div> -->
1862 </div>
1863 </div>
1864 </section>
1865 <section class="swagger-request-params">
1866 <div class="prop-row prop-group">
1867 <div class="prop-name">
1868 <div class="prop-title">id</div>
1869 <span class="json-property-required"></span>
1870 <div class="prop-subtitle"> in path </div>
1871 <div class="prop-subtitle">
1872 <span class="json-property-type">string</span>
1873 <span class="json-property-range" title="Value limits"></span>
1874 </div>
1875 </div>
1876 <div class="prop-value">
1877 <p>The user id </p>
1878 </div>
1879 </div>
1880 </section>
1881 </div>
1882 <div class="doc-examples">
1883 <section>
1884 <h5>Request Content-Types:
1885 <span>application/json</span>
1886 </h5>
1887 <h5>Request Example</h5>
1888 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1889 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1890 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1891 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1892 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1893 }
1894 </code></pre>
1895 <!-- </div> -->
1896 </section>
1897 </div>
1898 </div>
1899 <div class="doc-row">
1900 <div class="doc-copy">
1901 <section class="swagger-responses">
1902 <div class="prop-row prop-group">
1903 <div class="prop-name">
1904 <div class="prop-title">204 No Content</div>
1905 </div>
1906 <div class="prop-value">
1907 <p>successful operation</p>
1908 </div>
1909 </div>
1910 </section>
1911 </div>
1912 <div class="doc-examples">
1913 <h5>Response Content-Types:
1914 <span>application/json</span>
1915 </h5>
1916 </div>
1917 </div>
1918 <div class="doc-row">
1919 <div class="doc-copy">
1920 <section class="swagger-request-security">
1921 <table class="table">
1922 <thead>
1923 <tr>
1924 <th class="swagger-request-security-schema"></th>
1925 <th class="swagger-request-security-scopes"></th>
1926 </tr>
1927 </thead>
1928 <tbody>
1929 <tr>
1930 <td>
1931 <a href="#security-definition-OAuth2">OAuth2</a>
1932 </td>
1933 <td> </td>
1934 </tr>
1935 </tbody>
1936 </table>
1937 </section>
1938 </div>
1939 </div>
1940 </div>
1941 <div id="operation--users-me-get" class="operation panel" data-traverse-target="operation--users-me-get">
1942 <!-- <section class="operation-tags row"> -->
1943 <!-- <div class="doc-copy"> -->
1944 <div class="operation-tags">
1945 <a class="label" href="#tag-User">User</a>
1946 <!---->
1947 </div>
1948 <!-- </div> -->
1949 <!-- </section> -->
1950 <h2 class="operation-title">
1951 <span class="operation-name">
1952 <span class="operation-name">GET</span>
1953 <span class="operation-path">/users/me</span>
1954 </span>
1955 </h2>
1956 <div class="doc-row">
1957 <div class="doc-copy"> </div>
1958 <div class="doc-examples"></div>
1959 </div>
1960 <div class="doc-row">
1961 <div class="doc-copy">
1962 <section class="swagger-responses">
1963 <div class="prop-row prop-group">
1964 <div class="prop-name">
1965 <div class="prop-title">200 OK</div>
1966 <div class="prop-ref">
1967 <span class="json-schema-ref-array">
1968 <a class="json-schema-ref" href="#/definitions/User">User</a>
1969 </span>
1970 </div>
1971 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1972 </div>
1973 <div class="prop-value">
1974 <p>successful operation</p>
1975 </div>
1976 </div>
1977 <div class="prop-row prop-inner">
1978 <div class="prop-name">type</div>
1979 <div class="prop-value">
1980 <span class="json-property-type">
1981 <span class="json-schema-ref-array">
1982 <a class="json-schema-ref" href="#/definitions/User">User</a>
1983 </span>
1984 </span>
1985 <span class="json-property-range" title="Value limits"></span>
1986 </div>
1987 </div>
1988 </section>
1989 </div>
1990 <div class="doc-examples">
1991 <h5>Response Content-Types:
1992 <span>application/json</span>
1993 </h5>
1994 <section>
1995 <h5>Response Example
1996 <span>(200 OK)</span>
1997 </h5>
1998 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
1999 {
2000 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2001 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2002 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2003 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2004 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2005 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2006 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2007 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2008 <span class="hljs-attr">&quot;account&quot;</span>: {
2009 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2010 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2011 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2012 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2013 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2014 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2015 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2016 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2017 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2018 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2019 <span class="hljs-attr">&quot;avatar&quot;</span>: {
2020 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2021 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2022 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2023 }
2024 },
2025 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
2026 {
2027 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2028 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2029 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2030 <span class="hljs-attr">&quot;owner&quot;</span>: {
2031 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2032 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2033 },
2034 <span class="hljs-attr">&quot;videos&quot;</span>: [
2035 {
2036 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2037 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2038 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2039 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2040 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2041 <span class="hljs-attr">&quot;category&quot;</span>: {
2042 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2043 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2044 },
2045 <span class="hljs-attr">&quot;licence&quot;</span>: {
2046 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2047 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2048 },
2049 <span class="hljs-attr">&quot;language&quot;</span>: {
2050 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2051 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2052 },
2053 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2054 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2055 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2056 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2057 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2058 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2059 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2060 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2061 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2062 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2063 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2064 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2065 <span class="hljs-attr">&quot;account&quot;</span>: {
2066 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2067 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2068 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2069 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2070 <span class="hljs-attr">&quot;avatar&quot;</span>: {
2071 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2072 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2073 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2074 }
2075 }
2076 }
2077 ]
2078 }
2079 ]
2080 }
2081 ]
2082 </code></pre>
2083 <!-- </div> -->
2084 </section>
2085 </div>
2086 </div>
2087 <div class="doc-row">
2088 <div class="doc-copy">
2089 <section class="swagger-request-security">
2090 <table class="table">
2091 <thead>
2092 <tr>
2093 <th class="swagger-request-security-schema"></th>
2094 <th class="swagger-request-security-scopes"></th>
2095 </tr>
2096 </thead>
2097 <tbody>
2098 <tr>
2099 <td>
2100 <a href="#security-definition-OAuth2">OAuth2</a>
2101 </td>
2102 <td> </td>
2103 </tr>
2104 </tbody>
2105 </table>
2106 </section>
2107 </div>
2108 </div>
2109 </div>
2110 <div id="operation--users-me-put" class="operation panel" data-traverse-target="operation--users-me-put">
2111 <!-- <section class="operation-tags row"> -->
2112 <!-- <div class="doc-copy"> -->
2113 <div class="operation-tags">
2114 <a class="label" href="#tag-User">User</a>
2115 <!---->
2116 </div>
2117 <!-- </div> -->
2118 <!-- </section> -->
2119 <h2 class="operation-title">
2120 <span class="operation-name">
2121 <span class="operation-name">PUT</span>
2122 <span class="operation-path">/users/me</span>
2123 </span>
2124 </h2>
2125 <div class="doc-row">
2126 <div class="doc-copy">
2127 <section class="swagger-request-body">
2128 <div class="prop-row">
2129 <div class="prop-name">
2130 <div class="swagger-request-model">
2131 <span class="">
2132 <a class="json-schema-ref" href="#/definitions/UpdateMe">UpdateMe</a>
2133 </span>
2134 </div>
2135 </div>
2136 <div class="prop-value columns small-6">
2137 <!-- <div class="swagger-request-description"> -->
2138 <p>undefined</p>
2139 <!-- </div> -->
2140 </div>
2141 </div>
2142 </section>
2143 </div>
2144 <div class="doc-examples">
2145 <section>
2146 <h5>Request Content-Types:
2147 <span>application/json</span>
2148 </h5>
2149 <h5>Request Example</h5>
2150 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2151 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2152 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2153 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2154 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2155 }
2156 </code></pre>
2157 <!-- </div> -->
2158 </section>
2159 </div>
2160 </div>
2161 <div class="doc-row">
2162 <div class="doc-copy">
2163 <section class="swagger-responses">
2164 <div class="prop-row prop-group">
2165 <div class="prop-name">
2166 <div class="prop-title">204 No Content</div>
2167 </div>
2168 <div class="prop-value">
2169 <p>successful operation</p>
2170 </div>
2171 </div>
2172 </section>
2173 </div>
2174 <div class="doc-examples">
2175 <h5>Response Content-Types:
2176 <span>application/json</span>
2177 </h5>
2178 </div>
2179 </div>
2180 <div class="doc-row">
2181 <div class="doc-copy">
2182 <section class="swagger-request-security">
2183 <table class="table">
2184 <thead>
2185 <tr>
2186 <th class="swagger-request-security-schema"></th>
2187 <th class="swagger-request-security-scopes"></th>
2188 </tr>
2189 </thead>
2190 <tbody>
2191 <tr>
2192 <td>
2193 <a href="#security-definition-OAuth2">OAuth2</a>
2194 </td>
2195 <td> </td>
2196 </tr>
2197 </tbody>
2198 </table>
2199 </section>
2200 </div>
2201 </div>
2202 </div>
2203 <div id="operation--users-me-video-quota-used-get" class="operation panel" data-traverse-target="operation--users-me-video-quota-used-get">
2204 <!-- <section class="operation-tags row"> -->
2205 <!-- <div class="doc-copy"> -->
2206 <div class="operation-tags">
2207 <a class="label" href="#tag-User">User</a>
2208 <!---->
2209 </div>
2210 <!-- </div> -->
2211 <!-- </section> -->
2212 <h2 class="operation-title">
2213 <span class="operation-name">
2214 <span class="operation-name">GET</span>
2215 <span class="operation-path">/users/me/video-quota-used</span>
2216 </span>
2217 </h2>
2218 <div class="doc-row">
2219 <div class="doc-copy"> </div>
2220 <div class="doc-examples"></div>
2221 </div>
2222 <div class="doc-row">
2223 <div class="doc-copy">
2224 <section class="swagger-responses">
2225 <div class="prop-row prop-group">
2226 <div class="prop-name">
2227 <div class="prop-title">200 OK</div>
2228 <div class="prop-ref"></div>
2229 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2230 </div>
2231 <div class="prop-value">
2232 <p>successful operation</p>
2233 </div>
2234 </div>
2235 <div class="prop-row prop-inner">
2236 <div class="prop-name">type</div>
2237 <div class="prop-value">
2238 <span class="json-property-type">number</span>
2239 <span class="json-property-range" title="Value limits"></span>
2240 </div>
2241 </div>
2242 </section>
2243 </div>
2244 <div class="doc-examples">
2245 <h5>Response Content-Types:
2246 <span>application/json</span>
2247 </h5>
2248 <section>
2249 <h5>Response Example
2250 <span>(200 OK)</span>
2251 </h5>
2252 <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">&quot;number&quot;</span>
2253 </code></pre>
2254 <!-- </div> -->
2255 </section>
2256 </div>
2257 </div>
2258 <div class="doc-row">
2259 <div class="doc-copy">
2260 <section class="swagger-request-security">
2261 <table class="table">
2262 <thead>
2263 <tr>
2264 <th class="swagger-request-security-schema"></th>
2265 <th class="swagger-request-security-scopes"></th>
2266 </tr>
2267 </thead>
2268 <tbody>
2269 <tr>
2270 <td>
2271 <a href="#security-definition-OAuth2">OAuth2</a>
2272 </td>
2273 <td> </td>
2274 </tr>
2275 </tbody>
2276 </table>
2277 </section>
2278 </div>
2279 </div>
2280 </div>
2281 <div id="operation--users-me-videos--videoId--rating-get" class="operation panel" data-traverse-target="operation--users-me-videos--videoId--rating-get">
2282 <!-- <section class="operation-tags row"> -->
2283 <!-- <div class="doc-copy"> -->
2284 <div class="operation-tags">
2285 <a class="label" href="#tag-User">User</a>
2286 <!---->
2287 </div>
2288 <!-- </div> -->
2289 <!-- </section> -->
2290 <h2 class="operation-title">
2291 <span class="operation-name">
2292 <span class="operation-name">GET</span>
2293 <span class="operation-path">/users/me/videos/{videoId}/rating</span>
2294 </span>
2295 </h2>
2296 <div class="doc-row">
2297 <div class="doc-copy">
2298 <section class="swagger-request-params">
2299 <div class="prop-row prop-group">
2300 <div class="prop-name">
2301 <div class="prop-title">videoId</div>
2302 <span class="json-property-required"></span>
2303 <div class="prop-subtitle"> in path </div>
2304 <div class="prop-subtitle">
2305 <span class="json-property-type">string</span>
2306 <span class="json-property-range" title="Value limits"></span>
2307 </div>
2308 </div>
2309 <div class="prop-value">
2310 <p>The video id </p>
2311 </div>
2312 </div>
2313 </section>
2314 </div>
2315 <div class="doc-examples"></div>
2316 </div>
2317 <div class="doc-row">
2318 <div class="doc-copy">
2319 <section class="swagger-responses">
2320 <div class="prop-row prop-group">
2321 <div class="prop-name">
2322 <div class="prop-title">200 OK</div>
2323 <div class="prop-ref">
2324 <span class="">
2325 <a class="json-schema-ref" href="#/definitions/GetMeVideoRating">GetMeVideoRating</a>
2326 </span>
2327 </div>
2328 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2329 </div>
2330 <div class="prop-value">
2331 <p>successful operation</p>
2332 </div>
2333 </div>
2334 </section>
2335 </div>
2336 <div class="doc-examples">
2337 <h5>Response Content-Types:
2338 <span>application/json</span>
2339 </h5>
2340 <section>
2341 <h5>Response Example
2342 <span>(200 OK)</span>
2343 </h5>
2344 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2345 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2346 <span class="hljs-attr">&quot;rating&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>
2347 }
2348 </code></pre>
2349 <!-- </div> -->
2350 </section>
2351 </div>
2352 </div>
2353 <div class="doc-row">
2354 <div class="doc-copy">
2355 <section class="swagger-request-security">
2356 <table class="table">
2357 <thead>
2358 <tr>
2359 <th class="swagger-request-security-schema"></th>
2360 <th class="swagger-request-security-scopes"></th>
2361 </tr>
2362 </thead>
2363 <tbody>
2364 <tr>
2365 <td>
2366 <a href="#security-definition-OAuth2">OAuth2</a>
2367 </td>
2368 <td> </td>
2369 </tr>
2370 </tbody>
2371 </table>
2372 </section>
2373 </div>
2374 </div>
2375 </div>
2376 <div id="operation--users-me-videos-get" class="operation panel" data-traverse-target="operation--users-me-videos-get">
2377 <!-- <section class="operation-tags row"> -->
2378 <!-- <div class="doc-copy"> -->
2379 <div class="operation-tags">
2380 <a class="label" href="#tag-User">User</a>
2381 <!---->
2382 </div>
2383 <!-- </div> -->
2384 <!-- </section> -->
2385 <h2 class="operation-title">
2386 <span class="operation-name">
2387 <span class="operation-name">GET</span>
2388 <span class="operation-path">/users/me/videos</span>
2389 </span>
2390 </h2>
2391 <div class="doc-row">
2392 <div class="doc-copy">
2393 <section class="swagger-request-params">
2394 <div class="prop-row prop-group">
2395 <div class="prop-name">
2396 <div class="prop-title">start</div>
2397 <div class="prop-subtitle"> in query </div>
2398 <div class="prop-subtitle">
2399 <span class="json-property-type">number</span>
2400 <span class="json-property-range" title="Value limits"></span>
2401 </div>
2402 </div>
2403 <div class="prop-value">
2404 <p>starting page</p>
2405 </div>
2406 </div>
2407 <div class="prop-row prop-group">
2408 <div class="prop-name">
2409 <div class="prop-title">stop</div>
2410 <div class="prop-subtitle"> in query </div>
2411 <div class="prop-subtitle">
2412 <span class="json-property-type">number</span>
2413 <span class="json-property-range" title="Value limits"></span>
2414 </div>
2415 </div>
2416 <div class="prop-value">
2417 <p>stopping page</p>
2418 </div>
2419 </div>
2420 <div class="prop-row prop-group">
2421 <div class="prop-name">
2422 <div class="prop-title">sort</div>
2423 <div class="prop-subtitle"> in query </div>
2424 <div class="prop-subtitle">
2425 <span class="json-property-type">number</span>
2426 <span class="json-property-range" title="Value limits"></span>
2427 </div>
2428 </div>
2429 <div class="prop-value">
2430 <p>sorting</p>
2431 </div>
2432 </div>
2433 </section>
2434 </div>
2435 <div class="doc-examples"></div>
2436 </div>
2437 <div class="doc-row">
2438 <div class="doc-copy">
2439 <section class="swagger-responses">
2440 <div class="prop-row prop-group">
2441 <div class="prop-name">
2442 <div class="prop-title">200 OK</div>
2443 <div class="prop-ref">
2444 <span class="json-schema-ref-array">
2445 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2446 </span>
2447 </div>
2448 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2449 </div>
2450 <div class="prop-value">
2451 <p>successful operation</p>
2452 </div>
2453 </div>
2454 <div class="prop-row prop-inner">
2455 <div class="prop-name">type</div>
2456 <div class="prop-value">
2457 <span class="json-property-type">
2458 <span class="json-schema-ref-array">
2459 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2460 </span>
2461 </span>
2462 <span class="json-property-range" title="Value limits"></span>
2463 </div>
2464 </div>
2465 </section>
2466 </div>
2467 <div class="doc-examples">
2468 <h5>Response Content-Types:
2469 <span>application/json</span>
2470 </h5>
2471 <section>
2472 <h5>Response Example
2473 <span>(200 OK)</span>
2474 </h5>
2475 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
2476 {
2477 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2478 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2479 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2480 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2481 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2482 <span class="hljs-attr">&quot;category&quot;</span>: {
2483 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2484 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2485 },
2486 <span class="hljs-attr">&quot;licence&quot;</span>: {
2487 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2488 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2489 },
2490 <span class="hljs-attr">&quot;language&quot;</span>: {
2491 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2492 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2493 },
2494 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2495 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2496 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2497 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2498 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2499 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2500 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2501 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2502 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2503 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2504 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2505 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2506 <span class="hljs-attr">&quot;account&quot;</span>: {
2507 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2508 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2509 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2510 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2511 <span class="hljs-attr">&quot;avatar&quot;</span>: {
2512 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2513 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2514 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2515 }
2516 }
2517 }
2518 ]
2519 </code></pre>
2520 <!-- </div> -->
2521 </section>
2522 </div>
2523 </div>
2524 <div class="doc-row">
2525 <div class="doc-copy">
2526 <section class="swagger-request-security">
2527 <table class="table">
2528 <thead>
2529 <tr>
2530 <th class="swagger-request-security-schema"></th>
2531 <th class="swagger-request-security-scopes"></th>
2532 </tr>
2533 </thead>
2534 <tbody>
2535 <tr>
2536 <td>
2537 <a href="#security-definition-OAuth2">OAuth2</a>
2538 </td>
2539 <td> </td>
2540 </tr>
2541 </tbody>
2542 </table>
2543 </section>
2544 </div>
2545 </div>
2546 </div>
2547 <div id="operation--users-register-post" class="operation panel" data-traverse-target="operation--users-register-post">
2548 <!-- <section class="operation-tags row"> -->
2549 <!-- <div class="doc-copy"> -->
2550 <div class="operation-tags">
2551 <a class="label" href="#tag-User">User</a>
2552 <!---->
2553 </div>
2554 <!-- </div> -->
2555 <!-- </section> -->
2556 <h2 class="operation-title">
2557 <span class="operation-name">
2558 <span class="operation-name">POST</span>
2559 <span class="operation-path">/users/register</span>
2560 </span>
2561 </h2>
2562 <div class="doc-row">
2563 <div class="doc-copy">
2564 <section class="swagger-request-body">
2565 <div class="prop-row">
2566 <div class="prop-name">
2567 <div class="swagger-request-model">
2568 <span class="">
2569 <a class="json-schema-ref" href="#/definitions/RegisterUser">RegisterUser</a>
2570 </span>
2571 </div>
2572 </div>
2573 <div class="prop-value columns small-6">
2574 <!-- <div class="swagger-request-description"> -->
2575 <p>undefined</p>
2576 <!-- </div> -->
2577 </div>
2578 </div>
2579 </section>
2580 </div>
2581 <div class="doc-examples">
2582 <section>
2583 <h5>Request Content-Types:
2584 <span>application/json</span>
2585 </h5>
2586 <h5>Request Example</h5>
2587 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2588 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2589 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2590 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2591 }
2592 </code></pre>
2593 <!-- </div> -->
2594 </section>
2595 </div>
2596 </div>
2597 <div class="doc-row">
2598 <div class="doc-copy">
2599 <section class="swagger-responses">
2600 <div class="prop-row prop-group">
2601 <div class="prop-name">
2602 <div class="prop-title">204 No Content</div>
2603 </div>
2604 <div class="prop-value">
2605 <p>successful operation</p>
2606 </div>
2607 </div>
2608 </section>
2609 </div>
2610 <div class="doc-examples">
2611 <h5>Response Content-Types:
2612 <span>application/json</span>
2613 </h5>
2614 </div>
2615 </div>
2616 </div>
2617 <div id="operation--users-me-avatar-pick-post" class="operation panel" data-traverse-target="operation--users-me-avatar-pick-post">
2618 <!-- <section class="operation-tags row"> -->
2619 <!-- <div class="doc-copy"> -->
2620 <div class="operation-tags">
2621 <a class="label" href="#tag-User">User</a>
2622 <!---->
2623 </div>
2624 <!-- </div> -->
2625 <!-- </section> -->
2626 <h2 class="operation-title">
2627 <span class="operation-name">
2628 <span class="operation-name">POST</span>
2629 <span class="operation-path">/users/me/avatar/pick</span>
2630 </span>
2631 </h2>
2632 <div class="doc-row">
2633 <div class="doc-copy">
2634 <section class="swagger-request-params">
2635 <div class="prop-row prop-group">
2636 <div class="prop-name">
2637 <div class="prop-title">avatarfile</div>
2638 <div class="prop-subtitle"> in formData </div>
2639 <div class="prop-subtitle">
2640 <span class="json-property-type">file</span>
2641 <span class="json-property-range" title="Value limits"></span>
2642 </div>
2643 </div>
2644 <div class="prop-value">
2645 <p>The file to upload.</p>
2646 </div>
2647 </div>
2648 </section>
2649 </div>
2650 <div class="doc-examples"></div>
2651 </div>
2652 <div class="doc-row">
2653 <div class="doc-copy">
2654 <section class="swagger-responses">
2655 <div class="prop-row prop-group">
2656 <div class="prop-name">
2657 <div class="prop-title">200 OK</div>
2658 <div class="prop-ref">
2659 <span class="">
2660 <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
2661 </span>
2662 </div>
2663 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2664 </div>
2665 <div class="prop-value">
2666 <p>successful operation</p>
2667 </div>
2668 </div>
2669 </section>
2670 </div>
2671 <div class="doc-examples">
2672 <h5>Response Content-Types:
2673 <span>application/json</span>
2674 </h5>
2675 <section>
2676 <h5>Response Example
2677 <span>(200 OK)</span>
2678 </h5>
2679 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2680 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2681 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2682 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2683 }
2684 </code></pre>
2685 <!-- </div> -->
2686 </section>
2687 </div>
2688 </div>
2689 <div class="doc-row">
2690 <div class="doc-copy">
2691 <section class="swagger-request-security">
2692 <table class="table">
2693 <thead>
2694 <tr>
2695 <th class="swagger-request-security-schema"></th>
2696 <th class="swagger-request-security-scopes"></th>
2697 </tr>
2698 </thead>
2699 <tbody>
2700 <tr>
2701 <td>
2702 <a href="#security-definition-OAuth2">OAuth2</a>
2703 </td>
2704 <td> </td>
2705 </tr>
2706 </tbody>
2707 </table>
2708 </section>
2709 </div>
2710 </div>
2711 </div>
2712 <h1 id="tag-Video" class="swagger-summary-tag" data-traverse-target="tag-Video">Video</h1>
2713 <div id="operation--videos-get" class="operation panel" data-traverse-target="operation--videos-get">
2714 <!-- <section class="operation-tags row"> -->
2715 <!-- <div class="doc-copy"> -->
2716 <div class="operation-tags">
2717 <a class="label" href="#tag-Video">Video</a>
2718 <!---->
2719 </div>
2720 <!-- </div> -->
2721 <!-- </section> -->
2722 <h2 class="operation-title">
2723 <span class="operation-name">
2724 <span class="operation-name">GET</span>
2725 <span class="operation-path">/videos</span>
2726 </span>
2727 </h2>
2728 <div class="doc-row">
2729 <div class="doc-copy">
2730 <section class="swagger-request-params">
2731 <div class="prop-row prop-group">
2732 <div class="prop-name">
2733 <div class="prop-title">start</div>
2734 <div class="prop-subtitle"> in query </div>
2735 <div class="prop-subtitle">
2736 <span class="json-property-type">number</span>
2737 <span class="json-property-range" title="Value limits"></span>
2738 </div>
2739 </div>
2740 <div class="prop-value">
2741 <p>starting page</p>
2742 </div>
2743 </div>
2744 <div class="prop-row prop-group">
2745 <div class="prop-name">
2746 <div class="prop-title">stop</div>
2747 <div class="prop-subtitle"> in query </div>
2748 <div class="prop-subtitle">
2749 <span class="json-property-type">number</span>
2750 <span class="json-property-range" title="Value limits"></span>
2751 </div>
2752 </div>
2753 <div class="prop-value">
2754 <p>stopping page</p>
2755 </div>
2756 </div>
2757 <div class="prop-row prop-group">
2758 <div class="prop-name">
2759 <div class="prop-title">sort</div>
2760 <div class="prop-subtitle"> in query </div>
2761 <div class="prop-subtitle">
2762 <span class="json-property-type">number</span>
2763 <span class="json-property-range" title="Value limits"></span>
2764 </div>
2765 </div>
2766 <div class="prop-value">
2767 <p>sorting</p>
2768 </div>
2769 </div>
2770 </section>
2771 </div>
2772 <div class="doc-examples"></div>
2773 </div>
2774 <div class="doc-row">
2775 <div class="doc-copy">
2776 <section class="swagger-responses">
2777 <div class="prop-row prop-group">
2778 <div class="prop-name">
2779 <div class="prop-title">200 OK</div>
2780 <div class="prop-ref">
2781 <span class="json-schema-ref-array">
2782 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2783 </span>
2784 </div>
2785 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2786 </div>
2787 <div class="prop-value">
2788 <p>successful operation</p>
2789 </div>
2790 </div>
2791 <div class="prop-row prop-inner">
2792 <div class="prop-name">type</div>
2793 <div class="prop-value">
2794 <span class="json-property-type">
2795 <span class="json-schema-ref-array">
2796 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2797 </span>
2798 </span>
2799 <span class="json-property-range" title="Value limits"></span>
2800 </div>
2801 </div>
2802 </section>
2803 </div>
2804 <div class="doc-examples">
2805 <h5>Response Content-Types:
2806 <span>application/json</span>
2807 </h5>
2808 <section>
2809 <h5>Response Example
2810 <span>(200 OK)</span>
2811 </h5>
2812 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
2813 {
2814 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2815 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2816 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2817 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2818 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2819 <span class="hljs-attr">&quot;category&quot;</span>: {
2820 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2821 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2822 },
2823 <span class="hljs-attr">&quot;licence&quot;</span>: {
2824 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2825 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2826 },
2827 <span class="hljs-attr">&quot;language&quot;</span>: {
2828 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2829 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2830 },
2831 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2832 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2833 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2834 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2835 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2836 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2837 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2838 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2839 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2840 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2841 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2842 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2843 <span class="hljs-attr">&quot;account&quot;</span>: {
2844 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2845 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2846 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2847 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2848 <span class="hljs-attr">&quot;avatar&quot;</span>: {
2849 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2850 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2851 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2852 }
2853 }
2854 }
2855 ]
2856 </code></pre>
2857 <!-- </div> -->
2858 </section>
2859 </div>
2860 </div>
2861 </div>
2862 <div id="operation--videos-categories-get" class="operation panel" data-traverse-target="operation--videos-categories-get">
2863 <!-- <section class="operation-tags row"> -->
2864 <!-- <div class="doc-copy"> -->
2865 <div class="operation-tags">
2866 <a class="label" href="#tag-Video">Video</a>
2867 <!---->
2868 </div>
2869 <!-- </div> -->
2870 <!-- </section> -->
2871 <h2 class="operation-title">
2872 <span class="operation-name">
2873 <span class="operation-name">GET</span>
2874 <span class="operation-path">/videos/categories</span>
2875 </span>
2876 </h2>
2877 <div class="doc-row">
2878 <div class="doc-copy"> </div>
2879 <div class="doc-examples"></div>
2880 </div>
2881 <div class="doc-row">
2882 <div class="doc-copy">
2883 <section class="swagger-responses">
2884 <div class="prop-row prop-group">
2885 <div class="prop-name">
2886 <div class="prop-title">200 OK</div>
2887 <div class="prop-ref"></div>
2888 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2889 </div>
2890 <div class="prop-value">
2891 <p>successful operation</p>
2892 </div>
2893 </div>
2894 <div class="prop-row prop-inner">
2895 <div class="prop-name">type</div>
2896 <div class="prop-value">
2897 <span class="json-property-type">string[]</span>
2898 <span class="json-property-range" title="Value limits"></span>
2899 </div>
2900 </div>
2901 </section>
2902 </div>
2903 <div class="doc-examples">
2904 <h5>Response Content-Types:
2905 <span>application/json</span>
2906 </h5>
2907 <section>
2908 <h5>Response Example
2909 <span>(200 OK)</span>
2910 </h5>
2911 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
2912 <span class="hljs-string">&quot;string&quot;</span>
2913 ]
2914 </code></pre>
2915 <!-- </div> -->
2916 </section>
2917 </div>
2918 </div>
2919 </div>
2920 <div id="operation--videos-licences-get" class="operation panel" data-traverse-target="operation--videos-licences-get">
2921 <!-- <section class="operation-tags row"> -->
2922 <!-- <div class="doc-copy"> -->
2923 <div class="operation-tags">
2924 <a class="label" href="#tag-Video">Video</a>
2925 <!---->
2926 </div>
2927 <!-- </div> -->
2928 <!-- </section> -->
2929 <h2 class="operation-title">
2930 <span class="operation-name">
2931 <span class="operation-name">GET</span>
2932 <span class="operation-path">/videos/licences</span>
2933 </span>
2934 </h2>
2935 <div class="doc-row">
2936 <div class="doc-copy"> </div>
2937 <div class="doc-examples"></div>
2938 </div>
2939 <div class="doc-row">
2940 <div class="doc-copy">
2941 <section class="swagger-responses">
2942 <div class="prop-row prop-group">
2943 <div class="prop-name">
2944 <div class="prop-title">200 OK</div>
2945 <div class="prop-ref"></div>
2946 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2947 </div>
2948 <div class="prop-value">
2949 <p>successful operation</p>
2950 </div>
2951 </div>
2952 <div class="prop-row prop-inner">
2953 <div class="prop-name">type</div>
2954 <div class="prop-value">
2955 <span class="json-property-type">string[]</span>
2956 <span class="json-property-range" title="Value limits"></span>
2957 </div>
2958 </div>
2959 </section>
2960 </div>
2961 <div class="doc-examples">
2962 <h5>Response Content-Types:
2963 <span>application/json</span>
2964 </h5>
2965 <section>
2966 <h5>Response Example
2967 <span>(200 OK)</span>
2968 </h5>
2969 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
2970 <span class="hljs-string">&quot;string&quot;</span>
2971 ]
2972 </code></pre>
2973 <!-- </div> -->
2974 </section>
2975 </div>
2976 </div>
2977 </div>
2978 <div id="operation--videos-languages-get" class="operation panel" data-traverse-target="operation--videos-languages-get">
2979 <!-- <section class="operation-tags row"> -->
2980 <!-- <div class="doc-copy"> -->
2981 <div class="operation-tags">
2982 <a class="label" href="#tag-Video">Video</a>
2983 <!---->
2984 </div>
2985 <!-- </div> -->
2986 <!-- </section> -->
2987 <h2 class="operation-title">
2988 <span class="operation-name">
2989 <span class="operation-name">GET</span>
2990 <span class="operation-path">/videos/languages</span>
2991 </span>
2992 </h2>
2993 <div class="doc-row">
2994 <div class="doc-copy"> </div>
2995 <div class="doc-examples"></div>
2996 </div>
2997 <div class="doc-row">
2998 <div class="doc-copy">
2999 <section class="swagger-responses">
3000 <div class="prop-row prop-group">
3001 <div class="prop-name">
3002 <div class="prop-title">200 OK</div>
3003 <div class="prop-ref"></div>
3004 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3005 </div>
3006 <div class="prop-value">
3007 <p>successful operation</p>
3008 </div>
3009 </div>
3010 <div class="prop-row prop-inner">
3011 <div class="prop-name">type</div>
3012 <div class="prop-value">
3013 <span class="json-property-type">string[]</span>
3014 <span class="json-property-range" title="Value limits"></span>
3015 </div>
3016 </div>
3017 </section>
3018 </div>
3019 <div class="doc-examples">
3020 <h5>Response Content-Types:
3021 <span>application/json</span>
3022 </h5>
3023 <section>
3024 <h5>Response Example
3025 <span>(200 OK)</span>
3026 </h5>
3027 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
3028 <span class="hljs-string">&quot;string&quot;</span>
3029 ]
3030 </code></pre>
3031 <!-- </div> -->
3032 </section>
3033 </div>
3034 </div>
3035 </div>
3036 <div id="operation--videos-privacies-get" class="operation panel" data-traverse-target="operation--videos-privacies-get">
3037 <!-- <section class="operation-tags row"> -->
3038 <!-- <div class="doc-copy"> -->
3039 <div class="operation-tags">
3040 <a class="label" href="#tag-Video">Video</a>
3041 <!---->
3042 </div>
3043 <!-- </div> -->
3044 <!-- </section> -->
3045 <h2 class="operation-title">
3046 <span class="operation-name">
3047 <span class="operation-name">GET</span>
3048 <span class="operation-path">/videos/privacies</span>
3049 </span>
3050 </h2>
3051 <div class="doc-row">
3052 <div class="doc-copy"> </div>
3053 <div class="doc-examples"></div>
3054 </div>
3055 <div class="doc-row">
3056 <div class="doc-copy">
3057 <section class="swagger-responses">
3058 <div class="prop-row prop-group">
3059 <div class="prop-name">
3060 <div class="prop-title">200 OK</div>
3061 <div class="prop-ref"></div>
3062 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3063 </div>
3064 <div class="prop-value">
3065 <p>successful operation</p>
3066 </div>
3067 </div>
3068 <div class="prop-row prop-inner">
3069 <div class="prop-name">type</div>
3070 <div class="prop-value">
3071 <span class="json-property-type">string[]</span>
3072 <span class="json-property-range" title="Value limits"></span>
3073 </div>
3074 </div>
3075 </section>
3076 </div>
3077 <div class="doc-examples">
3078 <h5>Response Content-Types:
3079 <span>application/json</span>
3080 </h5>
3081 <section>
3082 <h5>Response Example
3083 <span>(200 OK)</span>
3084 </h5>
3085 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
3086 <span class="hljs-string">&quot;string&quot;</span>
3087 ]
3088 </code></pre>
3089 <!-- </div> -->
3090 </section>
3091 </div>
3092 </div>
3093 </div>
3094 <div id="operation--videos-search-get" class="operation panel" data-traverse-target="operation--videos-search-get">
3095 <!-- <section class="operation-tags row"> -->
3096 <!-- <div class="doc-copy"> -->
3097 <div class="operation-tags">
3098 <a class="label" href="#tag-Video">Video</a>
3099 <!---->
3100 </div>
3101 <!-- </div> -->
3102 <!-- </section> -->
3103 <h2 class="operation-title">
3104 <span class="operation-name">
3105 <span class="operation-name">GET</span>
3106 <span class="operation-path">/videos/search</span>
3107 </span>
3108 </h2>
3109 <div class="doc-row">
3110 <div class="doc-copy">
3111 <section class="swagger-request-params">
3112 <div class="prop-row prop-group">
3113 <div class="prop-name">
3114 <div class="prop-title">start</div>
3115 <div class="prop-subtitle"> in query </div>
3116 <div class="prop-subtitle">
3117 <span class="json-property-type">number</span>
3118 <span class="json-property-range" title="Value limits"></span>
3119 </div>
3120 </div>
3121 <div class="prop-value">
3122 <p>starting page</p>
3123 </div>
3124 </div>
3125 <div class="prop-row prop-group">
3126 <div class="prop-name">
3127 <div class="prop-title">stop</div>
3128 <div class="prop-subtitle"> in query </div>
3129 <div class="prop-subtitle">
3130 <span class="json-property-type">number</span>
3131 <span class="json-property-range" title="Value limits"></span>
3132 </div>
3133 </div>
3134 <div class="prop-value">
3135 <p>stopping page</p>
3136 </div>
3137 </div>
3138 <div class="prop-row prop-group">
3139 <div class="prop-name">
3140 <div class="prop-title">sort</div>
3141 <div class="prop-subtitle"> in query </div>
3142 <div class="prop-subtitle">
3143 <span class="json-property-type">number</span>
3144 <span class="json-property-range" title="Value limits"></span>
3145 </div>
3146 </div>
3147 <div class="prop-value">
3148 <p>sorting</p>
3149 </div>
3150 </div>
3151 </section>
3152 </div>
3153 <div class="doc-examples"></div>
3154 </div>
3155 <div class="doc-row">
3156 <div class="doc-copy">
3157 <section class="swagger-responses">
3158 <div class="prop-row prop-group">
3159 <div class="prop-name">
3160 <div class="prop-title">200 OK</div>
3161 <div class="prop-ref">
3162 <span class="json-schema-ref-array">
3163 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
3164 </span>
3165 </div>
3166 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3167 </div>
3168 <div class="prop-value">
3169 <p>successful operation</p>
3170 </div>
3171 </div>
3172 <div class="prop-row prop-inner">
3173 <div class="prop-name">type</div>
3174 <div class="prop-value">
3175 <span class="json-property-type">
3176 <span class="json-schema-ref-array">
3177 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
3178 </span>
3179 </span>
3180 <span class="json-property-range" title="Value limits"></span>
3181 </div>
3182 </div>
3183 </section>
3184 </div>
3185 <div class="doc-examples">
3186 <h5>Response Content-Types:
3187 <span>application/json</span>
3188 </h5>
3189 <section>
3190 <h5>Response Example
3191 <span>(200 OK)</span>
3192 </h5>
3193 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
3194 {
3195 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3196 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3197 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3198 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3199 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3200 <span class="hljs-attr">&quot;category&quot;</span>: {
3201 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3202 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3203 },
3204 <span class="hljs-attr">&quot;licence&quot;</span>: {
3205 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3206 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3207 },
3208 <span class="hljs-attr">&quot;language&quot;</span>: {
3209 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3210 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3211 },
3212 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3213 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3214 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3215 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3216 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3217 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3218 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3219 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3220 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3221 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3222 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3223 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3224 <span class="hljs-attr">&quot;account&quot;</span>: {
3225 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3226 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3227 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3228 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3229 <span class="hljs-attr">&quot;avatar&quot;</span>: {
3230 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3231 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3232 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3233 }
3234 }
3235 }
3236 ]
3237 </code></pre>
3238 <!-- </div> -->
3239 </section>
3240 </div>
3241 </div>
3242 </div>
3243 <div id="operation--videos--id--put" class="operation panel" data-traverse-target="operation--videos--id--put">
3244 <!-- <section class="operation-tags row"> -->
3245 <!-- <div class="doc-copy"> -->
3246 <div class="operation-tags">
3247 <a class="label" href="#tag-Video">Video</a>
3248 <!---->
3249 </div>
3250 <!-- </div> -->
3251 <!-- </section> -->
3252 <h2 class="operation-title">
3253 <span class="operation-name">
3254 <span class="operation-name">PUT</span>
3255 <span class="operation-path">/videos/{id}</span>
3256 </span>
3257 </h2>
3258 <div class="doc-row">
3259 <div class="doc-copy">
3260 <section class="swagger-request-params">
3261 <div class="prop-row prop-group">
3262 <div class="prop-name">
3263 <div class="prop-title">id</div>
3264 <span class="json-property-required"></span>
3265 <div class="prop-subtitle"> in path </div>
3266 <div class="prop-subtitle">
3267 <span class="json-property-type">string</span>
3268 <span class="json-property-range" title="Value limits"></span>
3269 </div>
3270 </div>
3271 <div class="prop-value">
3272 <p>The video id</p>
3273 </div>
3274 </div>
3275 <div class="prop-row prop-group">
3276 <div class="prop-name">
3277 <div class="prop-title">thumbnailfile</div>
3278 <div class="prop-subtitle"> in formData </div>
3279 <div class="prop-subtitle">
3280 <span class="json-property-type">file</span>
3281 <span class="json-property-range" title="Value limits"></span>
3282 </div>
3283 </div>
3284 <div class="prop-value">
3285 <p>Video thumbnail file</p>
3286 </div>
3287 </div>
3288 <div class="prop-row prop-group">
3289 <div class="prop-name">
3290 <div class="prop-title">previewfile</div>
3291 <div class="prop-subtitle"> in formData </div>
3292 <div class="prop-subtitle">
3293 <span class="json-property-type">file</span>
3294 <span class="json-property-range" title="Value limits"></span>
3295 </div>
3296 </div>
3297 <div class="prop-value">
3298 <p>Video preview file</p>
3299 </div>
3300 </div>
3301 <div class="prop-row prop-group">
3302 <div class="prop-name">
3303 <div class="prop-title">category</div>
3304 <div class="prop-subtitle"> in formData </div>
3305 <div class="prop-subtitle">
3306 <span class="json-property-type">number</span>
3307 <span class="json-property-range" title="Value limits"></span>
3308 </div>
3309 </div>
3310 <div class="prop-value">
3311 <p>Video category</p>
3312 </div>
3313 </div>
3314 <div class="prop-row prop-group">
3315 <div class="prop-name">
3316 <div class="prop-title">licence</div>
3317 <div class="prop-subtitle"> in formData </div>
3318 <div class="prop-subtitle">
3319 <span class="json-property-type">number</span>
3320 <span class="json-property-range" title="Value limits"></span>
3321 </div>
3322 </div>
3323 <div class="prop-value">
3324 <p>Video licence</p>
3325 </div>
3326 </div>
3327 <div class="prop-row prop-group">
3328 <div class="prop-name">
3329 <div class="prop-title">language</div>
3330 <div class="prop-subtitle"> in formData </div>
3331 <div class="prop-subtitle">
3332 <span class="json-property-type">number</span>
3333 <span class="json-property-range" title="Value limits"></span>
3334 </div>
3335 </div>
3336 <div class="prop-value">
3337 <p>Video language</p>
3338 </div>
3339 </div>
3340 <div class="prop-row prop-group">
3341 <div class="prop-name">
3342 <div class="prop-title">description</div>
3343 <div class="prop-subtitle"> in formData </div>
3344 <div class="prop-subtitle">
3345 <span class="json-property-type">string</span>
3346 <span class="json-property-range" title="Value limits"></span>
3347 </div>
3348 </div>
3349 <div class="prop-value">
3350 <p>Video description</p>
3351 </div>
3352 </div>
3353 <div class="prop-row prop-group">
3354 <div class="prop-name">
3355 <div class="prop-title">support</div>
3356 <div class="prop-subtitle"> in formData </div>
3357 <div class="prop-subtitle">
3358 <span class="json-property-type">string</span>
3359 <span class="json-property-range" title="Value limits"></span>
3360 </div>
3361 </div>
3362 <div class="prop-value">
3363 <p>Text describing how to support the video uploader</p>
3364 </div>
3365 </div>
3366 <div class="prop-row prop-group">
3367 <div class="prop-name">
3368 <div class="prop-title">nsfw</div>
3369 <div class="prop-subtitle"> in formData </div>
3370 <div class="prop-subtitle">
3371 <span class="json-property-type">boolean</span>
3372 <span class="json-property-range" title="Value limits"></span>
3373 </div>
3374 </div>
3375 <div class="prop-value">
3376 <p>Whether or not this video contains sensitive content</p>
3377 </div>
3378 </div>
3379 <div class="prop-row prop-group">
3380 <div class="prop-name">
3381 <div class="prop-title">name</div>
3382 <div class="prop-subtitle"> in formData </div>
3383 <div class="prop-subtitle">
3384 <span class="json-property-type">string</span>
3385 <span class="json-property-range" title="Value limits"></span>
3386 </div>
3387 </div>
3388 <div class="prop-value">
3389 <p>Video name</p>
3390 </div>
3391 </div>
3392 <div class="prop-row prop-group">
3393 <div class="prop-name">
3394 <div class="prop-title">tags</div>
3395 <div class="prop-subtitle"> in formData </div>
3396 <div class="prop-subtitle">
3397 <span class="json-property-type">string[]</span>
3398 <span class="json-property-range" title="Value limits"></span>
3399 </div>
3400 </div>
3401 <div class="prop-value">
3402 <p>Video tags</p>
3403 </div>
3404 </div>
3405 <div class="prop-row prop-group">
3406 <div class="prop-name">
3407 <div class="prop-title">commentsEnabled</div>
3408 <div class="prop-subtitle"> in formData </div>
3409 <div class="prop-subtitle">
3410 <span class="json-property-type">boolean</span>
3411 <span class="json-property-range" title="Value limits"></span>
3412 </div>
3413 </div>
3414 <div class="prop-value">
3415 <p>Enable or disable comments for this video</p>
3416 </div>
3417 </div>
3418 <div class="prop-row prop-group">
3419 <div class="prop-name">
3420 <div class="prop-title">privacy</div>
3421 <div class="prop-subtitle"> in formData </div>
3422 <div class="prop-subtitle">
3423 <span class="json-property-type">string</span>
3424 <span class="json-property-enum" title="Possible values">
3425 <span class="json-property-enum-item">Public</span>,
3426 <span class="json-property-enum-item">Unlisted</span>
3427 </span>
3428 <span class="json-property-range" title="Value limits"></span>
3429 </div>
3430 </div>
3431 <div class="prop-value">
3432 <p>Video privacy</p>
3433 </div>
3434 </div>
3435 </section>
3436 </div>
3437 <div class="doc-examples"></div>
3438 </div>
3439 <div class="doc-row">
3440 <div class="doc-copy">
3441 <section class="swagger-responses">
3442 <div class="prop-row prop-group">
3443 <div class="prop-name">
3444 <div class="prop-title">200 OK</div>
3445 <div class="prop-ref">
3446 <span class="">
3447 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
3448 </span>
3449 </div>
3450 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3451 </div>
3452 <div class="prop-value">
3453 <p>successful operation</p>
3454 </div>
3455 </div>
3456 </section>
3457 </div>
3458 <div class="doc-examples">
3459 <h5>Response Content-Types:
3460 <span>application/json</span>
3461 </h5>
3462 <section>
3463 <h5>Response Example
3464 <span>(200 OK)</span>
3465 </h5>
3466 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
3467 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3468 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3469 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3470 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3471 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3472 <span class="hljs-attr">&quot;category&quot;</span>: {
3473 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3474 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3475 },
3476 <span class="hljs-attr">&quot;licence&quot;</span>: {
3477 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3478 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3479 },
3480 <span class="hljs-attr">&quot;language&quot;</span>: {
3481 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3482 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3483 },
3484 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3485 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3486 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3487 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3488 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3489 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3490 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3491 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3492 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3493 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3494 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3495 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3496 <span class="hljs-attr">&quot;account&quot;</span>: {
3497 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3498 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3499 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3500 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3501 <span class="hljs-attr">&quot;avatar&quot;</span>: {
3502 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3503 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3504 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3505 }
3506 }
3507 }
3508 </code></pre>
3509 <!-- </div> -->
3510 </section>
3511 </div>
3512 </div>
3513 <div class="doc-row">
3514 <div class="doc-copy">
3515 <section class="swagger-request-security">
3516 <table class="table">
3517 <thead>
3518 <tr>
3519 <th class="swagger-request-security-schema"></th>
3520 <th class="swagger-request-security-scopes"></th>
3521 </tr>
3522 </thead>
3523 <tbody>
3524 <tr>
3525 <td>
3526 <a href="#security-definition-OAuth2">OAuth2</a>
3527 </td>
3528 <td> </td>
3529 </tr>
3530 </tbody>
3531 </table>
3532 </section>
3533 </div>
3534 </div>
3535 </div>
3536 <div id="operation--videos--id--get" class="operation panel" data-traverse-target="operation--videos--id--get">
3537 <!-- <section class="operation-tags row"> -->
3538 <!-- <div class="doc-copy"> -->
3539 <div class="operation-tags">
3540 <a class="label" href="#tag-Video">Video</a>
3541 <!---->
3542 </div>
3543 <!-- </div> -->
3544 <!-- </section> -->
3545 <h2 class="operation-title">
3546 <span class="operation-name">
3547 <span class="operation-name">GET</span>
3548 <span class="operation-path">/videos/{id}</span>
3549 </span>
3550 </h2>
3551 <div class="doc-row">
3552 <div class="doc-copy">
3553 <section class="swagger-request-params">
3554 <div class="prop-row prop-group">
3555 <div class="prop-name">
3556 <div class="prop-title">id</div>
3557 <span class="json-property-required"></span>
3558 <div class="prop-subtitle"> in path </div>
3559 <div class="prop-subtitle">
3560 <span class="json-property-type">string</span>
3561 <span class="json-property-range" title="Value limits"></span>
3562 </div>
3563 </div>
3564 <div class="prop-value">
3565 <p>The video id </p>
3566 </div>
3567 </div>
3568 </section>
3569 </div>
3570 <div class="doc-examples"></div>
3571 </div>
3572 <div class="doc-row">
3573 <div class="doc-copy">
3574 <section class="swagger-responses">
3575 <div class="prop-row prop-group">
3576 <div class="prop-name">
3577 <div class="prop-title">200 OK</div>
3578 <div class="prop-ref">
3579 <span class="">
3580 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
3581 </span>
3582 </div>
3583 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3584 </div>
3585 <div class="prop-value">
3586 <p>successful operation</p>
3587 </div>
3588 </div>
3589 </section>
3590 </div>
3591 <div class="doc-examples">
3592 <h5>Response Content-Types:
3593 <span>application/json</span>
3594 </h5>
3595 <section>
3596 <h5>Response Example
3597 <span>(200 OK)</span>
3598 </h5>
3599 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
3600 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3601 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3602 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3603 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3604 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3605 <span class="hljs-attr">&quot;category&quot;</span>: {
3606 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3607 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3608 },
3609 <span class="hljs-attr">&quot;licence&quot;</span>: {
3610 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3611 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3612 },
3613 <span class="hljs-attr">&quot;language&quot;</span>: {
3614 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3615 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3616 },
3617 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3618 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3619 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3620 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3621 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3622 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3623 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3624 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3625 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3626 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3627 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3628 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3629 <span class="hljs-attr">&quot;account&quot;</span>: {
3630 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3631 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3632 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3633 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3634 <span class="hljs-attr">&quot;avatar&quot;</span>: {
3635 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3636 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3637 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3638 }
3639 }
3640 }
3641 </code></pre>
3642 <!-- </div> -->
3643 </section>
3644 </div>
3645 </div>
3646 </div>
3647 <div id="operation--videos--id--delete" class="operation panel" data-traverse-target="operation--videos--id--delete">
3648 <!-- <section class="operation-tags row"> -->
3649 <!-- <div class="doc-copy"> -->
3650 <div class="operation-tags">
3651 <a class="label" href="#tag-Video">Video</a>
3652 <!---->
3653 </div>
3654 <!-- </div> -->
3655 <!-- </section> -->
3656 <h2 class="operation-title">
3657 <span class="operation-name">
3658 <span class="operation-name">DELETE</span>
3659 <span class="operation-path">/videos/{id}</span>
3660 </span>
3661 </h2>
3662 <div class="doc-row">
3663 <div class="doc-copy">
3664 <section class="swagger-request-params">
3665 <div class="prop-row prop-group">
3666 <div class="prop-name">
3667 <div class="prop-title">id</div>
3668 <span class="json-property-required"></span>
3669 <div class="prop-subtitle"> in path </div>
3670 <div class="prop-subtitle">
3671 <span class="json-property-type">string</span>
3672 <span class="json-property-range" title="Value limits"></span>
3673 </div>
3674 </div>
3675 <div class="prop-value">
3676 <p>The video id </p>
3677 </div>
3678 </div>
3679 </section>
3680 </div>
3681 <div class="doc-examples"></div>
3682 </div>
3683 <div class="doc-row">
3684 <div class="doc-copy">
3685 <section class="swagger-responses">
3686 <div class="prop-row prop-group">
3687 <div class="prop-name">
3688 <div class="prop-title">204 No Content</div>
3689 </div>
3690 <div class="prop-value">
3691 <p>successful operation</p>
3692 </div>
3693 </div>
3694 </section>
3695 </div>
3696 <div class="doc-examples">
3697 <h5>Response Content-Types:
3698 <span>application/json</span>
3699 </h5>
3700 </div>
3701 </div>
3702 <div class="doc-row">
3703 <div class="doc-copy">
3704 <section class="swagger-request-security">
3705 <table class="table">
3706 <thead>
3707 <tr>
3708 <th class="swagger-request-security-schema"></th>
3709 <th class="swagger-request-security-scopes"></th>
3710 </tr>
3711 </thead>
3712 <tbody>
3713 <tr>
3714 <td>
3715 <a href="#security-definition-OAuth2">OAuth2</a>
3716 </td>
3717 <td> </td>
3718 </tr>
3719 </tbody>
3720 </table>
3721 </section>
3722 </div>
3723 </div>
3724 </div>
3725 <div id="operation--videos--id--description-get" class="operation panel" data-traverse-target="operation--videos--id--description-get">
3726 <!-- <section class="operation-tags row"> -->
3727 <!-- <div class="doc-copy"> -->
3728 <div class="operation-tags">
3729 <a class="label" href="#tag-Video">Video</a>
3730 <!---->
3731 </div>
3732 <!-- </div> -->
3733 <!-- </section> -->
3734 <h2 class="operation-title">
3735 <span class="operation-name">
3736 <span class="operation-name">GET</span>
3737 <span class="operation-path">/videos/{id}/description</span>
3738 </span>
3739 </h2>
3740 <div class="doc-row">
3741 <div class="doc-copy">
3742 <section class="swagger-request-params">
3743 <div class="prop-row prop-group">
3744 <div class="prop-name">
3745 <div class="prop-title">id</div>
3746 <span class="json-property-required"></span>
3747 <div class="prop-subtitle"> in path </div>
3748 <div class="prop-subtitle">
3749 <span class="json-property-type">string</span>
3750 <span class="json-property-range" title="Value limits"></span>
3751 </div>
3752 </div>
3753 <div class="prop-value">
3754 <p>The video id </p>
3755 </div>
3756 </div>
3757 </section>
3758 </div>
3759 <div class="doc-examples"></div>
3760 </div>
3761 <div class="doc-row">
3762 <div class="doc-copy">
3763 <section class="swagger-responses">
3764 <div class="prop-row prop-group">
3765 <div class="prop-name">
3766 <div class="prop-title">200 OK</div>
3767 <div class="prop-ref"></div>
3768 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3769 </div>
3770 <div class="prop-value">
3771 <p>successful operation</p>
3772 </div>
3773 </div>
3774 <div class="prop-row prop-inner">
3775 <div class="prop-name">type</div>
3776 <div class="prop-value">
3777 <span class="json-property-type">string</span>
3778 <span class="json-property-range" title="Value limits"></span>
3779 </div>
3780 </div>
3781 </section>
3782 </div>
3783 <div class="doc-examples">
3784 <h5>Response Content-Types:
3785 <span>application/json</span>
3786 </h5>
3787 <section>
3788 <h5>Response Example
3789 <span>(200 OK)</span>
3790 </h5>
3791 <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">&quot;string&quot;</span>
3792 </code></pre>
3793 <!-- </div> -->
3794 </section>
3795 </div>
3796 </div>
3797 </div>
3798 <div id="operation--videos--id--views-post" class="operation panel" data-traverse-target="operation--videos--id--views-post">
3799 <!-- <section class="operation-tags row"> -->
3800 <!-- <div class="doc-copy"> -->
3801 <div class="operation-tags">
3802 <a class="label" href="#tag-Video">Video</a>
3803 <!---->
3804 </div>
3805 <!-- </div> -->
3806 <!-- </section> -->
3807 <h2 class="operation-title">
3808 <span class="operation-name">
3809 <span class="operation-name">POST</span>
3810 <span class="operation-path">/videos/{id}/views</span>
3811 </span>
3812 </h2>
3813 <div class="doc-row">
3814 <div class="doc-copy">
3815 <section class="swagger-request-params">
3816 <div class="prop-row prop-group">
3817 <div class="prop-name">
3818 <div class="prop-title">id</div>
3819 <span class="json-property-required"></span>
3820 <div class="prop-subtitle"> in path </div>
3821 <div class="prop-subtitle">
3822 <span class="json-property-type">string</span>
3823 <span class="json-property-range" title="Value limits"></span>
3824 </div>
3825 </div>
3826 <div class="prop-value">
3827 <p>The video id </p>
3828 </div>
3829 </div>
3830 </section>
3831 </div>
3832 <div class="doc-examples"></div>
3833 </div>
3834 <div class="doc-row">
3835 <div class="doc-copy">
3836 <section class="swagger-responses">
3837 <div class="prop-row prop-group">
3838 <div class="prop-name">
3839 <div class="prop-title">204 No Content</div>
3840 </div>
3841 <div class="prop-value">
3842 <p>successful operation</p>
3843 </div>
3844 </div>
3845 </section>
3846 </div>
3847 <div class="doc-examples">
3848 <h5>Response Content-Types:
3849 <span>application/json</span>
3850 </h5>
3851 </div>
3852 </div>
3853 </div>
3854 <div id="operation--videos-upload-post" class="operation panel" data-traverse-target="operation--videos-upload-post">
3855 <!-- <section class="operation-tags row"> -->
3856 <!-- <div class="doc-copy"> -->
3857 <div class="operation-tags">
3858 <a class="label" href="#tag-Video">Video</a>
3859 <!---->
3860 </div>
3861 <!-- </div> -->
3862 <!-- </section> -->
3863 <h2 class="operation-title">
3864 <span class="operation-name">
3865 <span class="operation-name">POST</span>
3866 <span class="operation-path">/videos/upload</span>
3867 </span>
3868 </h2>
3869 <div class="doc-row">
3870 <div class="doc-copy">
3871 <section class="swagger-request-params">
3872 <div class="prop-row prop-group">
3873 <div class="prop-name">
3874 <div class="prop-title">videofile</div>
3875 <span class="json-property-required"></span>
3876 <div class="prop-subtitle"> in formData </div>
3877 <div class="prop-subtitle">
3878 <span class="json-property-type">file</span>
3879 <span class="json-property-range" title="Value limits"></span>
3880 </div>
3881 </div>
3882 <div class="prop-value">
3883 <p>Video file</p>
3884 </div>
3885 </div>
3886 <div class="prop-row prop-group">
3887 <div class="prop-name">
3888 <div class="prop-title">thumbnailfile</div>
3889 <span class="json-property-required"></span>
3890 <div class="prop-subtitle"> in formData </div>
3891 <div class="prop-subtitle">
3892 <span class="json-property-type">file</span>
3893 <span class="json-property-range" title="Value limits"></span>
3894 </div>
3895 </div>
3896 <div class="prop-value">
3897 <p>Video thumbnail file</p>
3898 </div>
3899 </div>
3900 <div class="prop-row prop-group">
3901 <div class="prop-name">
3902 <div class="prop-title">previewfile</div>
3903 <span class="json-property-required"></span>
3904 <div class="prop-subtitle"> in formData </div>
3905 <div class="prop-subtitle">
3906 <span class="json-property-type">file</span>
3907 <span class="json-property-range" title="Value limits"></span>
3908 </div>
3909 </div>
3910 <div class="prop-value">
3911 <p>Video preview file</p>
3912 </div>
3913 </div>
3914 <div class="prop-row prop-group">
3915 <div class="prop-name">
3916 <div class="prop-title">category</div>
3917 <div class="prop-subtitle"> in formData </div>
3918 <div class="prop-subtitle">
3919 <span class="json-property-type">number</span>
3920 <span class="json-property-range" title="Value limits"></span>
3921 </div>
3922 </div>
3923 <div class="prop-value">
3924 <p>Video category</p>
3925 </div>
3926 </div>
3927 <div class="prop-row prop-group">
3928 <div class="prop-name">
3929 <div class="prop-title">licence</div>
3930 <div class="prop-subtitle"> in formData </div>
3931 <div class="prop-subtitle">
3932 <span class="json-property-type">number</span>
3933 <span class="json-property-range" title="Value limits"></span>
3934 </div>
3935 </div>
3936 <div class="prop-value">
3937 <p>Video licence</p>
3938 </div>
3939 </div>
3940 <div class="prop-row prop-group">
3941 <div class="prop-name">
3942 <div class="prop-title">language</div>
3943 <div class="prop-subtitle"> in formData </div>
3944 <div class="prop-subtitle">
3945 <span class="json-property-type">number</span>
3946 <span class="json-property-range" title="Value limits"></span>
3947 </div>
3948 </div>
3949 <div class="prop-value">
3950 <p>Video language</p>
3951 </div>
3952 </div>
3953 <div class="prop-row prop-group">
3954 <div class="prop-name">
3955 <div class="prop-title">description</div>
3956 <div class="prop-subtitle"> in formData </div>
3957 <div class="prop-subtitle">
3958 <span class="json-property-type">string</span>
3959 <span class="json-property-range" title="Value limits"></span>
3960 </div>
3961 </div>
3962 <div class="prop-value">
3963 <p>Video description</p>
3964 </div>
3965 </div>
3966 <div class="prop-row prop-group">
3967 <div class="prop-name">
3968 <div class="prop-title">support</div>
3969 <div class="prop-subtitle"> in formData </div>
3970 <div class="prop-subtitle">
3971 <span class="json-property-type">string</span>
3972 <span class="json-property-range" title="Value limits"></span>
3973 </div>
3974 </div>
3975 <div class="prop-value">
3976 <p>Text describing how to support the video uploader</p>
3977 </div>
3978 </div>
3979 <div class="prop-row prop-group">
3980 <div class="prop-name">
3981 <div class="prop-title">channelId</div>
3982 <span class="json-property-required"></span>
3983 <div class="prop-subtitle"> in formData </div>
3984 <div class="prop-subtitle">
3985 <span class="json-property-type">number</span>
3986 <span class="json-property-range" title="Value limits"></span>
3987 </div>
3988 </div>
3989 <div class="prop-value">
3990 <p>Channel id that will contain this video</p>
3991 </div>
3992 </div>
3993 <div class="prop-row prop-group">
3994 <div class="prop-name">
3995 <div class="prop-title">nsfw</div>
3996 <span class="json-property-required"></span>
3997 <div class="prop-subtitle"> in formData </div>
3998 <div class="prop-subtitle">
3999 <span class="json-property-type">boolean</span>
4000 <span class="json-property-range" title="Value limits"></span>
4001 </div>
4002 </div>
4003 <div class="prop-value">
4004 <p>Whether or not this video contains sensitive content</p>
4005 </div>
4006 </div>
4007 <div class="prop-row prop-group">
4008 <div class="prop-name">
4009 <div class="prop-title">name</div>
4010 <span class="json-property-required"></span>
4011 <div class="prop-subtitle"> in formData </div>
4012 <div class="prop-subtitle">
4013 <span class="json-property-type">string</span>
4014 <span class="json-property-range" title="Value limits"></span>
4015 </div>
4016 </div>
4017 <div class="prop-value">
4018 <p>Video name</p>
4019 </div>
4020 </div>
4021 <div class="prop-row prop-group">
4022 <div class="prop-name">
4023 <div class="prop-title">tags</div>
4024 <div class="prop-subtitle"> in formData </div>
4025 <div class="prop-subtitle">
4026 <span class="json-property-type">string[]</span>
4027 <span class="json-property-range" title="Value limits"></span>
4028 </div>
4029 </div>
4030 <div class="prop-value">
4031 <p>Video tags</p>
4032 </div>
4033 </div>
4034 <div class="prop-row prop-group">
4035 <div class="prop-name">
4036 <div class="prop-title">commentsEnabled</div>
4037 <div class="prop-subtitle"> in formData </div>
4038 <div class="prop-subtitle">
4039 <span class="json-property-type">boolean</span>
4040 <span class="json-property-range" title="Value limits"></span>
4041 </div>
4042 </div>
4043 <div class="prop-value">
4044 <p>Enable or disable comments for this video</p>
4045 </div>
4046 </div>
4047 <div class="prop-row prop-group">
4048 <div class="prop-name">
4049 <div class="prop-title">privacy</div>
4050 <span class="json-property-required"></span>
4051 <div class="prop-subtitle"> in formData </div>
4052 <div class="prop-subtitle">
4053 <span class="json-property-type">string</span>
4054 <span class="json-property-enum" title="Possible values">
4055 <span class="json-property-enum-item">Public</span>,
4056 <span class="json-property-enum-item">Unlisted</span>,
4057 <span class="json-property-enum-item">Private</span>
4058 </span>
4059 <span class="json-property-range" title="Value limits"></span>
4060 </div>
4061 </div>
4062 <div class="prop-value">
4063 <p>Video privacy</p>
4064 </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/VideoUploadResponse">VideoUploadResponse</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">&quot;video&quot;</span>: {
4099 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4100 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4101 }
4102 }
4103 </code></pre>
4104 <!-- </div> -->
4105 </section>
4106 </div>
4107 </div>
4108 <div class="doc-row">
4109 <div class="doc-copy">
4110 <section class="swagger-request-security">
4111 <table class="table">
4112 <thead>
4113 <tr>
4114 <th class="swagger-request-security-schema"></th>
4115 <th class="swagger-request-security-scopes"></th>
4116 </tr>
4117 </thead>
4118 <tbody>
4119 <tr>
4120 <td>
4121 <a href="#security-definition-OAuth2">OAuth2</a>
4122 </td>
4123 <td> </td>
4124 </tr>
4125 </tbody>
4126 </table>
4127 </section>
4128 </div>
4129 </div>
4130 </div>
4131 <h1 id="tag-VideoAbuse" class="swagger-summary-tag" data-traverse-target="tag-VideoAbuse">VideoAbuse</h1>
4132 <div id="operation--videos-abuse-get" class="operation panel" data-traverse-target="operation--videos-abuse-get">
4133 <!-- <section class="operation-tags row"> -->
4134 <!-- <div class="doc-copy"> -->
4135 <div class="operation-tags">
4136 <a class="label" href="#tag-VideoAbuse">VideoAbuse</a>
4137 <!---->
4138 </div>
4139 <!-- </div> -->
4140 <!-- </section> -->
4141 <h2 class="operation-title">
4142 <span class="operation-name">
4143 <span class="operation-name">GET</span>
4144 <span class="operation-path">/videos/abuse</span>
4145 </span>
4146 </h2>
4147 <div class="doc-row">
4148 <div class="doc-copy">
4149 <section class="swagger-request-params">
4150 <div class="prop-row prop-group">
4151 <div class="prop-name">
4152 <div class="prop-title">start</div>
4153 <div class="prop-subtitle"> in query </div>
4154 <div class="prop-subtitle">
4155 <span class="json-property-type">number</span>
4156 <span class="json-property-range" title="Value limits"></span>
4157 </div>
4158 </div>
4159 <div class="prop-value">
4160 <p>starting page</p>
4161 </div>
4162 </div>
4163 <div class="prop-row prop-group">
4164 <div class="prop-name">
4165 <div class="prop-title">stop</div>
4166 <div class="prop-subtitle"> in query </div>
4167 <div class="prop-subtitle">
4168 <span class="json-property-type">number</span>
4169 <span class="json-property-range" title="Value limits"></span>
4170 </div>
4171 </div>
4172 <div class="prop-value">
4173 <p>stopping page</p>
4174 </div>
4175 </div>
4176 <div class="prop-row prop-group">
4177 <div class="prop-name">
4178 <div class="prop-title">sort</div>
4179 <div class="prop-subtitle"> in query </div>
4180 <div class="prop-subtitle">
4181 <span class="json-property-type">number</span>
4182 <span class="json-property-range" title="Value limits"></span>
4183 </div>
4184 </div>
4185 <div class="prop-value">
4186 <p>sorting</p>
4187 </div>
4188 </div>
4189 </section>
4190 </div>
4191 <div class="doc-examples"></div>
4192 </div>
4193 <div class="doc-row">
4194 <div class="doc-copy">
4195 <section class="swagger-responses">
4196 <div class="prop-row prop-group">
4197 <div class="prop-name">
4198 <div class="prop-title">200 OK</div>
4199 <div class="prop-ref">
4200 <span class="json-schema-ref-array">
4201 <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a>
4202 </span>
4203 </div>
4204 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4205 </div>
4206 <div class="prop-value">
4207 <p>successful operation</p>
4208 </div>
4209 </div>
4210 <div class="prop-row prop-inner">
4211 <div class="prop-name">type</div>
4212 <div class="prop-value">
4213 <span class="json-property-type">
4214 <span class="json-schema-ref-array">
4215 <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a>
4216 </span>
4217 </span>
4218 <span class="json-property-range" title="Value limits"></span>
4219 </div>
4220 </div>
4221 </section>
4222 </div>
4223 <div class="doc-examples">
4224 <h5>Response Content-Types:
4225 <span>application/json</span>
4226 </h5>
4227 <section>
4228 <h5>Response Example
4229 <span>(200 OK)</span>
4230 </h5>
4231 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
4232 {
4233 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4234 <span class="hljs-attr">&quot;reason&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4235 <span class="hljs-attr">&quot;reporterAccount&quot;</span>: {
4236 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4237 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4238 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4239 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4240 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4241 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4242 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4243 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4244 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4245 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4246 <span class="hljs-attr">&quot;avatar&quot;</span>: {
4247 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4248 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4249 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4250 }
4251 },
4252 <span class="hljs-attr">&quot;video&quot;</span>: {
4253 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4254 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4255 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4256 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4257 },
4258 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4259 }
4260 ]
4261 </code></pre>
4262 <!-- </div> -->
4263 </section>
4264 </div>
4265 </div>
4266 <div class="doc-row">
4267 <div class="doc-copy">
4268 <section class="swagger-request-security">
4269 <table class="table">
4270 <thead>
4271 <tr>
4272 <th class="swagger-request-security-schema"></th>
4273 <th class="swagger-request-security-scopes"></th>
4274 </tr>
4275 </thead>
4276 <tbody>
4277 <tr>
4278 <td>
4279 <a href="#security-definition-OAuth2">OAuth2</a>
4280 </td>
4281 <td> </td>
4282 </tr>
4283 </tbody>
4284 </table>
4285 </section>
4286 </div>
4287 </div>
4288 </div>
4289 <div id="operation--videos--id--abuse-post" class="operation panel" data-traverse-target="operation--videos--id--abuse-post">
4290 <!-- <section class="operation-tags row"> -->
4291 <!-- <div class="doc-copy"> -->
4292 <div class="operation-tags">
4293 <a class="label" href="#tag-VideoAbuse">VideoAbuse</a>
4294 <!---->
4295 </div>
4296 <!-- </div> -->
4297 <!-- </section> -->
4298 <h2 class="operation-title">
4299 <span class="operation-name">
4300 <span class="operation-name">POST</span>
4301 <span class="operation-path">/videos/{id}/abuse</span>
4302 </span>
4303 </h2>
4304 <div class="doc-row">
4305 <div class="doc-copy">
4306 <section class="swagger-request-params">
4307 <div class="prop-row prop-group">
4308 <div class="prop-name">
4309 <div class="prop-title">id</div>
4310 <span class="json-property-required"></span>
4311 <div class="prop-subtitle"> in path </div>
4312 <div class="prop-subtitle">
4313 <span class="json-property-type">string</span>
4314 <span class="json-property-range" title="Value limits"></span>
4315 </div>
4316 </div>
4317 <div class="prop-value">
4318 <p>The video id </p>
4319 </div>
4320 </div>
4321 </section>
4322 </div>
4323 <div class="doc-examples"></div>
4324 </div>
4325 <div class="doc-row">
4326 <div class="doc-copy">
4327 <section class="swagger-responses">
4328 <div class="prop-row prop-group">
4329 <div class="prop-name">
4330 <div class="prop-title">204 No Content</div>
4331 </div>
4332 <div class="prop-value">
4333 <p>successful operation</p>
4334 </div>
4335 </div>
4336 </section>
4337 </div>
4338 <div class="doc-examples">
4339 <h5>Response Content-Types:
4340 <span>application/json</span>
4341 </h5>
4342 </div>
4343 </div>
4344 <div class="doc-row">
4345 <div class="doc-copy">
4346 <section class="swagger-request-security">
4347 <table class="table">
4348 <thead>
4349 <tr>
4350 <th class="swagger-request-security-schema"></th>
4351 <th class="swagger-request-security-scopes"></th>
4352 </tr>
4353 </thead>
4354 <tbody>
4355 <tr>
4356 <td>
4357 <a href="#security-definition-OAuth2">OAuth2</a>
4358 </td>
4359 <td> </td>
4360 </tr>
4361 </tbody>
4362 </table>
4363 </section>
4364 </div>
4365 </div>
4366 </div>
4367 <h1 id="tag-VideoBlacklist" class="swagger-summary-tag" data-traverse-target="tag-VideoBlacklist">VideoBlacklist</h1>
4368 <div id="operation--videos--videoId--blacklist-post" class="operation panel" data-traverse-target="operation--videos--videoId--blacklist-post">
4369 <!-- <section class="operation-tags row"> -->
4370 <!-- <div class="doc-copy"> -->
4371 <div class="operation-tags">
4372 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
4373 <!---->
4374 </div>
4375 <!-- </div> -->
4376 <!-- </section> -->
4377 <h2 class="operation-title">
4378 <span class="operation-name">
4379 <span class="operation-name">POST</span>
4380 <span class="operation-path">/videos/{videoId}/blacklist</span>
4381 </span>
4382 </h2>
4383 <div class="doc-row">
4384 <div class="doc-copy">
4385 <section class="swagger-request-params">
4386 <div class="prop-row prop-group">
4387 <div class="prop-name">
4388 <div class="prop-title">videoId</div>
4389 <span class="json-property-required"></span>
4390 <div class="prop-subtitle"> in path </div>
4391 <div class="prop-subtitle">
4392 <span class="json-property-type">string</span>
4393 <span class="json-property-range" title="Value limits"></span>
4394 </div>
4395 </div>
4396 <div class="prop-value">
4397 <p>The video id </p>
4398 </div>
4399 </div>
4400 </section>
4401 </div>
4402 <div class="doc-examples"></div>
4403 </div>
4404 <div class="doc-row">
4405 <div class="doc-copy">
4406 <section class="swagger-responses">
4407 <div class="prop-row prop-group">
4408 <div class="prop-name">
4409 <div class="prop-title">204 No Content</div>
4410 </div>
4411 <div class="prop-value">
4412 <p>successful operation</p>
4413 </div>
4414 </div>
4415 </section>
4416 </div>
4417 <div class="doc-examples">
4418 <h5>Response Content-Types:
4419 <span>application/json</span>
4420 </h5>
4421 </div>
4422 </div>
4423 <div class="doc-row">
4424 <div class="doc-copy">
4425 <section class="swagger-request-security">
4426 <table class="table">
4427 <thead>
4428 <tr>
4429 <th class="swagger-request-security-schema"></th>
4430 <th class="swagger-request-security-scopes"></th>
4431 </tr>
4432 </thead>
4433 <tbody>
4434 <tr>
4435 <td>
4436 <a href="#security-definition-OAuth2">OAuth2</a>
4437 </td>
4438 <td> </td>
4439 </tr>
4440 </tbody>
4441 </table>
4442 </section>
4443 </div>
4444 </div>
4445 </div>
4446 <div id="operation--videos--videoId--blacklist-delete" class="operation panel" data-traverse-target="operation--videos--videoId--blacklist-delete">
4447 <!-- <section class="operation-tags row"> -->
4448 <!-- <div class="doc-copy"> -->
4449 <div class="operation-tags">
4450 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
4451 <!---->
4452 </div>
4453 <!-- </div> -->
4454 <!-- </section> -->
4455 <h2 class="operation-title">
4456 <span class="operation-name">
4457 <span class="operation-name">DELETE</span>
4458 <span class="operation-path">/videos/{videoId}/blacklist</span>
4459 </span>
4460 </h2>
4461 <div class="doc-row">
4462 <div class="doc-copy">
4463 <section class="swagger-request-params">
4464 <div class="prop-row prop-group">
4465 <div class="prop-name">
4466 <div class="prop-title">videoId</div>
4467 <span class="json-property-required"></span>
4468 <div class="prop-subtitle"> in path </div>
4469 <div class="prop-subtitle">
4470 <span class="json-property-type">string</span>
4471 <span class="json-property-range" title="Value limits"></span>
4472 </div>
4473 </div>
4474 <div class="prop-value">
4475 <p>The video id </p>
4476 </div>
4477 </div>
4478 </section>
4479 </div>
4480 <div class="doc-examples"></div>
4481 </div>
4482 <div class="doc-row">
4483 <div class="doc-copy">
4484 <section class="swagger-responses">
4485 <div class="prop-row prop-group">
4486 <div class="prop-name">
4487 <div class="prop-title">204 No Content</div>
4488 </div>
4489 <div class="prop-value">
4490 <p>successful operation</p>
4491 </div>
4492 </div>
4493 </section>
4494 </div>
4495 <div class="doc-examples">
4496 <h5>Response Content-Types:
4497 <span>application/json</span>
4498 </h5>
4499 </div>
4500 </div>
4501 <div class="doc-row">
4502 <div class="doc-copy">
4503 <section class="swagger-request-security">
4504 <table class="table">
4505 <thead>
4506 <tr>
4507 <th class="swagger-request-security-schema"></th>
4508 <th class="swagger-request-security-scopes"></th>
4509 </tr>
4510 </thead>
4511 <tbody>
4512 <tr>
4513 <td>
4514 <a href="#security-definition-OAuth2">OAuth2</a>
4515 </td>
4516 <td> </td>
4517 </tr>
4518 </tbody>
4519 </table>
4520 </section>
4521 </div>
4522 </div>
4523 </div>
4524 <div id="operation--videos-blacklist-get" class="operation panel" data-traverse-target="operation--videos-blacklist-get">
4525 <!-- <section class="operation-tags row"> -->
4526 <!-- <div class="doc-copy"> -->
4527 <div class="operation-tags">
4528 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
4529 <!---->
4530 </div>
4531 <!-- </div> -->
4532 <!-- </section> -->
4533 <h2 class="operation-title">
4534 <span class="operation-name">
4535 <span class="operation-name">GET</span>
4536 <span class="operation-path">/videos/blacklist</span>
4537 </span>
4538 </h2>
4539 <div class="doc-row">
4540 <div class="doc-copy">
4541 <section class="swagger-request-params">
4542 <div class="prop-row prop-group">
4543 <div class="prop-name">
4544 <div class="prop-title">start</div>
4545 <div class="prop-subtitle"> in query </div>
4546 <div class="prop-subtitle">
4547 <span class="json-property-type">number</span>
4548 <span class="json-property-range" title="Value limits"></span>
4549 </div>
4550 </div>
4551 <div class="prop-value">
4552 <p>starting page</p>
4553 </div>
4554 </div>
4555 <div class="prop-row prop-group">
4556 <div class="prop-name">
4557 <div class="prop-title">stop</div>
4558 <div class="prop-subtitle"> in query </div>
4559 <div class="prop-subtitle">
4560 <span class="json-property-type">number</span>
4561 <span class="json-property-range" title="Value limits"></span>
4562 </div>
4563 </div>
4564 <div class="prop-value">
4565 <p>stopping page</p>
4566 </div>
4567 </div>
4568 <div class="prop-row prop-group">
4569 <div class="prop-name">
4570 <div class="prop-title">sort</div>
4571 <div class="prop-subtitle"> in query </div>
4572 <div class="prop-subtitle">
4573 <span class="json-property-type">number</span>
4574 <span class="json-property-range" title="Value limits"></span>
4575 </div>
4576 </div>
4577 <div class="prop-value">
4578 <p>sorting</p>
4579 </div>
4580 </div>
4581 </section>
4582 </div>
4583 <div class="doc-examples"></div>
4584 </div>
4585 <div class="doc-row">
4586 <div class="doc-copy">
4587 <section class="swagger-responses">
4588 <div class="prop-row prop-group">
4589 <div class="prop-name">
4590 <div class="prop-title">200 OK</div>
4591 <div class="prop-ref">
4592 <span class="json-schema-ref-array">
4593 <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a>
4594 </span>
4595 </div>
4596 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4597 </div>
4598 <div class="prop-value">
4599 <p>successful operation</p>
4600 </div>
4601 </div>
4602 <div class="prop-row prop-inner">
4603 <div class="prop-name">type</div>
4604 <div class="prop-value">
4605 <span class="json-property-type">
4606 <span class="json-schema-ref-array">
4607 <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a>
4608 </span>
4609 </span>
4610 <span class="json-property-range" title="Value limits"></span>
4611 </div>
4612 </div>
4613 </section>
4614 </div>
4615 <div class="doc-examples">
4616 <h5>Response Content-Types:
4617 <span>application/json</span>
4618 </h5>
4619 <section>
4620 <h5>Response Example
4621 <span>(200 OK)</span>
4622 </h5>
4623 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
4624 {
4625 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4626 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4627 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4628 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4629 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4630 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4631 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4632 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4633 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4634 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4635 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4636 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>
4637 }
4638 ]
4639 </code></pre>
4640 <!-- </div> -->
4641 </section>
4642 </div>
4643 </div>
4644 <div class="doc-row">
4645 <div class="doc-copy">
4646 <section class="swagger-request-security">
4647 <table class="table">
4648 <thead>
4649 <tr>
4650 <th class="swagger-request-security-schema"></th>
4651 <th class="swagger-request-security-scopes"></th>
4652 </tr>
4653 </thead>
4654 <tbody>
4655 <tr>
4656 <td>
4657 <a href="#security-definition-OAuth2">OAuth2</a>
4658 </td>
4659 <td> </td>
4660 </tr>
4661 </tbody>
4662 </table>
4663 </section>
4664 </div>
4665 </div>
4666 </div>
4667 <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1>
4668 <div id="operation--videos-channels-get" class="operation panel" data-traverse-target="operation--videos-channels-get">
4669 <!-- <section class="operation-tags row"> -->
4670 <!-- <div class="doc-copy"> -->
4671 <div class="operation-tags">
4672 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
4673 <!---->
4674 </div>
4675 <!-- </div> -->
4676 <!-- </section> -->
4677 <h2 class="operation-title">
4678 <span class="operation-name">
4679 <span class="operation-name">GET</span>
4680 <span class="operation-path">/videos/channels</span>
4681 </span>
4682 </h2>
4683 <div class="doc-row">
4684 <div class="doc-copy">
4685 <section class="swagger-request-params">
4686 <div class="prop-row prop-group">
4687 <div class="prop-name">
4688 <div class="prop-title">start</div>
4689 <div class="prop-subtitle"> in query </div>
4690 <div class="prop-subtitle">
4691 <span class="json-property-type">number</span>
4692 <span class="json-property-range" title="Value limits"></span>
4693 </div>
4694 </div>
4695 <div class="prop-value">
4696 <p>starting page</p>
4697 </div>
4698 </div>
4699 <div class="prop-row prop-group">
4700 <div class="prop-name">
4701 <div class="prop-title">stop</div>
4702 <div class="prop-subtitle"> in query </div>
4703 <div class="prop-subtitle">
4704 <span class="json-property-type">number</span>
4705 <span class="json-property-range" title="Value limits"></span>
4706 </div>
4707 </div>
4708 <div class="prop-value">
4709 <p>stopping page</p>
4710 </div>
4711 </div>
4712 <div class="prop-row prop-group">
4713 <div class="prop-name">
4714 <div class="prop-title">sort</div>
4715 <div class="prop-subtitle"> in query </div>
4716 <div class="prop-subtitle">
4717 <span class="json-property-type">number</span>
4718 <span class="json-property-range" title="Value limits"></span>
4719 </div>
4720 </div>
4721 <div class="prop-value">
4722 <p>sorting</p>
4723 </div>
4724 </div>
4725 </section>
4726 </div>
4727 <div class="doc-examples"></div>
4728 </div>
4729 <div class="doc-row">
4730 <div class="doc-copy">
4731 <section class="swagger-responses">
4732 <div class="prop-row prop-group">
4733 <div class="prop-name">
4734 <div class="prop-title">200 OK</div>
4735 <div class="prop-ref">
4736 <span class="json-schema-ref-array">
4737 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
4738 </span>
4739 </div>
4740 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4741 </div>
4742 <div class="prop-value">
4743 <p>successful operation</p>
4744 </div>
4745 </div>
4746 <div class="prop-row prop-inner">
4747 <div class="prop-name">type</div>
4748 <div class="prop-value">
4749 <span class="json-property-type">
4750 <span class="json-schema-ref-array">
4751 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
4752 </span>
4753 </span>
4754 <span class="json-property-range" title="Value limits"></span>
4755 </div>
4756 </div>
4757 </section>
4758 </div>
4759 <div class="doc-examples">
4760 <h5>Response Content-Types:
4761 <span>application/json</span>
4762 </h5>
4763 <section>
4764 <h5>Response Example
4765 <span>(200 OK)</span>
4766 </h5>
4767 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
4768 {
4769 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4770 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4771 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
4772 <span class="hljs-attr">&quot;owner&quot;</span>: {
4773 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4774 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4775 },
4776 <span class="hljs-attr">&quot;videos&quot;</span>: [
4777 {
4778 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4779 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4780 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4781 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4782 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4783 <span class="hljs-attr">&quot;category&quot;</span>: {
4784 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4785 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4786 },
4787 <span class="hljs-attr">&quot;licence&quot;</span>: {
4788 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4789 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4790 },
4791 <span class="hljs-attr">&quot;language&quot;</span>: {
4792 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4793 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4794 },
4795 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4796 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4797 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4798 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
4799 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4800 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4801 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4802 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4803 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4804 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4805 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4806 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
4807 <span class="hljs-attr">&quot;account&quot;</span>: {
4808 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4809 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4810 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4811 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4812 <span class="hljs-attr">&quot;avatar&quot;</span>: {
4813 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4814 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4815 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4816 }
4817 }
4818 }
4819 ]
4820 }
4821 ]
4822 </code></pre>
4823 <!-- </div> -->
4824 </section>
4825 </div>
4826 </div>
4827 </div>
4828 <div id="operation--videos-channels-post" class="operation panel" data-traverse-target="operation--videos-channels-post">
4829 <!-- <section class="operation-tags row"> -->
4830 <!-- <div class="doc-copy"> -->
4831 <div class="operation-tags">
4832 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
4833 <!---->
4834 </div>
4835 <!-- </div> -->
4836 <!-- </section> -->
4837 <h2 class="operation-title">
4838 <span class="operation-name">
4839 <span class="operation-name">POST</span>
4840 <span class="operation-path">/videos/channels</span>
4841 </span>
4842 </h2>
4843 <div class="doc-row">
4844 <div class="doc-copy">
4845 <section class="swagger-request-body">
4846 <div class="prop-row">
4847 <div class="prop-name">
4848 <div class="swagger-request-model">
4849 <span class="">
4850 <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a>
4851 </span>
4852 </div>
4853 </div>
4854 <div class="prop-value columns small-6">
4855 <!-- <div class="swagger-request-description"> -->
4856 <p>undefined</p>
4857 <!-- </div> -->
4858 </div>
4859 </div>
4860 </section>
4861 </div>
4862 <div class="doc-examples">
4863 <section>
4864 <h5>Request Content-Types:
4865 <span>application/json</span>
4866 </h5>
4867 <h5>Request Example</h5>
4868 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
4869 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4870 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4871 }
4872 </code></pre>
4873 <!-- </div> -->
4874 </section>
4875 </div>
4876 </div>
4877 <div class="doc-row">
4878 <div class="doc-copy">
4879 <section class="swagger-responses">
4880 <div class="prop-row prop-group">
4881 <div class="prop-name">
4882 <div class="prop-title">204 No Content</div>
4883 </div>
4884 <div class="prop-value">
4885 <p>successful operation</p>
4886 </div>
4887 </div>
4888 </section>
4889 </div>
4890 <div class="doc-examples">
4891 <h5>Response Content-Types:
4892 <span>application/json</span>
4893 </h5>
4894 </div>
4895 </div>
4896 <div class="doc-row">
4897 <div class="doc-copy">
4898 <section class="swagger-request-security">
4899 <table class="table">
4900 <thead>
4901 <tr>
4902 <th class="swagger-request-security-schema"></th>
4903 <th class="swagger-request-security-scopes"></th>
4904 </tr>
4905 </thead>
4906 <tbody>
4907 <tr>
4908 <td>
4909 <a href="#security-definition-OAuth2">OAuth2</a>
4910 </td>
4911 <td> </td>
4912 </tr>
4913 </tbody>
4914 </table>
4915 </section>
4916 </div>
4917 </div>
4918 </div>
4919 <div id="operation--videos-channels--id--get" class="operation panel" data-traverse-target="operation--videos-channels--id--get">
4920 <!-- <section class="operation-tags row"> -->
4921 <!-- <div class="doc-copy"> -->
4922 <div class="operation-tags">
4923 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
4924 <!---->
4925 </div>
4926 <!-- </div> -->
4927 <!-- </section> -->
4928 <h2 class="operation-title">
4929 <span class="operation-name">
4930 <span class="operation-name">GET</span>
4931 <span class="operation-path">/videos/channels/{id}</span>
4932 </span>
4933 </h2>
4934 <div class="doc-row">
4935 <div class="doc-copy">
4936 <section class="swagger-request-params">
4937 <div class="prop-row prop-group">
4938 <div class="prop-name">
4939 <div class="prop-title">id</div>
4940 <span class="json-property-required"></span>
4941 <div class="prop-subtitle"> in path </div>
4942 <div class="prop-subtitle">
4943 <span class="json-property-type">string</span>
4944 <span class="json-property-range" title="Value limits"></span>
4945 </div>
4946 </div>
4947 <div class="prop-value">
4948 <p>The video id </p>
4949 </div>
4950 </div>
4951 </section>
4952 </div>
4953 <div class="doc-examples"></div>
4954 </div>
4955 <div class="doc-row">
4956 <div class="doc-copy">
4957 <section class="swagger-responses">
4958 <div class="prop-row prop-group">
4959 <div class="prop-name">
4960 <div class="prop-title">200 OK</div>
4961 <div class="prop-ref">
4962 <span class="">
4963 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
4964 </span>
4965 </div>
4966 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4967 </div>
4968 <div class="prop-value">
4969 <p>successful operation</p>
4970 </div>
4971 </div>
4972 </section>
4973 </div>
4974 <div class="doc-examples">
4975 <h5>Response Content-Types:
4976 <span>application/json</span>
4977 </h5>
4978 <section>
4979 <h5>Response Example
4980 <span>(200 OK)</span>
4981 </h5>
4982 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
4983 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4984 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4985 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
4986 <span class="hljs-attr">&quot;owner&quot;</span>: {
4987 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4988 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4989 },
4990 <span class="hljs-attr">&quot;videos&quot;</span>: [
4991 {
4992 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4993 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4994 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4995 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4996 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4997 <span class="hljs-attr">&quot;category&quot;</span>: {
4998 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4999 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5000 },
5001 <span class="hljs-attr">&quot;licence&quot;</span>: {
5002 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5003 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5004 },
5005 <span class="hljs-attr">&quot;language&quot;</span>: {
5006 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5007 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5008 },
5009 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5010 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5011 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5012 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5013 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5014 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5015 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5016 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5017 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5018 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5019 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5020 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5021 <span class="hljs-attr">&quot;account&quot;</span>: {
5022 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5023 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5024 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5025 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5026 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5027 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5028 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5029 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5030 }
5031 }
5032 }
5033 ]
5034 }
5035 </code></pre>
5036 <!-- </div> -->
5037 </section>
5038 </div>
5039 </div>
5040 </div>
5041 <div id="operation--videos-channels--id--put" class="operation panel" data-traverse-target="operation--videos-channels--id--put">
5042 <!-- <section class="operation-tags row"> -->
5043 <!-- <div class="doc-copy"> -->
5044 <div class="operation-tags">
5045 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5046 <!---->
5047 </div>
5048 <!-- </div> -->
5049 <!-- </section> -->
5050 <h2 class="operation-title">
5051 <span class="operation-name">
5052 <span class="operation-name">PUT</span>
5053 <span class="operation-path">/videos/channels/{id}</span>
5054 </span>
5055 </h2>
5056 <div class="doc-row">
5057 <div class="doc-copy">
5058 <section class="swagger-request-body">
5059 <div class="prop-row">
5060 <div class="prop-name">
5061 <div class="swagger-request-model">
5062 <span class="">
5063 <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a>
5064 </span>
5065 </div>
5066 </div>
5067 <div class="prop-value columns small-6">
5068 <!-- <div class="swagger-request-description"> -->
5069 <p>undefined</p>
5070 <!-- </div> -->
5071 </div>
5072 </div>
5073 </section>
5074 <section class="swagger-request-params">
5075 <div class="prop-row prop-group">
5076 <div class="prop-name">
5077 <div class="prop-title">id</div>
5078 <span class="json-property-required"></span>
5079 <div class="prop-subtitle"> in path </div>
5080 <div class="prop-subtitle">
5081 <span class="json-property-type">string</span>
5082 <span class="json-property-range" title="Value limits"></span>
5083 </div>
5084 </div>
5085 <div class="prop-value">
5086 <p>The video id </p>
5087 </div>
5088 </div>
5089 </section>
5090 </div>
5091 <div class="doc-examples">
5092 <section>
5093 <h5>Request Content-Types:
5094 <span>application/json</span>
5095 </h5>
5096 <h5>Request Example</h5>
5097 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5098 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5099 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5100 }
5101 </code></pre>
5102 <!-- </div> -->
5103 </section>
5104 </div>
5105 </div>
5106 <div class="doc-row">
5107 <div class="doc-copy">
5108 <section class="swagger-responses">
5109 <div class="prop-row prop-group">
5110 <div class="prop-name">
5111 <div class="prop-title">204 No Content</div>
5112 </div>
5113 <div class="prop-value">
5114 <p>successful operation</p>
5115 </div>
5116 </div>
5117 </section>
5118 </div>
5119 <div class="doc-examples">
5120 <h5>Response Content-Types:
5121 <span>application/json</span>
5122 </h5>
5123 </div>
5124 </div>
5125 <div class="doc-row">
5126 <div class="doc-copy">
5127 <section class="swagger-request-security">
5128 <table class="table">
5129 <thead>
5130 <tr>
5131 <th class="swagger-request-security-schema"></th>
5132 <th class="swagger-request-security-scopes"></th>
5133 </tr>
5134 </thead>
5135 <tbody>
5136 <tr>
5137 <td>
5138 <a href="#security-definition-OAuth2">OAuth2</a>
5139 </td>
5140 <td> </td>
5141 </tr>
5142 </tbody>
5143 </table>
5144 </section>
5145 </div>
5146 </div>
5147 </div>
5148 <div id="operation--videos-channels--id--delete" class="operation panel" data-traverse-target="operation--videos-channels--id--delete">
5149 <!-- <section class="operation-tags row"> -->
5150 <!-- <div class="doc-copy"> -->
5151 <div class="operation-tags">
5152 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5153 <!---->
5154 </div>
5155 <!-- </div> -->
5156 <!-- </section> -->
5157 <h2 class="operation-title">
5158 <span class="operation-name">
5159 <span class="operation-name">DELETE</span>
5160 <span class="operation-path">/videos/channels/{id}</span>
5161 </span>
5162 </h2>
5163 <div class="doc-row">
5164 <div class="doc-copy">
5165 <section class="swagger-request-params">
5166 <div class="prop-row prop-group">
5167 <div class="prop-name">
5168 <div class="prop-title">id</div>
5169 <span class="json-property-required"></span>
5170 <div class="prop-subtitle"> in path </div>
5171 <div class="prop-subtitle">
5172 <span class="json-property-type">string</span>
5173 <span class="json-property-range" title="Value limits"></span>
5174 </div>
5175 </div>
5176 <div class="prop-value">
5177 <p>The video id </p>
5178 </div>
5179 </div>
5180 </section>
5181 </div>
5182 <div class="doc-examples"></div>
5183 </div>
5184 <div class="doc-row">
5185 <div class="doc-copy">
5186 <section class="swagger-responses">
5187 <div class="prop-row prop-group">
5188 <div class="prop-name">
5189 <div class="prop-title">204 No Content</div>
5190 </div>
5191 <div class="prop-value">
5192 <p>successful operation</p>
5193 </div>
5194 </div>
5195 </section>
5196 </div>
5197 <div class="doc-examples">
5198 <h5>Response Content-Types:
5199 <span>application/json</span>
5200 </h5>
5201 </div>
5202 </div>
5203 <div class="doc-row">
5204 <div class="doc-copy">
5205 <section class="swagger-request-security">
5206 <table class="table">
5207 <thead>
5208 <tr>
5209 <th class="swagger-request-security-schema"></th>
5210 <th class="swagger-request-security-scopes"></th>
5211 </tr>
5212 </thead>
5213 <tbody>
5214 <tr>
5215 <td>
5216 <a href="#security-definition-OAuth2">OAuth2</a>
5217 </td>
5218 <td> </td>
5219 </tr>
5220 </tbody>
5221 </table>
5222 </section>
5223 </div>
5224 </div>
5225 </div>
5226 <div id="operation--videos-accounts--accountId--channels-get" class="operation panel" data-traverse-target="operation--videos-accounts--accountId--channels-get">
5227 <!-- <section class="operation-tags row"> -->
5228 <!-- <div class="doc-copy"> -->
5229 <div class="operation-tags">
5230 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5231 <!---->
5232 </div>
5233 <!-- </div> -->
5234 <!-- </section> -->
5235 <h2 class="operation-title">
5236 <span class="operation-name">
5237 <span class="operation-name">GET</span>
5238 <span class="operation-path">/videos/accounts/{accountId}/channels</span>
5239 </span>
5240 </h2>
5241 <div class="doc-row">
5242 <div class="doc-copy">
5243 <section class="swagger-request-params">
5244 <div class="prop-row prop-group">
5245 <div class="prop-name">
5246 <div class="prop-title">accountId</div>
5247 <span class="json-property-required"></span>
5248 <div class="prop-subtitle"> in path </div>
5249 <div class="prop-subtitle">
5250 <span class="json-property-type">string</span>
5251 <span class="json-property-range" title="Value limits"></span>
5252 </div>
5253 </div>
5254 <div class="prop-value">
5255 <p>The account id </p>
5256 </div>
5257 </div>
5258 </section>
5259 </div>
5260 <div class="doc-examples"></div>
5261 </div>
5262 <div class="doc-row">
5263 <div class="doc-copy">
5264 <section class="swagger-responses">
5265 <div class="prop-row prop-group">
5266 <div class="prop-name">
5267 <div class="prop-title">200 OK</div>
5268 <div class="prop-ref">
5269 <span class="json-schema-ref-array">
5270 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
5271 </span>
5272 </div>
5273 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5274 </div>
5275 <div class="prop-value">
5276 <p>successful operation</p>
5277 </div>
5278 </div>
5279 <div class="prop-row prop-inner">
5280 <div class="prop-name">type</div>
5281 <div class="prop-value">
5282 <span class="json-property-type">
5283 <span class="json-schema-ref-array">
5284 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
5285 </span>
5286 </span>
5287 <span class="json-property-range" title="Value limits"></span>
5288 </div>
5289 </div>
5290 </section>
5291 </div>
5292 <div class="doc-examples">
5293 <h5>Response Content-Types:
5294 <span>application/json</span>
5295 </h5>
5296 <section>
5297 <h5>Response Example
5298 <span>(200 OK)</span>
5299 </h5>
5300 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
5301 {
5302 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5303 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5304 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5305 <span class="hljs-attr">&quot;owner&quot;</span>: {
5306 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5307 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5308 },
5309 <span class="hljs-attr">&quot;videos&quot;</span>: [
5310 {
5311 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5312 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5313 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5314 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5315 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5316 <span class="hljs-attr">&quot;category&quot;</span>: {
5317 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5318 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5319 },
5320 <span class="hljs-attr">&quot;licence&quot;</span>: {
5321 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5322 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5323 },
5324 <span class="hljs-attr">&quot;language&quot;</span>: {
5325 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5326 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5327 },
5328 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5329 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5330 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5331 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5332 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5333 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5334 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5335 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5336 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5337 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5338 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5339 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5340 <span class="hljs-attr">&quot;account&quot;</span>: {
5341 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5342 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5343 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5344 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5345 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5346 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5347 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5348 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5349 }
5350 }
5351 }
5352 ]
5353 }
5354 ]
5355 </code></pre>
5356 <!-- </div> -->
5357 </section>
5358 </div>
5359 </div>
5360 </div>
5361 <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1>
5362 <div id="operation--videos--videoId--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-get">
5363 <!-- <section class="operation-tags row"> -->
5364 <!-- <div class="doc-copy"> -->
5365 <div class="operation-tags">
5366 <a class="label" href="#tag-VideoComment">VideoComment</a>
5367 <!---->
5368 </div>
5369 <!-- </div> -->
5370 <!-- </section> -->
5371 <h2 class="operation-title">
5372 <span class="operation-name">
5373 <span class="operation-name">GET</span>
5374 <span class="operation-path">/videos/{videoId}/comment-threads</span>
5375 </span>
5376 </h2>
5377 <div class="doc-row">
5378 <div class="doc-copy">
5379 <section class="swagger-request-params">
5380 <div class="prop-row prop-group">
5381 <div class="prop-name">
5382 <div class="prop-title">videoId</div>
5383 <span class="json-property-required"></span>
5384 <div class="prop-subtitle"> in path </div>
5385 <div class="prop-subtitle">
5386 <span class="json-property-type">string</span>
5387 <span class="json-property-range" title="Value limits"></span>
5388 </div>
5389 </div>
5390 <div class="prop-value">
5391 <p>The video id </p>
5392 </div>
5393 </div>
5394 <div class="prop-row prop-group">
5395 <div class="prop-name">
5396 <div class="prop-title">start</div>
5397 <div class="prop-subtitle"> in query </div>
5398 <div class="prop-subtitle">
5399 <span class="json-property-type">number</span>
5400 <span class="json-property-range" title="Value limits"></span>
5401 </div>
5402 </div>
5403 <div class="prop-value">
5404 <p>starting page</p>
5405 </div>
5406 </div>
5407 <div class="prop-row prop-group">
5408 <div class="prop-name">
5409 <div class="prop-title">stop</div>
5410 <div class="prop-subtitle"> in query </div>
5411 <div class="prop-subtitle">
5412 <span class="json-property-type">number</span>
5413 <span class="json-property-range" title="Value limits"></span>
5414 </div>
5415 </div>
5416 <div class="prop-value">
5417 <p>stopping page</p>
5418 </div>
5419 </div>
5420 <div class="prop-row prop-group">
5421 <div class="prop-name">
5422 <div class="prop-title">sort</div>
5423 <div class="prop-subtitle"> in query </div>
5424 <div class="prop-subtitle">
5425 <span class="json-property-type">number</span>
5426 <span class="json-property-range" title="Value limits"></span>
5427 </div>
5428 </div>
5429 <div class="prop-value">
5430 <p>sorting</p>
5431 </div>
5432 </div>
5433 </section>
5434 </div>
5435 <div class="doc-examples"></div>
5436 </div>
5437 <div class="doc-row">
5438 <div class="doc-copy">
5439 <section class="swagger-responses">
5440 <div class="prop-row prop-group">
5441 <div class="prop-name">
5442 <div class="prop-title">200 OK</div>
5443 <div class="prop-ref">
5444 <span class="">
5445 <a class="json-schema-ref" href="#/definitions/CommentThreadResponse">CommentThreadResponse</a>
5446 </span>
5447 </div>
5448 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5449 </div>
5450 <div class="prop-value">
5451 <p>successful operation</p>
5452 </div>
5453 </div>
5454 </section>
5455 </div>
5456 <div class="doc-examples">
5457 <h5>Response Content-Types:
5458 <span>application/json</span>
5459 </h5>
5460 <section>
5461 <h5>Response Example
5462 <span>(200 OK)</span>
5463 </h5>
5464 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5465 <span class="hljs-attr">&quot;total&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5466 <span class="hljs-attr">&quot;data&quot;</span>: [
5467 {
5468 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5469 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5470 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5471 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5472 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5473 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5474 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5475 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5476 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5477 <span class="hljs-attr">&quot;account&quot;</span>: {
5478 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5479 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5480 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5481 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5482 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5483 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5484 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5485 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5486 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5487 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5488 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5489 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5490 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5491 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5492 }
5493 }
5494 }
5495 ]
5496 }
5497 </code></pre>
5498 <!-- </div> -->
5499 </section>
5500 </div>
5501 </div>
5502 </div>
5503 <div id="operation--videos--videoId--comment-threads-post" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-post">
5504 <!-- <section class="operation-tags row"> -->
5505 <!-- <div class="doc-copy"> -->
5506 <div class="operation-tags">
5507 <a class="label" href="#tag-VideoComment">VideoComment</a>
5508 <!---->
5509 </div>
5510 <!-- </div> -->
5511 <!-- </section> -->
5512 <h2 class="operation-title">
5513 <span class="operation-name">
5514 <span class="operation-name">POST</span>
5515 <span class="operation-path">/videos/{videoId}/comment-threads</span>
5516 </span>
5517 </h2>
5518 <div class="doc-row">
5519 <div class="doc-copy">
5520 <section class="swagger-request-params">
5521 <div class="prop-row prop-group">
5522 <div class="prop-name">
5523 <div class="prop-title">videoId</div>
5524 <span class="json-property-required"></span>
5525 <div class="prop-subtitle"> in path </div>
5526 <div class="prop-subtitle">
5527 <span class="json-property-type">string</span>
5528 <span class="json-property-range" title="Value limits"></span>
5529 </div>
5530 </div>
5531 <div class="prop-value">
5532 <p>The video id </p>
5533 </div>
5534 </div>
5535 </section>
5536 </div>
5537 <div class="doc-examples"></div>
5538 </div>
5539 <div class="doc-row">
5540 <div class="doc-copy">
5541 <section class="swagger-responses">
5542 <div class="prop-row prop-group">
5543 <div class="prop-name">
5544 <div class="prop-title">200 OK</div>
5545 <div class="prop-ref">
5546 <span class="">
5547 <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a>
5548 </span>
5549 </div>
5550 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5551 </div>
5552 <div class="prop-value">
5553 <p>successful operation</p>
5554 </div>
5555 </div>
5556 </section>
5557 </div>
5558 <div class="doc-examples">
5559 <h5>Response Content-Types:
5560 <span>application/json</span>
5561 </h5>
5562 <section>
5563 <h5>Response Example
5564 <span>(200 OK)</span>
5565 </h5>
5566 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5567 <span class="hljs-attr">&quot;comment&quot;</span>: {
5568 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5569 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5570 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5571 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5572 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5573 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5574 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5575 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5576 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5577 <span class="hljs-attr">&quot;account&quot;</span>: {
5578 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5579 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5580 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5581 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5582 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5583 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5584 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5585 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5586 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5587 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5588 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5589 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5590 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5591 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5592 }
5593 }
5594 }
5595 }
5596 </code></pre>
5597 <!-- </div> -->
5598 </section>
5599 </div>
5600 </div>
5601 <div class="doc-row">
5602 <div class="doc-copy">
5603 <section class="swagger-request-security">
5604 <table class="table">
5605 <thead>
5606 <tr>
5607 <th class="swagger-request-security-schema"></th>
5608 <th class="swagger-request-security-scopes"></th>
5609 </tr>
5610 </thead>
5611 <tbody>
5612 <tr>
5613 <td>
5614 <a href="#security-definition-OAuth2">OAuth2</a>
5615 </td>
5616 <td> </td>
5617 </tr>
5618 </tbody>
5619 </table>
5620 </section>
5621 </div>
5622 </div>
5623 </div>
5624 <div id="operation--videos--videoId--comment-threads--threadId--get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads--threadId--get">
5625 <!-- <section class="operation-tags row"> -->
5626 <!-- <div class="doc-copy"> -->
5627 <div class="operation-tags">
5628 <a class="label" href="#tag-VideoComment">VideoComment</a>
5629 <!---->
5630 </div>
5631 <!-- </div> -->
5632 <!-- </section> -->
5633 <h2 class="operation-title">
5634 <span class="operation-name">
5635 <span class="operation-name">GET</span>
5636 <span class="operation-path">/videos/{videoId}/comment-threads/{threadId}</span>
5637 </span>
5638 </h2>
5639 <div class="doc-row">
5640 <div class="doc-copy">
5641 <section class="swagger-request-params">
5642 <div class="prop-row prop-group">
5643 <div class="prop-name">
5644 <div class="prop-title">videoId</div>
5645 <span class="json-property-required"></span>
5646 <div class="prop-subtitle"> in path </div>
5647 <div class="prop-subtitle">
5648 <span class="json-property-type">string</span>
5649 <span class="json-property-range" title="Value limits"></span>
5650 </div>
5651 </div>
5652 <div class="prop-value">
5653 <p>The video id </p>
5654 </div>
5655 </div>
5656 <div class="prop-row prop-group">
5657 <div class="prop-name">
5658 <div class="prop-title">threadId</div>
5659 <span class="json-property-required"></span>
5660 <div class="prop-subtitle"> in path </div>
5661 <div class="prop-subtitle">
5662 <span class="json-property-type">string</span>
5663 <span class="json-property-range" title="Value limits"></span>
5664 </div>
5665 </div>
5666 <div class="prop-value">
5667 <p>The thread id </p>
5668 </div>
5669 </div>
5670 </section>
5671 </div>
5672 <div class="doc-examples"></div>
5673 </div>
5674 <div class="doc-row">
5675 <div class="doc-copy">
5676 <section class="swagger-responses">
5677 <div class="prop-row prop-group">
5678 <div class="prop-name">
5679 <div class="prop-title">200 OK</div>
5680 <div class="prop-ref">
5681 <span class="">
5682 <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
5683 </span>
5684 </div>
5685 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5686 </div>
5687 <div class="prop-value">
5688 <p>successful operation</p>
5689 </div>
5690 </div>
5691 </section>
5692 </div>
5693 <div class="doc-examples">
5694 <h5>Response Content-Types:
5695 <span>application/json</span>
5696 </h5>
5697 <section>
5698 <h5>Response Example
5699 <span>(200 OK)</span>
5700 </h5>
5701 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5702 <span class="hljs-attr">&quot;comment&quot;</span>: {
5703 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5704 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5705 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5706 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5707 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5708 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5709 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5710 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5711 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5712 <span class="hljs-attr">&quot;account&quot;</span>: {
5713 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5714 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5715 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5716 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5717 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5718 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5719 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5720 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5721 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5722 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5723 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5724 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5725 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5726 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5727 }
5728 }
5729 },
5730 <span class="hljs-attr">&quot;children&quot;</span>: [
5731 {
5732 <span class="hljs-attr">&quot;comment&quot;</span>: {
5733 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5734 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5735 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5736 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5737 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5738 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5739 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5740 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5741 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5742 <span class="hljs-attr">&quot;account&quot;</span>: {
5743 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5744 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5745 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5746 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5747 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5748 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5749 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5750 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5751 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5752 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5753 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5754 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5755 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5756 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5757 }
5758 }
5759 },
5760 <span class="hljs-attr">&quot;children&quot;</span>: [
5761 {
5762 <span class="hljs-attr">&quot;comment&quot;</span>: {
5763 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5764 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5765 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5766 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5767 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5768 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5769 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5770 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5771 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5772 <span class="hljs-attr">&quot;account&quot;</span>: {
5773 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5774 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5775 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5776 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5777 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5778 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5779 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5780 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5781 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5782 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5783 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5784 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5785 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5786 }
5787 }
5788 }
5789 }
5790 ]
5791 }
5792 ]
5793 }
5794 </code></pre>
5795 <!-- </div> -->
5796 </section>
5797 </div>
5798 </div>
5799 </div>
5800 <div id="operation--videos--videoId--comments--commentId--post" class="operation panel" data-traverse-target="operation--videos--videoId--comments--commentId--post">
5801 <!-- <section class="operation-tags row"> -->
5802 <!-- <div class="doc-copy"> -->
5803 <div class="operation-tags">
5804 <a class="label" href="#tag-VideoComment">VideoComment</a>
5805 <!---->
5806 </div>
5807 <!-- </div> -->
5808 <!-- </section> -->
5809 <h2 class="operation-title">
5810 <span class="operation-name">
5811 <span class="operation-name">POST</span>
5812 <span class="operation-path">/videos/{videoId}/comments/{commentId}</span>
5813 </span>
5814 </h2>
5815 <div class="doc-row">
5816 <div class="doc-copy">
5817 <section class="swagger-request-params">
5818 <div class="prop-row prop-group">
5819 <div class="prop-name">
5820 <div class="prop-title">videoId</div>
5821 <span class="json-property-required"></span>
5822 <div class="prop-subtitle"> in path </div>
5823 <div class="prop-subtitle">
5824 <span class="json-property-type">string</span>
5825 <span class="json-property-range" title="Value limits"></span>
5826 </div>
5827 </div>
5828 <div class="prop-value">
5829 <p>The video id </p>
5830 </div>
5831 </div>
5832 <div class="prop-row prop-group">
5833 <div class="prop-name">
5834 <div class="prop-title">commentId</div>
5835 <span class="json-property-required"></span>
5836 <div class="prop-subtitle"> in path </div>
5837 <div class="prop-subtitle">
5838 <span class="json-property-type">string</span>
5839 <span class="json-property-range" title="Value limits"></span>
5840 </div>
5841 </div>
5842 <div class="prop-value">
5843 <p>The comment id </p>
5844 </div>
5845 </div>
5846 </section>
5847 </div>
5848 <div class="doc-examples"></div>
5849 </div>
5850 <div class="doc-row">
5851 <div class="doc-copy">
5852 <section class="swagger-responses">
5853 <div class="prop-row prop-group">
5854 <div class="prop-name">
5855 <div class="prop-title">200 OK</div>
5856 <div class="prop-ref">
5857 <span class="">
5858 <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a>
5859 </span>
5860 </div>
5861 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5862 </div>
5863 <div class="prop-value">
5864 <p>successful operation</p>
5865 </div>
5866 </div>
5867 </section>
5868 </div>
5869 <div class="doc-examples">
5870 <h5>Response Content-Types:
5871 <span>application/json</span>
5872 </h5>
5873 <section>
5874 <h5>Response Example
5875 <span>(200 OK)</span>
5876 </h5>
5877 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5878 <span class="hljs-attr">&quot;comment&quot;</span>: {
5879 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5880 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5881 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5882 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5883 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5884 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5885 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5886 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5887 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5888 <span class="hljs-attr">&quot;account&quot;</span>: {
5889 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5890 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5891 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5892 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5893 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5894 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5895 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5896 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5897 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5898 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5899 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5900 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5901 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5902 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5903 }
5904 }
5905 }
5906 }
5907 </code></pre>
5908 <!-- </div> -->
5909 </section>
5910 </div>
5911 </div>
5912 <div class="doc-row">
5913 <div class="doc-copy">
5914 <section class="swagger-request-security">
5915 <table class="table">
5916 <thead>
5917 <tr>
5918 <th class="swagger-request-security-schema"></th>
5919 <th class="swagger-request-security-scopes"></th>
5920 </tr>
5921 </thead>
5922 <tbody>
5923 <tr>
5924 <td>
5925 <a href="#security-definition-OAuth2">OAuth2</a>
5926 </td>
5927 <td> </td>
5928 </tr>
5929 </tbody>
5930 </table>
5931 </section>
5932 </div>
5933 </div>
5934 </div>
5935 <div id="operation--videos--videoId--comments--commentId--delete" class="operation panel" data-traverse-target="operation--videos--videoId--comments--commentId--delete">
5936 <!-- <section class="operation-tags row"> -->
5937 <!-- <div class="doc-copy"> -->
5938 <div class="operation-tags">
5939 <a class="label" href="#tag-VideoComment">VideoComment</a>
5940 <!---->
5941 </div>
5942 <!-- </div> -->
5943 <!-- </section> -->
5944 <h2 class="operation-title">
5945 <span class="operation-name">
5946 <span class="operation-name">DELETE</span>
5947 <span class="operation-path">/videos/{videoId}/comments/{commentId}</span>
5948 </span>
5949 </h2>
5950 <div class="doc-row">
5951 <div class="doc-copy">
5952 <section class="swagger-request-params">
5953 <div class="prop-row prop-group">
5954 <div class="prop-name">
5955 <div class="prop-title">videoId</div>
5956 <span class="json-property-required"></span>
5957 <div class="prop-subtitle"> in path </div>
5958 <div class="prop-subtitle">
5959 <span class="json-property-type">string</span>
5960 <span class="json-property-range" title="Value limits"></span>
5961 </div>
5962 </div>
5963 <div class="prop-value">
5964 <p>The video id </p>
5965 </div>
5966 </div>
5967 <div class="prop-row prop-group">
5968 <div class="prop-name">
5969 <div class="prop-title">commentId</div>
5970 <span class="json-property-required"></span>
5971 <div class="prop-subtitle"> in path </div>
5972 <div class="prop-subtitle">
5973 <span class="json-property-type">string</span>
5974 <span class="json-property-range" title="Value limits"></span>
5975 </div>
5976 </div>
5977 <div class="prop-value">
5978 <p>The comment id </p>
5979 </div>
5980 </div>
5981 </section>
5982 </div>
5983 <div class="doc-examples"></div>
5984 </div>
5985 <div class="doc-row">
5986 <div class="doc-copy">
5987 <section class="swagger-responses">
5988 <div class="prop-row prop-group">
5989 <div class="prop-name">
5990 <div class="prop-title">204 No Content</div>
5991 </div>
5992 <div class="prop-value">
5993 <p>successful operation</p>
5994 </div>
5995 </div>
5996 </section>
5997 </div>
5998 <div class="doc-examples">
5999 <h5>Response Content-Types:
6000 <span>application/json</span>
6001 </h5>
6002 </div>
6003 </div>
6004 <div class="doc-row">
6005 <div class="doc-copy">
6006 <section class="swagger-request-security">
6007 <table class="table">
6008 <thead>
6009 <tr>
6010 <th class="swagger-request-security-schema"></th>
6011 <th class="swagger-request-security-scopes"></th>
6012 </tr>
6013 </thead>
6014 <tbody>
6015 <tr>
6016 <td>
6017 <a href="#security-definition-OAuth2">OAuth2</a>
6018 </td>
6019 <td> </td>
6020 </tr>
6021 </tbody>
6022 </table>
6023 </section>
6024 </div>
6025 </div>
6026 </div>
6027 <h1 id="tag-VideoRate" class="swagger-summary-tag" data-traverse-target="tag-VideoRate">VideoRate</h1>
6028 <div id="operation--videos--id--rate-put" class="operation panel" data-traverse-target="operation--videos--id--rate-put">
6029 <!-- <section class="operation-tags row"> -->
6030 <!-- <div class="doc-copy"> -->
6031 <div class="operation-tags">
6032 <a class="label" href="#tag-VideoRate">VideoRate</a>
6033 <!---->
6034 </div>
6035 <!-- </div> -->
6036 <!-- </section> -->
6037 <h2 class="operation-title">
6038 <span class="operation-name">
6039 <span class="operation-name">PUT</span>
6040 <span class="operation-path">/videos/{id}/rate</span>
6041 </span>
6042 </h2>
6043 <div class="doc-row">
6044 <div class="doc-copy">
6045 <section class="swagger-request-params">
6046 <div class="prop-row prop-group">
6047 <div class="prop-name">
6048 <div class="prop-title">id</div>
6049 <span class="json-property-required"></span>
6050 <div class="prop-subtitle"> in path </div>
6051 <div class="prop-subtitle">
6052 <span class="json-property-type">string</span>
6053 <span class="json-property-range" title="Value limits"></span>
6054 </div>
6055 </div>
6056 <div class="prop-value">
6057 <p>The video id </p>
6058 </div>
6059 </div>
6060 </section>
6061 </div>
6062 <div class="doc-examples"></div>
6063 </div>
6064 <div class="doc-row">
6065 <div class="doc-copy">
6066 <section class="swagger-responses">
6067 <div class="prop-row prop-group">
6068 <div class="prop-name">
6069 <div class="prop-title">204 No Content</div>
6070 </div>
6071 <div class="prop-value">
6072 <p>successful operation</p>
6073 </div>
6074 </div>
6075 </section>
6076 </div>
6077 <div class="doc-examples">
6078 <h5>Response Content-Types:
6079 <span>application/json</span>
6080 </h5>
6081 </div>
6082 </div>
6083 <div class="doc-row">
6084 <div class="doc-copy">
6085 <section class="swagger-request-security">
6086 <table class="table">
6087 <thead>
6088 <tr>
6089 <th class="swagger-request-security-schema"></th>
6090 <th class="swagger-request-security-scopes"></th>
6091 </tr>
6092 </thead>
6093 <tbody>
6094 <tr>
6095 <td>
6096 <a href="#security-definition-OAuth2">OAuth2</a>
6097 </td>
6098 <td> </td>
6099 </tr>
6100 </tbody>
6101 </table>
6102 </section>
6103 </div>
6104 </div>
6105 </div>
6106 <h1>Schema Definitions</h1>
6107 <div id="definition-VideoConstant" class="definition panel" data-traverse-target="definition-VideoConstant">
6108 <h2 class="panel-title">
6109 <a name="/definitions/VideoConstant"></a>VideoConstant:
6110 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6111 <span class="json-property-range" title="Value limits"></span>
6112
6113
6114 </span> -->
6115 </h2>
6116 <div class="doc-row">
6117 <div class="doc-copy">
6118 <section class="json-schema-properties">
6119 <dl>
6120 <dt data-property-name="id">
6121 <span class="json-property-name">id:</span>
6122 <span class="json-property-type">number</span>
6123 <span class="json-property-range" title="Value limits"></span>
6124 </dt>
6125 <dt data-property-name="label">
6126 <span class="json-property-name">label:</span>
6127 <span class="json-property-type">string</span>
6128 <span class="json-property-range" title="Value limits"></span>
6129 </dt>
6130 </dl>
6131 </section>
6132 </div>
6133 <div class="doc-examples">
6134 <section>
6135 <h5>Example</h5>
6136 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6137 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6138 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6139 }
6140 </code></pre>
6141 <!-- </div> -->
6142 </section>
6143 </div>
6144 </div>
6145 </div>
6146 <div id="definition-VideoPrivacy" class="definition panel" data-traverse-target="definition-VideoPrivacy">
6147 <h2 class="panel-title">
6148 <a name="/definitions/VideoPrivacy"></a>VideoPrivacy: string
6149 <!-- <span class="json-property-type"><span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values">
6150 <span class="json-property-enum-item">Public</span>,
6151 <span class="json-property-enum-item">Unlisted</span>,
6152 <span class="json-property-enum-item">Private</span>
6153 </span>
6154 <span class="json-property-range" title="Value limits"></span>
6155
6156
6157 </span> -->
6158 </h2>
6159 <div class="doc-row">
6160 <div class="doc-copy">
6161 <span class="json-property-type">string</span>
6162 <span class="json-property-enum" title="Possible values">
6163 <span class="json-property-enum-item">Public</span>,
6164 <span class="json-property-enum-item">Unlisted</span>,
6165 <span class="json-property-enum-item">Private</span>
6166 </span>
6167 <span class="json-property-range" title="Value limits"></span>
6168 </div>
6169 </div>
6170 </div>
6171 <div id="definition-Video" class="definition panel" data-traverse-target="definition-Video">
6172 <h2 class="panel-title">
6173 <a name="/definitions/Video"></a>Video:
6174 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6175 <span class="json-property-range" title="Value limits"></span>
6176
6177
6178 </span> -->
6179 </h2>
6180 <div class="doc-row">
6181 <div class="doc-copy">
6182 <section class="json-schema-properties">
6183 <dl>
6184 <dt data-property-name="id">
6185 <span class="json-property-name">id:</span>
6186 <span class="json-property-type">number</span>
6187 <span class="json-property-range" title="Value limits"></span>
6188 </dt>
6189 <dt data-property-name="uuid">
6190 <span class="json-property-name">uuid:</span>
6191 <span class="json-property-type">string</span>
6192 <span class="json-property-range" title="Value limits"></span>
6193 </dt>
6194 <dt data-property-name="createdAt">
6195 <span class="json-property-name">createdAt:</span>
6196 <span class="json-property-type">string</span>
6197 <span class="json-property-range" title="Value limits"></span>
6198 </dt>
6199 <dt data-property-name="publishedAt">
6200 <span class="json-property-name">publishedAt:</span>
6201 <span class="json-property-type">string</span>
6202 <span class="json-property-range" title="Value limits"></span>
6203 </dt>
6204 <dt data-property-name="updatedAt">
6205 <span class="json-property-name">updatedAt:</span>
6206 <span class="json-property-type">string</span>
6207 <span class="json-property-range" title="Value limits"></span>
6208 </dt>
6209 <dt data-property-name="category">
6210 <span class="json-property-name">category:</span>
6211 <span class="json-property-type">
6212 <span class="">
6213 <a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a>
6214 </span>
6215 </span>
6216 <span class="json-property-range" title="Value limits"></span>
6217 </dt>
6218 <dt data-property-name="licence">
6219 <span class="json-property-name">licence:</span>
6220 <span class="json-property-type">
6221 <span class="">
6222 <a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a>
6223 </span>
6224 </span>
6225 <span class="json-property-range" title="Value limits"></span>
6226 </dt>
6227 <dt data-property-name="language">
6228 <span class="json-property-name">language:</span>
6229 <span class="json-property-type">
6230 <span class="">
6231 <a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a>
6232 </span>
6233 </span>
6234 <span class="json-property-range" title="Value limits"></span>
6235 </dt>
6236 <dt data-property-name="privacy">
6237 <span class="json-property-name">privacy:</span>
6238 <span class="json-property-type">
6239 <span class="">
6240 <a class="json-schema-ref" href="#/definitions/VideoPrivacy">VideoPrivacy</a>
6241 </span>
6242 </span>
6243 <span class="json-property-range" title="Value limits"></span>
6244 </dt>
6245 <dt data-property-name="description">
6246 <span class="json-property-name">description:</span>
6247 <span class="json-property-type">string</span>
6248 <span class="json-property-range" title="Value limits"></span>
6249 </dt>
6250 <dt data-property-name="duration">
6251 <span class="json-property-name">duration:</span>
6252 <span class="json-property-type">number</span>
6253 <span class="json-property-range" title="Value limits"></span>
6254 </dt>
6255 <dt data-property-name="isLocal">
6256 <span class="json-property-name">isLocal:</span>
6257 <span class="json-property-type">boolean</span>
6258 <span class="json-property-range" title="Value limits"></span>
6259 </dt>
6260 <dt data-property-name="name">
6261 <span class="json-property-name">name:</span>
6262 <span class="json-property-type">string</span>
6263 <span class="json-property-range" title="Value limits"></span>
6264 </dt>
6265 <dt data-property-name="thumbnailPath">
6266 <span class="json-property-name">thumbnailPath:</span>
6267 <span class="json-property-type">string</span>
6268 <span class="json-property-range" title="Value limits"></span>
6269 </dt>
6270 <dt data-property-name="previewPath">
6271 <span class="json-property-name">previewPath:</span>
6272 <span class="json-property-type">string</span>
6273 <span class="json-property-range" title="Value limits"></span>
6274 </dt>
6275 <dt data-property-name="embedPath">
6276 <span class="json-property-name">embedPath:</span>
6277 <span class="json-property-type">string</span>
6278 <span class="json-property-range" title="Value limits"></span>
6279 </dt>
6280 <dt data-property-name="views">
6281 <span class="json-property-name">views:</span>
6282 <span class="json-property-type">number</span>
6283 <span class="json-property-range" title="Value limits"></span>
6284 </dt>
6285 <dt data-property-name="likes">
6286 <span class="json-property-name">likes:</span>
6287 <span class="json-property-type">number</span>
6288 <span class="json-property-range" title="Value limits"></span>
6289 </dt>
6290 <dt data-property-name="dislikes">
6291 <span class="json-property-name">dislikes:</span>
6292 <span class="json-property-type">number</span>
6293 <span class="json-property-range" title="Value limits"></span>
6294 </dt>
6295 <dt data-property-name="nsfw">
6296 <span class="json-property-name">nsfw:</span>
6297 <span class="json-property-type">boolean</span>
6298 <span class="json-property-range" title="Value limits"></span>
6299 </dt>
6300 <dt data-property-name="account">
6301 <span class="json-property-name">account:</span>
6302 <span class="json-property-type">object</span>
6303 <span class="json-property-range" title="Value limits"></span>
6304 </dt>
6305 </dl>
6306 </section>
6307 </div>
6308 <div class="doc-examples">
6309 <section>
6310 <h5>Example</h5>
6311 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6312 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6313 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6314 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6315 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6316 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6317 <span class="hljs-attr">&quot;category&quot;</span>: {
6318 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6319 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6320 },
6321 <span class="hljs-attr">&quot;licence&quot;</span>: {
6322 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6323 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6324 },
6325 <span class="hljs-attr">&quot;language&quot;</span>: {
6326 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6327 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6328 },
6329 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6330 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6331 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6332 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
6333 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6334 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6335 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6336 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6337 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6338 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6339 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6340 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
6341 <span class="hljs-attr">&quot;account&quot;</span>: {
6342 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6343 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6344 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6345 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6346 <span class="hljs-attr">&quot;avatar&quot;</span>: {
6347 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6348 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6349 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6350 }
6351 }
6352 }
6353 </code></pre>
6354 <!-- </div> -->
6355 </section>
6356 </div>
6357 </div>
6358 </div>
6359 <div id="definition-VideoAbuse" class="definition panel" data-traverse-target="definition-VideoAbuse">
6360 <h2 class="panel-title">
6361 <a name="/definitions/VideoAbuse"></a>VideoAbuse:
6362 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6363 <span class="json-property-range" title="Value limits"></span>
6364
6365
6366 </span> -->
6367 </h2>
6368 <div class="doc-row">
6369 <div class="doc-copy">
6370 <section class="json-schema-properties">
6371 <dl>
6372 <dt data-property-name="id">
6373 <span class="json-property-name">id:</span>
6374 <span class="json-property-type">number</span>
6375 <span class="json-property-range" title="Value limits"></span>
6376 </dt>
6377 <dt data-property-name="reason">
6378 <span class="json-property-name">reason:</span>
6379 <span class="json-property-type">string</span>
6380 <span class="json-property-range" title="Value limits"></span>
6381 </dt>
6382 <dt data-property-name="reporterAccount">
6383 <span class="json-property-name">reporterAccount:</span>
6384 <span class="json-property-type">
6385 <span class="">
6386 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
6387 </span>
6388 </span>
6389 <span class="json-property-range" title="Value limits"></span>
6390 </dt>
6391 <dt data-property-name="video">
6392 <span class="json-property-name">video:</span>
6393 <span class="json-property-type">object</span>
6394 <span class="json-property-range" title="Value limits"></span>
6395 </dt>
6396 <dt data-property-name="createdAt">
6397 <span class="json-property-name">createdAt:</span>
6398 <span class="json-property-type">string</span>
6399 <span class="json-property-range" title="Value limits"></span>
6400 </dt>
6401 </dl>
6402 </section>
6403 </div>
6404 <div class="doc-examples">
6405 <section>
6406 <h5>Example</h5>
6407 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6408 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6409 <span class="hljs-attr">&quot;reason&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6410 <span class="hljs-attr">&quot;reporterAccount&quot;</span>: {
6411 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6412 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6413 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6414 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6415 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6416 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6417 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6418 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6419 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6420 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6421 <span class="hljs-attr">&quot;avatar&quot;</span>: {
6422 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6423 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6424 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6425 }
6426 },
6427 <span class="hljs-attr">&quot;video&quot;</span>: {
6428 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6429 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6430 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6431 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6432 },
6433 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6434 }
6435 </code></pre>
6436 <!-- </div> -->
6437 </section>
6438 </div>
6439 </div>
6440 </div>
6441 <div id="definition-VideoBlacklist" class="definition panel" data-traverse-target="definition-VideoBlacklist">
6442 <h2 class="panel-title">
6443 <a name="/definitions/VideoBlacklist"></a>VideoBlacklist:
6444 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6445 <span class="json-property-range" title="Value limits"></span>
6446
6447
6448 </span> -->
6449 </h2>
6450 <div class="doc-row">
6451 <div class="doc-copy">
6452 <section class="json-schema-properties">
6453 <dl>
6454 <dt data-property-name="id">
6455 <span class="json-property-name">id:</span>
6456 <span class="json-property-type">number</span>
6457 <span class="json-property-range" title="Value limits"></span>
6458 </dt>
6459 <dt data-property-name="videoId">
6460 <span class="json-property-name">videoId:</span>
6461 <span class="json-property-type">number</span>
6462 <span class="json-property-range" title="Value limits"></span>
6463 </dt>
6464 <dt data-property-name="createdAt">
6465 <span class="json-property-name">createdAt:</span>
6466 <span class="json-property-type">string</span>
6467 <span class="json-property-range" title="Value limits"></span>
6468 </dt>
6469 <dt data-property-name="updatedAt">
6470 <span class="json-property-name">updatedAt:</span>
6471 <span class="json-property-type">string</span>
6472 <span class="json-property-range" title="Value limits"></span>
6473 </dt>
6474 <dt data-property-name="name">
6475 <span class="json-property-name">name:</span>
6476 <span class="json-property-type">string</span>
6477 <span class="json-property-range" title="Value limits"></span>
6478 </dt>
6479 <dt data-property-name="uuid">
6480 <span class="json-property-name">uuid:</span>
6481 <span class="json-property-type">string</span>
6482 <span class="json-property-range" title="Value limits"></span>
6483 </dt>
6484 <dt data-property-name="description">
6485 <span class="json-property-name">description:</span>
6486 <span class="json-property-type">string</span>
6487 <span class="json-property-range" title="Value limits"></span>
6488 </dt>
6489 <dt data-property-name="duration">
6490 <span class="json-property-name">duration:</span>
6491 <span class="json-property-type">number</span>
6492 <span class="json-property-range" title="Value limits"></span>
6493 </dt>
6494 <dt data-property-name="views">
6495 <span class="json-property-name">views:</span>
6496 <span class="json-property-type">number</span>
6497 <span class="json-property-range" title="Value limits"></span>
6498 </dt>
6499 <dt data-property-name="likes">
6500 <span class="json-property-name">likes:</span>
6501 <span class="json-property-type">number</span>
6502 <span class="json-property-range" title="Value limits"></span>
6503 </dt>
6504 <dt data-property-name="dislikes">
6505 <span class="json-property-name">dislikes:</span>
6506 <span class="json-property-type">number</span>
6507 <span class="json-property-range" title="Value limits"></span>
6508 </dt>
6509 <dt data-property-name="nsfw">
6510 <span class="json-property-name">nsfw:</span>
6511 <span class="json-property-type">boolean</span>
6512 <span class="json-property-range" title="Value limits"></span>
6513 </dt>
6514 </dl>
6515 </section>
6516 </div>
6517 <div class="doc-examples">
6518 <section>
6519 <h5>Example</h5>
6520 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6521 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6522 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6523 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6524 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6525 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6526 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6527 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6528 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6529 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6530 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6531 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6532 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>
6533 }
6534 </code></pre>
6535 <!-- </div> -->
6536 </section>
6537 </div>
6538 </div>
6539 </div>
6540 <div id="definition-VideoChannel" class="definition panel" data-traverse-target="definition-VideoChannel">
6541 <h2 class="panel-title">
6542 <a name="/definitions/VideoChannel"></a>VideoChannel:
6543 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6544 <span class="json-property-range" title="Value limits"></span>
6545
6546
6547 </span> -->
6548 </h2>
6549 <div class="doc-row">
6550 <div class="doc-copy">
6551 <section class="json-schema-properties">
6552 <dl>
6553 <dt data-property-name="displayName">
6554 <span class="json-property-name">displayName:</span>
6555 <span class="json-property-type">string</span>
6556 <span class="json-property-range" title="Value limits"></span>
6557 </dt>
6558 <dt data-property-name="description">
6559 <span class="json-property-name">description:</span>
6560 <span class="json-property-type">string</span>
6561 <span class="json-property-range" title="Value limits"></span>
6562 </dt>
6563 <dt data-property-name="isLocal">
6564 <span class="json-property-name">isLocal:</span>
6565 <span class="json-property-type">boolean</span>
6566 <span class="json-property-range" title="Value limits"></span>
6567 </dt>
6568 <dt data-property-name="owner">
6569 <span class="json-property-name">owner:</span>
6570 <span class="json-property-type">object</span>
6571 <span class="json-property-range" title="Value limits"></span>
6572 </dt>
6573 <dt data-property-name="videos">
6574 <span class="json-property-name">videos:</span>
6575 <span class="json-property-type">
6576 <span class="json-schema-ref-array">
6577 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
6578 </span>
6579 </span>
6580 <span class="json-property-range" title="Value limits"></span>
6581 </dt>
6582 </dl>
6583 </section>
6584 </div>
6585 <div class="doc-examples">
6586 <section>
6587 <h5>Example</h5>
6588 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6589 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6590 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6591 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
6592 <span class="hljs-attr">&quot;owner&quot;</span>: {
6593 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6594 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6595 },
6596 <span class="hljs-attr">&quot;videos&quot;</span>: [
6597 {
6598 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6599 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6600 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6601 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6602 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6603 <span class="hljs-attr">&quot;category&quot;</span>: {
6604 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6605 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6606 },
6607 <span class="hljs-attr">&quot;licence&quot;</span>: {
6608 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6609 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6610 },
6611 <span class="hljs-attr">&quot;language&quot;</span>: {
6612 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6613 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6614 },
6615 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6616 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6617 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6618 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
6619 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6620 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6621 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6622 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6623 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6624 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6625 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6626 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
6627 <span class="hljs-attr">&quot;account&quot;</span>: {
6628 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6629 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6630 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6631 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6632 <span class="hljs-attr">&quot;avatar&quot;</span>: {
6633 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6634 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6635 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6636 }
6637 }
6638 }
6639 ]
6640 }
6641 </code></pre>
6642 <!-- </div> -->
6643 </section>
6644 </div>
6645 </div>
6646 </div>
6647 <div id="definition-VideoComment" class="definition panel" data-traverse-target="definition-VideoComment">
6648 <h2 class="panel-title">
6649 <a name="/definitions/VideoComment"></a>VideoComment:
6650 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6651 <span class="json-property-range" title="Value limits"></span>
6652
6653
6654 </span> -->
6655 </h2>
6656 <div class="doc-row">
6657 <div class="doc-copy">
6658 <section class="json-schema-properties">
6659 <dl>
6660 <dt data-property-name="id">
6661 <span class="json-property-name">id:</span>
6662 <span class="json-property-type">number</span>
6663 <span class="json-property-range" title="Value limits"></span>
6664 </dt>
6665 <dt data-property-name="url">
6666 <span class="json-property-name">url:</span>
6667 <span class="json-property-type">string</span>
6668 <span class="json-property-range" title="Value limits"></span>
6669 </dt>
6670 <dt data-property-name="text">
6671 <span class="json-property-name">text:</span>
6672 <span class="json-property-type">string</span>
6673 <span class="json-property-range" title="Value limits"></span>
6674 </dt>
6675 <dt data-property-name="threadId">
6676 <span class="json-property-name">threadId:</span>
6677 <span class="json-property-type">number</span>
6678 <span class="json-property-range" title="Value limits"></span>
6679 </dt>
6680 <dt data-property-name="inReplyToCommentId">
6681 <span class="json-property-name">inReplyToCommentId:</span>
6682 <span class="json-property-type">number</span>
6683 <span class="json-property-range" title="Value limits"></span>
6684 </dt>
6685 <dt data-property-name="videoId">
6686 <span class="json-property-name">videoId:</span>
6687 <span class="json-property-type">number</span>
6688 <span class="json-property-range" title="Value limits"></span>
6689 </dt>
6690 <dt data-property-name="createdAt">
6691 <span class="json-property-name">createdAt:</span>
6692 <span class="json-property-type">string</span>
6693 <span class="json-property-range" title="Value limits"></span>
6694 </dt>
6695 <dt data-property-name="updatedAt">
6696 <span class="json-property-name">updatedAt:</span>
6697 <span class="json-property-type">string</span>
6698 <span class="json-property-range" title="Value limits"></span>
6699 </dt>
6700 <dt data-property-name="totalReplies">
6701 <span class="json-property-name">totalReplies:</span>
6702 <span class="json-property-type">number</span>
6703 <span class="json-property-range" title="Value limits"></span>
6704 </dt>
6705 <dt data-property-name="account">
6706 <span class="json-property-name">account:</span>
6707 <span class="json-property-type">
6708 <span class="">
6709 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
6710 </span>
6711 </span>
6712 <span class="json-property-range" title="Value limits"></span>
6713 </dt>
6714 </dl>
6715 </section>
6716 </div>
6717 <div class="doc-examples">
6718 <section>
6719 <h5>Example</h5>
6720 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6721 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6722 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6723 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6724 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6725 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6726 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6727 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6728 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6729 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6730 <span class="hljs-attr">&quot;account&quot;</span>: {
6731 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6732 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6733 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6734 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6735 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6736 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6737 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6738 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6739 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6740 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6741 <span class="hljs-attr">&quot;avatar&quot;</span>: {
6742 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6743 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6744 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6745 }
6746 }
6747 }
6748 </code></pre>
6749 <!-- </div> -->
6750 </section>
6751 </div>
6752 </div>
6753 </div>
6754 <div id="definition-VideoCommentThreadTree" class="definition panel" data-traverse-target="definition-VideoCommentThreadTree">
6755 <h2 class="panel-title">
6756 <a name="/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree:
6757 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6758 <span class="json-property-range" title="Value limits"></span>
6759
6760
6761 </span> -->
6762 </h2>
6763 <div class="doc-row">
6764 <div class="doc-copy">
6765 <section class="json-schema-properties">
6766 <dl>
6767 <dt data-property-name="comment">
6768 <span class="json-property-name">comment:</span>
6769 <span class="json-property-type">
6770 <span class="">
6771 <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
6772 </span>
6773 </span>
6774 <span class="json-property-range" title="Value limits"></span>
6775 </dt>
6776 <dt data-property-name="children">
6777 <span class="json-property-name">children:</span>
6778 <span class="json-property-type">
6779 <span class="json-schema-ref-array">
6780 <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
6781 </span>
6782 </span>
6783 <span class="json-property-range" title="Value limits"></span>
6784 </dt>
6785 </dl>
6786 </section>
6787 </div>
6788 <div class="doc-examples">
6789 <section>
6790 <h5>Example</h5>
6791 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6792 <span class="hljs-attr">&quot;comment&quot;</span>: {
6793 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6794 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6795 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6796 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6797 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6798 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6799 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6800 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6801 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6802 <span class="hljs-attr">&quot;account&quot;</span>: {
6803 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6804 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6805 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6806 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6807 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6808 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6809 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6810 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6811 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6812 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6813 <span class="hljs-attr">&quot;avatar&quot;</span>: {
6814 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6815 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6816 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6817 }
6818 }
6819 },
6820 <span class="hljs-attr">&quot;children&quot;</span>: [
6821 {
6822 <span class="hljs-attr">&quot;comment&quot;</span>: {
6823 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6824 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6825 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6826 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6827 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6828 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6829 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6830 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6831 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6832 <span class="hljs-attr">&quot;account&quot;</span>: {
6833 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6834 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6835 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6836 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6837 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6838 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6839 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6840 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6841 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6842 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6843 <span class="hljs-attr">&quot;avatar&quot;</span>: {
6844 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6845 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6846 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6847 }
6848 }
6849 },
6850 <span class="hljs-attr">&quot;children&quot;</span>: [
6851 {
6852 <span class="hljs-attr">&quot;comment&quot;</span>: {
6853 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6854 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6855 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6856 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6857 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6858 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6859 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6860 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6861 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6862 <span class="hljs-attr">&quot;account&quot;</span>: {
6863 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6864 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6865 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6866 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6867 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6868 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6869 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6870 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6871 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6872 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6873 <span class="hljs-attr">&quot;avatar&quot;</span>: {
6874 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6875 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6876 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6877 }
6878 }
6879 }
6880 }
6881 ]
6882 }
6883 ]
6884 }
6885 </code></pre>
6886 <!-- </div> -->
6887 </section>
6888 </div>
6889 </div>
6890 </div>
6891 <div id="definition-Avatar" class="definition panel" data-traverse-target="definition-Avatar">
6892 <h2 class="panel-title">
6893 <a name="/definitions/Avatar"></a>Avatar:
6894 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6895 <span class="json-property-range" title="Value limits"></span>
6896
6897
6898 </span> -->
6899 </h2>
6900 <div class="doc-row">
6901 <div class="doc-copy">
6902 <section class="json-schema-properties">
6903 <dl>
6904 <dt data-property-name="path">
6905 <span class="json-property-name">path:</span>
6906 <span class="json-property-type">string</span>
6907 <span class="json-property-range" title="Value limits"></span>
6908 </dt>
6909 <dt data-property-name="createdAt">
6910 <span class="json-property-name">createdAt:</span>
6911 <span class="json-property-type">string</span>
6912 <span class="json-property-range" title="Value limits"></span>
6913 </dt>
6914 <dt data-property-name="updatedAt">
6915 <span class="json-property-name">updatedAt:</span>
6916 <span class="json-property-type">string</span>
6917 <span class="json-property-range" title="Value limits"></span>
6918 </dt>
6919 </dl>
6920 </section>
6921 </div>
6922 <div class="doc-examples">
6923 <section>
6924 <h5>Example</h5>
6925 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6926 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6927 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6928 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6929 }
6930 </code></pre>
6931 <!-- </div> -->
6932 </section>
6933 </div>
6934 </div>
6935 </div>
6936 <div id="definition-Actor" class="definition panel" data-traverse-target="definition-Actor">
6937 <h2 class="panel-title">
6938 <a name="/definitions/Actor"></a>Actor:
6939 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6940 <span class="json-property-range" title="Value limits"></span>
6941
6942
6943 </span> -->
6944 </h2>
6945 <div class="doc-row">
6946 <div class="doc-copy">
6947 <section class="json-schema-properties">
6948 <dl>
6949 <dt data-property-name="id">
6950 <span class="json-property-name">id:</span>
6951 <span class="json-property-type">number</span>
6952 <span class="json-property-range" title="Value limits"></span>
6953 </dt>
6954 <dt data-property-name="uuid">
6955 <span class="json-property-name">uuid:</span>
6956 <span class="json-property-type">string</span>
6957 <span class="json-property-range" title="Value limits"></span>
6958 </dt>
6959 <dt data-property-name="url">
6960 <span class="json-property-name">url:</span>
6961 <span class="json-property-type">string</span>
6962 <span class="json-property-range" title="Value limits"></span>
6963 </dt>
6964 <dt data-property-name="name">
6965 <span class="json-property-name">name:</span>
6966 <span class="json-property-type">string</span>
6967 <span class="json-property-range" title="Value limits"></span>
6968 </dt>
6969 <dt data-property-name="host">
6970 <span class="json-property-name">host:</span>
6971 <span class="json-property-type">string</span>
6972 <span class="json-property-range" title="Value limits"></span>
6973 </dt>
6974 <dt data-property-name="followingCount">
6975 <span class="json-property-name">followingCount:</span>
6976 <span class="json-property-type">number</span>
6977 <span class="json-property-range" title="Value limits"></span>
6978 </dt>
6979 <dt data-property-name="followersCount">
6980 <span class="json-property-name">followersCount:</span>
6981 <span class="json-property-type">number</span>
6982 <span class="json-property-range" title="Value limits"></span>
6983 </dt>
6984 <dt data-property-name="createdAt">
6985 <span class="json-property-name">createdAt:</span>
6986 <span class="json-property-type">string</span>
6987 <span class="json-property-range" title="Value limits"></span>
6988 </dt>
6989 <dt data-property-name="updatedAt">
6990 <span class="json-property-name">updatedAt:</span>
6991 <span class="json-property-type">string</span>
6992 <span class="json-property-range" title="Value limits"></span>
6993 </dt>
6994 <dt data-property-name="avatar">
6995 <span class="json-property-name">avatar:</span>
6996 <span class="json-property-type">
6997 <span class="">
6998 <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
6999 </span>
7000 </span>
7001 <span class="json-property-range" title="Value limits"></span>
7002 </dt>
7003 </dl>
7004 </section>
7005 </div>
7006 <div class="doc-examples">
7007 <section>
7008 <h5>Example</h5>
7009 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7010 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7011 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7012 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7013 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7014 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7015 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7016 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7017 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7018 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7019 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7020 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7021 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7022 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7023 }
7024 }
7025 </code></pre>
7026 <!-- </div> -->
7027 </section>
7028 </div>
7029 </div>
7030 </div>
7031 <div id="definition-Account" class="definition panel" data-traverse-target="definition-Account">
7032 <h2 class="panel-title">
7033 <a name="/definitions/Account"></a>Account:
7034 <!-- <span class="json-property-type"><span class="json-property-type"></span>
7035 <span class="json-property-range" title="Value limits"></span>
7036
7037
7038 </span> -->
7039 </h2>
7040 <div class="doc-row">
7041 <div class="doc-copy">
7042 <section class="json-schema-allOf">
7043 <section class="json-schema-allOf-inherited">
7044 <ul>
7045 <span class="">
7046 <a class="json-schema-ref" href="#/definitions/Actor">Actor</a>
7047 </span>
7048 </ul>
7049 </section>
7050 <section class="json-schema-allOf-additional">
7051 <section class="json-schema-properties">
7052 <dl>
7053 <dt data-property-name="displayName">
7054 <span class="json-property-name">displayName:</span>
7055 <span class="json-property-type">string</span>
7056 <span class="json-property-range" title="Value limits"></span>
7057 </dt>
7058 </dl>
7059 </section>
7060 </section>
7061 </section>
7062 </div>
7063 <div class="doc-examples">
7064 <section>
7065 <h5>Example</h5>
7066 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7067 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7068 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7069 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7070 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7071 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7072 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7073 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7074 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7075 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7076 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7077 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7078 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7079 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7080 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7081 }
7082 }
7083 </code></pre>
7084 <!-- </div> -->
7085 </section>
7086 </div>
7087 </div>
7088 </div>
7089 <div id="definition-User" class="definition panel" data-traverse-target="definition-User">
7090 <h2 class="panel-title">
7091 <a name="/definitions/User"></a>User:
7092 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7093 <span class="json-property-range" title="Value limits"></span>
7094
7095
7096 </span> -->
7097 </h2>
7098 <div class="doc-row">
7099 <div class="doc-copy">
7100 <section class="json-schema-properties">
7101 <dl>
7102 <dt data-property-name="id">
7103 <span class="json-property-name">id:</span>
7104 <span class="json-property-type">number</span>
7105 <span class="json-property-range" title="Value limits"></span>
7106 </dt>
7107 <dt data-property-name="username">
7108 <span class="json-property-name">username:</span>
7109 <span class="json-property-type">string</span>
7110 <span class="json-property-range" title="Value limits"></span>
7111 </dt>
7112 <dt data-property-name="email">
7113 <span class="json-property-name">email:</span>
7114 <span class="json-property-type">string</span>
7115 <span class="json-property-range" title="Value limits"></span>
7116 </dt>
7117 <dt data-property-name="displayNSFW">
7118 <span class="json-property-name">displayNSFW:</span>
7119 <span class="json-property-type">boolean</span>
7120 <span class="json-property-range" title="Value limits"></span>
7121 </dt>
7122 <dt data-property-name="autoPlayVideo">
7123 <span class="json-property-name">autoPlayVideo:</span>
7124 <span class="json-property-type">boolean</span>
7125 <span class="json-property-range" title="Value limits"></span>
7126 </dt>
7127 <dt data-property-name="role">
7128 <span class="json-property-name">role:</span>
7129 <span class="json-property-type">string</span>
7130 <span class="json-property-enum" title="Possible values">
7131 <span class="json-property-enum-item">User</span>,
7132 <span class="json-property-enum-item">Moderator</span>,
7133 <span class="json-property-enum-item">Administrator</span>
7134 </span>
7135 <span class="json-property-range" title="Value limits"></span>
7136 </dt>
7137 <dt data-property-name="videoQuota">
7138 <span class="json-property-name">videoQuota:</span>
7139 <span class="json-property-type">number</span>
7140 <span class="json-property-range" title="Value limits"></span>
7141 </dt>
7142 <dt data-property-name="createdAt">
7143 <span class="json-property-name">createdAt:</span>
7144 <span class="json-property-type">string</span>
7145 <span class="json-property-range" title="Value limits"></span>
7146 </dt>
7147 <dt data-property-name="account">
7148 <span class="json-property-name">account:</span>
7149 <span class="json-property-type">
7150 <span class="">
7151 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
7152 </span>
7153 </span>
7154 <span class="json-property-range" title="Value limits"></span>
7155 </dt>
7156 <dt data-property-name="videoChannels">
7157 <span class="json-property-name">videoChannels:</span>
7158 <span class="json-property-type">
7159 <span class="json-schema-ref-array">
7160 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
7161 </span>
7162 </span>
7163 <span class="json-property-range" title="Value limits"></span>
7164 </dt>
7165 </dl>
7166 </section>
7167 </div>
7168 <div class="doc-examples">
7169 <section>
7170 <h5>Example</h5>
7171 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7172 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7173 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7174 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7175 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
7176 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
7177 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7178 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7179 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7180 <span class="hljs-attr">&quot;account&quot;</span>: {
7181 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7182 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7183 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7184 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7185 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7186 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7187 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7188 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7189 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7190 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7191 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7192 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7193 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7194 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7195 }
7196 },
7197 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
7198 {
7199 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7200 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7201 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
7202 <span class="hljs-attr">&quot;owner&quot;</span>: {
7203 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7204 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7205 },
7206 <span class="hljs-attr">&quot;videos&quot;</span>: [
7207 {
7208 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7209 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7210 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7211 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7212 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7213 <span class="hljs-attr">&quot;category&quot;</span>: {
7214 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7215 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7216 },
7217 <span class="hljs-attr">&quot;licence&quot;</span>: {
7218 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7219 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7220 },
7221 <span class="hljs-attr">&quot;language&quot;</span>: {
7222 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7223 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7224 },
7225 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7226 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7227 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7228 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
7229 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7230 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7231 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7232 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7233 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7234 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7235 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7236 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
7237 <span class="hljs-attr">&quot;account&quot;</span>: {
7238 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7239 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7240 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7241 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7242 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7243 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7244 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7245 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7246 }
7247 }
7248 }
7249 ]
7250 }
7251 ]
7252 }
7253 </code></pre>
7254 <!-- </div> -->
7255 </section>
7256 </div>
7257 </div>
7258 </div>
7259 <div id="definition-ServerConfig" class="definition panel" data-traverse-target="definition-ServerConfig">
7260 <h2 class="panel-title">
7261 <a name="/definitions/ServerConfig"></a>ServerConfig:
7262 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7263 <span class="json-property-range" title="Value limits"></span>
7264
7265
7266 </span> -->
7267 </h2>
7268 <div class="doc-row">
7269 <div class="doc-copy">
7270 <section class="json-schema-properties">
7271 <dl>
7272 <dt data-property-name="signup">
7273 <span class="json-property-name">signup:</span>
7274 <span class="json-property-type">object</span>
7275 <span class="json-property-range" title="Value limits"></span>
7276 </dt>
7277 <dt data-property-name="transcoding">
7278 <span class="json-property-name">transcoding:</span>
7279 <span class="json-property-type">object</span>
7280 <span class="json-property-range" title="Value limits"></span>
7281 </dt>
7282 <dt data-property-name="avatar">
7283 <span class="json-property-name">avatar:</span>
7284 <span class="json-property-type">object</span>
7285 <span class="json-property-range" title="Value limits"></span>
7286 </dt>
7287 <dt data-property-name="video">
7288 <span class="json-property-name">video:</span>
7289 <span class="json-property-type">object</span>
7290 <span class="json-property-range" title="Value limits"></span>
7291 </dt>
7292 </dl>
7293 </section>
7294 </div>
7295 <div class="doc-examples">
7296 <section>
7297 <h5>Example</h5>
7298 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7299 <span class="hljs-attr">&quot;signup&quot;</span>: {
7300 <span class="hljs-attr">&quot;allowed&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>
7301 },
7302 <span class="hljs-attr">&quot;transcoding&quot;</span>: {
7303 <span class="hljs-attr">&quot;enabledResolutions&quot;</span>: [
7304 <span class="hljs-string">&quot;number&quot;</span>
7305 ]
7306 },
7307 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7308 <span class="hljs-attr">&quot;file&quot;</span>: {
7309 <span class="hljs-attr">&quot;size&quot;</span>: {
7310 <span class="hljs-attr">&quot;max&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>
7311 }
7312 },
7313 <span class="hljs-attr">&quot;extensions&quot;</span>: [
7314 <span class="hljs-string">&quot;string&quot;</span>
7315 ]
7316 },
7317 <span class="hljs-attr">&quot;video&quot;</span>: {
7318 <span class="hljs-attr">&quot;file&quot;</span>: {
7319 <span class="hljs-attr">&quot;extensions&quot;</span>: [
7320 <span class="hljs-string">&quot;string&quot;</span>
7321 ]
7322 }
7323 }
7324 }
7325 </code></pre>
7326 <!-- </div> -->
7327 </section>
7328 </div>
7329 </div>
7330 </div>
7331 <div id="definition-Follow" class="definition panel" data-traverse-target="definition-Follow">
7332 <h2 class="panel-title">
7333 <a name="/definitions/Follow"></a>Follow:
7334 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7335 <span class="json-property-range" title="Value limits"></span>
7336
7337
7338 </span> -->
7339 </h2>
7340 <div class="doc-row">
7341 <div class="doc-copy">
7342 <section class="json-schema-properties">
7343 <dl>
7344 <dt data-property-name="id">
7345 <span class="json-property-name">id:</span>
7346 <span class="json-property-type">number</span>
7347 <span class="json-property-range" title="Value limits"></span>
7348 </dt>
7349 <dt data-property-name="follower">
7350 <span class="json-property-name">follower:</span>
7351 <span class="json-property-type">
7352 <span class="">
7353 <a class="json-schema-ref" href="#/definitions/Actor">Actor</a>
7354 </span>
7355 </span>
7356 <span class="json-property-range" title="Value limits"></span>
7357 </dt>
7358 <dt data-property-name="following">
7359 <span class="json-property-name">following:</span>
7360 <span class="json-property-type">
7361 <span class="">
7362 <a class="json-schema-ref" href="#/definitions/Actor">Actor</a>
7363 </span>
7364 </span>
7365 <span class="json-property-range" title="Value limits"></span>
7366 </dt>
7367 <dt data-property-name="score">
7368 <span class="json-property-name">score:</span>
7369 <span class="json-property-type">number</span>
7370 <span class="json-property-range" title="Value limits"></span>
7371 </dt>
7372 <dt data-property-name="state">
7373 <span class="json-property-name">state:</span>
7374 <span class="json-property-type">string</span>
7375 <span class="json-property-enum" title="Possible values">
7376 <span class="json-property-enum-item">pending</span>,
7377 <span class="json-property-enum-item">accepted</span>
7378 </span>
7379 <span class="json-property-range" title="Value limits"></span>
7380 </dt>
7381 <dt data-property-name="createdAt">
7382 <span class="json-property-name">createdAt:</span>
7383 <span class="json-property-type">string</span>
7384 <span class="json-property-range" title="Value limits"></span>
7385 </dt>
7386 <dt data-property-name="updatedAt">
7387 <span class="json-property-name">updatedAt:</span>
7388 <span class="json-property-type">string</span>
7389 <span class="json-property-range" title="Value limits"></span>
7390 </dt>
7391 </dl>
7392 </section>
7393 </div>
7394 <div class="doc-examples">
7395 <section>
7396 <h5>Example</h5>
7397 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7398 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7399 <span class="hljs-attr">&quot;follower&quot;</span>: {
7400 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7401 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7402 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7403 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7404 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7405 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7406 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7407 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7408 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7409 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7410 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7411 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7412 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7413 }
7414 },
7415 <span class="hljs-attr">&quot;following&quot;</span>: {
7416 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7417 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7418 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7419 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7420 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7421 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7422 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7423 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7424 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7425 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7426 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7427 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7428 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7429 }
7430 },
7431 <span class="hljs-attr">&quot;score&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7432 <span class="hljs-attr">&quot;state&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7433 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7434 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7435 }
7436 </code></pre>
7437 <!-- </div> -->
7438 </section>
7439 </div>
7440 </div>
7441 </div>
7442 <div id="definition-Job" class="definition panel" data-traverse-target="definition-Job">
7443 <h2 class="panel-title">
7444 <a name="/definitions/Job"></a>Job:
7445 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7446 <span class="json-property-range" title="Value limits"></span>
7447
7448
7449 </span> -->
7450 </h2>
7451 <div class="doc-row">
7452 <div class="doc-copy">
7453 <section class="json-schema-properties">
7454 <dl>
7455 <dt data-property-name="id">
7456 <span class="json-property-name">id:</span>
7457 <span class="json-property-type">number</span>
7458 <span class="json-property-range" title="Value limits"></span>
7459 </dt>
7460 <dt data-property-name="state">
7461 <span class="json-property-name">state:</span>
7462 <span class="json-property-type">string</span>
7463 <span class="json-property-enum" title="Possible values">
7464 <span class="json-property-enum-item">pending</span>,
7465 <span class="json-property-enum-item">processing</span>,
7466 <span class="json-property-enum-item">error</span>,
7467 <span class="json-property-enum-item">success</span>
7468 </span>
7469 <span class="json-property-range" title="Value limits"></span>
7470 </dt>
7471 <dt data-property-name="category">
7472 <span class="json-property-name">category:</span>
7473 <span class="json-property-type">string</span>
7474 <span class="json-property-enum" title="Possible values">
7475 <span class="json-property-enum-item">transcoding</span>,
7476 <span class="json-property-enum-item">activitypub-http</span>
7477 </span>
7478 <span class="json-property-range" title="Value limits"></span>
7479 </dt>
7480 <dt data-property-name="handlerName">
7481 <span class="json-property-name">handlerName:</span>
7482 <span class="json-property-type">string</span>
7483 <span class="json-property-range" title="Value limits"></span>
7484 </dt>
7485 <dt data-property-name="handlerInputData">
7486 <span class="json-property-name">handlerInputData:</span>
7487 <span class="json-property-type">string</span>
7488 <span class="json-property-range" title="Value limits"></span>
7489 </dt>
7490 <dt data-property-name="createdAt">
7491 <span class="json-property-name">createdAt:</span>
7492 <span class="json-property-type">string</span>
7493 <span class="json-property-range" title="Value limits"></span>
7494 </dt>
7495 <dt data-property-name="updatedAt">
7496 <span class="json-property-name">updatedAt:</span>
7497 <span class="json-property-type">string</span>
7498 <span class="json-property-range" title="Value limits"></span>
7499 </dt>
7500 </dl>
7501 </section>
7502 </div>
7503 <div class="doc-examples">
7504 <section>
7505 <h5>Example</h5>
7506 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7507 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7508 <span class="hljs-attr">&quot;state&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7509 <span class="hljs-attr">&quot;category&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7510 <span class="hljs-attr">&quot;handlerName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7511 <span class="hljs-attr">&quot;handlerInputData&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7512 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7513 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7514 }
7515 </code></pre>
7516 <!-- </div> -->
7517 </section>
7518 </div>
7519 </div>
7520 </div>
7521 <div id="definition-AddUserResponse" class="definition panel" data-traverse-target="definition-AddUserResponse">
7522 <h2 class="panel-title">
7523 <a name="/definitions/AddUserResponse"></a>AddUserResponse:
7524 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7525 <span class="json-property-range" title="Value limits"></span>
7526
7527
7528 </span> -->
7529 </h2>
7530 <div class="doc-row">
7531 <div class="doc-copy">
7532 <section class="json-schema-properties">
7533 <dl>
7534 <dt data-property-name="id">
7535 <span class="json-property-name">id:</span>
7536 <span class="json-property-type">number</span>
7537 <span class="json-property-range" title="Value limits"></span>
7538 </dt>
7539 <dt data-property-name="uuid">
7540 <span class="json-property-name">uuid:</span>
7541 <span class="json-property-type">string</span>
7542 <span class="json-property-range" title="Value limits"></span>
7543 </dt>
7544 </dl>
7545 </section>
7546 </div>
7547 <div class="doc-examples">
7548 <section>
7549 <h5>Example</h5>
7550 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7551 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7552 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7553 }
7554 </code></pre>
7555 <!-- </div> -->
7556 </section>
7557 </div>
7558 </div>
7559 </div>
7560 <div id="definition-VideoUploadResponse" class="definition panel" data-traverse-target="definition-VideoUploadResponse">
7561 <h2 class="panel-title">
7562 <a name="/definitions/VideoUploadResponse"></a>VideoUploadResponse:
7563 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7564 <span class="json-property-range" title="Value limits"></span>
7565
7566
7567 </span> -->
7568 </h2>
7569 <div class="doc-row">
7570 <div class="doc-copy">
7571 <section class="json-schema-properties">
7572 <dl>
7573 <dt data-property-name="video">
7574 <span class="json-property-name">video:</span>
7575 <span class="json-property-type">object</span>
7576 <span class="json-property-range" title="Value limits"></span>
7577 </dt>
7578 </dl>
7579 </section>
7580 </div>
7581 <div class="doc-examples">
7582 <section>
7583 <h5>Example</h5>
7584 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7585 <span class="hljs-attr">&quot;video&quot;</span>: {
7586 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7587 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7588 }
7589 }
7590 </code></pre>
7591 <!-- </div> -->
7592 </section>
7593 </div>
7594 </div>
7595 </div>
7596 <div id="definition-CommentThreadResponse" class="definition panel" data-traverse-target="definition-CommentThreadResponse">
7597 <h2 class="panel-title">
7598 <a name="/definitions/CommentThreadResponse"></a>CommentThreadResponse:
7599 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7600 <span class="json-property-range" title="Value limits"></span>
7601
7602
7603 </span> -->
7604 </h2>
7605 <div class="doc-row">
7606 <div class="doc-copy">
7607 <section class="json-schema-properties">
7608 <dl>
7609 <dt data-property-name="total">
7610 <span class="json-property-name">total:</span>
7611 <span class="json-property-type">number</span>
7612 <span class="json-property-range" title="Value limits"></span>
7613 </dt>
7614 <dt data-property-name="data">
7615 <span class="json-property-name">data:</span>
7616 <span class="json-property-type">
7617 <span class="json-schema-ref-array">
7618 <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
7619 </span>
7620 </span>
7621 <span class="json-property-range" title="Value limits"></span>
7622 </dt>
7623 </dl>
7624 </section>
7625 </div>
7626 <div class="doc-examples">
7627 <section>
7628 <h5>Example</h5>
7629 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7630 <span class="hljs-attr">&quot;total&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7631 <span class="hljs-attr">&quot;data&quot;</span>: [
7632 {
7633 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7634 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7635 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7636 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7637 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7638 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7639 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7640 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7641 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7642 <span class="hljs-attr">&quot;account&quot;</span>: {
7643 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7644 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7645 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7646 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7647 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7648 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7649 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7650 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7651 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7652 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7653 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7654 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7655 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7656 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7657 }
7658 }
7659 }
7660 ]
7661 }
7662 </code></pre>
7663 <!-- </div> -->
7664 </section>
7665 </div>
7666 </div>
7667 </div>
7668 <div id="definition-CommentThreadPostResponse" class="definition panel" data-traverse-target="definition-CommentThreadPostResponse">
7669 <h2 class="panel-title">
7670 <a name="/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse:
7671 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7672 <span class="json-property-range" title="Value limits"></span>
7673
7674
7675 </span> -->
7676 </h2>
7677 <div class="doc-row">
7678 <div class="doc-copy">
7679 <section class="json-schema-properties">
7680 <dl>
7681 <dt data-property-name="comment">
7682 <span class="json-property-name">comment:</span>
7683 <span class="json-property-type">
7684 <span class="">
7685 <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
7686 </span>
7687 </span>
7688 <span class="json-property-range" title="Value limits"></span>
7689 </dt>
7690 </dl>
7691 </section>
7692 </div>
7693 <div class="doc-examples">
7694 <section>
7695 <h5>Example</h5>
7696 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7697 <span class="hljs-attr">&quot;comment&quot;</span>: {
7698 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7699 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7700 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7701 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7702 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7703 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7704 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7705 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7706 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7707 <span class="hljs-attr">&quot;account&quot;</span>: {
7708 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7709 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7710 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7711 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7712 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7713 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7714 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7715 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7716 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7717 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7718 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7719 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7720 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7721 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7722 }
7723 }
7724 }
7725 }
7726 </code></pre>
7727 <!-- </div> -->
7728 </section>
7729 </div>
7730 </div>
7731 </div>
7732 <div id="definition-AddUser" class="definition panel" data-traverse-target="definition-AddUser">
7733 <h2 class="panel-title">
7734 <a name="/definitions/AddUser"></a>AddUser:
7735 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7736 <span class="json-property-range" title="Value limits"></span>
7737
7738
7739 </span> -->
7740 </h2>
7741 <div class="doc-row">
7742 <div class="doc-copy">
7743 <section class="json-schema-properties">
7744 <dl>
7745 <dt data-property-name="username" class="has-description">
7746 <span class="json-property-name">username:</span>
7747 <span class="json-property-type">string</span>
7748 <span class="json-property-range" title="Value limits"></span>
7749 <span class="json-property-required"></span>
7750 </dt>
7751 <dd>
7752 <p>The user username </p>
7753 </dd>
7754 <dt data-property-name="password" class="has-description">
7755 <span class="json-property-name">password:</span>
7756 <span class="json-property-type">string</span>
7757 <span class="json-property-range" title="Value limits"></span>
7758 <span class="json-property-required"></span>
7759 </dt>
7760 <dd>
7761 <p>The user password </p>
7762 </dd>
7763 <dt data-property-name="email" class="has-description">
7764 <span class="json-property-name">email:</span>
7765 <span class="json-property-type">string</span>
7766 <span class="json-property-range" title="Value limits"></span>
7767 <span class="json-property-required"></span>
7768 </dt>
7769 <dd>
7770 <p>The user email </p>
7771 </dd>
7772 <dt data-property-name="videoQuota" class="has-description">
7773 <span class="json-property-name">videoQuota:</span>
7774 <span class="json-property-type">string</span>
7775 <span class="json-property-range" title="Value limits"></span>
7776 <span class="json-property-required"></span>
7777 </dt>
7778 <dd>
7779 <p>The user videoQuota </p>
7780 </dd>
7781 <dt data-property-name="role" class="has-description">
7782 <span class="json-property-name">role:</span>
7783 <span class="json-property-type">string</span>
7784 <span class="json-property-range" title="Value limits"></span>
7785 <span class="json-property-required"></span>
7786 </dt>
7787 <dd>
7788 <p>The user role </p>
7789 </dd>
7790 </dl>
7791 </section>
7792 </div>
7793 <div class="doc-examples">
7794 <section>
7795 <h5>Example</h5>
7796 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7797 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7798 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7799 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7800 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7801 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7802 }
7803 </code></pre>
7804 <!-- </div> -->
7805 </section>
7806 </div>
7807 </div>
7808 </div>
7809 <div id="definition-UpdateUser" class="definition panel" data-traverse-target="definition-UpdateUser">
7810 <h2 class="panel-title">
7811 <a name="/definitions/UpdateUser"></a>UpdateUser:
7812 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7813 <span class="json-property-range" title="Value limits"></span>
7814
7815
7816 </span> -->
7817 </h2>
7818 <div class="doc-row">
7819 <div class="doc-copy">
7820 <section class="json-schema-properties">
7821 <dl>
7822 <dt data-property-name="id" class="has-description">
7823 <span class="json-property-name">id:</span>
7824 <span class="json-property-type">string</span>
7825 <span class="json-property-range" title="Value limits"></span>
7826 <span class="json-property-required"></span>
7827 </dt>
7828 <dd>
7829 <p>The user id </p>
7830 </dd>
7831 <dt data-property-name="email" class="has-description">
7832 <span class="json-property-name">email:</span>
7833 <span class="json-property-type">string</span>
7834 <span class="json-property-range" title="Value limits"></span>
7835 <span class="json-property-required"></span>
7836 </dt>
7837 <dd>
7838 <p>The updated email of the user </p>
7839 </dd>
7840 <dt data-property-name="videoQuota" class="has-description">
7841 <span class="json-property-name">videoQuota:</span>
7842 <span class="json-property-type">string</span>
7843 <span class="json-property-range" title="Value limits"></span>
7844 <span class="json-property-required"></span>
7845 </dt>
7846 <dd>
7847 <p>The updated videoQuota of the user </p>
7848 </dd>
7849 <dt data-property-name="role" class="has-description">
7850 <span class="json-property-name">role:</span>
7851 <span class="json-property-type">string</span>
7852 <span class="json-property-range" title="Value limits"></span>
7853 <span class="json-property-required"></span>
7854 </dt>
7855 <dd>
7856 <p>The updated role of the user </p>
7857 </dd>
7858 </dl>
7859 </section>
7860 </div>
7861 <div class="doc-examples">
7862 <section>
7863 <h5>Example</h5>
7864 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7865 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7866 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7867 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7868 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7869 }
7870 </code></pre>
7871 <!-- </div> -->
7872 </section>
7873 </div>
7874 </div>
7875 </div>
7876 <div id="definition-UpdateMe" class="definition panel" data-traverse-target="definition-UpdateMe">
7877 <h2 class="panel-title">
7878 <a name="/definitions/UpdateMe"></a>UpdateMe:
7879 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7880 <span class="json-property-range" title="Value limits"></span>
7881
7882
7883 </span> -->
7884 </h2>
7885 <div class="doc-row">
7886 <div class="doc-copy">
7887 <section class="json-schema-properties">
7888 <dl>
7889 <dt data-property-name="password" class="has-description">
7890 <span class="json-property-name">password:</span>
7891 <span class="json-property-type">string</span>
7892 <span class="json-property-range" title="Value limits"></span>
7893 <span class="json-property-required"></span>
7894 </dt>
7895 <dd>
7896 <p>Your new password </p>
7897 </dd>
7898 <dt data-property-name="email" class="has-description">
7899 <span class="json-property-name">email:</span>
7900 <span class="json-property-type">string</span>
7901 <span class="json-property-range" title="Value limits"></span>
7902 <span class="json-property-required"></span>
7903 </dt>
7904 <dd>
7905 <p>Your new email </p>
7906 </dd>
7907 <dt data-property-name="displayNSFW" class="has-description">
7908 <span class="json-property-name">displayNSFW:</span>
7909 <span class="json-property-type">string</span>
7910 <span class="json-property-range" title="Value limits"></span>
7911 <span class="json-property-required"></span>
7912 </dt>
7913 <dd>
7914 <p>Your new displayNSFW </p>
7915 </dd>
7916 <dt data-property-name="autoPlayVideo" class="has-description">
7917 <span class="json-property-name">autoPlayVideo:</span>
7918 <span class="json-property-type">string</span>
7919 <span class="json-property-range" title="Value limits"></span>
7920 <span class="json-property-required"></span>
7921 </dt>
7922 <dd>
7923 <p>Your new autoPlayVideo </p>
7924 </dd>
7925 </dl>
7926 </section>
7927 </div>
7928 <div class="doc-examples">
7929 <section>
7930 <h5>Example</h5>
7931 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7932 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7933 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7934 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7935 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7936 }
7937 </code></pre>
7938 <!-- </div> -->
7939 </section>
7940 </div>
7941 </div>
7942 </div>
7943 <div id="definition-GetMeVideoRating" class="definition panel" data-traverse-target="definition-GetMeVideoRating">
7944 <h2 class="panel-title">
7945 <a name="/definitions/GetMeVideoRating"></a>GetMeVideoRating:
7946 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7947 <span class="json-property-range" title="Value limits"></span>
7948
7949
7950 </span> -->
7951 </h2>
7952 <div class="doc-row">
7953 <div class="doc-copy">
7954 <section class="json-schema-properties">
7955 <dl>
7956 <dt data-property-name="id" class="has-description">
7957 <span class="json-property-name">id:</span>
7958 <span class="json-property-type">string</span>
7959 <span class="json-property-range" title="Value limits"></span>
7960 <span class="json-property-required"></span>
7961 </dt>
7962 <dd>
7963 <p>Id of the video </p>
7964 </dd>
7965 <dt data-property-name="rating" class="has-description">
7966 <span class="json-property-name">rating:</span>
7967 <span class="json-property-type">number</span>
7968 <span class="json-property-range" title="Value limits"></span>
7969 <span class="json-property-required"></span>
7970 </dt>
7971 <dd>
7972 <p>Rating of the video </p>
7973 </dd>
7974 </dl>
7975 </section>
7976 </div>
7977 <div class="doc-examples">
7978 <section>
7979 <h5>Example</h5>
7980 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7981 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7982 <span class="hljs-attr">&quot;rating&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>
7983 }
7984 </code></pre>
7985 <!-- </div> -->
7986 </section>
7987 </div>
7988 </div>
7989 </div>
7990 <div id="definition-RegisterUser" class="definition panel" data-traverse-target="definition-RegisterUser">
7991 <h2 class="panel-title">
7992 <a name="/definitions/RegisterUser"></a>RegisterUser:
7993 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7994 <span class="json-property-range" title="Value limits"></span>
7995
7996
7997 </span> -->
7998 </h2>
7999 <div class="doc-row">
8000 <div class="doc-copy">
8001 <section class="json-schema-properties">
8002 <dl>
8003 <dt data-property-name="username" class="has-description">
8004 <span class="json-property-name">username:</span>
8005 <span class="json-property-type">string</span>
8006 <span class="json-property-range" title="Value limits"></span>
8007 <span class="json-property-required"></span>
8008 </dt>
8009 <dd>
8010 <p>The username of the user </p>
8011 </dd>
8012 <dt data-property-name="password" class="has-description">
8013 <span class="json-property-name">password:</span>
8014 <span class="json-property-type">string</span>
8015 <span class="json-property-range" title="Value limits"></span>
8016 <span class="json-property-required"></span>
8017 </dt>
8018 <dd>
8019 <p>The password of the user </p>
8020 </dd>
8021 <dt data-property-name="email" class="has-description">
8022 <span class="json-property-name">email:</span>
8023 <span class="json-property-type">string</span>
8024 <span class="json-property-range" title="Value limits"></span>
8025 <span class="json-property-required"></span>
8026 </dt>
8027 <dd>
8028 <p>The email of the user </p>
8029 </dd>
8030 </dl>
8031 </section>
8032 </div>
8033 <div class="doc-examples">
8034 <section>
8035 <h5>Example</h5>
8036 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8037 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8038 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8039 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
8040 }
8041 </code></pre>
8042 <!-- </div> -->
8043 </section>
8044 </div>
8045 </div>
8046 </div>
8047 <div id="definition-VideoChannelInput" class="definition panel" data-traverse-target="definition-VideoChannelInput">
8048 <h2 class="panel-title">
8049 <a name="/definitions/VideoChannelInput"></a>VideoChannelInput:
8050 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8051 <span class="json-property-range" title="Value limits"></span>
8052
8053
8054 </span> -->
8055 </h2>
8056 <div class="doc-row">
8057 <div class="doc-copy">
8058 <section class="json-schema-properties">
8059 <dl>
8060 <dt data-property-name="name">
8061 <span class="json-property-name">name:</span>
8062 <span class="json-property-type">string</span>
8063 <span class="json-property-range" title="Value limits"></span>
8064 </dt>
8065 <dt data-property-name="description">
8066 <span class="json-property-name">description:</span>
8067 <span class="json-property-type">string</span>
8068 <span class="json-property-range" title="Value limits"></span>
8069 </dt>
8070 </dl>
8071 </section>
8072 </div>
8073 <div class="doc-examples">
8074 <section>
8075 <h5>Example</h5>
8076 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8077 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8078 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
8079 }
8080 </code></pre>
8081 <!-- </div> -->
8082 </section>
8083 </div>
8084 </div>
8085 </div>
8086 <div class="doc-row no-margin">
8087 <div class="doc-copy doc-separator">
8088 <a class="powered-by" href="https://sourcey.com/spectacle">Documentation by
8089 <span>Spectacle</span>
8090 </a>
8091 </div>
8092 </div>
8093 </article>
8094 </div>
8095 </div>
8096 </body>
8097 </html>