]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blob - support/doc/api/html/index.html
Fix start/count/sort params in documentation
[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--name--get"> GET /accounts/{name} </a>
29 </li>
30 <li>
31 <a href="#operation--accounts--name--videos-get"> GET /accounts/{name}/videos </a>
32 </li>
33 <li>
34 <a href="#operation--accounts-get"> GET /accounts </a>
35 </li>
36 </ul>
37 </section>
38 <section>
39 <a href="#tag-Config">Config</a>
40 <ul>
41 <li>
42 <a href="#operation--config-get"> GET /config </a>
43 </li>
44 </ul>
45 </section>
46 <section>
47 <a href="#tag-Feeds">Feeds</a>
48 <ul>
49 <li>
50 <a href="#operation--feeds-videos.-format--get"> GET /feeds/videos.{format} </a>
51 </li>
52 </ul>
53 </section>
54 <section>
55 <a href="#tag-Job">Job</a>
56 <ul>
57 <li>
58 <a href="#operation--jobs-get"> GET /jobs </a>
59 </li>
60 </ul>
61 </section>
62 <section>
63 <a href="#tag-ServerFollowing">ServerFollowing</a>
64 <ul>
65 <li>
66 <a href="#operation--server-following--host--delete"> DELETE /server/following/{host} </a>
67 </li>
68 <li>
69 <a href="#operation--server-followers-get"> GET /server/followers </a>
70 </li>
71 <li>
72 <a href="#operation--server-following-get"> GET /server/following </a>
73 </li>
74 <li>
75 <a href="#operation--server-following-post"> POST /server/following </a>
76 </li>
77 </ul>
78 </section>
79 <section>
80 <a href="#tag-User">User</a>
81 <ul>
82 <li>
83 <a href="#operation--users-post"> POST /users </a>
84 </li>
85 <li>
86 <a href="#operation--users-get"> GET /users </a>
87 </li>
88 <li>
89 <a href="#operation--users--id--delete"> DELETE /users/{id} </a>
90 </li>
91 <li>
92 <a href="#operation--users--id--get"> GET /users/{id} </a>
93 </li>
94 <li>
95 <a href="#operation--users--id--put"> PUT /users/{id} </a>
96 </li>
97 <li>
98 <a href="#operation--users-me-get"> GET /users/me </a>
99 </li>
100 <li>
101 <a href="#operation--users-me-put"> PUT /users/me </a>
102 </li>
103 <li>
104 <a href="#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used </a>
105 </li>
106 <li>
107 <a href="#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating </a>
108 </li>
109 <li>
110 <a href="#operation--users-me-videos-get"> GET /users/me/videos </a>
111 </li>
112 <li>
113 <a href="#operation--users-register-post"> POST /users/register </a>
114 </li>
115 <li>
116 <a href="#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick </a>
117 </li>
118 </ul>
119 </section>
120 <section>
121 <a href="#tag-Video">Video</a>
122 <ul>
123 <li>
124 <a href="#operation--videos-get"> GET /videos </a>
125 </li>
126 <li>
127 <a href="#operation--videos-categories-get"> GET /videos/categories </a>
128 </li>
129 <li>
130 <a href="#operation--videos-licences-get"> GET /videos/licences </a>
131 </li>
132 <li>
133 <a href="#operation--videos-languages-get"> GET /videos/languages </a>
134 </li>
135 <li>
136 <a href="#operation--videos-privacies-get"> GET /videos/privacies </a>
137 </li>
138 <li>
139 <a href="#operation--videos-search-get"> GET /videos/search </a>
140 </li>
141 <li>
142 <a href="#operation--videos--id--put"> PUT /videos/{id} </a>
143 </li>
144 <li>
145 <a href="#operation--videos--id--get"> GET /videos/{id} </a>
146 </li>
147 <li>
148 <a href="#operation--videos--id--delete"> DELETE /videos/{id} </a>
149 </li>
150 <li>
151 <a href="#operation--videos--id--description-get"> GET /videos/{id}/description </a>
152 </li>
153 <li>
154 <a href="#operation--videos--id--views-post"> POST /videos/{id}/views </a>
155 </li>
156 <li>
157 <a href="#operation--videos-upload-post"> POST /videos/upload </a>
158 </li>
159 </ul>
160 </section>
161 <section>
162 <a href="#tag-VideoAbuse">VideoAbuse</a>
163 <ul>
164 <li>
165 <a href="#operation--videos-abuse-get"> GET /videos/abuse </a>
166 </li>
167 <li>
168 <a href="#operation--videos--id--abuse-post"> POST /videos/{id}/abuse </a>
169 </li>
170 </ul>
171 </section>
172 <section>
173 <a href="#tag-VideoBlacklist">VideoBlacklist</a>
174 <ul>
175 <li>
176 <a href="#operation--videos--id--blacklist-post"> POST /videos/{id}/blacklist </a>
177 </li>
178 <li>
179 <a href="#operation--videos--id--blacklist-delete"> DELETE /videos/{id}/blacklist </a>
180 </li>
181 <li>
182 <a href="#operation--videos-blacklist-get"> GET /videos/blacklist </a>
183 </li>
184 </ul>
185 </section>
186 <section>
187 <a href="#tag-VideoChannel">VideoChannel</a>
188 <ul>
189 <li>
190 <a href="#operation--video-channels-get"> GET /video-channels </a>
191 </li>
192 <li>
193 <a href="#operation--video-channels-post"> POST /video-channels </a>
194 </li>
195 <li>
196 <a href="#operation--video-channels--id--get"> GET /video-channels/{id} </a>
197 </li>
198 <li>
199 <a href="#operation--video-channels--id--put"> PUT /video-channels/{id} </a>
200 </li>
201 <li>
202 <a href="#operation--video-channels--id--delete"> DELETE /video-channels/{id} </a>
203 </li>
204 <li>
205 <a href="#operation--video-channels--id--videos-get"> GET /video-channels/{id}/videos </a>
206 </li>
207 <li>
208 <a href="#operation--accounts--name--video-channels-get"> GET /accounts/{name}/video-channels </a>
209 </li>
210 </ul>
211 </section>
212 <section>
213 <a href="#tag-VideoComment">VideoComment</a>
214 <ul>
215 <li>
216 <a href="#operation--videos--id--comment-threads-get"> GET /videos/{id}/comment-threads </a>
217 </li>
218 <li>
219 <a href="#operation--videos--id--comment-threads-post"> POST /videos/{id}/comment-threads </a>
220 </li>
221 <li>
222 <a href="#operation--videos--id--comment-threads--threadId--get"> GET /videos/{id}/comment-threads/{threadId} </a>
223 </li>
224 <li>
225 <a href="#operation--videos--id--comments--commentId--post"> POST /videos/{id}/comments/{commentId} </a>
226 </li>
227 <li>
228 <a href="#operation--videos--id--comments--commentId--delete"> DELETE /videos/{id}/comments/{commentId} </a>
229 </li>
230 </ul>
231 </section>
232 <section>
233 <a href="#tag-VideoRate">VideoRate</a>
234 <ul>
235 <li>
236 <a href="#operation--videos--id--rate-put"> PUT /videos/{id}/rate </a>
237 </li>
238 </ul>
239 </section>
240 <h5>Schema Definitions</h5>
241 <a href="#definition-VideoConstantNumber"> VideoConstantNumber </a>
242 <a href="#definition-VideoConstantString"> VideoConstantString </a>
243 <a href="#definition-VideoPrivacy"> VideoPrivacy </a>
244 <a href="#definition-Video"> Video </a>
245 <a href="#definition-VideoAbuse"> VideoAbuse </a>
246 <a href="#definition-VideoBlacklist"> VideoBlacklist </a>
247 <a href="#definition-VideoChannel"> VideoChannel </a>
248 <a href="#definition-VideoComment"> VideoComment </a>
249 <a href="#definition-VideoCommentThreadTree"> VideoCommentThreadTree </a>
250 <a href="#definition-Avatar"> Avatar </a>
251 <a href="#definition-Actor"> Actor </a>
252 <a href="#definition-Account"> Account </a>
253 <a href="#definition-User"> User </a>
254 <a href="#definition-ServerConfig"> ServerConfig </a>
255 <a href="#definition-Follow"> Follow </a>
256 <a href="#definition-Job"> Job </a>
257 <a href="#definition-AddUserResponse"> AddUserResponse </a>
258 <a href="#definition-VideoUploadResponse"> VideoUploadResponse </a>
259 <a href="#definition-CommentThreadResponse"> CommentThreadResponse </a>
260 <a href="#definition-CommentThreadPostResponse"> CommentThreadPostResponse </a>
261 <a href="#definition-AddUser"> AddUser </a>
262 <a href="#definition-UpdateUser"> UpdateUser </a>
263 <a href="#definition-UpdateMe"> UpdateMe </a>
264 <a href="#definition-GetMeVideoRating"> GetMeVideoRating </a>
265 <a href="#definition-RegisterUser"> RegisterUser </a>
266 <a href="#definition-VideoChannelInput"> VideoChannelInput </a>
267 </nav>
268 </div>
269 <div id="docs" class="row collapse expanded drawer" data-drawer>
270 <button class="floating-menu-icon" type="button" data-drawer-slide="right">
271 <span class="hamburger"></span>
272 </button>
273 <div class="example-box doc-content"></div>
274 <article>
275 <h1 class="doc-title">PeerTube
276 <span>API Reference</span>
277 </h1>
278 <div id="introduction" data-traverse-target="introduction">
279 <div class="doc-row">
280 <div class="doc-copy">
281 <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.</p>
282 </div>
283 <div class="doc-examples">
284 <section>
285 <h5>API Endpoint</h5>
286 <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre>
287 <!-- </div> -->
288 <h5>Schemes:
289 <span>https</span>
290 </h5>
291 <h5>Version:
292 <span>1.0.0-beta</span>
293 </h5>
294 </section>
295 </div>
296 </div>
297 </div>
298 <!-- <h1 id="security" data-traverse-target="security">Security</h1> -->
299 <h1 id="authentication" data-traverse-target="authentication">Authentication</h1>
300 <div id="security-definition-OAuth2" class="panel">
301 <div class="doc-row">
302 <div class="doc-copy">
303 <h3 class="security-definition-title">
304 <span class="security-name">OAuth2</span>
305 <span class="swagger-security-definition-oauth2"></span>
306 </h3>
307 <section class="security-definition-description">
308 <p>In the header:
309 <em>Authorization: Bearer mytoken</em>
310 </p>
311 </section>
312 <section class="swagger-security-definition-properties">
313 <div class="prop-row security-definition-property">
314 <div class="prop-name">
315 <div class="prop-title security-definition-property-name">type</div>
316 </div>
317 <div class="prop-value security-definition-property-type"> oauth2 </div>
318 </div>
319 <div class="prop-row security-definition-property">
320 <div class="prop-name">
321 <div class="prop-title security-definition-property-name">flow</div>
322 </div>
323 <div class="prop-value security-definition-property-type"> password </div>
324 </div>
325 <div class="prop-row security-definition-property">
326 <div class="prop-name">
327 <div class="prop-title security-definition-property-name">tokenUrl</div>
328 </div>
329 <div class="prop-value security-definition-property-type"> https://peertube.example.com/api/v1/users/token </div>
330 </div>
331 </section>
332 </div>
333 </div>
334 </div>
335 <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1>
336 <div id="operation--accounts--name--get" class="operation panel" data-traverse-target="operation--accounts--name--get">
337 <!-- <section class="operation-tags row"> -->
338 <!-- <div class="doc-copy"> -->
339 <div class="operation-tags">
340 <a class="label" href="#tag-Accounts">Accounts</a>
341 <!---->
342 </div>
343 <!-- </div> -->
344 <!-- </section> -->
345 <h2 class="operation-title">
346 <span class="operation-name">
347 <span class="operation-name">GET</span>
348 <span class="operation-path">/accounts/{name}</span>
349 </span>
350 </h2>
351 <div class="doc-row">
352 <div class="doc-copy">
353 <section class="swagger-request-params">
354 <div class="prop-row prop-group">
355 <div class="prop-name">
356 <div class="prop-title">name:
357 <span class="prop-type">
358 <span class="json-property-type">string</span>
359 <span class="json-property-range" title="Value limits"></span>
360 </span>
361 </div>
362 <span class="json-property-required"></span>
363 <div class="prop-subtitle"> in path </div>
364 </div>
365 <div class="prop-value">
366 <p>The name of the account (chocobozzz or
367 <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p>
368 </div>
369 </div>
370 <div class="prop-row prop-group">
371 <div class="prop-name">
372 <div class="prop-title">start:
373 <span class="prop-type">
374 <span class="json-property-type">number</span>
375 <span class="json-property-range" title="Value limits"></span>
376 </span>
377 </div>
378 <div class="prop-subtitle"> in query </div>
379 </div>
380 <div class="prop-value">
381 <p>Offset</p>
382 </div>
383 </div>
384 <div class="prop-row prop-group">
385 <div class="prop-name">
386 <div class="prop-title">count:
387 <span class="prop-type">
388 <span class="json-property-type">number</span>
389 <span class="json-property-range" title="Value limits"></span>
390 </span>
391 </div>
392 <div class="prop-subtitle"> in query </div>
393 </div>
394 <div class="prop-value">
395 <p>Number of items</p>
396 </div>
397 </div>
398 <div class="prop-row prop-group">
399 <div class="prop-name">
400 <div class="prop-title">sort:
401 <span class="prop-type">
402 <span class="json-property-type">string</span>
403 <span class="json-property-range" title="Value limits"></span>
404 </span>
405 </div>
406 <div class="prop-subtitle"> in query </div>
407 </div>
408 <div class="prop-value">
409 <p>Sort column (-createdAt for example)</p>
410 </div>
411 </div>
412 </section>
413 </div>
414 <div class="doc-examples"></div>
415 </div>
416 <div class="doc-row">
417 <div class="doc-copy">
418 <section class="swagger-responses">
419 <div class="prop-row prop-group">
420 <div class="prop-name">
421 <div class="prop-title">200 OK</div>
422 <div class="prop-ref">
423 <span class="">
424 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
425 </span>
426 </div>
427 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
428 </div>
429 <div class="prop-value">
430 <p>successful operation</p>
431 </div>
432 </div>
433 </section>
434 </div>
435 <div class="doc-examples">
436 <h5>Response Content-Types:
437 <span>application/json</span>
438 </h5>
439 <section>
440 <h5>Response Example
441 <span>(200 OK)</span>
442 </h5>
443 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
444 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
445 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
446 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
447 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
448 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
449 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
450 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
451 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
452 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
453 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
454 <span class="hljs-attr">&quot;avatar&quot;</span>: {
455 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
456 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
457 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
458 }
459 }
460 </code></pre>
461 <!-- </div> -->
462 </section>
463 </div>
464 </div>
465 </div>
466 <div id="operation--accounts--name--videos-get" class="operation panel" data-traverse-target="operation--accounts--name--videos-get">
467 <!-- <section class="operation-tags row"> -->
468 <!-- <div class="doc-copy"> -->
469 <div class="operation-tags">
470 <a class="label" href="#tag-Accounts">Accounts</a>
471 <!---->
472 </div>
473 <!-- </div> -->
474 <!-- </section> -->
475 <h2 class="operation-title">
476 <span class="operation-name">
477 <span class="operation-name">GET</span>
478 <span class="operation-path">/accounts/{name}/videos</span>
479 </span>
480 </h2>
481 <div class="doc-row">
482 <div class="doc-copy">
483 <section class="swagger-request-params">
484 <div class="prop-row prop-group">
485 <div class="prop-name">
486 <div class="prop-title">name:
487 <span class="prop-type">
488 <span class="json-property-type">string</span>
489 <span class="json-property-range" title="Value limits"></span>
490 </span>
491 </div>
492 <span class="json-property-required"></span>
493 <div class="prop-subtitle"> in path </div>
494 </div>
495 <div class="prop-value">
496 <p>The name of the account (chocobozzz or
497 <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p>
498 </div>
499 </div>
500 </section>
501 </div>
502 <div class="doc-examples"></div>
503 </div>
504 <div class="doc-row">
505 <div class="doc-copy">
506 <section class="swagger-responses">
507 <div class="prop-row prop-group">
508 <div class="prop-name">
509 <div class="prop-title">200 OK</div>
510 <div class="prop-ref">
511 <span class="">
512 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
513 </span>
514 </div>
515 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
516 </div>
517 <div class="prop-value">
518 <p>successful operation</p>
519 </div>
520 </div>
521 </section>
522 </div>
523 <div class="doc-examples">
524 <h5>Response Content-Types:
525 <span>application/json</span>
526 </h5>
527 <section>
528 <h5>Response Example
529 <span>(200 OK)</span>
530 </h5>
531 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
532 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
533 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
534 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
535 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
536 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
537 <span class="hljs-attr">&quot;category&quot;</span>: {
538 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
539 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
540 },
541 <span class="hljs-attr">&quot;licence&quot;</span>: {
542 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
543 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
544 },
545 <span class="hljs-attr">&quot;language&quot;</span>: {
546 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
547 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
548 },
549 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
550 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
551 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
552 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
553 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
554 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
555 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
556 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
557 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
558 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
559 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
560 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
561 <span class="hljs-attr">&quot;account&quot;</span>: {
562 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
563 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
564 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
565 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
566 <span class="hljs-attr">&quot;avatar&quot;</span>: {
567 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
568 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
569 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
570 }
571 }
572 }
573 </code></pre>
574 <!-- </div> -->
575 </section>
576 </div>
577 </div>
578 </div>
579 <div id="operation--accounts-get" class="operation panel" data-traverse-target="operation--accounts-get">
580 <!-- <section class="operation-tags row"> -->
581 <!-- <div class="doc-copy"> -->
582 <div class="operation-tags">
583 <a class="label" href="#tag-Accounts">Accounts</a>
584 <!---->
585 </div>
586 <!-- </div> -->
587 <!-- </section> -->
588 <h2 class="operation-title">
589 <span class="operation-name">
590 <span class="operation-name">GET</span>
591 <span class="operation-path">/accounts</span>
592 </span>
593 </h2>
594 <div class="doc-row">
595 <div class="doc-copy"> </div>
596 <div class="doc-examples"></div>
597 </div>
598 <div class="doc-row">
599 <div class="doc-copy">
600 <section class="swagger-responses">
601 <div class="prop-row prop-group">
602 <div class="prop-name">
603 <div class="prop-title">200 OK</div>
604 <div class="prop-ref">
605 <span class="json-schema-ref-array">
606 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
607 </span>
608 </div>
609 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
610 </div>
611 <div class="prop-value">
612 <p>successful operation</p>
613 </div>
614 </div>
615 <div class="prop-row prop-inner">
616 <div class="prop-name">type</div>
617 <div class="prop-value">
618 <span class="json-property-type">
619 <span class="json-schema-ref-array">
620 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
621 </span>
622 </span>
623 <span class="json-property-range" title="Value limits"></span>
624 </div>
625 </div>
626 </section>
627 </div>
628 <div class="doc-examples">
629 <h5>Response Content-Types:
630 <span>application/json</span>
631 </h5>
632 <section>
633 <h5>Response Example
634 <span>(200 OK)</span>
635 </h5>
636 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
637 {
638 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
639 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
640 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
641 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
642 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
643 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
644 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
645 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
646 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
647 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
648 <span class="hljs-attr">&quot;avatar&quot;</span>: {
649 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
650 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
651 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
652 }
653 }
654 ]
655 </code></pre>
656 <!-- </div> -->
657 </section>
658 </div>
659 </div>
660 </div>
661 <h1 id="tag-Config" class="swagger-summary-tag" data-traverse-target="tag-Config">Config</h1>
662 <div id="operation--config-get" class="operation panel" data-traverse-target="operation--config-get">
663 <!-- <section class="operation-tags row"> -->
664 <!-- <div class="doc-copy"> -->
665 <div class="operation-tags">
666 <a class="label" href="#tag-Config">Config</a>
667 <!---->
668 </div>
669 <!-- </div> -->
670 <!-- </section> -->
671 <h2 class="operation-title">
672 <span class="operation-name">
673 <span class="operation-name">GET</span>
674 <span class="operation-path">/config</span>
675 </span>
676 </h2>
677 <div class="doc-row">
678 <div class="doc-copy"> </div>
679 <div class="doc-examples"></div>
680 </div>
681 <div class="doc-row">
682 <div class="doc-copy">
683 <section class="swagger-responses">
684 <div class="prop-row prop-group">
685 <div class="prop-name">
686 <div class="prop-title">200 OK</div>
687 <div class="prop-ref">
688 <span class="">
689 <a class="json-schema-ref" href="#/definitions/ServerConfig">ServerConfig</a>
690 </span>
691 </div>
692 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
693 </div>
694 <div class="prop-value">
695 <p>successful operation</p>
696 </div>
697 </div>
698 </section>
699 </div>
700 <div class="doc-examples">
701 <h5>Response Content-Types:
702 <span>application/json</span>
703 </h5>
704 <section>
705 <h5>Response Example
706 <span>(200 OK)</span>
707 </h5>
708 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
709 <span class="hljs-attr">&quot;signup&quot;</span>: {
710 <span class="hljs-attr">&quot;allowed&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>
711 },
712 <span class="hljs-attr">&quot;transcoding&quot;</span>: {
713 <span class="hljs-attr">&quot;enabledResolutions&quot;</span>: [
714 <span class="hljs-string">&quot;number&quot;</span>
715 ]
716 },
717 <span class="hljs-attr">&quot;avatar&quot;</span>: {
718 <span class="hljs-attr">&quot;file&quot;</span>: {
719 <span class="hljs-attr">&quot;size&quot;</span>: {
720 <span class="hljs-attr">&quot;max&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>
721 }
722 },
723 <span class="hljs-attr">&quot;extensions&quot;</span>: [
724 <span class="hljs-string">&quot;string&quot;</span>
725 ]
726 },
727 <span class="hljs-attr">&quot;video&quot;</span>: {
728 <span class="hljs-attr">&quot;file&quot;</span>: {
729 <span class="hljs-attr">&quot;extensions&quot;</span>: [
730 <span class="hljs-string">&quot;string&quot;</span>
731 ]
732 }
733 }
734 }
735 </code></pre>
736 <!-- </div> -->
737 </section>
738 </div>
739 </div>
740 </div>
741 <h1 id="tag-Feeds" class="swagger-summary-tag" data-traverse-target="tag-Feeds">Feeds</h1>
742 <div id="operation--feeds-videos.-format--get" class="operation panel" data-traverse-target="operation--feeds-videos.-format--get">
743 <!-- <section class="operation-tags row"> -->
744 <!-- <div class="doc-copy"> -->
745 <div class="operation-tags">
746 <a class="label" href="#tag-Feeds">Feeds</a>
747 <!---->
748 </div>
749 <!-- </div> -->
750 <!-- </section> -->
751 <h2 class="operation-title">
752 <span class="operation-name">
753 <span class="operation-name">GET</span>
754 <span class="operation-path">/feeds/videos.{format}</span>
755 </span>
756 </h2>
757 <div class="doc-row">
758 <div class="doc-copy">
759 <section class="swagger-request-params">
760 <div class="prop-row prop-group">
761 <div class="prop-name">
762 <div class="prop-title">format:
763 <span class="prop-type">
764 <span class="json-property-type">string</span>
765 <span class="json-property-enum" title="Possible values">
766 <span class="json-property-enum-item json-property-enum-default-value">xml</span>,
767 <span class="json-property-enum-item">atom</span>,
768 <span class="json-property-enum-item">json</span>
769 </span>
770 <span class="json-property-range" title="Value limits"></span>
771 <span class="json-property-default-value" title="Default value">xml</span>
772 </span>
773 </div>
774 <span class="json-property-required"></span>
775 <div class="prop-subtitle"> in path </div>
776 </div>
777 <div class="prop-value">
778 <p>The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0</p>
779 </div>
780 </div>
781 <div class="prop-row prop-group">
782 <div class="prop-name">
783 <div class="prop-title">accountId:
784 <span class="prop-type">
785 <span class="json-property-type">number</span>
786 <span class="json-property-range" title="Value limits"></span>
787 </span>
788 </div>
789 <div class="prop-subtitle"> in query </div>
790 </div>
791 <div class="prop-value">
792 <p>The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds</p>
793 </div>
794 </div>
795 <div class="prop-row prop-group">
796 <div class="prop-name">
797 <div class="prop-title">accountName:
798 <span class="prop-type">
799 <span class="json-property-type">string</span>
800 <span class="json-property-range" title="Value limits"></span>
801 </span>
802 </div>
803 <div class="prop-subtitle"> in query </div>
804 </div>
805 <div class="prop-value">
806 <p>The name of the local account to filter to</p>
807 </div>
808 </div>
809 </section>
810 </div>
811 <div class="doc-examples"></div>
812 </div>
813 <div class="doc-row">
814 <div class="doc-copy">
815 <section class="swagger-responses">
816 <div class="prop-row prop-group">
817 <div class="prop-name">
818 <div class="prop-title">200 OK</div>
819 </div>
820 <div class="prop-value">
821 <p>successful operation</p>
822 </div>
823 </div>
824 </section>
825 </div>
826 <div class="doc-examples">
827 <h5>Response Content-Types:
828 <span>application/atom+xml, application/rss+xml, application/json</span>
829 </h5>
830 </div>
831 </div>
832 </div>
833 <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1>
834 <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get">
835 <!-- <section class="operation-tags row"> -->
836 <!-- <div class="doc-copy"> -->
837 <div class="operation-tags">
838 <a class="label" href="#tag-Job">Job</a>
839 <!---->
840 </div>
841 <!-- </div> -->
842 <!-- </section> -->
843 <h2 class="operation-title">
844 <span class="operation-name">
845 <span class="operation-name">GET</span>
846 <span class="operation-path">/jobs</span>
847 </span>
848 </h2>
849 <div class="doc-row">
850 <div class="doc-copy">
851 <section class="swagger-request-params">
852 <div class="prop-row prop-group">
853 <div class="prop-name">
854 <div class="prop-title">state:
855 <span class="prop-type">
856 <span class="json-property-type">string</span>
857 <span class="json-property-range" title="Value limits"></span>
858 </span>
859 </div>
860 <span class="json-property-required"></span>
861 <div class="prop-subtitle"> in path </div>
862 </div>
863 <div class="prop-value">
864 <p>The state of the job</p>
865 </div>
866 </div>
867 <div class="prop-row prop-group">
868 <div class="prop-name">
869 <div class="prop-title">start:
870 <span class="prop-type">
871 <span class="json-property-type">number</span>
872 <span class="json-property-range" title="Value limits"></span>
873 </span>
874 </div>
875 <div class="prop-subtitle"> in query </div>
876 </div>
877 <div class="prop-value">
878 <p>Offset</p>
879 </div>
880 </div>
881 <div class="prop-row prop-group">
882 <div class="prop-name">
883 <div class="prop-title">count:
884 <span class="prop-type">
885 <span class="json-property-type">number</span>
886 <span class="json-property-range" title="Value limits"></span>
887 </span>
888 </div>
889 <div class="prop-subtitle"> in query </div>
890 </div>
891 <div class="prop-value">
892 <p>Number of items</p>
893 </div>
894 </div>
895 <div class="prop-row prop-group">
896 <div class="prop-name">
897 <div class="prop-title">sort:
898 <span class="prop-type">
899 <span class="json-property-type">string</span>
900 <span class="json-property-range" title="Value limits"></span>
901 </span>
902 </div>
903 <div class="prop-subtitle"> in query </div>
904 </div>
905 <div class="prop-value">
906 <p>Sort column (-createdAt for example)</p>
907 </div>
908 </div>
909 </section>
910 </div>
911 <div class="doc-examples"></div>
912 </div>
913 <div class="doc-row">
914 <div class="doc-copy">
915 <section class="swagger-responses">
916 <div class="prop-row prop-group">
917 <div class="prop-name">
918 <div class="prop-title">200 OK</div>
919 <div class="prop-ref">
920 <span class="json-schema-ref-array">
921 <a class="json-schema-ref" href="#/definitions/Job">Job</a>
922 </span>
923 </div>
924 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
925 </div>
926 <div class="prop-value">
927 <p>successful operation</p>
928 </div>
929 </div>
930 <div class="prop-row prop-inner">
931 <div class="prop-name">type</div>
932 <div class="prop-value">
933 <span class="json-property-type">
934 <span class="json-schema-ref-array">
935 <a class="json-schema-ref" href="#/definitions/Job">Job</a>
936 </span>
937 </span>
938 <span class="json-property-range" title="Value limits"></span>
939 </div>
940 </div>
941 </section>
942 </div>
943 <div class="doc-examples">
944 <h5>Response Content-Types:
945 <span>application/json</span>
946 </h5>
947 <section>
948 <h5>Response Example
949 <span>(200 OK)</span>
950 </h5>
951 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
952 {
953 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
954 <span class="hljs-attr">&quot;state&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
955 <span class="hljs-attr">&quot;category&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
956 <span class="hljs-attr">&quot;handlerName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
957 <span class="hljs-attr">&quot;handlerInputData&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
958 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
959 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
960 }
961 ]
962 </code></pre>
963 <!-- </div> -->
964 </section>
965 </div>
966 </div>
967 <div class="doc-row">
968 <div class="doc-copy">
969 <section class="swagger-request-security">
970 <table class="table">
971 <thead>
972 <tr>
973 <th class="swagger-request-security-schema"></th>
974 <th class="swagger-request-security-scopes"></th>
975 </tr>
976 </thead>
977 <tbody>
978 <tr>
979 <td>
980 <a href="#security-definition-OAuth2">OAuth2</a>
981 </td>
982 <td> </td>
983 </tr>
984 </tbody>
985 </table>
986 </section>
987 </div>
988 </div>
989 </div>
990 <h1 id="tag-ServerFollowing" class="swagger-summary-tag" data-traverse-target="tag-ServerFollowing">ServerFollowing</h1>
991 <div id="operation--server-following--host--delete" class="operation panel" data-traverse-target="operation--server-following--host--delete">
992 <!-- <section class="operation-tags row"> -->
993 <!-- <div class="doc-copy"> -->
994 <div class="operation-tags">
995 <a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
996 <!---->
997 </div>
998 <!-- </div> -->
999 <!-- </section> -->
1000 <h2 class="operation-title">
1001 <span class="operation-name">
1002 <span class="operation-name">DELETE</span>
1003 <span class="operation-path">/server/following/{host}</span>
1004 </span>
1005 </h2>
1006 <div class="doc-row">
1007 <div class="doc-copy">
1008 <section class="swagger-request-params">
1009 <div class="prop-row prop-group">
1010 <div class="prop-name">
1011 <div class="prop-title">host:
1012 <span class="prop-type">
1013 <span class="json-property-type">string</span>
1014 <span class="json-property-range" title="Value limits"></span>
1015 </span>
1016 </div>
1017 <span class="json-property-required"></span>
1018 <div class="prop-subtitle"> in path </div>
1019 </div>
1020 <div class="prop-value">
1021 <p>The host to unfollow </p>
1022 </div>
1023 </div>
1024 </section>
1025 </div>
1026 <div class="doc-examples"></div>
1027 </div>
1028 <div class="doc-row">
1029 <div class="doc-copy">
1030 <section class="swagger-responses">
1031 <div class="prop-row prop-group">
1032 <div class="prop-name">
1033 <div class="prop-title">201 Created</div>
1034 </div>
1035 <div class="prop-value">
1036 <p>successful operation</p>
1037 </div>
1038 </div>
1039 </section>
1040 </div>
1041 <div class="doc-examples">
1042 <h5>Response Content-Types:
1043 <span>application/json</span>
1044 </h5>
1045 </div>
1046 </div>
1047 <div class="doc-row">
1048 <div class="doc-copy">
1049 <section class="swagger-request-security">
1050 <table class="table">
1051 <thead>
1052 <tr>
1053 <th class="swagger-request-security-schema"></th>
1054 <th class="swagger-request-security-scopes"></th>
1055 </tr>
1056 </thead>
1057 <tbody>
1058 <tr>
1059 <td>
1060 <a href="#security-definition-OAuth2">OAuth2</a>
1061 </td>
1062 <td> </td>
1063 </tr>
1064 </tbody>
1065 </table>
1066 </section>
1067 </div>
1068 </div>
1069 </div>
1070 <div id="operation--server-followers-get" class="operation panel" data-traverse-target="operation--server-followers-get">
1071 <!-- <section class="operation-tags row"> -->
1072 <!-- <div class="doc-copy"> -->
1073 <div class="operation-tags">
1074 <a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
1075 <!---->
1076 </div>
1077 <!-- </div> -->
1078 <!-- </section> -->
1079 <h2 class="operation-title">
1080 <span class="operation-name">
1081 <span class="operation-name">GET</span>
1082 <span class="operation-path">/server/followers</span>
1083 </span>
1084 </h2>
1085 <div class="doc-row">
1086 <div class="doc-copy">
1087 <section class="swagger-request-params">
1088 <div class="prop-row prop-group">
1089 <div class="prop-name">
1090 <div class="prop-title">start:
1091 <span class="prop-type">
1092 <span class="json-property-type">number</span>
1093 <span class="json-property-range" title="Value limits"></span>
1094 </span>
1095 </div>
1096 <div class="prop-subtitle"> in query </div>
1097 </div>
1098 <div class="prop-value">
1099 <p>Offset</p>
1100 </div>
1101 </div>
1102 <div class="prop-row prop-group">
1103 <div class="prop-name">
1104 <div class="prop-title">count:
1105 <span class="prop-type">
1106 <span class="json-property-type">number</span>
1107 <span class="json-property-range" title="Value limits"></span>
1108 </span>
1109 </div>
1110 <div class="prop-subtitle"> in query </div>
1111 </div>
1112 <div class="prop-value">
1113 <p>Number of items</p>
1114 </div>
1115 </div>
1116 <div class="prop-row prop-group">
1117 <div class="prop-name">
1118 <div class="prop-title">sort:
1119 <span class="prop-type">
1120 <span class="json-property-type">string</span>
1121 <span class="json-property-range" title="Value limits"></span>
1122 </span>
1123 </div>
1124 <div class="prop-subtitle"> in query </div>
1125 </div>
1126 <div class="prop-value">
1127 <p>Sort column (-createdAt for example)</p>
1128 </div>
1129 </div>
1130 </section>
1131 </div>
1132 <div class="doc-examples"></div>
1133 </div>
1134 <div class="doc-row">
1135 <div class="doc-copy">
1136 <section class="swagger-responses">
1137 <div class="prop-row prop-group">
1138 <div class="prop-name">
1139 <div class="prop-title">200 OK</div>
1140 <div class="prop-ref">
1141 <span class="json-schema-ref-array">
1142 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1143 </span>
1144 </div>
1145 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1146 </div>
1147 <div class="prop-value">
1148 <p>successful operation</p>
1149 </div>
1150 </div>
1151 <div class="prop-row prop-inner">
1152 <div class="prop-name">type</div>
1153 <div class="prop-value">
1154 <span class="json-property-type">
1155 <span class="json-schema-ref-array">
1156 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1157 </span>
1158 </span>
1159 <span class="json-property-range" title="Value limits"></span>
1160 </div>
1161 </div>
1162 </section>
1163 </div>
1164 <div class="doc-examples">
1165 <h5>Response Content-Types:
1166 <span>application/json</span>
1167 </h5>
1168 <section>
1169 <h5>Response Example
1170 <span>(200 OK)</span>
1171 </h5>
1172 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
1173 {
1174 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1175 <span class="hljs-attr">&quot;follower&quot;</span>: {
1176 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1177 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1178 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1179 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1180 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1181 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1182 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1183 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1184 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1185 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1186 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1187 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1188 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1189 }
1190 },
1191 <span class="hljs-attr">&quot;following&quot;</span>: {
1192 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1193 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1194 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1195 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1196 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1197 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1198 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1199 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1200 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1201 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1202 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1203 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1204 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1205 }
1206 },
1207 <span class="hljs-attr">&quot;score&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1208 <span class="hljs-attr">&quot;state&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1209 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1210 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1211 }
1212 ]
1213 </code></pre>
1214 <!-- </div> -->
1215 </section>
1216 </div>
1217 </div>
1218 </div>
1219 <div id="operation--server-following-get" class="operation panel" data-traverse-target="operation--server-following-get">
1220 <!-- <section class="operation-tags row"> -->
1221 <!-- <div class="doc-copy"> -->
1222 <div class="operation-tags">
1223 <a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
1224 <!---->
1225 </div>
1226 <!-- </div> -->
1227 <!-- </section> -->
1228 <h2 class="operation-title">
1229 <span class="operation-name">
1230 <span class="operation-name">GET</span>
1231 <span class="operation-path">/server/following</span>
1232 </span>
1233 </h2>
1234 <div class="doc-row">
1235 <div class="doc-copy">
1236 <section class="swagger-request-params">
1237 <div class="prop-row prop-group">
1238 <div class="prop-name">
1239 <div class="prop-title">start:
1240 <span class="prop-type">
1241 <span class="json-property-type">number</span>
1242 <span class="json-property-range" title="Value limits"></span>
1243 </span>
1244 </div>
1245 <div class="prop-subtitle"> in query </div>
1246 </div>
1247 <div class="prop-value">
1248 <p>Offset</p>
1249 </div>
1250 </div>
1251 <div class="prop-row prop-group">
1252 <div class="prop-name">
1253 <div class="prop-title">count:
1254 <span class="prop-type">
1255 <span class="json-property-type">number</span>
1256 <span class="json-property-range" title="Value limits"></span>
1257 </span>
1258 </div>
1259 <div class="prop-subtitle"> in query </div>
1260 </div>
1261 <div class="prop-value">
1262 <p>Number of items</p>
1263 </div>
1264 </div>
1265 <div class="prop-row prop-group">
1266 <div class="prop-name">
1267 <div class="prop-title">sort:
1268 <span class="prop-type">
1269 <span class="json-property-type">string</span>
1270 <span class="json-property-range" title="Value limits"></span>
1271 </span>
1272 </div>
1273 <div class="prop-subtitle"> in query </div>
1274 </div>
1275 <div class="prop-value">
1276 <p>Sort column (-createdAt for example)</p>
1277 </div>
1278 </div>
1279 </section>
1280 </div>
1281 <div class="doc-examples"></div>
1282 </div>
1283 <div class="doc-row">
1284 <div class="doc-copy">
1285 <section class="swagger-responses">
1286 <div class="prop-row prop-group">
1287 <div class="prop-name">
1288 <div class="prop-title">200 OK</div>
1289 <div class="prop-ref">
1290 <span class="json-schema-ref-array">
1291 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1292 </span>
1293 </div>
1294 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1295 </div>
1296 <div class="prop-value">
1297 <p>successful operation</p>
1298 </div>
1299 </div>
1300 <div class="prop-row prop-inner">
1301 <div class="prop-name">type</div>
1302 <div class="prop-value">
1303 <span class="json-property-type">
1304 <span class="json-schema-ref-array">
1305 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1306 </span>
1307 </span>
1308 <span class="json-property-range" title="Value limits"></span>
1309 </div>
1310 </div>
1311 </section>
1312 </div>
1313 <div class="doc-examples">
1314 <h5>Response Content-Types:
1315 <span>application/json</span>
1316 </h5>
1317 <section>
1318 <h5>Response Example
1319 <span>(200 OK)</span>
1320 </h5>
1321 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
1322 {
1323 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1324 <span class="hljs-attr">&quot;follower&quot;</span>: {
1325 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1326 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1327 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1328 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1329 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1330 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1331 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1332 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1333 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1334 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1335 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1336 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1337 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1338 }
1339 },
1340 <span class="hljs-attr">&quot;following&quot;</span>: {
1341 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1342 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1343 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1344 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1345 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1346 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1347 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1348 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1349 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1350 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1351 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1352 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1353 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1354 }
1355 },
1356 <span class="hljs-attr">&quot;score&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1357 <span class="hljs-attr">&quot;state&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1358 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1359 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1360 }
1361 ]
1362 </code></pre>
1363 <!-- </div> -->
1364 </section>
1365 </div>
1366 </div>
1367 </div>
1368 <div id="operation--server-following-post" class="operation panel" data-traverse-target="operation--server-following-post">
1369 <!-- <section class="operation-tags row"> -->
1370 <!-- <div class="doc-copy"> -->
1371 <div class="operation-tags">
1372 <a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
1373 <!---->
1374 </div>
1375 <!-- </div> -->
1376 <!-- </section> -->
1377 <h2 class="operation-title">
1378 <span class="operation-name">
1379 <span class="operation-name">POST</span>
1380 <span class="operation-path">/server/following</span>
1381 </span>
1382 </h2>
1383 <div class="doc-row">
1384 <div class="doc-copy">
1385 <section class="swagger-request-body">
1386 <div class="prop-row">
1387 <div class="prop-name">
1388 <div class="swagger-request-model">
1389 <span class="">
1390 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1391 </span>
1392 </div>
1393 </div>
1394 <div class="prop-value columns small-6">
1395 <!-- <div class="swagger-request-description"> -->
1396 <p>undefined</p>
1397 <!-- </div> -->
1398 </div>
1399 </div>
1400 </section>
1401 </div>
1402 <div class="doc-examples">
1403 <section>
1404 <h5>Request Content-Types:
1405 <span>application/json</span>
1406 </h5>
1407 <h5>Request Example</h5>
1408 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1409 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1410 <span class="hljs-attr">&quot;follower&quot;</span>: {
1411 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1412 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1413 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1414 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1415 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1416 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1417 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1418 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1419 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1420 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1421 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1422 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1423 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1424 }
1425 },
1426 <span class="hljs-attr">&quot;following&quot;</span>: {
1427 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1428 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1429 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1430 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1431 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1432 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1433 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1434 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1435 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1436 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1437 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1438 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1439 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1440 }
1441 },
1442 <span class="hljs-attr">&quot;score&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1443 <span class="hljs-attr">&quot;state&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1444 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1445 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1446 }
1447 </code></pre>
1448 <!-- </div> -->
1449 </section>
1450 </div>
1451 </div>
1452 <div class="doc-row">
1453 <div class="doc-copy">
1454 <section class="swagger-responses">
1455 <div class="prop-row prop-group">
1456 <div class="prop-name">
1457 <div class="prop-title">204 No Content</div>
1458 </div>
1459 <div class="prop-value">
1460 <p>Successful operation</p>
1461 </div>
1462 </div>
1463 </section>
1464 </div>
1465 <div class="doc-examples">
1466 <h5>Response Content-Types:
1467 <span>application/json</span>
1468 </h5>
1469 </div>
1470 </div>
1471 <div class="doc-row">
1472 <div class="doc-copy">
1473 <section class="swagger-request-security">
1474 <table class="table">
1475 <thead>
1476 <tr>
1477 <th class="swagger-request-security-schema"></th>
1478 <th class="swagger-request-security-scopes"></th>
1479 </tr>
1480 </thead>
1481 <tbody>
1482 <tr>
1483 <td>
1484 <a href="#security-definition-OAuth2">OAuth2</a>
1485 </td>
1486 <td> </td>
1487 </tr>
1488 </tbody>
1489 </table>
1490 </section>
1491 </div>
1492 </div>
1493 </div>
1494 <h1 id="tag-User" class="swagger-summary-tag" data-traverse-target="tag-User">User</h1>
1495 <div id="operation--users-post" class="operation panel" data-traverse-target="operation--users-post">
1496 <!-- <section class="operation-tags row"> -->
1497 <!-- <div class="doc-copy"> -->
1498 <div class="operation-tags">
1499 <a class="label" href="#tag-User">User</a>
1500 <!---->
1501 </div>
1502 <!-- </div> -->
1503 <!-- </section> -->
1504 <h2 class="operation-title">
1505 <span class="operation-name">
1506 <span class="operation-name">POST</span>
1507 <span class="operation-path">/users</span>
1508 </span>
1509 </h2>
1510 <div class="doc-row">
1511 <div class="doc-copy">
1512 <section class="swagger-request-body">
1513 <div class="prop-row">
1514 <div class="prop-name">
1515 <div class="swagger-request-model">
1516 <span class="">
1517 <a class="json-schema-ref" href="#/definitions/AddUser">AddUser</a>
1518 </span>
1519 </div>
1520 </div>
1521 <div class="prop-value columns small-6">
1522 <!-- <div class="swagger-request-description"> -->
1523 <p>User to create</p>
1524 <!-- </div> -->
1525 </div>
1526 </div>
1527 </section>
1528 </div>
1529 <div class="doc-examples">
1530 <section>
1531 <h5>Request Content-Types:
1532 <span>application/json</span>
1533 </h5>
1534 <h5>Request Example</h5>
1535 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1536 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1537 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1538 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1539 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1540 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1541 }
1542 </code></pre>
1543 <!-- </div> -->
1544 </section>
1545 </div>
1546 </div>
1547 <div class="doc-row">
1548 <div class="doc-copy">
1549 <section class="swagger-responses">
1550 <div class="prop-row prop-group">
1551 <div class="prop-name">
1552 <div class="prop-title">200 OK</div>
1553 <div class="prop-ref">
1554 <span class="">
1555 <a class="json-schema-ref" href="#/definitions/AddUserResponse">AddUserResponse</a>
1556 </span>
1557 </div>
1558 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1559 </div>
1560 <div class="prop-value">
1561 <p>successful operation</p>
1562 </div>
1563 </div>
1564 </section>
1565 </div>
1566 <div class="doc-examples">
1567 <h5>Response Content-Types:
1568 <span>application/json</span>
1569 </h5>
1570 <section>
1571 <h5>Response Example
1572 <span>(200 OK)</span>
1573 </h5>
1574 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1575 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1576 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1577 }
1578 </code></pre>
1579 <!-- </div> -->
1580 </section>
1581 </div>
1582 </div>
1583 <div class="doc-row">
1584 <div class="doc-copy">
1585 <section class="swagger-request-security">
1586 <table class="table">
1587 <thead>
1588 <tr>
1589 <th class="swagger-request-security-schema"></th>
1590 <th class="swagger-request-security-scopes"></th>
1591 </tr>
1592 </thead>
1593 <tbody>
1594 <tr>
1595 <td>
1596 <a href="#security-definition-OAuth2">OAuth2</a>
1597 </td>
1598 <td> </td>
1599 </tr>
1600 </tbody>
1601 </table>
1602 </section>
1603 </div>
1604 </div>
1605 </div>
1606 <div id="operation--users-get" class="operation panel" data-traverse-target="operation--users-get">
1607 <!-- <section class="operation-tags row"> -->
1608 <!-- <div class="doc-copy"> -->
1609 <div class="operation-tags">
1610 <a class="label" href="#tag-User">User</a>
1611 <!---->
1612 </div>
1613 <!-- </div> -->
1614 <!-- </section> -->
1615 <h2 class="operation-title">
1616 <span class="operation-name">
1617 <span class="operation-name">GET</span>
1618 <span class="operation-path">/users</span>
1619 </span>
1620 </h2>
1621 <div class="doc-row">
1622 <div class="doc-copy">
1623 <section class="swagger-request-params">
1624 <div class="prop-row prop-group">
1625 <div class="prop-name">
1626 <div class="prop-title">start:
1627 <span class="prop-type">
1628 <span class="json-property-type">number</span>
1629 <span class="json-property-range" title="Value limits"></span>
1630 </span>
1631 </div>
1632 <div class="prop-subtitle"> in query </div>
1633 </div>
1634 <div class="prop-value">
1635 <p>Offset</p>
1636 </div>
1637 </div>
1638 <div class="prop-row prop-group">
1639 <div class="prop-name">
1640 <div class="prop-title">count:
1641 <span class="prop-type">
1642 <span class="json-property-type">number</span>
1643 <span class="json-property-range" title="Value limits"></span>
1644 </span>
1645 </div>
1646 <div class="prop-subtitle"> in query </div>
1647 </div>
1648 <div class="prop-value">
1649 <p>Number of items</p>
1650 </div>
1651 </div>
1652 <div class="prop-row prop-group">
1653 <div class="prop-name">
1654 <div class="prop-title">sort:
1655 <span class="prop-type">
1656 <span class="json-property-type">string</span>
1657 <span class="json-property-range" title="Value limits"></span>
1658 </span>
1659 </div>
1660 <div class="prop-subtitle"> in query </div>
1661 </div>
1662 <div class="prop-value">
1663 <p>Sort column (-createdAt for example)</p>
1664 </div>
1665 </div>
1666 </section>
1667 </div>
1668 <div class="doc-examples"></div>
1669 </div>
1670 <div class="doc-row">
1671 <div class="doc-copy">
1672 <section class="swagger-responses">
1673 <div class="prop-row prop-group">
1674 <div class="prop-name">
1675 <div class="prop-title">200 OK</div>
1676 <div class="prop-ref">
1677 <span class="json-schema-ref-array">
1678 <a class="json-schema-ref" href="#/definitions/User">User</a>
1679 </span>
1680 </div>
1681 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1682 </div>
1683 <div class="prop-value">
1684 <p>successful operation</p>
1685 </div>
1686 </div>
1687 <div class="prop-row prop-inner">
1688 <div class="prop-name">type</div>
1689 <div class="prop-value">
1690 <span class="json-property-type">
1691 <span class="json-schema-ref-array">
1692 <a class="json-schema-ref" href="#/definitions/User">User</a>
1693 </span>
1694 </span>
1695 <span class="json-property-range" title="Value limits"></span>
1696 </div>
1697 </div>
1698 </section>
1699 </div>
1700 <div class="doc-examples">
1701 <h5>Response Content-Types:
1702 <span>application/json</span>
1703 </h5>
1704 <section>
1705 <h5>Response Example
1706 <span>(200 OK)</span>
1707 </h5>
1708 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
1709 {
1710 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1711 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1712 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1713 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1714 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1715 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1716 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1717 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1718 <span class="hljs-attr">&quot;account&quot;</span>: {
1719 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1720 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1721 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1722 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1723 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1724 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1725 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1726 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1727 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1728 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1729 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1730 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1731 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1732 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1733 }
1734 },
1735 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
1736 {
1737 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1738 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1739 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1740 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
1741 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1742 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1743 }
1744 }
1745 ]
1746 }
1747 ]
1748 </code></pre>
1749 <!-- </div> -->
1750 </section>
1751 </div>
1752 </div>
1753 <div class="doc-row">
1754 <div class="doc-copy">
1755 <section class="swagger-request-security">
1756 <table class="table">
1757 <thead>
1758 <tr>
1759 <th class="swagger-request-security-schema"></th>
1760 <th class="swagger-request-security-scopes"></th>
1761 </tr>
1762 </thead>
1763 <tbody>
1764 <tr>
1765 <td>
1766 <a href="#security-definition-OAuth2">OAuth2</a>
1767 </td>
1768 <td> </td>
1769 </tr>
1770 </tbody>
1771 </table>
1772 </section>
1773 </div>
1774 </div>
1775 </div>
1776 <div id="operation--users--id--delete" class="operation panel" data-traverse-target="operation--users--id--delete">
1777 <!-- <section class="operation-tags row"> -->
1778 <!-- <div class="doc-copy"> -->
1779 <div class="operation-tags">
1780 <a class="label" href="#tag-User">User</a>
1781 <!---->
1782 </div>
1783 <!-- </div> -->
1784 <!-- </section> -->
1785 <h2 class="operation-title">
1786 <span class="operation-name">
1787 <span class="operation-name">DELETE</span>
1788 <span class="operation-path">/users/{id}</span>
1789 </span>
1790 </h2>
1791 <div class="doc-row">
1792 <div class="doc-copy">
1793 <section class="swagger-request-params">
1794 <div class="prop-row prop-group">
1795 <div class="prop-name">
1796 <div class="prop-title">id:
1797 <span class="prop-type">
1798 <span class="json-property-type">number</span>
1799 <span class="json-property-range" title="Value limits"></span>
1800 </span>
1801 </div>
1802 <span class="json-property-required"></span>
1803 <div class="prop-subtitle"> in path </div>
1804 </div>
1805 <div class="prop-value">
1806 <p>The user id</p>
1807 </div>
1808 </div>
1809 </section>
1810 </div>
1811 <div class="doc-examples"></div>
1812 </div>
1813 <div class="doc-row">
1814 <div class="doc-copy">
1815 <section class="swagger-responses">
1816 <div class="prop-row prop-group">
1817 <div class="prop-name">
1818 <div class="prop-title">204 No Content</div>
1819 </div>
1820 <div class="prop-value">
1821 <p>Successful operation</p>
1822 </div>
1823 </div>
1824 </section>
1825 </div>
1826 <div class="doc-examples">
1827 <h5>Response Content-Types:
1828 <span>application/json</span>
1829 </h5>
1830 </div>
1831 </div>
1832 <div class="doc-row">
1833 <div class="doc-copy">
1834 <section class="swagger-request-security">
1835 <table class="table">
1836 <thead>
1837 <tr>
1838 <th class="swagger-request-security-schema"></th>
1839 <th class="swagger-request-security-scopes"></th>
1840 </tr>
1841 </thead>
1842 <tbody>
1843 <tr>
1844 <td>
1845 <a href="#security-definition-OAuth2">OAuth2</a>
1846 </td>
1847 <td> </td>
1848 </tr>
1849 </tbody>
1850 </table>
1851 </section>
1852 </div>
1853 </div>
1854 </div>
1855 <div id="operation--users--id--get" class="operation panel" data-traverse-target="operation--users--id--get">
1856 <!-- <section class="operation-tags row"> -->
1857 <!-- <div class="doc-copy"> -->
1858 <div class="operation-tags">
1859 <a class="label" href="#tag-User">User</a>
1860 <!---->
1861 </div>
1862 <!-- </div> -->
1863 <!-- </section> -->
1864 <h2 class="operation-title">
1865 <span class="operation-name">
1866 <span class="operation-name">GET</span>
1867 <span class="operation-path">/users/{id}</span>
1868 </span>
1869 </h2>
1870 <div class="doc-row">
1871 <div class="doc-copy">
1872 <section class="swagger-request-params">
1873 <div class="prop-row prop-group">
1874 <div class="prop-name">
1875 <div class="prop-title">id:
1876 <span class="prop-type">
1877 <span class="json-property-type">number</span>
1878 <span class="json-property-range" title="Value limits"></span>
1879 </span>
1880 </div>
1881 <span class="json-property-required"></span>
1882 <div class="prop-subtitle"> in path </div>
1883 </div>
1884 <div class="prop-value">
1885 <p>The user id</p>
1886 </div>
1887 </div>
1888 </section>
1889 </div>
1890 <div class="doc-examples"></div>
1891 </div>
1892 <div class="doc-row">
1893 <div class="doc-copy">
1894 <section class="swagger-responses">
1895 <div class="prop-row prop-group">
1896 <div class="prop-name">
1897 <div class="prop-title">200 OK</div>
1898 <div class="prop-ref">
1899 <span class="">
1900 <a class="json-schema-ref" href="#/definitions/User">User</a>
1901 </span>
1902 </div>
1903 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1904 </div>
1905 <div class="prop-value">
1906 <p>successful operation</p>
1907 </div>
1908 </div>
1909 </section>
1910 </div>
1911 <div class="doc-examples">
1912 <h5>Response Content-Types:
1913 <span>application/json</span>
1914 </h5>
1915 <section>
1916 <h5>Response Example
1917 <span>(200 OK)</span>
1918 </h5>
1919 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1920 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1921 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1922 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1923 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1924 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1925 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1926 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1927 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1928 <span class="hljs-attr">&quot;account&quot;</span>: {
1929 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1930 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1931 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1932 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1933 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1934 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1935 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1936 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1937 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1938 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1939 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1940 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1941 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1942 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1943 }
1944 },
1945 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
1946 {
1947 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1948 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1949 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1950 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
1951 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1952 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1953 }
1954 }
1955 ]
1956 }
1957 </code></pre>
1958 <!-- </div> -->
1959 </section>
1960 </div>
1961 </div>
1962 <div class="doc-row">
1963 <div class="doc-copy">
1964 <section class="swagger-request-security">
1965 <table class="table">
1966 <thead>
1967 <tr>
1968 <th class="swagger-request-security-schema"></th>
1969 <th class="swagger-request-security-scopes"></th>
1970 </tr>
1971 </thead>
1972 <tbody>
1973 <tr>
1974 <td>
1975 <a href="#security-definition-OAuth2">OAuth2</a>
1976 </td>
1977 <td> </td>
1978 </tr>
1979 </tbody>
1980 </table>
1981 </section>
1982 </div>
1983 </div>
1984 </div>
1985 <div id="operation--users--id--put" class="operation panel" data-traverse-target="operation--users--id--put">
1986 <!-- <section class="operation-tags row"> -->
1987 <!-- <div class="doc-copy"> -->
1988 <div class="operation-tags">
1989 <a class="label" href="#tag-User">User</a>
1990 <!---->
1991 </div>
1992 <!-- </div> -->
1993 <!-- </section> -->
1994 <h2 class="operation-title">
1995 <span class="operation-name">
1996 <span class="operation-name">PUT</span>
1997 <span class="operation-path">/users/{id}</span>
1998 </span>
1999 </h2>
2000 <div class="doc-row">
2001 <div class="doc-copy">
2002 <section class="swagger-request-body">
2003 <div class="prop-row">
2004 <div class="prop-name">
2005 <div class="swagger-request-model">
2006 <span class="">
2007 <a class="json-schema-ref" href="#/definitions/UpdateUser">UpdateUser</a>
2008 </span>
2009 </div>
2010 </div>
2011 <div class="prop-value columns small-6">
2012 <!-- <div class="swagger-request-description"> -->
2013 <p>undefined</p>
2014 <!-- </div> -->
2015 </div>
2016 </div>
2017 </section>
2018 <section class="swagger-request-params">
2019 <div class="prop-row prop-group">
2020 <div class="prop-name">
2021 <div class="prop-title">id:
2022 <span class="prop-type">
2023 <span class="json-property-type">number</span>
2024 <span class="json-property-range" title="Value limits"></span>
2025 </span>
2026 </div>
2027 <span class="json-property-required"></span>
2028 <div class="prop-subtitle"> in path </div>
2029 </div>
2030 <div class="prop-value">
2031 <p>The user id</p>
2032 </div>
2033 </div>
2034 </section>
2035 </div>
2036 <div class="doc-examples">
2037 <section>
2038 <h5>Request Content-Types:
2039 <span>application/json</span>
2040 </h5>
2041 <h5>Request Example</h5>
2042 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2043 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2044 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2045 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2046 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2047 }
2048 </code></pre>
2049 <!-- </div> -->
2050 </section>
2051 </div>
2052 </div>
2053 <div class="doc-row">
2054 <div class="doc-copy">
2055 <section class="swagger-responses">
2056 <div class="prop-row prop-group">
2057 <div class="prop-name">
2058 <div class="prop-title">204 No Content</div>
2059 </div>
2060 <div class="prop-value">
2061 <p>Successful operation</p>
2062 </div>
2063 </div>
2064 </section>
2065 </div>
2066 <div class="doc-examples">
2067 <h5>Response Content-Types:
2068 <span>application/json</span>
2069 </h5>
2070 </div>
2071 </div>
2072 <div class="doc-row">
2073 <div class="doc-copy">
2074 <section class="swagger-request-security">
2075 <table class="table">
2076 <thead>
2077 <tr>
2078 <th class="swagger-request-security-schema"></th>
2079 <th class="swagger-request-security-scopes"></th>
2080 </tr>
2081 </thead>
2082 <tbody>
2083 <tr>
2084 <td>
2085 <a href="#security-definition-OAuth2">OAuth2</a>
2086 </td>
2087 <td> </td>
2088 </tr>
2089 </tbody>
2090 </table>
2091 </section>
2092 </div>
2093 </div>
2094 </div>
2095 <div id="operation--users-me-get" class="operation panel" data-traverse-target="operation--users-me-get">
2096 <!-- <section class="operation-tags row"> -->
2097 <!-- <div class="doc-copy"> -->
2098 <div class="operation-tags">
2099 <a class="label" href="#tag-User">User</a>
2100 <!---->
2101 </div>
2102 <!-- </div> -->
2103 <!-- </section> -->
2104 <h2 class="operation-title">
2105 <span class="operation-name">
2106 <span class="operation-name">GET</span>
2107 <span class="operation-path">/users/me</span>
2108 </span>
2109 </h2>
2110 <div class="doc-row">
2111 <div class="doc-copy"> </div>
2112 <div class="doc-examples"></div>
2113 </div>
2114 <div class="doc-row">
2115 <div class="doc-copy">
2116 <section class="swagger-responses">
2117 <div class="prop-row prop-group">
2118 <div class="prop-name">
2119 <div class="prop-title">200 OK</div>
2120 <div class="prop-ref">
2121 <span class="json-schema-ref-array">
2122 <a class="json-schema-ref" href="#/definitions/User">User</a>
2123 </span>
2124 </div>
2125 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2126 </div>
2127 <div class="prop-value">
2128 <p>successful operation</p>
2129 </div>
2130 </div>
2131 <div class="prop-row prop-inner">
2132 <div class="prop-name">type</div>
2133 <div class="prop-value">
2134 <span class="json-property-type">
2135 <span class="json-schema-ref-array">
2136 <a class="json-schema-ref" href="#/definitions/User">User</a>
2137 </span>
2138 </span>
2139 <span class="json-property-range" title="Value limits"></span>
2140 </div>
2141 </div>
2142 </section>
2143 </div>
2144 <div class="doc-examples">
2145 <h5>Response Content-Types:
2146 <span>application/json</span>
2147 </h5>
2148 <section>
2149 <h5>Response Example
2150 <span>(200 OK)</span>
2151 </h5>
2152 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
2153 {
2154 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2155 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2156 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2157 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2158 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2159 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2160 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2161 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2162 <span class="hljs-attr">&quot;account&quot;</span>: {
2163 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2164 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2165 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2166 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2167 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2168 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2169 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2170 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2171 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2172 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2173 <span class="hljs-attr">&quot;avatar&quot;</span>: {
2174 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2175 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2176 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2177 }
2178 },
2179 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
2180 {
2181 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2182 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2183 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2184 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
2185 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2186 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2187 }
2188 }
2189 ]
2190 }
2191 ]
2192 </code></pre>
2193 <!-- </div> -->
2194 </section>
2195 </div>
2196 </div>
2197 <div class="doc-row">
2198 <div class="doc-copy">
2199 <section class="swagger-request-security">
2200 <table class="table">
2201 <thead>
2202 <tr>
2203 <th class="swagger-request-security-schema"></th>
2204 <th class="swagger-request-security-scopes"></th>
2205 </tr>
2206 </thead>
2207 <tbody>
2208 <tr>
2209 <td>
2210 <a href="#security-definition-OAuth2">OAuth2</a>
2211 </td>
2212 <td> </td>
2213 </tr>
2214 </tbody>
2215 </table>
2216 </section>
2217 </div>
2218 </div>
2219 </div>
2220 <div id="operation--users-me-put" class="operation panel" data-traverse-target="operation--users-me-put">
2221 <!-- <section class="operation-tags row"> -->
2222 <!-- <div class="doc-copy"> -->
2223 <div class="operation-tags">
2224 <a class="label" href="#tag-User">User</a>
2225 <!---->
2226 </div>
2227 <!-- </div> -->
2228 <!-- </section> -->
2229 <h2 class="operation-title">
2230 <span class="operation-name">
2231 <span class="operation-name">PUT</span>
2232 <span class="operation-path">/users/me</span>
2233 </span>
2234 </h2>
2235 <div class="doc-row">
2236 <div class="doc-copy">
2237 <section class="swagger-request-body">
2238 <div class="prop-row">
2239 <div class="prop-name">
2240 <div class="swagger-request-model">
2241 <span class="">
2242 <a class="json-schema-ref" href="#/definitions/UpdateMe">UpdateMe</a>
2243 </span>
2244 </div>
2245 </div>
2246 <div class="prop-value columns small-6">
2247 <!-- <div class="swagger-request-description"> -->
2248 <p>undefined</p>
2249 <!-- </div> -->
2250 </div>
2251 </div>
2252 </section>
2253 </div>
2254 <div class="doc-examples">
2255 <section>
2256 <h5>Request Content-Types:
2257 <span>application/json</span>
2258 </h5>
2259 <h5>Request Example</h5>
2260 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2261 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2262 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2263 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2264 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2265 }
2266 </code></pre>
2267 <!-- </div> -->
2268 </section>
2269 </div>
2270 </div>
2271 <div class="doc-row">
2272 <div class="doc-copy">
2273 <section class="swagger-responses">
2274 <div class="prop-row prop-group">
2275 <div class="prop-name">
2276 <div class="prop-title">204 No Content</div>
2277 </div>
2278 <div class="prop-value">
2279 <p>Successful operation</p>
2280 </div>
2281 </div>
2282 </section>
2283 </div>
2284 <div class="doc-examples">
2285 <h5>Response Content-Types:
2286 <span>application/json</span>
2287 </h5>
2288 </div>
2289 </div>
2290 <div class="doc-row">
2291 <div class="doc-copy">
2292 <section class="swagger-request-security">
2293 <table class="table">
2294 <thead>
2295 <tr>
2296 <th class="swagger-request-security-schema"></th>
2297 <th class="swagger-request-security-scopes"></th>
2298 </tr>
2299 </thead>
2300 <tbody>
2301 <tr>
2302 <td>
2303 <a href="#security-definition-OAuth2">OAuth2</a>
2304 </td>
2305 <td> </td>
2306 </tr>
2307 </tbody>
2308 </table>
2309 </section>
2310 </div>
2311 </div>
2312 </div>
2313 <div id="operation--users-me-video-quota-used-get" class="operation panel" data-traverse-target="operation--users-me-video-quota-used-get">
2314 <!-- <section class="operation-tags row"> -->
2315 <!-- <div class="doc-copy"> -->
2316 <div class="operation-tags">
2317 <a class="label" href="#tag-User">User</a>
2318 <!---->
2319 </div>
2320 <!-- </div> -->
2321 <!-- </section> -->
2322 <h2 class="operation-title">
2323 <span class="operation-name">
2324 <span class="operation-name">GET</span>
2325 <span class="operation-path">/users/me/video-quota-used</span>
2326 </span>
2327 </h2>
2328 <div class="doc-row">
2329 <div class="doc-copy"> </div>
2330 <div class="doc-examples"></div>
2331 </div>
2332 <div class="doc-row">
2333 <div class="doc-copy">
2334 <section class="swagger-responses">
2335 <div class="prop-row prop-group">
2336 <div class="prop-name">
2337 <div class="prop-title">200 OK</div>
2338 <div class="prop-ref"> </div>
2339 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2340 </div>
2341 <div class="prop-value">
2342 <p>successful operation</p>
2343 </div>
2344 </div>
2345 <div class="prop-row prop-inner">
2346 <div class="prop-name">type</div>
2347 <div class="prop-value">
2348 <span class="json-property-type">number</span>
2349 <span class="json-property-range" title="Value limits"></span>
2350 </div>
2351 </div>
2352 </section>
2353 </div>
2354 <div class="doc-examples">
2355 <h5>Response Content-Types:
2356 <span>application/json</span>
2357 </h5>
2358 <section>
2359 <h5>Response Example
2360 <span>(200 OK)</span>
2361 </h5>
2362 <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">&quot;number&quot;</span>
2363 </code></pre>
2364 <!-- </div> -->
2365 </section>
2366 </div>
2367 </div>
2368 <div class="doc-row">
2369 <div class="doc-copy">
2370 <section class="swagger-request-security">
2371 <table class="table">
2372 <thead>
2373 <tr>
2374 <th class="swagger-request-security-schema"></th>
2375 <th class="swagger-request-security-scopes"></th>
2376 </tr>
2377 </thead>
2378 <tbody>
2379 <tr>
2380 <td>
2381 <a href="#security-definition-OAuth2">OAuth2</a>
2382 </td>
2383 <td> </td>
2384 </tr>
2385 </tbody>
2386 </table>
2387 </section>
2388 </div>
2389 </div>
2390 </div>
2391 <div id="operation--users-me-videos--videoId--rating-get" class="operation panel" data-traverse-target="operation--users-me-videos--videoId--rating-get">
2392 <!-- <section class="operation-tags row"> -->
2393 <!-- <div class="doc-copy"> -->
2394 <div class="operation-tags">
2395 <a class="label" href="#tag-User">User</a>
2396 <!---->
2397 </div>
2398 <!-- </div> -->
2399 <!-- </section> -->
2400 <h2 class="operation-title">
2401 <span class="operation-name">
2402 <span class="operation-name">GET</span>
2403 <span class="operation-path">/users/me/videos/{videoId}/rating</span>
2404 </span>
2405 </h2>
2406 <div class="doc-row">
2407 <div class="doc-copy">
2408 <section class="swagger-request-params">
2409 <div class="prop-row prop-group">
2410 <div class="prop-name">
2411 <div class="prop-title">videoId:
2412 <span class="prop-type">
2413 <span class="json-property-type">string</span>
2414 <span class="json-property-range" title="Value limits"></span>
2415 </span>
2416 </div>
2417 <span class="json-property-required"></span>
2418 <div class="prop-subtitle"> in path </div>
2419 </div>
2420 <div class="prop-value">
2421 <p>The video id </p>
2422 </div>
2423 </div>
2424 </section>
2425 </div>
2426 <div class="doc-examples"></div>
2427 </div>
2428 <div class="doc-row">
2429 <div class="doc-copy">
2430 <section class="swagger-responses">
2431 <div class="prop-row prop-group">
2432 <div class="prop-name">
2433 <div class="prop-title">200 OK</div>
2434 <div class="prop-ref">
2435 <span class="">
2436 <a class="json-schema-ref" href="#/definitions/GetMeVideoRating">GetMeVideoRating</a>
2437 </span>
2438 </div>
2439 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2440 </div>
2441 <div class="prop-value">
2442 <p>successful operation</p>
2443 </div>
2444 </div>
2445 </section>
2446 </div>
2447 <div class="doc-examples">
2448 <h5>Response Content-Types:
2449 <span>application/json</span>
2450 </h5>
2451 <section>
2452 <h5>Response Example
2453 <span>(200 OK)</span>
2454 </h5>
2455 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2456 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2457 <span class="hljs-attr">&quot;rating&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>
2458 }
2459 </code></pre>
2460 <!-- </div> -->
2461 </section>
2462 </div>
2463 </div>
2464 <div class="doc-row">
2465 <div class="doc-copy">
2466 <section class="swagger-request-security">
2467 <table class="table">
2468 <thead>
2469 <tr>
2470 <th class="swagger-request-security-schema"></th>
2471 <th class="swagger-request-security-scopes"></th>
2472 </tr>
2473 </thead>
2474 <tbody>
2475 <tr>
2476 <td>
2477 <a href="#security-definition-OAuth2">OAuth2</a>
2478 </td>
2479 <td> </td>
2480 </tr>
2481 </tbody>
2482 </table>
2483 </section>
2484 </div>
2485 </div>
2486 </div>
2487 <div id="operation--users-me-videos-get" class="operation panel" data-traverse-target="operation--users-me-videos-get">
2488 <!-- <section class="operation-tags row"> -->
2489 <!-- <div class="doc-copy"> -->
2490 <div class="operation-tags">
2491 <a class="label" href="#tag-User">User</a>
2492 <!---->
2493 </div>
2494 <!-- </div> -->
2495 <!-- </section> -->
2496 <h2 class="operation-title">
2497 <span class="operation-name">
2498 <span class="operation-name">GET</span>
2499 <span class="operation-path">/users/me/videos</span>
2500 </span>
2501 </h2>
2502 <div class="doc-row">
2503 <div class="doc-copy">
2504 <section class="swagger-request-params">
2505 <div class="prop-row prop-group">
2506 <div class="prop-name">
2507 <div class="prop-title">start:
2508 <span class="prop-type">
2509 <span class="json-property-type">number</span>
2510 <span class="json-property-range" title="Value limits"></span>
2511 </span>
2512 </div>
2513 <div class="prop-subtitle"> in query </div>
2514 </div>
2515 <div class="prop-value">
2516 <p>Offset</p>
2517 </div>
2518 </div>
2519 <div class="prop-row prop-group">
2520 <div class="prop-name">
2521 <div class="prop-title">count:
2522 <span class="prop-type">
2523 <span class="json-property-type">number</span>
2524 <span class="json-property-range" title="Value limits"></span>
2525 </span>
2526 </div>
2527 <div class="prop-subtitle"> in query </div>
2528 </div>
2529 <div class="prop-value">
2530 <p>Number of items</p>
2531 </div>
2532 </div>
2533 <div class="prop-row prop-group">
2534 <div class="prop-name">
2535 <div class="prop-title">sort:
2536 <span class="prop-type">
2537 <span class="json-property-type">string</span>
2538 <span class="json-property-range" title="Value limits"></span>
2539 </span>
2540 </div>
2541 <div class="prop-subtitle"> in query </div>
2542 </div>
2543 <div class="prop-value">
2544 <p>Sort column (-createdAt for example)</p>
2545 </div>
2546 </div>
2547 </section>
2548 </div>
2549 <div class="doc-examples"></div>
2550 </div>
2551 <div class="doc-row">
2552 <div class="doc-copy">
2553 <section class="swagger-responses">
2554 <div class="prop-row prop-group">
2555 <div class="prop-name">
2556 <div class="prop-title">200 OK</div>
2557 <div class="prop-ref">
2558 <span class="json-schema-ref-array">
2559 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2560 </span>
2561 </div>
2562 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2563 </div>
2564 <div class="prop-value">
2565 <p>successful operation</p>
2566 </div>
2567 </div>
2568 <div class="prop-row prop-inner">
2569 <div class="prop-name">type</div>
2570 <div class="prop-value">
2571 <span class="json-property-type">
2572 <span class="json-schema-ref-array">
2573 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2574 </span>
2575 </span>
2576 <span class="json-property-range" title="Value limits"></span>
2577 </div>
2578 </div>
2579 </section>
2580 </div>
2581 <div class="doc-examples">
2582 <h5>Response Content-Types:
2583 <span>application/json</span>
2584 </h5>
2585 <section>
2586 <h5>Response Example
2587 <span>(200 OK)</span>
2588 </h5>
2589 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
2590 {
2591 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2592 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2593 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2594 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2595 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2596 <span class="hljs-attr">&quot;category&quot;</span>: {
2597 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2598 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2599 },
2600 <span class="hljs-attr">&quot;licence&quot;</span>: {
2601 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2602 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2603 },
2604 <span class="hljs-attr">&quot;language&quot;</span>: {
2605 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2606 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2607 },
2608 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2609 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2610 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2611 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2612 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2613 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2614 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2615 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2616 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2617 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2618 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2619 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2620 <span class="hljs-attr">&quot;account&quot;</span>: {
2621 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2622 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2623 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2624 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2625 <span class="hljs-attr">&quot;avatar&quot;</span>: {
2626 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2627 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2628 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2629 }
2630 }
2631 }
2632 ]
2633 </code></pre>
2634 <!-- </div> -->
2635 </section>
2636 </div>
2637 </div>
2638 <div class="doc-row">
2639 <div class="doc-copy">
2640 <section class="swagger-request-security">
2641 <table class="table">
2642 <thead>
2643 <tr>
2644 <th class="swagger-request-security-schema"></th>
2645 <th class="swagger-request-security-scopes"></th>
2646 </tr>
2647 </thead>
2648 <tbody>
2649 <tr>
2650 <td>
2651 <a href="#security-definition-OAuth2">OAuth2</a>
2652 </td>
2653 <td> </td>
2654 </tr>
2655 </tbody>
2656 </table>
2657 </section>
2658 </div>
2659 </div>
2660 </div>
2661 <div id="operation--users-register-post" class="operation panel" data-traverse-target="operation--users-register-post">
2662 <!-- <section class="operation-tags row"> -->
2663 <!-- <div class="doc-copy"> -->
2664 <div class="operation-tags">
2665 <a class="label" href="#tag-User">User</a>
2666 <!---->
2667 </div>
2668 <!-- </div> -->
2669 <!-- </section> -->
2670 <h2 class="operation-title">
2671 <span class="operation-name">
2672 <span class="operation-name">POST</span>
2673 <span class="operation-path">/users/register</span>
2674 </span>
2675 </h2>
2676 <div class="doc-row">
2677 <div class="doc-copy">
2678 <section class="swagger-request-body">
2679 <div class="prop-row">
2680 <div class="prop-name">
2681 <div class="swagger-request-model">
2682 <span class="">
2683 <a class="json-schema-ref" href="#/definitions/RegisterUser">RegisterUser</a>
2684 </span>
2685 </div>
2686 </div>
2687 <div class="prop-value columns small-6">
2688 <!-- <div class="swagger-request-description"> -->
2689 <p>undefined</p>
2690 <!-- </div> -->
2691 </div>
2692 </div>
2693 </section>
2694 </div>
2695 <div class="doc-examples">
2696 <section>
2697 <h5>Request Content-Types:
2698 <span>application/json</span>
2699 </h5>
2700 <h5>Request Example</h5>
2701 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2702 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2703 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2704 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2705 }
2706 </code></pre>
2707 <!-- </div> -->
2708 </section>
2709 </div>
2710 </div>
2711 <div class="doc-row">
2712 <div class="doc-copy">
2713 <section class="swagger-responses">
2714 <div class="prop-row prop-group">
2715 <div class="prop-name">
2716 <div class="prop-title">204 No Content</div>
2717 </div>
2718 <div class="prop-value">
2719 <p>Successful operation</p>
2720 </div>
2721 </div>
2722 </section>
2723 </div>
2724 <div class="doc-examples">
2725 <h5>Response Content-Types:
2726 <span>application/json</span>
2727 </h5>
2728 </div>
2729 </div>
2730 </div>
2731 <div id="operation--users-me-avatar-pick-post" class="operation panel" data-traverse-target="operation--users-me-avatar-pick-post">
2732 <!-- <section class="operation-tags row"> -->
2733 <!-- <div class="doc-copy"> -->
2734 <div class="operation-tags">
2735 <a class="label" href="#tag-User">User</a>
2736 <!---->
2737 </div>
2738 <!-- </div> -->
2739 <!-- </section> -->
2740 <h2 class="operation-title">
2741 <span class="operation-name">
2742 <span class="operation-name">POST</span>
2743 <span class="operation-path">/users/me/avatar/pick</span>
2744 </span>
2745 </h2>
2746 <div class="doc-row">
2747 <div class="doc-copy">
2748 <section class="swagger-request-params">
2749 <div class="prop-row prop-group">
2750 <div class="prop-name">
2751 <div class="prop-title">avatarfile:
2752 <span class="prop-type">
2753 <span class="json-property-type">file</span>
2754 <span class="json-property-range" title="Value limits"></span>
2755 </span>
2756 </div>
2757 <div class="prop-subtitle"> in formData </div>
2758 </div>
2759 <div class="prop-value">
2760 <p>The file to upload.</p>
2761 </div>
2762 </div>
2763 </section>
2764 </div>
2765 <div class="doc-examples"></div>
2766 </div>
2767 <div class="doc-row">
2768 <div class="doc-copy">
2769 <section class="swagger-responses">
2770 <div class="prop-row prop-group">
2771 <div class="prop-name">
2772 <div class="prop-title">200 OK</div>
2773 <div class="prop-ref">
2774 <span class="">
2775 <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
2776 </span>
2777 </div>
2778 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2779 </div>
2780 <div class="prop-value">
2781 <p>successful operation</p>
2782 </div>
2783 </div>
2784 </section>
2785 </div>
2786 <div class="doc-examples">
2787 <h5>Response Content-Types:
2788 <span>application/json</span>
2789 </h5>
2790 <section>
2791 <h5>Response Example
2792 <span>(200 OK)</span>
2793 </h5>
2794 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2795 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2796 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2797 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2798 }
2799 </code></pre>
2800 <!-- </div> -->
2801 </section>
2802 </div>
2803 </div>
2804 <div class="doc-row">
2805 <div class="doc-copy">
2806 <section class="swagger-request-security">
2807 <table class="table">
2808 <thead>
2809 <tr>
2810 <th class="swagger-request-security-schema"></th>
2811 <th class="swagger-request-security-scopes"></th>
2812 </tr>
2813 </thead>
2814 <tbody>
2815 <tr>
2816 <td>
2817 <a href="#security-definition-OAuth2">OAuth2</a>
2818 </td>
2819 <td> </td>
2820 </tr>
2821 </tbody>
2822 </table>
2823 </section>
2824 </div>
2825 </div>
2826 </div>
2827 <h1 id="tag-Video" class="swagger-summary-tag" data-traverse-target="tag-Video">Video</h1>
2828 <div id="operation--videos-get" class="operation panel" data-traverse-target="operation--videos-get">
2829 <!-- <section class="operation-tags row"> -->
2830 <!-- <div class="doc-copy"> -->
2831 <div class="operation-tags">
2832 <a class="label" href="#tag-Video">Video</a>
2833 <!---->
2834 </div>
2835 <!-- </div> -->
2836 <!-- </section> -->
2837 <h2 class="operation-title">
2838 <span class="operation-name">
2839 <span class="operation-name">GET</span>
2840 <span class="operation-path">/videos</span>
2841 </span>
2842 </h2>
2843 <div class="doc-row">
2844 <div class="doc-copy">
2845 <section class="swagger-request-params">
2846 <div class="prop-row prop-group">
2847 <div class="prop-name">
2848 <div class="prop-title">category:
2849 <span class="prop-type">
2850 <span class="json-property-type">number</span>
2851 <span class="json-property-range" title="Value limits"></span>
2852 </span>
2853 </div>
2854 <div class="prop-subtitle"> in query </div>
2855 </div>
2856 <div class="prop-value">
2857 <p>category id of the video</p>
2858 </div>
2859 </div>
2860 <div class="prop-row prop-group">
2861 <div class="prop-name">
2862 <div class="prop-title">start:
2863 <span class="prop-type">
2864 <span class="json-property-type">number</span>
2865 <span class="json-property-range" title="Value limits"></span>
2866 </span>
2867 </div>
2868 <div class="prop-subtitle"> in query </div>
2869 </div>
2870 <div class="prop-value">
2871 <p>Offset</p>
2872 </div>
2873 </div>
2874 <div class="prop-row prop-group">
2875 <div class="prop-name">
2876 <div class="prop-title">count:
2877 <span class="prop-type">
2878 <span class="json-property-type">number</span>
2879 <span class="json-property-range" title="Value limits"></span>
2880 </span>
2881 </div>
2882 <div class="prop-subtitle"> in query </div>
2883 </div>
2884 <div class="prop-value">
2885 <p>Number of items</p>
2886 </div>
2887 </div>
2888 <div class="prop-row prop-group">
2889 <div class="prop-name">
2890 <div class="prop-title">sort:
2891 <span class="prop-type">
2892 <span class="json-property-type">string</span>
2893 <span class="json-property-range" title="Value limits"></span>
2894 </span>
2895 </div>
2896 <div class="prop-subtitle"> in query </div>
2897 </div>
2898 <div class="prop-value">
2899 <p>Sort column (-createdAt for example)</p>
2900 </div>
2901 </div>
2902 </section>
2903 </div>
2904 <div class="doc-examples"></div>
2905 </div>
2906 <div class="doc-row">
2907 <div class="doc-copy">
2908 <section class="swagger-responses">
2909 <div class="prop-row prop-group">
2910 <div class="prop-name">
2911 <div class="prop-title">200 OK</div>
2912 <div class="prop-ref">
2913 <span class="json-schema-ref-array">
2914 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2915 </span>
2916 </div>
2917 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2918 </div>
2919 <div class="prop-value">
2920 <p>successful operation</p>
2921 </div>
2922 </div>
2923 <div class="prop-row prop-inner">
2924 <div class="prop-name">type</div>
2925 <div class="prop-value">
2926 <span class="json-property-type">
2927 <span class="json-schema-ref-array">
2928 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2929 </span>
2930 </span>
2931 <span class="json-property-range" title="Value limits"></span>
2932 </div>
2933 </div>
2934 </section>
2935 </div>
2936 <div class="doc-examples">
2937 <h5>Response Content-Types:
2938 <span>application/json</span>
2939 </h5>
2940 <section>
2941 <h5>Response Example
2942 <span>(200 OK)</span>
2943 </h5>
2944 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
2945 {
2946 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2947 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2948 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2949 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2950 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2951 <span class="hljs-attr">&quot;category&quot;</span>: {
2952 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2953 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2954 },
2955 <span class="hljs-attr">&quot;licence&quot;</span>: {
2956 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2957 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2958 },
2959 <span class="hljs-attr">&quot;language&quot;</span>: {
2960 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2961 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2962 },
2963 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2964 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2965 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2966 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2967 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2968 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2969 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2970 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2971 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2972 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2973 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2974 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2975 <span class="hljs-attr">&quot;account&quot;</span>: {
2976 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2977 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2978 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2979 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2980 <span class="hljs-attr">&quot;avatar&quot;</span>: {
2981 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2982 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2983 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2984 }
2985 }
2986 }
2987 ]
2988 </code></pre>
2989 <!-- </div> -->
2990 </section>
2991 </div>
2992 </div>
2993 </div>
2994 <div id="operation--videos-categories-get" class="operation panel" data-traverse-target="operation--videos-categories-get">
2995 <!-- <section class="operation-tags row"> -->
2996 <!-- <div class="doc-copy"> -->
2997 <div class="operation-tags">
2998 <a class="label" href="#tag-Video">Video</a>
2999 <!---->
3000 </div>
3001 <!-- </div> -->
3002 <!-- </section> -->
3003 <h2 class="operation-title">
3004 <span class="operation-name">
3005 <span class="operation-name">GET</span>
3006 <span class="operation-path">/videos/categories</span>
3007 </span>
3008 </h2>
3009 <div class="doc-row">
3010 <div class="doc-copy"> </div>
3011 <div class="doc-examples"></div>
3012 </div>
3013 <div class="doc-row">
3014 <div class="doc-copy">
3015 <section class="swagger-responses">
3016 <div class="prop-row prop-group">
3017 <div class="prop-name">
3018 <div class="prop-title">200 OK</div>
3019 <div class="prop-ref"> </div>
3020 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3021 </div>
3022 <div class="prop-value">
3023 <p>successful operation</p>
3024 </div>
3025 </div>
3026 <div class="prop-row prop-inner">
3027 <div class="prop-name">type</div>
3028 <div class="prop-value">
3029 <span class="json-property-type">string[]</span>
3030 <span class="json-property-range" title="Value limits"></span>
3031 </div>
3032 </div>
3033 </section>
3034 </div>
3035 <div class="doc-examples">
3036 <h5>Response Content-Types:
3037 <span>application/json</span>
3038 </h5>
3039 <section>
3040 <h5>Response Example
3041 <span>(200 OK)</span>
3042 </h5>
3043 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
3044 <span class="hljs-string">&quot;string&quot;</span>
3045 ]
3046 </code></pre>
3047 <!-- </div> -->
3048 </section>
3049 </div>
3050 </div>
3051 </div>
3052 <div id="operation--videos-licences-get" class="operation panel" data-traverse-target="operation--videos-licences-get">
3053 <!-- <section class="operation-tags row"> -->
3054 <!-- <div class="doc-copy"> -->
3055 <div class="operation-tags">
3056 <a class="label" href="#tag-Video">Video</a>
3057 <!---->
3058 </div>
3059 <!-- </div> -->
3060 <!-- </section> -->
3061 <h2 class="operation-title">
3062 <span class="operation-name">
3063 <span class="operation-name">GET</span>
3064 <span class="operation-path">/videos/licences</span>
3065 </span>
3066 </h2>
3067 <div class="doc-row">
3068 <div class="doc-copy"> </div>
3069 <div class="doc-examples"></div>
3070 </div>
3071 <div class="doc-row">
3072 <div class="doc-copy">
3073 <section class="swagger-responses">
3074 <div class="prop-row prop-group">
3075 <div class="prop-name">
3076 <div class="prop-title">200 OK</div>
3077 <div class="prop-ref"> </div>
3078 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3079 </div>
3080 <div class="prop-value">
3081 <p>successful operation</p>
3082 </div>
3083 </div>
3084 <div class="prop-row prop-inner">
3085 <div class="prop-name">type</div>
3086 <div class="prop-value">
3087 <span class="json-property-type">string[]</span>
3088 <span class="json-property-range" title="Value limits"></span>
3089 </div>
3090 </div>
3091 </section>
3092 </div>
3093 <div class="doc-examples">
3094 <h5>Response Content-Types:
3095 <span>application/json</span>
3096 </h5>
3097 <section>
3098 <h5>Response Example
3099 <span>(200 OK)</span>
3100 </h5>
3101 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
3102 <span class="hljs-string">&quot;string&quot;</span>
3103 ]
3104 </code></pre>
3105 <!-- </div> -->
3106 </section>
3107 </div>
3108 </div>
3109 </div>
3110 <div id="operation--videos-languages-get" class="operation panel" data-traverse-target="operation--videos-languages-get">
3111 <!-- <section class="operation-tags row"> -->
3112 <!-- <div class="doc-copy"> -->
3113 <div class="operation-tags">
3114 <a class="label" href="#tag-Video">Video</a>
3115 <!---->
3116 </div>
3117 <!-- </div> -->
3118 <!-- </section> -->
3119 <h2 class="operation-title">
3120 <span class="operation-name">
3121 <span class="operation-name">GET</span>
3122 <span class="operation-path">/videos/languages</span>
3123 </span>
3124 </h2>
3125 <div class="doc-row">
3126 <div class="doc-copy"> </div>
3127 <div class="doc-examples"></div>
3128 </div>
3129 <div class="doc-row">
3130 <div class="doc-copy">
3131 <section class="swagger-responses">
3132 <div class="prop-row prop-group">
3133 <div class="prop-name">
3134 <div class="prop-title">200 OK</div>
3135 <div class="prop-ref"> </div>
3136 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3137 </div>
3138 <div class="prop-value">
3139 <p>successful operation</p>
3140 </div>
3141 </div>
3142 <div class="prop-row prop-inner">
3143 <div class="prop-name">type</div>
3144 <div class="prop-value">
3145 <span class="json-property-type">string[]</span>
3146 <span class="json-property-range" title="Value limits"></span>
3147 </div>
3148 </div>
3149 </section>
3150 </div>
3151 <div class="doc-examples">
3152 <h5>Response Content-Types:
3153 <span>application/json</span>
3154 </h5>
3155 <section>
3156 <h5>Response Example
3157 <span>(200 OK)</span>
3158 </h5>
3159 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
3160 <span class="hljs-string">&quot;string&quot;</span>
3161 ]
3162 </code></pre>
3163 <!-- </div> -->
3164 </section>
3165 </div>
3166 </div>
3167 </div>
3168 <div id="operation--videos-privacies-get" class="operation panel" data-traverse-target="operation--videos-privacies-get">
3169 <!-- <section class="operation-tags row"> -->
3170 <!-- <div class="doc-copy"> -->
3171 <div class="operation-tags">
3172 <a class="label" href="#tag-Video">Video</a>
3173 <!---->
3174 </div>
3175 <!-- </div> -->
3176 <!-- </section> -->
3177 <h2 class="operation-title">
3178 <span class="operation-name">
3179 <span class="operation-name">GET</span>
3180 <span class="operation-path">/videos/privacies</span>
3181 </span>
3182 </h2>
3183 <div class="doc-row">
3184 <div class="doc-copy"> </div>
3185 <div class="doc-examples"></div>
3186 </div>
3187 <div class="doc-row">
3188 <div class="doc-copy">
3189 <section class="swagger-responses">
3190 <div class="prop-row prop-group">
3191 <div class="prop-name">
3192 <div class="prop-title">200 OK</div>
3193 <div class="prop-ref"> </div>
3194 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3195 </div>
3196 <div class="prop-value">
3197 <p>successful operation</p>
3198 </div>
3199 </div>
3200 <div class="prop-row prop-inner">
3201 <div class="prop-name">type</div>
3202 <div class="prop-value">
3203 <span class="json-property-type">string[]</span>
3204 <span class="json-property-range" title="Value limits"></span>
3205 </div>
3206 </div>
3207 </section>
3208 </div>
3209 <div class="doc-examples">
3210 <h5>Response Content-Types:
3211 <span>application/json</span>
3212 </h5>
3213 <section>
3214 <h5>Response Example
3215 <span>(200 OK)</span>
3216 </h5>
3217 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
3218 <span class="hljs-string">&quot;string&quot;</span>
3219 ]
3220 </code></pre>
3221 <!-- </div> -->
3222 </section>
3223 </div>
3224 </div>
3225 </div>
3226 <div id="operation--videos-search-get" class="operation panel" data-traverse-target="operation--videos-search-get">
3227 <!-- <section class="operation-tags row"> -->
3228 <!-- <div class="doc-copy"> -->
3229 <div class="operation-tags">
3230 <a class="label" href="#tag-Video">Video</a>
3231 <!---->
3232 </div>
3233 <!-- </div> -->
3234 <!-- </section> -->
3235 <h2 class="operation-title">
3236 <span class="operation-name">
3237 <span class="operation-name">GET</span>
3238 <span class="operation-path">/videos/search</span>
3239 </span>
3240 </h2>
3241 <div class="doc-row">
3242 <div class="doc-copy">
3243 <section class="swagger-request-params">
3244 <div class="prop-row prop-group">
3245 <div class="prop-name">
3246 <div class="prop-title">start:
3247 <span class="prop-type">
3248 <span class="json-property-type">number</span>
3249 <span class="json-property-range" title="Value limits"></span>
3250 </span>
3251 </div>
3252 <div class="prop-subtitle"> in query </div>
3253 </div>
3254 <div class="prop-value">
3255 <p>Offset</p>
3256 </div>
3257 </div>
3258 <div class="prop-row prop-group">
3259 <div class="prop-name">
3260 <div class="prop-title">count:
3261 <span class="prop-type">
3262 <span class="json-property-type">number</span>
3263 <span class="json-property-range" title="Value limits"></span>
3264 </span>
3265 </div>
3266 <div class="prop-subtitle"> in query </div>
3267 </div>
3268 <div class="prop-value">
3269 <p>Number of items</p>
3270 </div>
3271 </div>
3272 <div class="prop-row prop-group">
3273 <div class="prop-name">
3274 <div class="prop-title">sort:
3275 <span class="prop-type">
3276 <span class="json-property-type">string</span>
3277 <span class="json-property-range" title="Value limits"></span>
3278 </span>
3279 </div>
3280 <div class="prop-subtitle"> in query </div>
3281 </div>
3282 <div class="prop-value">
3283 <p>Sort column (-createdAt for example)</p>
3284 </div>
3285 </div>
3286 </section>
3287 </div>
3288 <div class="doc-examples"></div>
3289 </div>
3290 <div class="doc-row">
3291 <div class="doc-copy">
3292 <section class="swagger-responses">
3293 <div class="prop-row prop-group">
3294 <div class="prop-name">
3295 <div class="prop-title">200 OK</div>
3296 <div class="prop-ref">
3297 <span class="json-schema-ref-array">
3298 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
3299 </span>
3300 </div>
3301 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3302 </div>
3303 <div class="prop-value">
3304 <p>successful operation</p>
3305 </div>
3306 </div>
3307 <div class="prop-row prop-inner">
3308 <div class="prop-name">type</div>
3309 <div class="prop-value">
3310 <span class="json-property-type">
3311 <span class="json-schema-ref-array">
3312 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
3313 </span>
3314 </span>
3315 <span class="json-property-range" title="Value limits"></span>
3316 </div>
3317 </div>
3318 </section>
3319 </div>
3320 <div class="doc-examples">
3321 <h5>Response Content-Types:
3322 <span>application/json</span>
3323 </h5>
3324 <section>
3325 <h5>Response Example
3326 <span>(200 OK)</span>
3327 </h5>
3328 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
3329 {
3330 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3331 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3332 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3333 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3334 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3335 <span class="hljs-attr">&quot;category&quot;</span>: {
3336 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3337 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3338 },
3339 <span class="hljs-attr">&quot;licence&quot;</span>: {
3340 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3341 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3342 },
3343 <span class="hljs-attr">&quot;language&quot;</span>: {
3344 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3345 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3346 },
3347 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3348 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3349 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3350 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3351 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3352 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3353 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3354 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3355 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3356 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3357 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3358 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3359 <span class="hljs-attr">&quot;account&quot;</span>: {
3360 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3361 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3362 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3363 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3364 <span class="hljs-attr">&quot;avatar&quot;</span>: {
3365 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3366 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3367 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3368 }
3369 }
3370 }
3371 ]
3372 </code></pre>
3373 <!-- </div> -->
3374 </section>
3375 </div>
3376 </div>
3377 </div>
3378 <div id="operation--videos--id--put" class="operation panel" data-traverse-target="operation--videos--id--put">
3379 <!-- <section class="operation-tags row"> -->
3380 <!-- <div class="doc-copy"> -->
3381 <div class="operation-tags">
3382 <a class="label" href="#tag-Video">Video</a>
3383 <!---->
3384 </div>
3385 <!-- </div> -->
3386 <!-- </section> -->
3387 <h2 class="operation-title">
3388 <span class="operation-name">
3389 <span class="operation-name">PUT</span>
3390 <span class="operation-path">/videos/{id}</span>
3391 </span>
3392 </h2>
3393 <div class="doc-row">
3394 <div class="doc-copy">
3395 <section class="swagger-request-params">
3396 <div class="prop-row prop-group">
3397 <div class="prop-name">
3398 <div class="prop-title">id:
3399 <span class="prop-type">
3400 <span class="json-property-type">string</span>
3401 <span class="json-property-range" title="Value limits"></span>
3402 </span>
3403 </div>
3404 <span class="json-property-required"></span>
3405 <div class="prop-subtitle"> in path </div>
3406 </div>
3407 <div class="prop-value">
3408 <p>The video id or uuid</p>
3409 </div>
3410 </div>
3411 <div class="prop-row prop-group">
3412 <div class="prop-name">
3413 <div class="prop-title">thumbnailfile:
3414 <span class="prop-type">
3415 <span class="json-property-type">file</span>
3416 <span class="json-property-range" title="Value limits"></span>
3417 </span>
3418 </div>
3419 <div class="prop-subtitle"> in formData </div>
3420 </div>
3421 <div class="prop-value">
3422 <p>Video thumbnail file</p>
3423 </div>
3424 </div>
3425 <div class="prop-row prop-group">
3426 <div class="prop-name">
3427 <div class="prop-title">previewfile:
3428 <span class="prop-type">
3429 <span class="json-property-type">file</span>
3430 <span class="json-property-range" title="Value limits"></span>
3431 </span>
3432 </div>
3433 <div class="prop-subtitle"> in formData </div>
3434 </div>
3435 <div class="prop-value">
3436 <p>Video preview file</p>
3437 </div>
3438 </div>
3439 <div class="prop-row prop-group">
3440 <div class="prop-name">
3441 <div class="prop-title">category:
3442 <span class="prop-type">
3443 <span class="json-property-type">number</span>
3444 <span class="json-property-range" title="Value limits"></span>
3445 </span>
3446 </div>
3447 <div class="prop-subtitle"> in formData </div>
3448 </div>
3449 <div class="prop-value">
3450 <p>Video category</p>
3451 </div>
3452 </div>
3453 <div class="prop-row prop-group">
3454 <div class="prop-name">
3455 <div class="prop-title">licence:
3456 <span class="prop-type">
3457 <span class="json-property-type">number</span>
3458 <span class="json-property-range" title="Value limits"></span>
3459 </span>
3460 </div>
3461 <div class="prop-subtitle"> in formData </div>
3462 </div>
3463 <div class="prop-value">
3464 <p>Video licence</p>
3465 </div>
3466 </div>
3467 <div class="prop-row prop-group">
3468 <div class="prop-name">
3469 <div class="prop-title">language:
3470 <span class="prop-type">
3471 <span class="json-property-type">string</span>
3472 <span class="json-property-range" title="Value limits"></span>
3473 </span>
3474 </div>
3475 <div class="prop-subtitle"> in formData </div>
3476 </div>
3477 <div class="prop-value">
3478 <p>Video language</p>
3479 </div>
3480 </div>
3481 <div class="prop-row prop-group">
3482 <div class="prop-name">
3483 <div class="prop-title">description:
3484 <span class="prop-type">
3485 <span class="json-property-type">string</span>
3486 <span class="json-property-range" title="Value limits"></span>
3487 </span>
3488 </div>
3489 <div class="prop-subtitle"> in formData </div>
3490 </div>
3491 <div class="prop-value">
3492 <p>Video description</p>
3493 </div>
3494 </div>
3495 <div class="prop-row prop-group">
3496 <div class="prop-name">
3497 <div class="prop-title">waitTranscoding:
3498 <span class="prop-type">
3499 <span class="json-property-type">boolean</span>
3500 <span class="json-property-range" title="Value limits"></span>
3501 </span>
3502 </div>
3503 <div class="prop-subtitle"> in formData </div>
3504 </div>
3505 <div class="prop-value">
3506 <p>Whether or not we wait transcoding before publish the video</p>
3507 </div>
3508 </div>
3509 <div class="prop-row prop-group">
3510 <div class="prop-name">
3511 <div class="prop-title">support:
3512 <span class="prop-type">
3513 <span class="json-property-type">string</span>
3514 <span class="json-property-range" title="Value limits"></span>
3515 </span>
3516 </div>
3517 <div class="prop-subtitle"> in formData </div>
3518 </div>
3519 <div class="prop-value">
3520 <p>Text describing how to support the video uploader</p>
3521 </div>
3522 </div>
3523 <div class="prop-row prop-group">
3524 <div class="prop-name">
3525 <div class="prop-title">nsfw:
3526 <span class="prop-type">
3527 <span class="json-property-type">boolean</span>
3528 <span class="json-property-range" title="Value limits"></span>
3529 </span>
3530 </div>
3531 <div class="prop-subtitle"> in formData </div>
3532 </div>
3533 <div class="prop-value">
3534 <p>Whether or not this video contains sensitive content</p>
3535 </div>
3536 </div>
3537 <div class="prop-row prop-group">
3538 <div class="prop-name">
3539 <div class="prop-title">name:
3540 <span class="prop-type">
3541 <span class="json-property-type">string</span>
3542 <span class="json-property-range" title="Value limits"></span>
3543 </span>
3544 </div>
3545 <div class="prop-subtitle"> in formData </div>
3546 </div>
3547 <div class="prop-value">
3548 <p>Video name</p>
3549 </div>
3550 </div>
3551 <div class="prop-row prop-group">
3552 <div class="prop-name">
3553 <div class="prop-title">tags:
3554 <span class="prop-type">
3555 <span class="json-property-type">string[]</span>
3556 <span class="json-property-range" title="Value limits"></span>
3557 </span>
3558 </div>
3559 <div class="prop-subtitle"> in formData </div>
3560 </div>
3561 <div class="prop-value">
3562 <p>Video tags</p>
3563 </div>
3564 </div>
3565 <div class="prop-row prop-group">
3566 <div class="prop-name">
3567 <div class="prop-title">commentsEnabled:
3568 <span class="prop-type">
3569 <span class="json-property-type">boolean</span>
3570 <span class="json-property-range" title="Value limits"></span>
3571 </span>
3572 </div>
3573 <div class="prop-subtitle"> in formData </div>
3574 </div>
3575 <div class="prop-value">
3576 <p>Enable or disable comments for this video</p>
3577 </div>
3578 </div>
3579 <div class="prop-row prop-group">
3580 <div class="prop-name">
3581 <div class="prop-title">privacy:
3582 <span class="prop-type">
3583 <span class="json-property-type">string</span>
3584 <span class="json-property-enum" title="Possible values">
3585 <span class="json-property-enum-item">Public</span>,
3586 <span class="json-property-enum-item">Unlisted</span>
3587 </span>
3588 <span class="json-property-range" title="Value limits"></span>
3589 </span>
3590 </div>
3591 <div class="prop-subtitle"> in formData </div>
3592 </div>
3593 <div class="prop-value">
3594 <p>Video privacy</p>
3595 </div>
3596 </div>
3597 <div class="prop-row prop-group">
3598 <div class="prop-name">
3599 <div class="prop-title">scheduleUpdate:
3600 <span class="prop-type">
3601 <span class="json-property-type">object</span>
3602 <span class="json-property-range" title="Value limits"></span>
3603 </span>
3604 </div>
3605 <div class="prop-subtitle"> in formData </div>
3606 </div>
3607 <div class="prop-value">
3608 <p>Schedule an update at a specific datetime</p>
3609 </div>
3610 </div>
3611 </section>
3612 </div>
3613 <div class="doc-examples"></div>
3614 </div>
3615 <div class="doc-row">
3616 <div class="doc-copy">
3617 <section class="swagger-responses">
3618 <div class="prop-row prop-group">
3619 <div class="prop-name">
3620 <div class="prop-title">200 OK</div>
3621 <div class="prop-ref">
3622 <span class="">
3623 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
3624 </span>
3625 </div>
3626 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3627 </div>
3628 <div class="prop-value">
3629 <p>successful operation</p>
3630 </div>
3631 </div>
3632 </section>
3633 </div>
3634 <div class="doc-examples">
3635 <h5>Response Content-Types:
3636 <span>application/json</span>
3637 </h5>
3638 <section>
3639 <h5>Response Example
3640 <span>(200 OK)</span>
3641 </h5>
3642 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
3643 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3644 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3645 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3646 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3647 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3648 <span class="hljs-attr">&quot;category&quot;</span>: {
3649 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3650 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3651 },
3652 <span class="hljs-attr">&quot;licence&quot;</span>: {
3653 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3654 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3655 },
3656 <span class="hljs-attr">&quot;language&quot;</span>: {
3657 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3658 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3659 },
3660 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3661 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3662 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3663 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3664 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3665 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3666 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3667 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3668 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3669 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3670 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3671 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3672 <span class="hljs-attr">&quot;account&quot;</span>: {
3673 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3674 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3675 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3676 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3677 <span class="hljs-attr">&quot;avatar&quot;</span>: {
3678 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3679 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3680 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3681 }
3682 }
3683 }
3684 </code></pre>
3685 <!-- </div> -->
3686 </section>
3687 </div>
3688 </div>
3689 <div class="doc-row">
3690 <div class="doc-copy">
3691 <section class="swagger-request-security">
3692 <table class="table">
3693 <thead>
3694 <tr>
3695 <th class="swagger-request-security-schema"></th>
3696 <th class="swagger-request-security-scopes"></th>
3697 </tr>
3698 </thead>
3699 <tbody>
3700 <tr>
3701 <td>
3702 <a href="#security-definition-OAuth2">OAuth2</a>
3703 </td>
3704 <td> </td>
3705 </tr>
3706 </tbody>
3707 </table>
3708 </section>
3709 </div>
3710 </div>
3711 </div>
3712 <div id="operation--videos--id--get" class="operation panel" data-traverse-target="operation--videos--id--get">
3713 <!-- <section class="operation-tags row"> -->
3714 <!-- <div class="doc-copy"> -->
3715 <div class="operation-tags">
3716 <a class="label" href="#tag-Video">Video</a>
3717 <!---->
3718 </div>
3719 <!-- </div> -->
3720 <!-- </section> -->
3721 <h2 class="operation-title">
3722 <span class="operation-name">
3723 <span class="operation-name">GET</span>
3724 <span class="operation-path">/videos/{id}</span>
3725 </span>
3726 </h2>
3727 <div class="doc-row">
3728 <div class="doc-copy">
3729 <section class="swagger-request-params">
3730 <div class="prop-row prop-group">
3731 <div class="prop-name">
3732 <div class="prop-title">id:
3733 <span class="prop-type">
3734 <span class="json-property-type">string</span>
3735 <span class="json-property-range" title="Value limits"></span>
3736 </span>
3737 </div>
3738 <span class="json-property-required"></span>
3739 <div class="prop-subtitle"> in path </div>
3740 </div>
3741 <div class="prop-value">
3742 <p>The video id or uuid</p>
3743 </div>
3744 </div>
3745 </section>
3746 </div>
3747 <div class="doc-examples"></div>
3748 </div>
3749 <div class="doc-row">
3750 <div class="doc-copy">
3751 <section class="swagger-responses">
3752 <div class="prop-row prop-group">
3753 <div class="prop-name">
3754 <div class="prop-title">200 OK</div>
3755 <div class="prop-ref">
3756 <span class="">
3757 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
3758 </span>
3759 </div>
3760 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3761 </div>
3762 <div class="prop-value">
3763 <p>successful operation</p>
3764 </div>
3765 </div>
3766 </section>
3767 </div>
3768 <div class="doc-examples">
3769 <h5>Response Content-Types:
3770 <span>application/json</span>
3771 </h5>
3772 <section>
3773 <h5>Response Example
3774 <span>(200 OK)</span>
3775 </h5>
3776 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
3777 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3778 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3779 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3780 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3781 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3782 <span class="hljs-attr">&quot;category&quot;</span>: {
3783 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3784 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3785 },
3786 <span class="hljs-attr">&quot;licence&quot;</span>: {
3787 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3788 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3789 },
3790 <span class="hljs-attr">&quot;language&quot;</span>: {
3791 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3792 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3793 },
3794 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3795 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3796 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3797 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3798 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3799 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3800 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3801 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3802 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3803 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3804 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3805 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3806 <span class="hljs-attr">&quot;account&quot;</span>: {
3807 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3808 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3809 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3810 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3811 <span class="hljs-attr">&quot;avatar&quot;</span>: {
3812 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3813 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3814 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3815 }
3816 }
3817 }
3818 </code></pre>
3819 <!-- </div> -->
3820 </section>
3821 </div>
3822 </div>
3823 </div>
3824 <div id="operation--videos--id--delete" class="operation panel" data-traverse-target="operation--videos--id--delete">
3825 <!-- <section class="operation-tags row"> -->
3826 <!-- <div class="doc-copy"> -->
3827 <div class="operation-tags">
3828 <a class="label" href="#tag-Video">Video</a>
3829 <!---->
3830 </div>
3831 <!-- </div> -->
3832 <!-- </section> -->
3833 <h2 class="operation-title">
3834 <span class="operation-name">
3835 <span class="operation-name">DELETE</span>
3836 <span class="operation-path">/videos/{id}</span>
3837 </span>
3838 </h2>
3839 <div class="doc-row">
3840 <div class="doc-copy">
3841 <section class="swagger-request-params">
3842 <div class="prop-row prop-group">
3843 <div class="prop-name">
3844 <div class="prop-title">id:
3845 <span class="prop-type">
3846 <span class="json-property-type">string</span>
3847 <span class="json-property-range" title="Value limits"></span>
3848 </span>
3849 </div>
3850 <span class="json-property-required"></span>
3851 <div class="prop-subtitle"> in path </div>
3852 </div>
3853 <div class="prop-value">
3854 <p>The video id or uuid</p>
3855 </div>
3856 </div>
3857 </section>
3858 </div>
3859 <div class="doc-examples"></div>
3860 </div>
3861 <div class="doc-row">
3862 <div class="doc-copy">
3863 <section class="swagger-responses">
3864 <div class="prop-row prop-group">
3865 <div class="prop-name">
3866 <div class="prop-title">204 No Content</div>
3867 </div>
3868 <div class="prop-value">
3869 <p>Successful operation</p>
3870 </div>
3871 </div>
3872 </section>
3873 </div>
3874 <div class="doc-examples">
3875 <h5>Response Content-Types:
3876 <span>application/json</span>
3877 </h5>
3878 </div>
3879 </div>
3880 <div class="doc-row">
3881 <div class="doc-copy">
3882 <section class="swagger-request-security">
3883 <table class="table">
3884 <thead>
3885 <tr>
3886 <th class="swagger-request-security-schema"></th>
3887 <th class="swagger-request-security-scopes"></th>
3888 </tr>
3889 </thead>
3890 <tbody>
3891 <tr>
3892 <td>
3893 <a href="#security-definition-OAuth2">OAuth2</a>
3894 </td>
3895 <td> </td>
3896 </tr>
3897 </tbody>
3898 </table>
3899 </section>
3900 </div>
3901 </div>
3902 </div>
3903 <div id="operation--videos--id--description-get" class="operation panel" data-traverse-target="operation--videos--id--description-get">
3904 <!-- <section class="operation-tags row"> -->
3905 <!-- <div class="doc-copy"> -->
3906 <div class="operation-tags">
3907 <a class="label" href="#tag-Video">Video</a>
3908 <!---->
3909 </div>
3910 <!-- </div> -->
3911 <!-- </section> -->
3912 <h2 class="operation-title">
3913 <span class="operation-name">
3914 <span class="operation-name">GET</span>
3915 <span class="operation-path">/videos/{id}/description</span>
3916 </span>
3917 </h2>
3918 <div class="doc-row">
3919 <div class="doc-copy">
3920 <section class="swagger-request-params">
3921 <div class="prop-row prop-group">
3922 <div class="prop-name">
3923 <div class="prop-title">id:
3924 <span class="prop-type">
3925 <span class="json-property-type">string</span>
3926 <span class="json-property-range" title="Value limits"></span>
3927 </span>
3928 </div>
3929 <span class="json-property-required"></span>
3930 <div class="prop-subtitle"> in path </div>
3931 </div>
3932 <div class="prop-value">
3933 <p>The video id or uuid</p>
3934 </div>
3935 </div>
3936 </section>
3937 </div>
3938 <div class="doc-examples"></div>
3939 </div>
3940 <div class="doc-row">
3941 <div class="doc-copy">
3942 <section class="swagger-responses">
3943 <div class="prop-row prop-group">
3944 <div class="prop-name">
3945 <div class="prop-title">200 OK</div>
3946 <div class="prop-ref"> </div>
3947 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3948 </div>
3949 <div class="prop-value">
3950 <p>successful operation</p>
3951 </div>
3952 </div>
3953 <div class="prop-row prop-inner">
3954 <div class="prop-name">type</div>
3955 <div class="prop-value">
3956 <span class="json-property-type">string</span>
3957 <span class="json-property-range" title="Value limits"></span>
3958 </div>
3959 </div>
3960 </section>
3961 </div>
3962 <div class="doc-examples">
3963 <h5>Response Content-Types:
3964 <span>application/json</span>
3965 </h5>
3966 <section>
3967 <h5>Response Example
3968 <span>(200 OK)</span>
3969 </h5>
3970 <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">&quot;string&quot;</span>
3971 </code></pre>
3972 <!-- </div> -->
3973 </section>
3974 </div>
3975 </div>
3976 </div>
3977 <div id="operation--videos--id--views-post" class="operation panel" data-traverse-target="operation--videos--id--views-post">
3978 <!-- <section class="operation-tags row"> -->
3979 <!-- <div class="doc-copy"> -->
3980 <div class="operation-tags">
3981 <a class="label" href="#tag-Video">Video</a>
3982 <!---->
3983 </div>
3984 <!-- </div> -->
3985 <!-- </section> -->
3986 <h2 class="operation-title">
3987 <span class="operation-name">
3988 <span class="operation-name">POST</span>
3989 <span class="operation-path">/videos/{id}/views</span>
3990 </span>
3991 </h2>
3992 <div class="doc-row">
3993 <div class="doc-copy">
3994 <section class="swagger-request-params">
3995 <div class="prop-row prop-group">
3996 <div class="prop-name">
3997 <div class="prop-title">id:
3998 <span class="prop-type">
3999 <span class="json-property-type">string</span>
4000 <span class="json-property-range" title="Value limits"></span>
4001 </span>
4002 </div>
4003 <span class="json-property-required"></span>
4004 <div class="prop-subtitle"> in path </div>
4005 </div>
4006 <div class="prop-value">
4007 <p>The video id or uuid</p>
4008 </div>
4009 </div>
4010 </section>
4011 </div>
4012 <div class="doc-examples"></div>
4013 </div>
4014 <div class="doc-row">
4015 <div class="doc-copy">
4016 <section class="swagger-responses">
4017 <div class="prop-row prop-group">
4018 <div class="prop-name">
4019 <div class="prop-title">204 No Content</div>
4020 </div>
4021 <div class="prop-value">
4022 <p>Successful operation</p>
4023 </div>
4024 </div>
4025 </section>
4026 </div>
4027 <div class="doc-examples">
4028 <h5>Response Content-Types:
4029 <span>application/json</span>
4030 </h5>
4031 </div>
4032 </div>
4033 </div>
4034 <div id="operation--videos-upload-post" class="operation panel" data-traverse-target="operation--videos-upload-post">
4035 <!-- <section class="operation-tags row"> -->
4036 <!-- <div class="doc-copy"> -->
4037 <div class="operation-tags">
4038 <a class="label" href="#tag-Video">Video</a>
4039 <!---->
4040 </div>
4041 <!-- </div> -->
4042 <!-- </section> -->
4043 <h2 class="operation-title">
4044 <span class="operation-name">
4045 <span class="operation-name">POST</span>
4046 <span class="operation-path">/videos/upload</span>
4047 </span>
4048 </h2>
4049 <div class="doc-row">
4050 <div class="doc-copy">
4051 <section class="swagger-request-params">
4052 <div class="prop-row prop-group">
4053 <div class="prop-name">
4054 <div class="prop-title">videofile:
4055 <span class="prop-type">
4056 <span class="json-property-type">file</span>
4057 <span class="json-property-range" title="Value limits"></span>
4058 </span>
4059 </div>
4060 <span class="json-property-required"></span>
4061 <div class="prop-subtitle"> in formData </div>
4062 </div>
4063 <div class="prop-value">
4064 <p>Video file</p>
4065 </div>
4066 </div>
4067 <div class="prop-row prop-group">
4068 <div class="prop-name">
4069 <div class="prop-title">channelId:
4070 <span class="prop-type">
4071 <span class="json-property-type">number</span>
4072 <span class="json-property-range" title="Value limits"></span>
4073 </span>
4074 </div>
4075 <span class="json-property-required"></span>
4076 <div class="prop-subtitle"> in formData </div>
4077 </div>
4078 <div class="prop-value">
4079 <p>Channel id that will contain this video</p>
4080 </div>
4081 </div>
4082 <div class="prop-row prop-group">
4083 <div class="prop-name">
4084 <div class="prop-title">thumbnailfile:
4085 <span class="prop-type">
4086 <span class="json-property-type">file</span>
4087 <span class="json-property-range" title="Value limits"></span>
4088 </span>
4089 </div>
4090 <div class="prop-subtitle"> in formData </div>
4091 </div>
4092 <div class="prop-value">
4093 <p>Video thumbnail file</p>
4094 </div>
4095 </div>
4096 <div class="prop-row prop-group">
4097 <div class="prop-name">
4098 <div class="prop-title">previewfile:
4099 <span class="prop-type">
4100 <span class="json-property-type">file</span>
4101 <span class="json-property-range" title="Value limits"></span>
4102 </span>
4103 </div>
4104 <div class="prop-subtitle"> in formData </div>
4105 </div>
4106 <div class="prop-value">
4107 <p>Video preview file</p>
4108 </div>
4109 </div>
4110 <div class="prop-row prop-group">
4111 <div class="prop-name">
4112 <div class="prop-title">category:
4113 <span class="prop-type">
4114 <span class="json-property-type">number</span>
4115 <span class="json-property-range" title="Value limits"></span>
4116 </span>
4117 </div>
4118 <div class="prop-subtitle"> in formData </div>
4119 </div>
4120 <div class="prop-value">
4121 <p>Video category</p>
4122 </div>
4123 </div>
4124 <div class="prop-row prop-group">
4125 <div class="prop-name">
4126 <div class="prop-title">licence:
4127 <span class="prop-type">
4128 <span class="json-property-type">number</span>
4129 <span class="json-property-range" title="Value limits"></span>
4130 </span>
4131 </div>
4132 <div class="prop-subtitle"> in formData </div>
4133 </div>
4134 <div class="prop-value">
4135 <p>Video licence</p>
4136 </div>
4137 </div>
4138 <div class="prop-row prop-group">
4139 <div class="prop-name">
4140 <div class="prop-title">language:
4141 <span class="prop-type">
4142 <span class="json-property-type">string</span>
4143 <span class="json-property-range" title="Value limits"></span>
4144 </span>
4145 </div>
4146 <div class="prop-subtitle"> in formData </div>
4147 </div>
4148 <div class="prop-value">
4149 <p>Video language</p>
4150 </div>
4151 </div>
4152 <div class="prop-row prop-group">
4153 <div class="prop-name">
4154 <div class="prop-title">description:
4155 <span class="prop-type">
4156 <span class="json-property-type">string</span>
4157 <span class="json-property-range" title="Value limits"></span>
4158 </span>
4159 </div>
4160 <div class="prop-subtitle"> in formData </div>
4161 </div>
4162 <div class="prop-value">
4163 <p>Video description</p>
4164 </div>
4165 </div>
4166 <div class="prop-row prop-group">
4167 <div class="prop-name">
4168 <div class="prop-title">waitTranscoding:
4169 <span class="prop-type">
4170 <span class="json-property-type">boolean</span>
4171 <span class="json-property-range" title="Value limits"></span>
4172 </span>
4173 </div>
4174 <div class="prop-subtitle"> in formData </div>
4175 </div>
4176 <div class="prop-value">
4177 <p>Whether or not we wait transcoding before publish the video</p>
4178 </div>
4179 </div>
4180 <div class="prop-row prop-group">
4181 <div class="prop-name">
4182 <div class="prop-title">support:
4183 <span class="prop-type">
4184 <span class="json-property-type">string</span>
4185 <span class="json-property-range" title="Value limits"></span>
4186 </span>
4187 </div>
4188 <div class="prop-subtitle"> in formData </div>
4189 </div>
4190 <div class="prop-value">
4191 <p>Text describing how to support the video uploader</p>
4192 </div>
4193 </div>
4194 <div class="prop-row prop-group">
4195 <div class="prop-name">
4196 <div class="prop-title">nsfw:
4197 <span class="prop-type">
4198 <span class="json-property-type">boolean</span>
4199 <span class="json-property-range" title="Value limits"></span>
4200 </span>
4201 </div>
4202 <div class="prop-subtitle"> in formData </div>
4203 </div>
4204 <div class="prop-value">
4205 <p>Whether or not this video contains sensitive content</p>
4206 </div>
4207 </div>
4208 <div class="prop-row prop-group">
4209 <div class="prop-name">
4210 <div class="prop-title">name:
4211 <span class="prop-type">
4212 <span class="json-property-type">string</span>
4213 <span class="json-property-range" title="Value limits"></span>
4214 </span>
4215 </div>
4216 <div class="prop-subtitle"> in formData </div>
4217 </div>
4218 <div class="prop-value">
4219 <p>Video name</p>
4220 </div>
4221 </div>
4222 <div class="prop-row prop-group">
4223 <div class="prop-name">
4224 <div class="prop-title">tags:
4225 <span class="prop-type">
4226 <span class="json-property-type">string[]</span>
4227 <span class="json-property-range" title="Value limits"></span>
4228 </span>
4229 </div>
4230 <div class="prop-subtitle"> in formData </div>
4231 </div>
4232 <div class="prop-value">
4233 <p>Video tags</p>
4234 </div>
4235 </div>
4236 <div class="prop-row prop-group">
4237 <div class="prop-name">
4238 <div class="prop-title">commentsEnabled:
4239 <span class="prop-type">
4240 <span class="json-property-type">boolean</span>
4241 <span class="json-property-range" title="Value limits"></span>
4242 </span>
4243 </div>
4244 <div class="prop-subtitle"> in formData </div>
4245 </div>
4246 <div class="prop-value">
4247 <p>Enable or disable comments for this video</p>
4248 </div>
4249 </div>
4250 <div class="prop-row prop-group">
4251 <div class="prop-name">
4252 <div class="prop-title">privacy:
4253 <span class="prop-type">
4254 <span class="json-property-type">string</span>
4255 <span class="json-property-enum" title="Possible values">
4256 <span class="json-property-enum-item">Public</span>,
4257 <span class="json-property-enum-item">Unlisted</span>
4258 </span>
4259 <span class="json-property-range" title="Value limits"></span>
4260 </span>
4261 </div>
4262 <div class="prop-subtitle"> in formData </div>
4263 </div>
4264 <div class="prop-value">
4265 <p>Video privacy</p>
4266 </div>
4267 </div>
4268 <div class="prop-row prop-group">
4269 <div class="prop-name">
4270 <div class="prop-title">scheduleUpdate:
4271 <span class="prop-type">
4272 <span class="json-property-type">object</span>
4273 <span class="json-property-range" title="Value limits"></span>
4274 </span>
4275 </div>
4276 <div class="prop-subtitle"> in formData </div>
4277 </div>
4278 <div class="prop-value">
4279 <p>Schedule an update at a specific datetime</p>
4280 </div>
4281 </div>
4282 </section>
4283 </div>
4284 <div class="doc-examples"></div>
4285 </div>
4286 <div class="doc-row">
4287 <div class="doc-copy">
4288 <section class="swagger-responses">
4289 <div class="prop-row prop-group">
4290 <div class="prop-name">
4291 <div class="prop-title">200 OK</div>
4292 <div class="prop-ref">
4293 <span class="">
4294 <a class="json-schema-ref" href="#/definitions/VideoUploadResponse">VideoUploadResponse</a>
4295 </span>
4296 </div>
4297 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4298 </div>
4299 <div class="prop-value">
4300 <p>successful operation</p>
4301 </div>
4302 </div>
4303 </section>
4304 </div>
4305 <div class="doc-examples">
4306 <h5>Response Content-Types:
4307 <span>application/json</span>
4308 </h5>
4309 <section>
4310 <h5>Response Example
4311 <span>(200 OK)</span>
4312 </h5>
4313 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
4314 <span class="hljs-attr">&quot;video&quot;</span>: {
4315 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4316 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4317 }
4318 }
4319 </code></pre>
4320 <!-- </div> -->
4321 </section>
4322 </div>
4323 </div>
4324 <div class="doc-row">
4325 <div class="doc-copy">
4326 <section class="swagger-request-security">
4327 <table class="table">
4328 <thead>
4329 <tr>
4330 <th class="swagger-request-security-schema"></th>
4331 <th class="swagger-request-security-scopes"></th>
4332 </tr>
4333 </thead>
4334 <tbody>
4335 <tr>
4336 <td>
4337 <a href="#security-definition-OAuth2">OAuth2</a>
4338 </td>
4339 <td> </td>
4340 </tr>
4341 </tbody>
4342 </table>
4343 </section>
4344 </div>
4345 </div>
4346 </div>
4347 <h1 id="tag-VideoAbuse" class="swagger-summary-tag" data-traverse-target="tag-VideoAbuse">VideoAbuse</h1>
4348 <div id="operation--videos-abuse-get" class="operation panel" data-traverse-target="operation--videos-abuse-get">
4349 <!-- <section class="operation-tags row"> -->
4350 <!-- <div class="doc-copy"> -->
4351 <div class="operation-tags">
4352 <a class="label" href="#tag-VideoAbuse">VideoAbuse</a>
4353 <!---->
4354 </div>
4355 <!-- </div> -->
4356 <!-- </section> -->
4357 <h2 class="operation-title">
4358 <span class="operation-name">
4359 <span class="operation-name">GET</span>
4360 <span class="operation-path">/videos/abuse</span>
4361 </span>
4362 </h2>
4363 <div class="doc-row">
4364 <div class="doc-copy">
4365 <section class="swagger-request-params">
4366 <div class="prop-row prop-group">
4367 <div class="prop-name">
4368 <div class="prop-title">start:
4369 <span class="prop-type">
4370 <span class="json-property-type">number</span>
4371 <span class="json-property-range" title="Value limits"></span>
4372 </span>
4373 </div>
4374 <div class="prop-subtitle"> in query </div>
4375 </div>
4376 <div class="prop-value">
4377 <p>Offset</p>
4378 </div>
4379 </div>
4380 <div class="prop-row prop-group">
4381 <div class="prop-name">
4382 <div class="prop-title">count:
4383 <span class="prop-type">
4384 <span class="json-property-type">number</span>
4385 <span class="json-property-range" title="Value limits"></span>
4386 </span>
4387 </div>
4388 <div class="prop-subtitle"> in query </div>
4389 </div>
4390 <div class="prop-value">
4391 <p>Number of items</p>
4392 </div>
4393 </div>
4394 <div class="prop-row prop-group">
4395 <div class="prop-name">
4396 <div class="prop-title">sort:
4397 <span class="prop-type">
4398 <span class="json-property-type">string</span>
4399 <span class="json-property-range" title="Value limits"></span>
4400 </span>
4401 </div>
4402 <div class="prop-subtitle"> in query </div>
4403 </div>
4404 <div class="prop-value">
4405 <p>Sort column (-createdAt for example)</p>
4406 </div>
4407 </div>
4408 </section>
4409 </div>
4410 <div class="doc-examples"></div>
4411 </div>
4412 <div class="doc-row">
4413 <div class="doc-copy">
4414 <section class="swagger-responses">
4415 <div class="prop-row prop-group">
4416 <div class="prop-name">
4417 <div class="prop-title">200 OK</div>
4418 <div class="prop-ref">
4419 <span class="json-schema-ref-array">
4420 <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a>
4421 </span>
4422 </div>
4423 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4424 </div>
4425 <div class="prop-value">
4426 <p>successful operation</p>
4427 </div>
4428 </div>
4429 <div class="prop-row prop-inner">
4430 <div class="prop-name">type</div>
4431 <div class="prop-value">
4432 <span class="json-property-type">
4433 <span class="json-schema-ref-array">
4434 <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a>
4435 </span>
4436 </span>
4437 <span class="json-property-range" title="Value limits"></span>
4438 </div>
4439 </div>
4440 </section>
4441 </div>
4442 <div class="doc-examples">
4443 <h5>Response Content-Types:
4444 <span>application/json</span>
4445 </h5>
4446 <section>
4447 <h5>Response Example
4448 <span>(200 OK)</span>
4449 </h5>
4450 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
4451 {
4452 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4453 <span class="hljs-attr">&quot;reason&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4454 <span class="hljs-attr">&quot;reporterAccount&quot;</span>: {
4455 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4456 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4457 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4458 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4459 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4460 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4461 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4462 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4463 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4464 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4465 <span class="hljs-attr">&quot;avatar&quot;</span>: {
4466 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4467 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4468 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4469 }
4470 },
4471 <span class="hljs-attr">&quot;video&quot;</span>: {
4472 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4473 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4474 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4475 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4476 },
4477 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4478 }
4479 ]
4480 </code></pre>
4481 <!-- </div> -->
4482 </section>
4483 </div>
4484 </div>
4485 <div class="doc-row">
4486 <div class="doc-copy">
4487 <section class="swagger-request-security">
4488 <table class="table">
4489 <thead>
4490 <tr>
4491 <th class="swagger-request-security-schema"></th>
4492 <th class="swagger-request-security-scopes"></th>
4493 </tr>
4494 </thead>
4495 <tbody>
4496 <tr>
4497 <td>
4498 <a href="#security-definition-OAuth2">OAuth2</a>
4499 </td>
4500 <td> </td>
4501 </tr>
4502 </tbody>
4503 </table>
4504 </section>
4505 </div>
4506 </div>
4507 </div>
4508 <div id="operation--videos--id--abuse-post" class="operation panel" data-traverse-target="operation--videos--id--abuse-post">
4509 <!-- <section class="operation-tags row"> -->
4510 <!-- <div class="doc-copy"> -->
4511 <div class="operation-tags">
4512 <a class="label" href="#tag-VideoAbuse">VideoAbuse</a>
4513 <!---->
4514 </div>
4515 <!-- </div> -->
4516 <!-- </section> -->
4517 <h2 class="operation-title">
4518 <span class="operation-name">
4519 <span class="operation-name">POST</span>
4520 <span class="operation-path">/videos/{id}/abuse</span>
4521 </span>
4522 </h2>
4523 <div class="doc-row">
4524 <div class="doc-copy">
4525 <section class="swagger-request-params">
4526 <div class="prop-row prop-group">
4527 <div class="prop-name">
4528 <div class="prop-title">id:
4529 <span class="prop-type">
4530 <span class="json-property-type">string</span>
4531 <span class="json-property-range" title="Value limits"></span>
4532 </span>
4533 </div>
4534 <span class="json-property-required"></span>
4535 <div class="prop-subtitle"> in path </div>
4536 </div>
4537 <div class="prop-value">
4538 <p>The video id or uuid</p>
4539 </div>
4540 </div>
4541 </section>
4542 </div>
4543 <div class="doc-examples"></div>
4544 </div>
4545 <div class="doc-row">
4546 <div class="doc-copy">
4547 <section class="swagger-responses">
4548 <div class="prop-row prop-group">
4549 <div class="prop-name">
4550 <div class="prop-title">204 No Content</div>
4551 </div>
4552 <div class="prop-value">
4553 <p>Successful operation</p>
4554 </div>
4555 </div>
4556 </section>
4557 </div>
4558 <div class="doc-examples">
4559 <h5>Response Content-Types:
4560 <span>application/json</span>
4561 </h5>
4562 </div>
4563 </div>
4564 <div class="doc-row">
4565 <div class="doc-copy">
4566 <section class="swagger-request-security">
4567 <table class="table">
4568 <thead>
4569 <tr>
4570 <th class="swagger-request-security-schema"></th>
4571 <th class="swagger-request-security-scopes"></th>
4572 </tr>
4573 </thead>
4574 <tbody>
4575 <tr>
4576 <td>
4577 <a href="#security-definition-OAuth2">OAuth2</a>
4578 </td>
4579 <td> </td>
4580 </tr>
4581 </tbody>
4582 </table>
4583 </section>
4584 </div>
4585 </div>
4586 </div>
4587 <h1 id="tag-VideoBlacklist" class="swagger-summary-tag" data-traverse-target="tag-VideoBlacklist">VideoBlacklist</h1>
4588 <div id="operation--videos--id--blacklist-post" class="operation panel" data-traverse-target="operation--videos--id--blacklist-post">
4589 <!-- <section class="operation-tags row"> -->
4590 <!-- <div class="doc-copy"> -->
4591 <div class="operation-tags">
4592 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
4593 <!---->
4594 </div>
4595 <!-- </div> -->
4596 <!-- </section> -->
4597 <h2 class="operation-title">
4598 <span class="operation-name">
4599 <span class="operation-name">POST</span>
4600 <span class="operation-path">/videos/{id}/blacklist</span>
4601 </span>
4602 </h2>
4603 <div class="doc-row">
4604 <div class="doc-copy">
4605 <section class="swagger-request-params">
4606 <div class="prop-row prop-group">
4607 <div class="prop-name">
4608 <div class="prop-title">id:
4609 <span class="prop-type">
4610 <span class="json-property-type">string</span>
4611 <span class="json-property-range" title="Value limits"></span>
4612 </span>
4613 </div>
4614 <span class="json-property-required"></span>
4615 <div class="prop-subtitle"> in path </div>
4616 </div>
4617 <div class="prop-value">
4618 <p>The video id or uuid</p>
4619 </div>
4620 </div>
4621 </section>
4622 </div>
4623 <div class="doc-examples"></div>
4624 </div>
4625 <div class="doc-row">
4626 <div class="doc-copy">
4627 <section class="swagger-responses">
4628 <div class="prop-row prop-group">
4629 <div class="prop-name">
4630 <div class="prop-title">204 No Content</div>
4631 </div>
4632 <div class="prop-value">
4633 <p>Successful operation</p>
4634 </div>
4635 </div>
4636 </section>
4637 </div>
4638 <div class="doc-examples">
4639 <h5>Response Content-Types:
4640 <span>application/json</span>
4641 </h5>
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 <div id="operation--videos--id--blacklist-delete" class="operation panel" data-traverse-target="operation--videos--id--blacklist-delete">
4668 <!-- <section class="operation-tags row"> -->
4669 <!-- <div class="doc-copy"> -->
4670 <div class="operation-tags">
4671 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
4672 <!---->
4673 </div>
4674 <!-- </div> -->
4675 <!-- </section> -->
4676 <h2 class="operation-title">
4677 <span class="operation-name">
4678 <span class="operation-name">DELETE</span>
4679 <span class="operation-path">/videos/{id}/blacklist</span>
4680 </span>
4681 </h2>
4682 <div class="doc-row">
4683 <div class="doc-copy">
4684 <section class="swagger-request-params">
4685 <div class="prop-row prop-group">
4686 <div class="prop-name">
4687 <div class="prop-title">id:
4688 <span class="prop-type">
4689 <span class="json-property-type">string</span>
4690 <span class="json-property-range" title="Value limits"></span>
4691 </span>
4692 </div>
4693 <span class="json-property-required"></span>
4694 <div class="prop-subtitle"> in path </div>
4695 </div>
4696 <div class="prop-value">
4697 <p>The video id or uuid</p>
4698 </div>
4699 </div>
4700 </section>
4701 </div>
4702 <div class="doc-examples"></div>
4703 </div>
4704 <div class="doc-row">
4705 <div class="doc-copy">
4706 <section class="swagger-responses">
4707 <div class="prop-row prop-group">
4708 <div class="prop-name">
4709 <div class="prop-title">204 No Content</div>
4710 </div>
4711 <div class="prop-value">
4712 <p>Successful operation</p>
4713 </div>
4714 </div>
4715 </section>
4716 </div>
4717 <div class="doc-examples">
4718 <h5>Response Content-Types:
4719 <span>application/json</span>
4720 </h5>
4721 </div>
4722 </div>
4723 <div class="doc-row">
4724 <div class="doc-copy">
4725 <section class="swagger-request-security">
4726 <table class="table">
4727 <thead>
4728 <tr>
4729 <th class="swagger-request-security-schema"></th>
4730 <th class="swagger-request-security-scopes"></th>
4731 </tr>
4732 </thead>
4733 <tbody>
4734 <tr>
4735 <td>
4736 <a href="#security-definition-OAuth2">OAuth2</a>
4737 </td>
4738 <td> </td>
4739 </tr>
4740 </tbody>
4741 </table>
4742 </section>
4743 </div>
4744 </div>
4745 </div>
4746 <div id="operation--videos-blacklist-get" class="operation panel" data-traverse-target="operation--videos-blacklist-get">
4747 <!-- <section class="operation-tags row"> -->
4748 <!-- <div class="doc-copy"> -->
4749 <div class="operation-tags">
4750 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
4751 <!---->
4752 </div>
4753 <!-- </div> -->
4754 <!-- </section> -->
4755 <h2 class="operation-title">
4756 <span class="operation-name">
4757 <span class="operation-name">GET</span>
4758 <span class="operation-path">/videos/blacklist</span>
4759 </span>
4760 </h2>
4761 <div class="doc-row">
4762 <div class="doc-copy">
4763 <section class="swagger-request-params">
4764 <div class="prop-row prop-group">
4765 <div class="prop-name">
4766 <div class="prop-title">start:
4767 <span class="prop-type">
4768 <span class="json-property-type">number</span>
4769 <span class="json-property-range" title="Value limits"></span>
4770 </span>
4771 </div>
4772 <div class="prop-subtitle"> in query </div>
4773 </div>
4774 <div class="prop-value">
4775 <p>Offset</p>
4776 </div>
4777 </div>
4778 <div class="prop-row prop-group">
4779 <div class="prop-name">
4780 <div class="prop-title">count:
4781 <span class="prop-type">
4782 <span class="json-property-type">number</span>
4783 <span class="json-property-range" title="Value limits"></span>
4784 </span>
4785 </div>
4786 <div class="prop-subtitle"> in query </div>
4787 </div>
4788 <div class="prop-value">
4789 <p>Number of items</p>
4790 </div>
4791 </div>
4792 <div class="prop-row prop-group">
4793 <div class="prop-name">
4794 <div class="prop-title">sort:
4795 <span class="prop-type">
4796 <span class="json-property-type">string</span>
4797 <span class="json-property-range" title="Value limits"></span>
4798 </span>
4799 </div>
4800 <div class="prop-subtitle"> in query </div>
4801 </div>
4802 <div class="prop-value">
4803 <p>Sort column (-createdAt for example)</p>
4804 </div>
4805 </div>
4806 </section>
4807 </div>
4808 <div class="doc-examples"></div>
4809 </div>
4810 <div class="doc-row">
4811 <div class="doc-copy">
4812 <section class="swagger-responses">
4813 <div class="prop-row prop-group">
4814 <div class="prop-name">
4815 <div class="prop-title">200 OK</div>
4816 <div class="prop-ref">
4817 <span class="json-schema-ref-array">
4818 <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a>
4819 </span>
4820 </div>
4821 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4822 </div>
4823 <div class="prop-value">
4824 <p>successful operation</p>
4825 </div>
4826 </div>
4827 <div class="prop-row prop-inner">
4828 <div class="prop-name">type</div>
4829 <div class="prop-value">
4830 <span class="json-property-type">
4831 <span class="json-schema-ref-array">
4832 <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a>
4833 </span>
4834 </span>
4835 <span class="json-property-range" title="Value limits"></span>
4836 </div>
4837 </div>
4838 </section>
4839 </div>
4840 <div class="doc-examples">
4841 <h5>Response Content-Types:
4842 <span>application/json</span>
4843 </h5>
4844 <section>
4845 <h5>Response Example
4846 <span>(200 OK)</span>
4847 </h5>
4848 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
4849 {
4850 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4851 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4852 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4853 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4854 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4855 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4856 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4857 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4858 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4859 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4860 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4861 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>
4862 }
4863 ]
4864 </code></pre>
4865 <!-- </div> -->
4866 </section>
4867 </div>
4868 </div>
4869 <div class="doc-row">
4870 <div class="doc-copy">
4871 <section class="swagger-request-security">
4872 <table class="table">
4873 <thead>
4874 <tr>
4875 <th class="swagger-request-security-schema"></th>
4876 <th class="swagger-request-security-scopes"></th>
4877 </tr>
4878 </thead>
4879 <tbody>
4880 <tr>
4881 <td>
4882 <a href="#security-definition-OAuth2">OAuth2</a>
4883 </td>
4884 <td> </td>
4885 </tr>
4886 </tbody>
4887 </table>
4888 </section>
4889 </div>
4890 </div>
4891 </div>
4892 <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1>
4893 <div id="operation--video-channels-get" class="operation panel" data-traverse-target="operation--video-channels-get">
4894 <!-- <section class="operation-tags row"> -->
4895 <!-- <div class="doc-copy"> -->
4896 <div class="operation-tags">
4897 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
4898 <!---->
4899 </div>
4900 <!-- </div> -->
4901 <!-- </section> -->
4902 <h2 class="operation-title">
4903 <span class="operation-name">
4904 <span class="operation-name">GET</span>
4905 <span class="operation-path">/video-channels</span>
4906 </span>
4907 </h2>
4908 <div class="doc-row">
4909 <div class="doc-copy">
4910 <section class="swagger-request-params">
4911 <div class="prop-row prop-group">
4912 <div class="prop-name">
4913 <div class="prop-title">start:
4914 <span class="prop-type">
4915 <span class="json-property-type">number</span>
4916 <span class="json-property-range" title="Value limits"></span>
4917 </span>
4918 </div>
4919 <div class="prop-subtitle"> in query </div>
4920 </div>
4921 <div class="prop-value">
4922 <p>Offset</p>
4923 </div>
4924 </div>
4925 <div class="prop-row prop-group">
4926 <div class="prop-name">
4927 <div class="prop-title">count:
4928 <span class="prop-type">
4929 <span class="json-property-type">number</span>
4930 <span class="json-property-range" title="Value limits"></span>
4931 </span>
4932 </div>
4933 <div class="prop-subtitle"> in query </div>
4934 </div>
4935 <div class="prop-value">
4936 <p>Number of items</p>
4937 </div>
4938 </div>
4939 <div class="prop-row prop-group">
4940 <div class="prop-name">
4941 <div class="prop-title">sort:
4942 <span class="prop-type">
4943 <span class="json-property-type">string</span>
4944 <span class="json-property-range" title="Value limits"></span>
4945 </span>
4946 </div>
4947 <div class="prop-subtitle"> in query </div>
4948 </div>
4949 <div class="prop-value">
4950 <p>Sort column (-createdAt for example)</p>
4951 </div>
4952 </div>
4953 </section>
4954 </div>
4955 <div class="doc-examples"></div>
4956 </div>
4957 <div class="doc-row">
4958 <div class="doc-copy">
4959 <section class="swagger-responses">
4960 <div class="prop-row prop-group">
4961 <div class="prop-name">
4962 <div class="prop-title">200 OK</div>
4963 <div class="prop-ref">
4964 <span class="json-schema-ref-array">
4965 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
4966 </span>
4967 </div>
4968 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4969 </div>
4970 <div class="prop-value">
4971 <p>successful operation</p>
4972 </div>
4973 </div>
4974 <div class="prop-row prop-inner">
4975 <div class="prop-name">type</div>
4976 <div class="prop-value">
4977 <span class="json-property-type">
4978 <span class="json-schema-ref-array">
4979 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
4980 </span>
4981 </span>
4982 <span class="json-property-range" title="Value limits"></span>
4983 </div>
4984 </div>
4985 </section>
4986 </div>
4987 <div class="doc-examples">
4988 <h5>Response Content-Types:
4989 <span>application/json</span>
4990 </h5>
4991 <section>
4992 <h5>Response Example
4993 <span>(200 OK)</span>
4994 </h5>
4995 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
4996 {
4997 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4998 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4999 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5000 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
5001 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5002 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5003 }
5004 }
5005 ]
5006 </code></pre>
5007 <!-- </div> -->
5008 </section>
5009 </div>
5010 </div>
5011 </div>
5012 <div id="operation--video-channels-post" class="operation panel" data-traverse-target="operation--video-channels-post">
5013 <!-- <section class="operation-tags row"> -->
5014 <!-- <div class="doc-copy"> -->
5015 <div class="operation-tags">
5016 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5017 <!---->
5018 </div>
5019 <!-- </div> -->
5020 <!-- </section> -->
5021 <h2 class="operation-title">
5022 <span class="operation-name">
5023 <span class="operation-name">POST</span>
5024 <span class="operation-path">/video-channels</span>
5025 </span>
5026 </h2>
5027 <div class="doc-row">
5028 <div class="doc-copy">
5029 <section class="swagger-request-body">
5030 <div class="prop-row">
5031 <div class="prop-name">
5032 <div class="swagger-request-model">
5033 <span class="">
5034 <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a>
5035 </span>
5036 </div>
5037 </div>
5038 <div class="prop-value columns small-6">
5039 <!-- <div class="swagger-request-description"> -->
5040 <p>undefined</p>
5041 <!-- </div> -->
5042 </div>
5043 </div>
5044 </section>
5045 </div>
5046 <div class="doc-examples">
5047 <section>
5048 <h5>Request Content-Types:
5049 <span>application/json</span>
5050 </h5>
5051 <h5>Request Example</h5>
5052 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5053 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5054 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5055 }
5056 </code></pre>
5057 <!-- </div> -->
5058 </section>
5059 </div>
5060 </div>
5061 <div class="doc-row">
5062 <div class="doc-copy">
5063 <section class="swagger-responses">
5064 <div class="prop-row prop-group">
5065 <div class="prop-name">
5066 <div class="prop-title">204 No Content</div>
5067 </div>
5068 <div class="prop-value">
5069 <p>Successful operation</p>
5070 </div>
5071 </div>
5072 </section>
5073 </div>
5074 <div class="doc-examples">
5075 <h5>Response Content-Types:
5076 <span>application/json</span>
5077 </h5>
5078 </div>
5079 </div>
5080 <div class="doc-row">
5081 <div class="doc-copy">
5082 <section class="swagger-request-security">
5083 <table class="table">
5084 <thead>
5085 <tr>
5086 <th class="swagger-request-security-schema"></th>
5087 <th class="swagger-request-security-scopes"></th>
5088 </tr>
5089 </thead>
5090 <tbody>
5091 <tr>
5092 <td>
5093 <a href="#security-definition-OAuth2">OAuth2</a>
5094 </td>
5095 <td> </td>
5096 </tr>
5097 </tbody>
5098 </table>
5099 </section>
5100 </div>
5101 </div>
5102 </div>
5103 <div id="operation--video-channels--id--get" class="operation panel" data-traverse-target="operation--video-channels--id--get">
5104 <!-- <section class="operation-tags row"> -->
5105 <!-- <div class="doc-copy"> -->
5106 <div class="operation-tags">
5107 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5108 <!---->
5109 </div>
5110 <!-- </div> -->
5111 <!-- </section> -->
5112 <h2 class="operation-title">
5113 <span class="operation-name">
5114 <span class="operation-name">GET</span>
5115 <span class="operation-path">/video-channels/{id}</span>
5116 </span>
5117 </h2>
5118 <div class="doc-row">
5119 <div class="doc-copy">
5120 <section class="swagger-request-params">
5121 <div class="prop-row prop-group">
5122 <div class="prop-name">
5123 <div class="prop-title">id:
5124 <span class="prop-type">
5125 <span class="json-property-type">string</span>
5126 <span class="json-property-range" title="Value limits"></span>
5127 </span>
5128 </div>
5129 <span class="json-property-required"></span>
5130 <div class="prop-subtitle"> in path </div>
5131 </div>
5132 <div class="prop-value">
5133 <p>The video channel id or uuid</p>
5134 </div>
5135 </div>
5136 </section>
5137 </div>
5138 <div class="doc-examples"></div>
5139 </div>
5140 <div class="doc-row">
5141 <div class="doc-copy">
5142 <section class="swagger-responses">
5143 <div class="prop-row prop-group">
5144 <div class="prop-name">
5145 <div class="prop-title">200 OK</div>
5146 <div class="prop-ref">
5147 <span class="">
5148 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
5149 </span>
5150 </div>
5151 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5152 </div>
5153 <div class="prop-value">
5154 <p>successful operation</p>
5155 </div>
5156 </div>
5157 </section>
5158 </div>
5159 <div class="doc-examples">
5160 <h5>Response Content-Types:
5161 <span>application/json</span>
5162 </h5>
5163 <section>
5164 <h5>Response Example
5165 <span>(200 OK)</span>
5166 </h5>
5167 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5168 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5169 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5170 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5171 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
5172 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5173 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5174 }
5175 }
5176 </code></pre>
5177 <!-- </div> -->
5178 </section>
5179 </div>
5180 </div>
5181 </div>
5182 <div id="operation--video-channels--id--put" class="operation panel" data-traverse-target="operation--video-channels--id--put">
5183 <!-- <section class="operation-tags row"> -->
5184 <!-- <div class="doc-copy"> -->
5185 <div class="operation-tags">
5186 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5187 <!---->
5188 </div>
5189 <!-- </div> -->
5190 <!-- </section> -->
5191 <h2 class="operation-title">
5192 <span class="operation-name">
5193 <span class="operation-name">PUT</span>
5194 <span class="operation-path">/video-channels/{id}</span>
5195 </span>
5196 </h2>
5197 <div class="doc-row">
5198 <div class="doc-copy">
5199 <section class="swagger-request-body">
5200 <div class="prop-row">
5201 <div class="prop-name">
5202 <div class="swagger-request-model">
5203 <span class="">
5204 <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a>
5205 </span>
5206 </div>
5207 </div>
5208 <div class="prop-value columns small-6">
5209 <!-- <div class="swagger-request-description"> -->
5210 <p>undefined</p>
5211 <!-- </div> -->
5212 </div>
5213 </div>
5214 </section>
5215 <section class="swagger-request-params">
5216 <div class="prop-row prop-group">
5217 <div class="prop-name">
5218 <div class="prop-title">id:
5219 <span class="prop-type">
5220 <span class="json-property-type">string</span>
5221 <span class="json-property-range" title="Value limits"></span>
5222 </span>
5223 </div>
5224 <span class="json-property-required"></span>
5225 <div class="prop-subtitle"> in path </div>
5226 </div>
5227 <div class="prop-value">
5228 <p>The video channel id or uuid</p>
5229 </div>
5230 </div>
5231 </section>
5232 </div>
5233 <div class="doc-examples">
5234 <section>
5235 <h5>Request Content-Types:
5236 <span>application/json</span>
5237 </h5>
5238 <h5>Request Example</h5>
5239 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5240 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5241 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5242 }
5243 </code></pre>
5244 <!-- </div> -->
5245 </section>
5246 </div>
5247 </div>
5248 <div class="doc-row">
5249 <div class="doc-copy">
5250 <section class="swagger-responses">
5251 <div class="prop-row prop-group">
5252 <div class="prop-name">
5253 <div class="prop-title">204 No Content</div>
5254 </div>
5255 <div class="prop-value">
5256 <p>Successful operation</p>
5257 </div>
5258 </div>
5259 </section>
5260 </div>
5261 <div class="doc-examples">
5262 <h5>Response Content-Types:
5263 <span>application/json</span>
5264 </h5>
5265 </div>
5266 </div>
5267 <div class="doc-row">
5268 <div class="doc-copy">
5269 <section class="swagger-request-security">
5270 <table class="table">
5271 <thead>
5272 <tr>
5273 <th class="swagger-request-security-schema"></th>
5274 <th class="swagger-request-security-scopes"></th>
5275 </tr>
5276 </thead>
5277 <tbody>
5278 <tr>
5279 <td>
5280 <a href="#security-definition-OAuth2">OAuth2</a>
5281 </td>
5282 <td> </td>
5283 </tr>
5284 </tbody>
5285 </table>
5286 </section>
5287 </div>
5288 </div>
5289 </div>
5290 <div id="operation--video-channels--id--delete" class="operation panel" data-traverse-target="operation--video-channels--id--delete">
5291 <!-- <section class="operation-tags row"> -->
5292 <!-- <div class="doc-copy"> -->
5293 <div class="operation-tags">
5294 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5295 <!---->
5296 </div>
5297 <!-- </div> -->
5298 <!-- </section> -->
5299 <h2 class="operation-title">
5300 <span class="operation-name">
5301 <span class="operation-name">DELETE</span>
5302 <span class="operation-path">/video-channels/{id}</span>
5303 </span>
5304 </h2>
5305 <div class="doc-row">
5306 <div class="doc-copy">
5307 <section class="swagger-request-params">
5308 <div class="prop-row prop-group">
5309 <div class="prop-name">
5310 <div class="prop-title">id:
5311 <span class="prop-type">
5312 <span class="json-property-type">string</span>
5313 <span class="json-property-range" title="Value limits"></span>
5314 </span>
5315 </div>
5316 <span class="json-property-required"></span>
5317 <div class="prop-subtitle"> in path </div>
5318 </div>
5319 <div class="prop-value">
5320 <p>The video channel id or uuid</p>
5321 </div>
5322 </div>
5323 </section>
5324 </div>
5325 <div class="doc-examples"></div>
5326 </div>
5327 <div class="doc-row">
5328 <div class="doc-copy">
5329 <section class="swagger-responses">
5330 <div class="prop-row prop-group">
5331 <div class="prop-name">
5332 <div class="prop-title">204 No Content</div>
5333 </div>
5334 <div class="prop-value">
5335 <p>Successful operation</p>
5336 </div>
5337 </div>
5338 </section>
5339 </div>
5340 <div class="doc-examples">
5341 <h5>Response Content-Types:
5342 <span>application/json</span>
5343 </h5>
5344 </div>
5345 </div>
5346 <div class="doc-row">
5347 <div class="doc-copy">
5348 <section class="swagger-request-security">
5349 <table class="table">
5350 <thead>
5351 <tr>
5352 <th class="swagger-request-security-schema"></th>
5353 <th class="swagger-request-security-scopes"></th>
5354 </tr>
5355 </thead>
5356 <tbody>
5357 <tr>
5358 <td>
5359 <a href="#security-definition-OAuth2">OAuth2</a>
5360 </td>
5361 <td> </td>
5362 </tr>
5363 </tbody>
5364 </table>
5365 </section>
5366 </div>
5367 </div>
5368 </div>
5369 <div id="operation--video-channels--id--videos-get" class="operation panel" data-traverse-target="operation--video-channels--id--videos-get">
5370 <!-- <section class="operation-tags row"> -->
5371 <!-- <div class="doc-copy"> -->
5372 <div class="operation-tags">
5373 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5374 <!---->
5375 </div>
5376 <!-- </div> -->
5377 <!-- </section> -->
5378 <h2 class="operation-title">
5379 <span class="operation-name">
5380 <span class="operation-name">GET</span>
5381 <span class="operation-path">/video-channels/{id}/videos</span>
5382 </span>
5383 </h2>
5384 <div class="doc-row">
5385 <div class="doc-copy">
5386 <section class="swagger-request-params">
5387 <div class="prop-row prop-group">
5388 <div class="prop-name">
5389 <div class="prop-title">id:
5390 <span class="prop-type">
5391 <span class="json-property-type">string</span>
5392 <span class="json-property-range" title="Value limits"></span>
5393 </span>
5394 </div>
5395 <span class="json-property-required"></span>
5396 <div class="prop-subtitle"> in path </div>
5397 </div>
5398 <div class="prop-value">
5399 <p>The video channel id or uuid</p>
5400 </div>
5401 </div>
5402 </section>
5403 </div>
5404 <div class="doc-examples"></div>
5405 </div>
5406 <div class="doc-row">
5407 <div class="doc-copy">
5408 <section class="swagger-responses">
5409 <div class="prop-row prop-group">
5410 <div class="prop-name">
5411 <div class="prop-title">200 OK</div>
5412 <div class="prop-ref">
5413 <span class="">
5414 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
5415 </span>
5416 </div>
5417 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5418 </div>
5419 <div class="prop-value">
5420 <p>successful operation</p>
5421 </div>
5422 </div>
5423 </section>
5424 </div>
5425 <div class="doc-examples">
5426 <h5>Response Content-Types:
5427 <span>application/json</span>
5428 </h5>
5429 <section>
5430 <h5>Response Example
5431 <span>(200 OK)</span>
5432 </h5>
5433 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5434 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5435 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5436 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5437 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5438 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5439 <span class="hljs-attr">&quot;category&quot;</span>: {
5440 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5441 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5442 },
5443 <span class="hljs-attr">&quot;licence&quot;</span>: {
5444 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5445 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5446 },
5447 <span class="hljs-attr">&quot;language&quot;</span>: {
5448 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5449 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5450 },
5451 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5452 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5453 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5454 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5455 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5456 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5457 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5458 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5459 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5460 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5461 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5462 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5463 <span class="hljs-attr">&quot;account&quot;</span>: {
5464 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5465 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5466 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5467 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5468 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5469 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5470 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5471 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5472 }
5473 }
5474 }
5475 </code></pre>
5476 <!-- </div> -->
5477 </section>
5478 </div>
5479 </div>
5480 </div>
5481 <div id="operation--accounts--name--video-channels-get" class="operation panel" data-traverse-target="operation--accounts--name--video-channels-get">
5482 <!-- <section class="operation-tags row"> -->
5483 <!-- <div class="doc-copy"> -->
5484 <div class="operation-tags">
5485 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5486 <!---->
5487 </div>
5488 <!-- </div> -->
5489 <!-- </section> -->
5490 <h2 class="operation-title">
5491 <span class="operation-name">
5492 <span class="operation-name">GET</span>
5493 <span class="operation-path">/accounts/{name}/video-channels</span>
5494 </span>
5495 </h2>
5496 <div class="doc-row">
5497 <div class="doc-copy">
5498 <section class="swagger-request-params">
5499 <div class="prop-row prop-group">
5500 <div class="prop-name">
5501 <div class="prop-title">name:
5502 <span class="prop-type">
5503 <span class="json-property-type">string</span>
5504 <span class="json-property-range" title="Value limits"></span>
5505 </span>
5506 </div>
5507 <span class="json-property-required"></span>
5508 <div class="prop-subtitle"> in path </div>
5509 </div>
5510 <div class="prop-value">
5511 <p>The name of the account (chocobozzz or
5512 <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p>
5513 </div>
5514 </div>
5515 </section>
5516 </div>
5517 <div class="doc-examples"></div>
5518 </div>
5519 <div class="doc-row">
5520 <div class="doc-copy">
5521 <section class="swagger-responses">
5522 <div class="prop-row prop-group">
5523 <div class="prop-name">
5524 <div class="prop-title">200 OK</div>
5525 <div class="prop-ref">
5526 <span class="json-schema-ref-array">
5527 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
5528 </span>
5529 </div>
5530 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5531 </div>
5532 <div class="prop-value">
5533 <p>successful operation</p>
5534 </div>
5535 </div>
5536 <div class="prop-row prop-inner">
5537 <div class="prop-name">type</div>
5538 <div class="prop-value">
5539 <span class="json-property-type">
5540 <span class="json-schema-ref-array">
5541 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
5542 </span>
5543 </span>
5544 <span class="json-property-range" title="Value limits"></span>
5545 </div>
5546 </div>
5547 </section>
5548 </div>
5549 <div class="doc-examples">
5550 <h5>Response Content-Types:
5551 <span>application/json</span>
5552 </h5>
5553 <section>
5554 <h5>Response Example
5555 <span>(200 OK)</span>
5556 </h5>
5557 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
5558 {
5559 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5560 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5561 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5562 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
5563 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5564 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5565 }
5566 }
5567 ]
5568 </code></pre>
5569 <!-- </div> -->
5570 </section>
5571 </div>
5572 </div>
5573 </div>
5574 <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1>
5575 <div id="operation--videos--id--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--id--comment-threads-get">
5576 <!-- <section class="operation-tags row"> -->
5577 <!-- <div class="doc-copy"> -->
5578 <div class="operation-tags">
5579 <a class="label" href="#tag-VideoComment">VideoComment</a>
5580 <!---->
5581 </div>
5582 <!-- </div> -->
5583 <!-- </section> -->
5584 <h2 class="operation-title">
5585 <span class="operation-name">
5586 <span class="operation-name">GET</span>
5587 <span class="operation-path">/videos/{id}/comment-threads</span>
5588 </span>
5589 </h2>
5590 <div class="doc-row">
5591 <div class="doc-copy">
5592 <section class="swagger-request-params">
5593 <div class="prop-row prop-group">
5594 <div class="prop-name">
5595 <div class="prop-title">id:
5596 <span class="prop-type">
5597 <span class="json-property-type">string</span>
5598 <span class="json-property-range" title="Value limits"></span>
5599 </span>
5600 </div>
5601 <span class="json-property-required"></span>
5602 <div class="prop-subtitle"> in path </div>
5603 </div>
5604 <div class="prop-value">
5605 <p>The video id or uuid</p>
5606 </div>
5607 </div>
5608 <div class="prop-row prop-group">
5609 <div class="prop-name">
5610 <div class="prop-title">start:
5611 <span class="prop-type">
5612 <span class="json-property-type">number</span>
5613 <span class="json-property-range" title="Value limits"></span>
5614 </span>
5615 </div>
5616 <div class="prop-subtitle"> in query </div>
5617 </div>
5618 <div class="prop-value">
5619 <p>Offset</p>
5620 </div>
5621 </div>
5622 <div class="prop-row prop-group">
5623 <div class="prop-name">
5624 <div class="prop-title">count:
5625 <span class="prop-type">
5626 <span class="json-property-type">number</span>
5627 <span class="json-property-range" title="Value limits"></span>
5628 </span>
5629 </div>
5630 <div class="prop-subtitle"> in query </div>
5631 </div>
5632 <div class="prop-value">
5633 <p>Number of items</p>
5634 </div>
5635 </div>
5636 <div class="prop-row prop-group">
5637 <div class="prop-name">
5638 <div class="prop-title">sort:
5639 <span class="prop-type">
5640 <span class="json-property-type">string</span>
5641 <span class="json-property-range" title="Value limits"></span>
5642 </span>
5643 </div>
5644 <div class="prop-subtitle"> in query </div>
5645 </div>
5646 <div class="prop-value">
5647 <p>Sort column (-createdAt for example)</p>
5648 </div>
5649 </div>
5650 </section>
5651 </div>
5652 <div class="doc-examples"></div>
5653 </div>
5654 <div class="doc-row">
5655 <div class="doc-copy">
5656 <section class="swagger-responses">
5657 <div class="prop-row prop-group">
5658 <div class="prop-name">
5659 <div class="prop-title">200 OK</div>
5660 <div class="prop-ref">
5661 <span class="">
5662 <a class="json-schema-ref" href="#/definitions/CommentThreadResponse">CommentThreadResponse</a>
5663 </span>
5664 </div>
5665 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5666 </div>
5667 <div class="prop-value">
5668 <p>successful operation</p>
5669 </div>
5670 </div>
5671 </section>
5672 </div>
5673 <div class="doc-examples">
5674 <h5>Response Content-Types:
5675 <span>application/json</span>
5676 </h5>
5677 <section>
5678 <h5>Response Example
5679 <span>(200 OK)</span>
5680 </h5>
5681 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5682 <span class="hljs-attr">&quot;total&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5683 <span class="hljs-attr">&quot;data&quot;</span>: [
5684 {
5685 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5686 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5687 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5688 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5689 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5690 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5691 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5692 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5693 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5694 <span class="hljs-attr">&quot;account&quot;</span>: {
5695 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5696 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5697 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5698 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5699 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5700 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5701 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5702 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5703 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5704 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5705 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5706 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5707 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5708 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5709 }
5710 }
5711 }
5712 ]
5713 }
5714 </code></pre>
5715 <!-- </div> -->
5716 </section>
5717 </div>
5718 </div>
5719 </div>
5720 <div id="operation--videos--id--comment-threads-post" class="operation panel" data-traverse-target="operation--videos--id--comment-threads-post">
5721 <!-- <section class="operation-tags row"> -->
5722 <!-- <div class="doc-copy"> -->
5723 <div class="operation-tags">
5724 <a class="label" href="#tag-VideoComment">VideoComment</a>
5725 <!---->
5726 </div>
5727 <!-- </div> -->
5728 <!-- </section> -->
5729 <h2 class="operation-title">
5730 <span class="operation-name">
5731 <span class="operation-name">POST</span>
5732 <span class="operation-path">/videos/{id}/comment-threads</span>
5733 </span>
5734 </h2>
5735 <div class="doc-row">
5736 <div class="doc-copy">
5737 <section class="swagger-request-params">
5738 <div class="prop-row prop-group">
5739 <div class="prop-name">
5740 <div class="prop-title">id:
5741 <span class="prop-type">
5742 <span class="json-property-type">string</span>
5743 <span class="json-property-range" title="Value limits"></span>
5744 </span>
5745 </div>
5746 <span class="json-property-required"></span>
5747 <div class="prop-subtitle"> in path </div>
5748 </div>
5749 <div class="prop-value">
5750 <p>The video id or uuid</p>
5751 </div>
5752 </div>
5753 </section>
5754 </div>
5755 <div class="doc-examples"></div>
5756 </div>
5757 <div class="doc-row">
5758 <div class="doc-copy">
5759 <section class="swagger-responses">
5760 <div class="prop-row prop-group">
5761 <div class="prop-name">
5762 <div class="prop-title">200 OK</div>
5763 <div class="prop-ref">
5764 <span class="">
5765 <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a>
5766 </span>
5767 </div>
5768 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5769 </div>
5770 <div class="prop-value">
5771 <p>successful operation</p>
5772 </div>
5773 </div>
5774 </section>
5775 </div>
5776 <div class="doc-examples">
5777 <h5>Response Content-Types:
5778 <span>application/json</span>
5779 </h5>
5780 <section>
5781 <h5>Response Example
5782 <span>(200 OK)</span>
5783 </h5>
5784 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5785 <span class="hljs-attr">&quot;comment&quot;</span>: {
5786 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5787 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5788 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5789 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5790 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5791 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5792 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5793 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5794 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5795 <span class="hljs-attr">&quot;account&quot;</span>: {
5796 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5797 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5798 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5799 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5800 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5801 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5802 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5803 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5804 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5805 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5806 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5807 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5808 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5809 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5810 }
5811 }
5812 }
5813 }
5814 </code></pre>
5815 <!-- </div> -->
5816 </section>
5817 </div>
5818 </div>
5819 <div class="doc-row">
5820 <div class="doc-copy">
5821 <section class="swagger-request-security">
5822 <table class="table">
5823 <thead>
5824 <tr>
5825 <th class="swagger-request-security-schema"></th>
5826 <th class="swagger-request-security-scopes"></th>
5827 </tr>
5828 </thead>
5829 <tbody>
5830 <tr>
5831 <td>
5832 <a href="#security-definition-OAuth2">OAuth2</a>
5833 </td>
5834 <td> </td>
5835 </tr>
5836 </tbody>
5837 </table>
5838 </section>
5839 </div>
5840 </div>
5841 </div>
5842 <div id="operation--videos--id--comment-threads--threadId--get" class="operation panel" data-traverse-target="operation--videos--id--comment-threads--threadId--get">
5843 <!-- <section class="operation-tags row"> -->
5844 <!-- <div class="doc-copy"> -->
5845 <div class="operation-tags">
5846 <a class="label" href="#tag-VideoComment">VideoComment</a>
5847 <!---->
5848 </div>
5849 <!-- </div> -->
5850 <!-- </section> -->
5851 <h2 class="operation-title">
5852 <span class="operation-name">
5853 <span class="operation-name">GET</span>
5854 <span class="operation-path">/videos/{id}/comment-threads/{threadId}</span>
5855 </span>
5856 </h2>
5857 <div class="doc-row">
5858 <div class="doc-copy">
5859 <section class="swagger-request-params">
5860 <div class="prop-row prop-group">
5861 <div class="prop-name">
5862 <div class="prop-title">id:
5863 <span class="prop-type">
5864 <span class="json-property-type">string</span>
5865 <span class="json-property-range" title="Value limits"></span>
5866 </span>
5867 </div>
5868 <span class="json-property-required"></span>
5869 <div class="prop-subtitle"> in path </div>
5870 </div>
5871 <div class="prop-value">
5872 <p>The video id or uuid</p>
5873 </div>
5874 </div>
5875 <div class="prop-row prop-group">
5876 <div class="prop-name">
5877 <div class="prop-title">threadId:
5878 <span class="prop-type">
5879 <span class="json-property-type">number</span>
5880 <span class="json-property-range" title="Value limits"></span>
5881 </span>
5882 </div>
5883 <span class="json-property-required"></span>
5884 <div class="prop-subtitle"> in path </div>
5885 </div>
5886 <div class="prop-value">
5887 <p>The thread id (root comment id)</p>
5888 </div>
5889 </div>
5890 </section>
5891 </div>
5892 <div class="doc-examples"></div>
5893 </div>
5894 <div class="doc-row">
5895 <div class="doc-copy">
5896 <section class="swagger-responses">
5897 <div class="prop-row prop-group">
5898 <div class="prop-name">
5899 <div class="prop-title">200 OK</div>
5900 <div class="prop-ref">
5901 <span class="">
5902 <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
5903 </span>
5904 </div>
5905 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5906 </div>
5907 <div class="prop-value">
5908 <p>successful operation</p>
5909 </div>
5910 </div>
5911 </section>
5912 </div>
5913 <div class="doc-examples">
5914 <h5>Response Content-Types:
5915 <span>application/json</span>
5916 </h5>
5917 <section>
5918 <h5>Response Example
5919 <span>(200 OK)</span>
5920 </h5>
5921 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5922 <span class="hljs-attr">&quot;comment&quot;</span>: {
5923 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5924 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5925 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5926 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5927 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5928 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5929 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5930 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5931 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5932 <span class="hljs-attr">&quot;account&quot;</span>: {
5933 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5934 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5935 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5936 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5937 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5938 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5939 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5940 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5941 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5942 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5943 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5944 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5945 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5946 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5947 }
5948 }
5949 },
5950 <span class="hljs-attr">&quot;children&quot;</span>: [
5951 {
5952 <span class="hljs-attr">&quot;comment&quot;</span>: {
5953 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5954 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5955 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5956 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5957 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5958 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5959 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5960 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5961 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5962 <span class="hljs-attr">&quot;account&quot;</span>: {
5963 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5964 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5965 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5966 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5967 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5968 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5969 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5970 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5971 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5972 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5973 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5974 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5975 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5976 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5977 }
5978 }
5979 },
5980 <span class="hljs-attr">&quot;children&quot;</span>: [
5981 {
5982 <span class="hljs-attr">&quot;comment&quot;</span>: {
5983 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5984 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5985 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5986 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5987 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5988 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5989 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5990 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5991 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5992 <span class="hljs-attr">&quot;account&quot;</span>: {
5993 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5994 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5995 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5996 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5997 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5998 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5999 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6000 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6001 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6002 <span class="hljs-attr">&quot;avatar&quot;</span>: {
6003 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6004 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6005 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6006 }
6007 }
6008 }
6009 }
6010 ]
6011 }
6012 ]
6013 }
6014 </code></pre>
6015 <!-- </div> -->
6016 </section>
6017 </div>
6018 </div>
6019 </div>
6020 <div id="operation--videos--id--comments--commentId--post" class="operation panel" data-traverse-target="operation--videos--id--comments--commentId--post">
6021 <!-- <section class="operation-tags row"> -->
6022 <!-- <div class="doc-copy"> -->
6023 <div class="operation-tags">
6024 <a class="label" href="#tag-VideoComment">VideoComment</a>
6025 <!---->
6026 </div>
6027 <!-- </div> -->
6028 <!-- </section> -->
6029 <h2 class="operation-title">
6030 <span class="operation-name">
6031 <span class="operation-name">POST</span>
6032 <span class="operation-path">/videos/{id}/comments/{commentId}</span>
6033 </span>
6034 </h2>
6035 <div class="doc-row">
6036 <div class="doc-copy">
6037 <section class="swagger-request-params">
6038 <div class="prop-row prop-group">
6039 <div class="prop-name">
6040 <div class="prop-title">id:
6041 <span class="prop-type">
6042 <span class="json-property-type">string</span>
6043 <span class="json-property-range" title="Value limits"></span>
6044 </span>
6045 </div>
6046 <span class="json-property-required"></span>
6047 <div class="prop-subtitle"> in path </div>
6048 </div>
6049 <div class="prop-value">
6050 <p>The video id or uuid</p>
6051 </div>
6052 </div>
6053 <div class="prop-row prop-group">
6054 <div class="prop-name">
6055 <div class="prop-title">threadId:
6056 <span class="prop-type">
6057 <span class="json-property-type">number</span>
6058 <span class="json-property-range" title="Value limits"></span>
6059 </span>
6060 </div>
6061 <span class="json-property-required"></span>
6062 <div class="prop-subtitle"> in path </div>
6063 </div>
6064 <div class="prop-value">
6065 <p>The comment id</p>
6066 </div>
6067 </div>
6068 </section>
6069 </div>
6070 <div class="doc-examples"></div>
6071 </div>
6072 <div class="doc-row">
6073 <div class="doc-copy">
6074 <section class="swagger-responses">
6075 <div class="prop-row prop-group">
6076 <div class="prop-name">
6077 <div class="prop-title">200 OK</div>
6078 <div class="prop-ref">
6079 <span class="">
6080 <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a>
6081 </span>
6082 </div>
6083 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
6084 </div>
6085 <div class="prop-value">
6086 <p>successful operation</p>
6087 </div>
6088 </div>
6089 </section>
6090 </div>
6091 <div class="doc-examples">
6092 <h5>Response Content-Types:
6093 <span>application/json</span>
6094 </h5>
6095 <section>
6096 <h5>Response Example
6097 <span>(200 OK)</span>
6098 </h5>
6099 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6100 <span class="hljs-attr">&quot;comment&quot;</span>: {
6101 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6102 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6103 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6104 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6105 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6106 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6107 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6108 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6109 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6110 <span class="hljs-attr">&quot;account&quot;</span>: {
6111 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6112 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6113 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6114 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6115 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6116 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6117 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6118 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6119 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6120 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6121 <span class="hljs-attr">&quot;avatar&quot;</span>: {
6122 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6123 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6124 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6125 }
6126 }
6127 }
6128 }
6129 </code></pre>
6130 <!-- </div> -->
6131 </section>
6132 </div>
6133 </div>
6134 <div class="doc-row">
6135 <div class="doc-copy">
6136 <section class="swagger-request-security">
6137 <table class="table">
6138 <thead>
6139 <tr>
6140 <th class="swagger-request-security-schema"></th>
6141 <th class="swagger-request-security-scopes"></th>
6142 </tr>
6143 </thead>
6144 <tbody>
6145 <tr>
6146 <td>
6147 <a href="#security-definition-OAuth2">OAuth2</a>
6148 </td>
6149 <td> </td>
6150 </tr>
6151 </tbody>
6152 </table>
6153 </section>
6154 </div>
6155 </div>
6156 </div>
6157 <div id="operation--videos--id--comments--commentId--delete" class="operation panel" data-traverse-target="operation--videos--id--comments--commentId--delete">
6158 <!-- <section class="operation-tags row"> -->
6159 <!-- <div class="doc-copy"> -->
6160 <div class="operation-tags">
6161 <a class="label" href="#tag-VideoComment">VideoComment</a>
6162 <!---->
6163 </div>
6164 <!-- </div> -->
6165 <!-- </section> -->
6166 <h2 class="operation-title">
6167 <span class="operation-name">
6168 <span class="operation-name">DELETE</span>
6169 <span class="operation-path">/videos/{id}/comments/{commentId}</span>
6170 </span>
6171 </h2>
6172 <div class="doc-row">
6173 <div class="doc-copy">
6174 <section class="swagger-request-params">
6175 <div class="prop-row prop-group">
6176 <div class="prop-name">
6177 <div class="prop-title">id:
6178 <span class="prop-type">
6179 <span class="json-property-type">string</span>
6180 <span class="json-property-range" title="Value limits"></span>
6181 </span>
6182 </div>
6183 <span class="json-property-required"></span>
6184 <div class="prop-subtitle"> in path </div>
6185 </div>
6186 <div class="prop-value">
6187 <p>The video id or uuid</p>
6188 </div>
6189 </div>
6190 <div class="prop-row prop-group">
6191 <div class="prop-name">
6192 <div class="prop-title">threadId:
6193 <span class="prop-type">
6194 <span class="json-property-type">number</span>
6195 <span class="json-property-range" title="Value limits"></span>
6196 </span>
6197 </div>
6198 <span class="json-property-required"></span>
6199 <div class="prop-subtitle"> in path </div>
6200 </div>
6201 <div class="prop-value">
6202 <p>The comment id</p>
6203 </div>
6204 </div>
6205 </section>
6206 </div>
6207 <div class="doc-examples"></div>
6208 </div>
6209 <div class="doc-row">
6210 <div class="doc-copy">
6211 <section class="swagger-responses">
6212 <div class="prop-row prop-group">
6213 <div class="prop-name">
6214 <div class="prop-title">204 No Content</div>
6215 </div>
6216 <div class="prop-value">
6217 <p>Successful operation</p>
6218 </div>
6219 </div>
6220 </section>
6221 </div>
6222 <div class="doc-examples">
6223 <h5>Response Content-Types:
6224 <span>application/json</span>
6225 </h5>
6226 </div>
6227 </div>
6228 <div class="doc-row">
6229 <div class="doc-copy">
6230 <section class="swagger-request-security">
6231 <table class="table">
6232 <thead>
6233 <tr>
6234 <th class="swagger-request-security-schema"></th>
6235 <th class="swagger-request-security-scopes"></th>
6236 </tr>
6237 </thead>
6238 <tbody>
6239 <tr>
6240 <td>
6241 <a href="#security-definition-OAuth2">OAuth2</a>
6242 </td>
6243 <td> </td>
6244 </tr>
6245 </tbody>
6246 </table>
6247 </section>
6248 </div>
6249 </div>
6250 </div>
6251 <h1 id="tag-VideoRate" class="swagger-summary-tag" data-traverse-target="tag-VideoRate">VideoRate</h1>
6252 <div id="operation--videos--id--rate-put" class="operation panel" data-traverse-target="operation--videos--id--rate-put">
6253 <!-- <section class="operation-tags row"> -->
6254 <!-- <div class="doc-copy"> -->
6255 <div class="operation-tags">
6256 <a class="label" href="#tag-VideoRate">VideoRate</a>
6257 <!---->
6258 </div>
6259 <!-- </div> -->
6260 <!-- </section> -->
6261 <h2 class="operation-title">
6262 <span class="operation-name">
6263 <span class="operation-name">PUT</span>
6264 <span class="operation-path">/videos/{id}/rate</span>
6265 </span>
6266 </h2>
6267 <div class="doc-row">
6268 <div class="doc-copy">
6269 <section class="swagger-request-params">
6270 <div class="prop-row prop-group">
6271 <div class="prop-name">
6272 <div class="prop-title">id:
6273 <span class="prop-type">
6274 <span class="json-property-type">string</span>
6275 <span class="json-property-range" title="Value limits"></span>
6276 </span>
6277 </div>
6278 <span class="json-property-required"></span>
6279 <div class="prop-subtitle"> in path </div>
6280 </div>
6281 <div class="prop-value">
6282 <p>The video id or uuid</p>
6283 </div>
6284 </div>
6285 </section>
6286 </div>
6287 <div class="doc-examples"></div>
6288 </div>
6289 <div class="doc-row">
6290 <div class="doc-copy">
6291 <section class="swagger-responses">
6292 <div class="prop-row prop-group">
6293 <div class="prop-name">
6294 <div class="prop-title">204 No Content</div>
6295 </div>
6296 <div class="prop-value">
6297 <p>Successful operation</p>
6298 </div>
6299 </div>
6300 </section>
6301 </div>
6302 <div class="doc-examples">
6303 <h5>Response Content-Types:
6304 <span>application/json</span>
6305 </h5>
6306 </div>
6307 </div>
6308 <div class="doc-row">
6309 <div class="doc-copy">
6310 <section class="swagger-request-security">
6311 <table class="table">
6312 <thead>
6313 <tr>
6314 <th class="swagger-request-security-schema"></th>
6315 <th class="swagger-request-security-scopes"></th>
6316 </tr>
6317 </thead>
6318 <tbody>
6319 <tr>
6320 <td>
6321 <a href="#security-definition-OAuth2">OAuth2</a>
6322 </td>
6323 <td> </td>
6324 </tr>
6325 </tbody>
6326 </table>
6327 </section>
6328 </div>
6329 </div>
6330 </div>
6331 <h1>Schema Definitions</h1>
6332 <div id="definition-VideoConstantNumber" class="definition panel" data-traverse-target="definition-VideoConstantNumber">
6333 <h2 class="panel-title">
6334 <a name="/definitions/VideoConstantNumber"></a>VideoConstantNumber:
6335 <!-- <span class="json-property-type">
6336 <span class="json-property-type">object</span>
6337 <span class="json-property-range" title="Value limits"></span>
6338
6339
6340 </span> -->
6341 </h2>
6342 <div class="doc-row">
6343 <div class="doc-copy">
6344 <section class="json-schema-properties">
6345 <dl>
6346 <dt data-property-name="id">
6347 <span class="json-property-name">id:</span>
6348 <span class="json-property-type">number</span>
6349 <span class="json-property-range" title="Value limits"></span>
6350 </dt>
6351 <dt data-property-name="label">
6352 <span class="json-property-name">label:</span>
6353 <span class="json-property-type">string</span>
6354 <span class="json-property-range" title="Value limits"></span>
6355 </dt>
6356 </dl>
6357 </section>
6358 </div>
6359 <div class="doc-examples">
6360 <section>
6361 <h5>Example</h5>
6362 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6363 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6364 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6365 }
6366 </code></pre>
6367 <!-- </div> -->
6368 </section>
6369 </div>
6370 </div>
6371 </div>
6372 <div id="definition-VideoConstantString" class="definition panel" data-traverse-target="definition-VideoConstantString">
6373 <h2 class="panel-title">
6374 <a name="/definitions/VideoConstantString"></a>VideoConstantString:
6375 <!-- <span class="json-property-type">
6376 <span class="json-property-type">object</span>
6377 <span class="json-property-range" title="Value limits"></span>
6378
6379
6380 </span> -->
6381 </h2>
6382 <div class="doc-row">
6383 <div class="doc-copy">
6384 <section class="json-schema-properties">
6385 <dl>
6386 <dt data-property-name="id">
6387 <span class="json-property-name">id:</span>
6388 <span class="json-property-type">string</span>
6389 <span class="json-property-range" title="Value limits"></span>
6390 </dt>
6391 <dt data-property-name="label">
6392 <span class="json-property-name">label:</span>
6393 <span class="json-property-type">string</span>
6394 <span class="json-property-range" title="Value limits"></span>
6395 </dt>
6396 </dl>
6397 </section>
6398 </div>
6399 <div class="doc-examples">
6400 <section>
6401 <h5>Example</h5>
6402 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6403 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6404 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6405 }
6406 </code></pre>
6407 <!-- </div> -->
6408 </section>
6409 </div>
6410 </div>
6411 </div>
6412 <div id="definition-VideoPrivacy" class="definition panel" data-traverse-target="definition-VideoPrivacy">
6413 <h2 class="panel-title">
6414 <a name="/definitions/VideoPrivacy"></a>VideoPrivacy: string
6415 <!-- <span class="json-property-type">
6416 <span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values">
6417 <span class="json-property-enum-item">Public</span>,
6418 <span class="json-property-enum-item">Unlisted</span>,
6419 <span class="json-property-enum-item">Private</span>
6420 </span>
6421 <span class="json-property-range" title="Value limits"></span>
6422
6423
6424 </span> -->
6425 </h2>
6426 <div class="doc-row">
6427 <div class="doc-copy">
6428 <span class="json-property-type">string</span>
6429 <span class="json-property-enum" title="Possible values">
6430 <span class="json-property-enum-item">Public</span>,
6431 <span class="json-property-enum-item">Unlisted</span>,
6432 <span class="json-property-enum-item">Private</span>
6433 </span>
6434 <span class="json-property-range" title="Value limits"></span>
6435 </div>
6436 </div>
6437 </div>
6438 <div id="definition-Video" class="definition panel" data-traverse-target="definition-Video">
6439 <h2 class="panel-title">
6440 <a name="/definitions/Video"></a>Video:
6441 <!-- <span class="json-property-type">
6442 <span class="json-property-type">object</span>
6443 <span class="json-property-range" title="Value limits"></span>
6444
6445
6446 </span> -->
6447 </h2>
6448 <div class="doc-row">
6449 <div class="doc-copy">
6450 <section class="json-schema-properties">
6451 <dl>
6452 <dt data-property-name="id">
6453 <span class="json-property-name">id:</span>
6454 <span class="json-property-type">number</span>
6455 <span class="json-property-range" title="Value limits"></span>
6456 </dt>
6457 <dt data-property-name="uuid">
6458 <span class="json-property-name">uuid:</span>
6459 <span class="json-property-type">string</span>
6460 <span class="json-property-range" title="Value limits"></span>
6461 </dt>
6462 <dt data-property-name="createdAt">
6463 <span class="json-property-name">createdAt:</span>
6464 <span class="json-property-type">string</span>
6465 <span class="json-property-range" title="Value limits"></span>
6466 </dt>
6467 <dt data-property-name="publishedAt">
6468 <span class="json-property-name">publishedAt:</span>
6469 <span class="json-property-type">string</span>
6470 <span class="json-property-range" title="Value limits"></span>
6471 </dt>
6472 <dt data-property-name="updatedAt">
6473 <span class="json-property-name">updatedAt:</span>
6474 <span class="json-property-type">string</span>
6475 <span class="json-property-range" title="Value limits"></span>
6476 </dt>
6477 <dt data-property-name="category">
6478 <span class="json-property-name">category:</span>
6479 <span class="json-property-type">
6480 <span class="">
6481 <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a>
6482 </span>
6483 </span>
6484 <span class="json-property-range" title="Value limits"></span>
6485 </dt>
6486 <dt data-property-name="licence">
6487 <span class="json-property-name">licence:</span>
6488 <span class="json-property-type">
6489 <span class="">
6490 <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a>
6491 </span>
6492 </span>
6493 <span class="json-property-range" title="Value limits"></span>
6494 </dt>
6495 <dt data-property-name="language">
6496 <span class="json-property-name">language:</span>
6497 <span class="json-property-type">
6498 <span class="">
6499 <a class="json-schema-ref" href="#/definitions/VideoConstantString">VideoConstantString</a>
6500 </span>
6501 </span>
6502 <span class="json-property-range" title="Value limits"></span>
6503 </dt>
6504 <dt data-property-name="privacy">
6505 <span class="json-property-name">privacy:</span>
6506 <span class="json-property-type">
6507 <span class="">
6508 <a class="json-schema-ref" href="#/definitions/VideoPrivacy">VideoPrivacy</a>
6509 </span>
6510 </span>
6511 <span class="json-property-range" title="Value limits"></span>
6512 </dt>
6513 <dt data-property-name="description">
6514 <span class="json-property-name">description:</span>
6515 <span class="json-property-type">string</span>
6516 <span class="json-property-range" title="Value limits"></span>
6517 </dt>
6518 <dt data-property-name="duration">
6519 <span class="json-property-name">duration:</span>
6520 <span class="json-property-type">number</span>
6521 <span class="json-property-range" title="Value limits"></span>
6522 </dt>
6523 <dt data-property-name="isLocal">
6524 <span class="json-property-name">isLocal:</span>
6525 <span class="json-property-type">boolean</span>
6526 <span class="json-property-range" title="Value limits"></span>
6527 </dt>
6528 <dt data-property-name="name">
6529 <span class="json-property-name">name:</span>
6530 <span class="json-property-type">string</span>
6531 <span class="json-property-range" title="Value limits"></span>
6532 </dt>
6533 <dt data-property-name="thumbnailPath">
6534 <span class="json-property-name">thumbnailPath:</span>
6535 <span class="json-property-type">string</span>
6536 <span class="json-property-range" title="Value limits"></span>
6537 </dt>
6538 <dt data-property-name="previewPath">
6539 <span class="json-property-name">previewPath:</span>
6540 <span class="json-property-type">string</span>
6541 <span class="json-property-range" title="Value limits"></span>
6542 </dt>
6543 <dt data-property-name="embedPath">
6544 <span class="json-property-name">embedPath:</span>
6545 <span class="json-property-type">string</span>
6546 <span class="json-property-range" title="Value limits"></span>
6547 </dt>
6548 <dt data-property-name="views">
6549 <span class="json-property-name">views:</span>
6550 <span class="json-property-type">number</span>
6551 <span class="json-property-range" title="Value limits"></span>
6552 </dt>
6553 <dt data-property-name="likes">
6554 <span class="json-property-name">likes:</span>
6555 <span class="json-property-type">number</span>
6556 <span class="json-property-range" title="Value limits"></span>
6557 </dt>
6558 <dt data-property-name="dislikes">
6559 <span class="json-property-name">dislikes:</span>
6560 <span class="json-property-type">number</span>
6561 <span class="json-property-range" title="Value limits"></span>
6562 </dt>
6563 <dt data-property-name="nsfw">
6564 <span class="json-property-name">nsfw:</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="account">
6569 <span class="json-property-name">account:</span>
6570 <span class="json-property-type">object</span>
6571 <span class="json-property-range" title="Value limits"></span>
6572 </dt>
6573 <dt class="json-inner-schema">
6574 <section class="json-schema-properties">
6575 <dl>
6576 <dt data-property-name="name">
6577 <span class="json-property-name">name:</span>
6578 <span class="json-property-type">string</span>
6579 <span class="json-property-range" title="Value limits"></span>
6580 </dt>
6581 <dt data-property-name="displayName">
6582 <span class="json-property-name">displayName:</span>
6583 <span class="json-property-type">string</span>
6584 <span class="json-property-range" title="Value limits"></span>
6585 </dt>
6586 <dt data-property-name="url">
6587 <span class="json-property-name">url:</span>
6588 <span class="json-property-type">string</span>
6589 <span class="json-property-range" title="Value limits"></span>
6590 </dt>
6591 <dt data-property-name="host">
6592 <span class="json-property-name">host:</span>
6593 <span class="json-property-type">string</span>
6594 <span class="json-property-range" title="Value limits"></span>
6595 </dt>
6596 <dt data-property-name="avatar">
6597 <span class="json-property-name">avatar:</span>
6598 <span class="json-property-type">
6599 <span class="">
6600 <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
6601 </span>
6602 </span>
6603 <span class="json-property-range" title="Value limits"></span>
6604 </dt>
6605 </dl>
6606 </section>
6607 </dt>
6608 </dl>
6609 </section>
6610 </div>
6611 <div class="doc-examples">
6612 <section>
6613 <h5>Example</h5>
6614 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6615 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6616 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6617 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6618 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6619 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6620 <span class="hljs-attr">&quot;category&quot;</span>: {
6621 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6622 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6623 },
6624 <span class="hljs-attr">&quot;licence&quot;</span>: {
6625 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6626 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6627 },
6628 <span class="hljs-attr">&quot;language&quot;</span>: {
6629 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6630 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6631 },
6632 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6633 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6634 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6635 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
6636 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6637 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6638 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6639 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6640 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6641 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6642 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6643 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
6644 <span class="hljs-attr">&quot;account&quot;</span>: {
6645 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6646 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6647 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6648 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6649 <span class="hljs-attr">&quot;avatar&quot;</span>: {
6650 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6651 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6652 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6653 }
6654 }
6655 }
6656 </code></pre>
6657 <!-- </div> -->
6658 </section>
6659 </div>
6660 </div>
6661 </div>
6662 <div id="definition-VideoAbuse" class="definition panel" data-traverse-target="definition-VideoAbuse">
6663 <h2 class="panel-title">
6664 <a name="/definitions/VideoAbuse"></a>VideoAbuse:
6665 <!-- <span class="json-property-type">
6666 <span class="json-property-type">object</span>
6667 <span class="json-property-range" title="Value limits"></span>
6668
6669
6670 </span> -->
6671 </h2>
6672 <div class="doc-row">
6673 <div class="doc-copy">
6674 <section class="json-schema-properties">
6675 <dl>
6676 <dt data-property-name="id">
6677 <span class="json-property-name">id:</span>
6678 <span class="json-property-type">number</span>
6679 <span class="json-property-range" title="Value limits"></span>
6680 </dt>
6681 <dt data-property-name="reason">
6682 <span class="json-property-name">reason:</span>
6683 <span class="json-property-type">string</span>
6684 <span class="json-property-range" title="Value limits"></span>
6685 </dt>
6686 <dt data-property-name="reporterAccount">
6687 <span class="json-property-name">reporterAccount:</span>
6688 <span class="json-property-type">
6689 <span class="">
6690 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
6691 </span>
6692 </span>
6693 <span class="json-property-range" title="Value limits"></span>
6694 </dt>
6695 <dt data-property-name="video">
6696 <span class="json-property-name">video:</span>
6697 <span class="json-property-type">object</span>
6698 <span class="json-property-range" title="Value limits"></span>
6699 </dt>
6700 <dt class="json-inner-schema">
6701 <section class="json-schema-properties">
6702 <dl>
6703 <dt data-property-name="id">
6704 <span class="json-property-name">id:</span>
6705 <span class="json-property-type">number</span>
6706 <span class="json-property-range" title="Value limits"></span>
6707 </dt>
6708 <dt data-property-name="name">
6709 <span class="json-property-name">name:</span>
6710 <span class="json-property-type">string</span>
6711 <span class="json-property-range" title="Value limits"></span>
6712 </dt>
6713 <dt data-property-name="uuid">
6714 <span class="json-property-name">uuid:</span>
6715 <span class="json-property-type">string</span>
6716 <span class="json-property-range" title="Value limits"></span>
6717 </dt>
6718 <dt data-property-name="url">
6719 <span class="json-property-name">url:</span>
6720 <span class="json-property-type">string</span>
6721 <span class="json-property-range" title="Value limits"></span>
6722 </dt>
6723 </dl>
6724 </section>
6725 </dt>
6726 <dt data-property-name="createdAt">
6727 <span class="json-property-name">createdAt:</span>
6728 <span class="json-property-type">string</span>
6729 <span class="json-property-range" title="Value limits"></span>
6730 </dt>
6731 </dl>
6732 </section>
6733 </div>
6734 <div class="doc-examples">
6735 <section>
6736 <h5>Example</h5>
6737 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6738 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6739 <span class="hljs-attr">&quot;reason&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6740 <span class="hljs-attr">&quot;reporterAccount&quot;</span>: {
6741 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6742 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6743 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6744 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6745 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6746 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6747 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6748 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6749 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6750 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6751 <span class="hljs-attr">&quot;avatar&quot;</span>: {
6752 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6753 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6754 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6755 }
6756 },
6757 <span class="hljs-attr">&quot;video&quot;</span>: {
6758 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6759 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6760 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6761 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6762 },
6763 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6764 }
6765 </code></pre>
6766 <!-- </div> -->
6767 </section>
6768 </div>
6769 </div>
6770 </div>
6771 <div id="definition-VideoBlacklist" class="definition panel" data-traverse-target="definition-VideoBlacklist">
6772 <h2 class="panel-title">
6773 <a name="/definitions/VideoBlacklist"></a>VideoBlacklist:
6774 <!-- <span class="json-property-type">
6775 <span class="json-property-type">object</span>
6776 <span class="json-property-range" title="Value limits"></span>
6777
6778
6779 </span> -->
6780 </h2>
6781 <div class="doc-row">
6782 <div class="doc-copy">
6783 <section class="json-schema-properties">
6784 <dl>
6785 <dt data-property-name="id">
6786 <span class="json-property-name">id:</span>
6787 <span class="json-property-type">number</span>
6788 <span class="json-property-range" title="Value limits"></span>
6789 </dt>
6790 <dt data-property-name="videoId">
6791 <span class="json-property-name">videoId:</span>
6792 <span class="json-property-type">number</span>
6793 <span class="json-property-range" title="Value limits"></span>
6794 </dt>
6795 <dt data-property-name="createdAt">
6796 <span class="json-property-name">createdAt:</span>
6797 <span class="json-property-type">string</span>
6798 <span class="json-property-range" title="Value limits"></span>
6799 </dt>
6800 <dt data-property-name="updatedAt">
6801 <span class="json-property-name">updatedAt:</span>
6802 <span class="json-property-type">string</span>
6803 <span class="json-property-range" title="Value limits"></span>
6804 </dt>
6805 <dt data-property-name="name">
6806 <span class="json-property-name">name:</span>
6807 <span class="json-property-type">string</span>
6808 <span class="json-property-range" title="Value limits"></span>
6809 </dt>
6810 <dt data-property-name="uuid">
6811 <span class="json-property-name">uuid:</span>
6812 <span class="json-property-type">string</span>
6813 <span class="json-property-range" title="Value limits"></span>
6814 </dt>
6815 <dt data-property-name="description">
6816 <span class="json-property-name">description:</span>
6817 <span class="json-property-type">string</span>
6818 <span class="json-property-range" title="Value limits"></span>
6819 </dt>
6820 <dt data-property-name="duration">
6821 <span class="json-property-name">duration:</span>
6822 <span class="json-property-type">number</span>
6823 <span class="json-property-range" title="Value limits"></span>
6824 </dt>
6825 <dt data-property-name="views">
6826 <span class="json-property-name">views:</span>
6827 <span class="json-property-type">number</span>
6828 <span class="json-property-range" title="Value limits"></span>
6829 </dt>
6830 <dt data-property-name="likes">
6831 <span class="json-property-name">likes:</span>
6832 <span class="json-property-type">number</span>
6833 <span class="json-property-range" title="Value limits"></span>
6834 </dt>
6835 <dt data-property-name="dislikes">
6836 <span class="json-property-name">dislikes:</span>
6837 <span class="json-property-type">number</span>
6838 <span class="json-property-range" title="Value limits"></span>
6839 </dt>
6840 <dt data-property-name="nsfw">
6841 <span class="json-property-name">nsfw:</span>
6842 <span class="json-property-type">boolean</span>
6843 <span class="json-property-range" title="Value limits"></span>
6844 </dt>
6845 </dl>
6846 </section>
6847 </div>
6848 <div class="doc-examples">
6849 <section>
6850 <h5>Example</h5>
6851 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6852 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6853 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6854 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6855 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6856 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6857 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6858 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6859 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6860 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6861 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6862 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6863 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>
6864 }
6865 </code></pre>
6866 <!-- </div> -->
6867 </section>
6868 </div>
6869 </div>
6870 </div>
6871 <div id="definition-VideoChannel" class="definition panel" data-traverse-target="definition-VideoChannel">
6872 <h2 class="panel-title">
6873 <a name="/definitions/VideoChannel"></a>VideoChannel:
6874 <!-- <span class="json-property-type">
6875 <span class="json-property-type">object</span>
6876 <span class="json-property-range" title="Value limits"></span>
6877
6878
6879 </span> -->
6880 </h2>
6881 <div class="doc-row">
6882 <div class="doc-copy">
6883 <section class="json-schema-properties">
6884 <dl>
6885 <dt data-property-name="displayName">
6886 <span class="json-property-name">displayName:</span>
6887 <span class="json-property-type">string</span>
6888 <span class="json-property-range" title="Value limits"></span>
6889 </dt>
6890 <dt data-property-name="description">
6891 <span class="json-property-name">description:</span>
6892 <span class="json-property-type">string</span>
6893 <span class="json-property-range" title="Value limits"></span>
6894 </dt>
6895 <dt data-property-name="isLocal">
6896 <span class="json-property-name">isLocal:</span>
6897 <span class="json-property-type">boolean</span>
6898 <span class="json-property-range" title="Value limits"></span>
6899 </dt>
6900 <dt data-property-name="ownerAccount">
6901 <span class="json-property-name">ownerAccount:</span>
6902 <span class="json-property-type">object</span>
6903 <span class="json-property-range" title="Value limits"></span>
6904 </dt>
6905 <dt class="json-inner-schema">
6906 <section class="json-schema-properties">
6907 <dl>
6908 <dt data-property-name="id">
6909 <span class="json-property-name">id:</span>
6910 <span class="json-property-type">number</span>
6911 <span class="json-property-range" title="Value limits"></span>
6912 </dt>
6913 <dt data-property-name="uuid">
6914 <span class="json-property-name">uuid:</span>
6915 <span class="json-property-type">string</span>
6916 <span class="json-property-range" title="Value limits"></span>
6917 </dt>
6918 </dl>
6919 </section>
6920 </dt>
6921 </dl>
6922 </section>
6923 </div>
6924 <div class="doc-examples">
6925 <section>
6926 <h5>Example</h5>
6927 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6928 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6929 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6930 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
6931 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
6932 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6933 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6934 }
6935 }
6936 </code></pre>
6937 <!-- </div> -->
6938 </section>
6939 </div>
6940 </div>
6941 </div>
6942 <div id="definition-VideoComment" class="definition panel" data-traverse-target="definition-VideoComment">
6943 <h2 class="panel-title">
6944 <a name="/definitions/VideoComment"></a>VideoComment:
6945 <!-- <span class="json-property-type">
6946 <span class="json-property-type">object</span>
6947 <span class="json-property-range" title="Value limits"></span>
6948
6949
6950 </span> -->
6951 </h2>
6952 <div class="doc-row">
6953 <div class="doc-copy">
6954 <section class="json-schema-properties">
6955 <dl>
6956 <dt data-property-name="id">
6957 <span class="json-property-name">id:</span>
6958 <span class="json-property-type">number</span>
6959 <span class="json-property-range" title="Value limits"></span>
6960 </dt>
6961 <dt data-property-name="url">
6962 <span class="json-property-name">url:</span>
6963 <span class="json-property-type">string</span>
6964 <span class="json-property-range" title="Value limits"></span>
6965 </dt>
6966 <dt data-property-name="text">
6967 <span class="json-property-name">text:</span>
6968 <span class="json-property-type">string</span>
6969 <span class="json-property-range" title="Value limits"></span>
6970 </dt>
6971 <dt data-property-name="threadId">
6972 <span class="json-property-name">threadId:</span>
6973 <span class="json-property-type">number</span>
6974 <span class="json-property-range" title="Value limits"></span>
6975 </dt>
6976 <dt data-property-name="inReplyToCommentId">
6977 <span class="json-property-name">inReplyToCommentId:</span>
6978 <span class="json-property-type">number</span>
6979 <span class="json-property-range" title="Value limits"></span>
6980 </dt>
6981 <dt data-property-name="videoId">
6982 <span class="json-property-name">videoId:</span>
6983 <span class="json-property-type">number</span>
6984 <span class="json-property-range" title="Value limits"></span>
6985 </dt>
6986 <dt data-property-name="createdAt">
6987 <span class="json-property-name">createdAt:</span>
6988 <span class="json-property-type">string</span>
6989 <span class="json-property-range" title="Value limits"></span>
6990 </dt>
6991 <dt data-property-name="updatedAt">
6992 <span class="json-property-name">updatedAt:</span>
6993 <span class="json-property-type">string</span>
6994 <span class="json-property-range" title="Value limits"></span>
6995 </dt>
6996 <dt data-property-name="totalReplies">
6997 <span class="json-property-name">totalReplies:</span>
6998 <span class="json-property-type">number</span>
6999 <span class="json-property-range" title="Value limits"></span>
7000 </dt>
7001 <dt data-property-name="account">
7002 <span class="json-property-name">account:</span>
7003 <span class="json-property-type">
7004 <span class="">
7005 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
7006 </span>
7007 </span>
7008 <span class="json-property-range" title="Value limits"></span>
7009 </dt>
7010 </dl>
7011 </section>
7012 </div>
7013 <div class="doc-examples">
7014 <section>
7015 <h5>Example</h5>
7016 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7017 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7018 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7019 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7020 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7021 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7022 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7023 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7024 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7025 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7026 <span class="hljs-attr">&quot;account&quot;</span>: {
7027 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7028 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7029 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7030 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7031 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7032 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7033 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7034 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7035 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7036 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7037 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7038 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7039 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7040 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7041 }
7042 }
7043 }
7044 </code></pre>
7045 <!-- </div> -->
7046 </section>
7047 </div>
7048 </div>
7049 </div>
7050 <div id="definition-VideoCommentThreadTree" class="definition panel" data-traverse-target="definition-VideoCommentThreadTree">
7051 <h2 class="panel-title">
7052 <a name="/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree:
7053 <!-- <span class="json-property-type">
7054 <span class="json-property-type">object</span>
7055 <span class="json-property-range" title="Value limits"></span>
7056
7057
7058 </span> -->
7059 </h2>
7060 <div class="doc-row">
7061 <div class="doc-copy">
7062 <section class="json-schema-properties">
7063 <dl>
7064 <dt data-property-name="comment">
7065 <span class="json-property-name">comment:</span>
7066 <span class="json-property-type">
7067 <span class="">
7068 <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
7069 </span>
7070 </span>
7071 <span class="json-property-range" title="Value limits"></span>
7072 </dt>
7073 <dt data-property-name="children">
7074 <span class="json-property-name">children:</span>
7075 <span class="json-property-type">
7076 <span class="json-schema-ref-array">
7077 <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
7078 </span>
7079 </span>
7080 <span class="json-property-range" title="Value limits"></span>
7081 </dt>
7082 <dt class="json-inner-schema">
7083 <section class="json-schema-array-items">
7084 <span class="json-property-type">
7085 <span class="">
7086 <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
7087 </span>
7088 </span>
7089 <span class="json-property-range" title="Value limits"></span>
7090 <div class="json-inner-schema"> </div>
7091 </section>
7092 </dt>
7093 </dl>
7094 </section>
7095 </div>
7096 <div class="doc-examples">
7097 <section>
7098 <h5>Example</h5>
7099 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7100 <span class="hljs-attr">&quot;comment&quot;</span>: {
7101 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7102 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7103 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7104 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7105 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7106 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7107 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7108 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7109 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7110 <span class="hljs-attr">&quot;account&quot;</span>: {
7111 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7112 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7113 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7114 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7115 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7116 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7117 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7118 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7119 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7120 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7121 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7122 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7123 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7124 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7125 }
7126 }
7127 },
7128 <span class="hljs-attr">&quot;children&quot;</span>: [
7129 {
7130 <span class="hljs-attr">&quot;comment&quot;</span>: {
7131 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7132 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7133 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7134 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7135 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7136 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7137 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7138 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7139 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7140 <span class="hljs-attr">&quot;account&quot;</span>: {
7141 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7142 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7143 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7144 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7145 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7146 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7147 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7148 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7149 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7150 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7151 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7152 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7153 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7154 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7155 }
7156 }
7157 },
7158 <span class="hljs-attr">&quot;children&quot;</span>: [
7159 {
7160 <span class="hljs-attr">&quot;comment&quot;</span>: {
7161 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7162 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7163 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7164 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7165 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7166 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7167 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7168 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7169 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7170 <span class="hljs-attr">&quot;account&quot;</span>: {
7171 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7172 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7173 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7174 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7175 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7176 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7177 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7178 <span class="hljs-attr">&quot;followersCount&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;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7181 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7182 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7183 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7184 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7185 }
7186 }
7187 }
7188 }
7189 ]
7190 }
7191 ]
7192 }
7193 </code></pre>
7194 <!-- </div> -->
7195 </section>
7196 </div>
7197 </div>
7198 </div>
7199 <div id="definition-Avatar" class="definition panel" data-traverse-target="definition-Avatar">
7200 <h2 class="panel-title">
7201 <a name="/definitions/Avatar"></a>Avatar:
7202 <!-- <span class="json-property-type">
7203 <span class="json-property-type">object</span>
7204 <span class="json-property-range" title="Value limits"></span>
7205
7206
7207 </span> -->
7208 </h2>
7209 <div class="doc-row">
7210 <div class="doc-copy">
7211 <section class="json-schema-properties">
7212 <dl>
7213 <dt data-property-name="path">
7214 <span class="json-property-name">path:</span>
7215 <span class="json-property-type">string</span>
7216 <span class="json-property-range" title="Value limits"></span>
7217 </dt>
7218 <dt data-property-name="createdAt">
7219 <span class="json-property-name">createdAt:</span>
7220 <span class="json-property-type">string</span>
7221 <span class="json-property-range" title="Value limits"></span>
7222 </dt>
7223 <dt data-property-name="updatedAt">
7224 <span class="json-property-name">updatedAt:</span>
7225 <span class="json-property-type">string</span>
7226 <span class="json-property-range" title="Value limits"></span>
7227 </dt>
7228 </dl>
7229 </section>
7230 </div>
7231 <div class="doc-examples">
7232 <section>
7233 <h5>Example</h5>
7234 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7235 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7236 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7237 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7238 }
7239 </code></pre>
7240 <!-- </div> -->
7241 </section>
7242 </div>
7243 </div>
7244 </div>
7245 <div id="definition-Actor" class="definition panel" data-traverse-target="definition-Actor">
7246 <h2 class="panel-title">
7247 <a name="/definitions/Actor"></a>Actor:
7248 <!-- <span class="json-property-type">
7249 <span class="json-property-type">object</span>
7250 <span class="json-property-range" title="Value limits"></span>
7251
7252
7253 </span> -->
7254 </h2>
7255 <div class="doc-row">
7256 <div class="doc-copy">
7257 <section class="json-schema-properties">
7258 <dl>
7259 <dt data-property-name="id">
7260 <span class="json-property-name">id:</span>
7261 <span class="json-property-type">number</span>
7262 <span class="json-property-range" title="Value limits"></span>
7263 </dt>
7264 <dt data-property-name="uuid">
7265 <span class="json-property-name">uuid:</span>
7266 <span class="json-property-type">string</span>
7267 <span class="json-property-range" title="Value limits"></span>
7268 </dt>
7269 <dt data-property-name="url">
7270 <span class="json-property-name">url:</span>
7271 <span class="json-property-type">string</span>
7272 <span class="json-property-range" title="Value limits"></span>
7273 </dt>
7274 <dt data-property-name="name">
7275 <span class="json-property-name">name:</span>
7276 <span class="json-property-type">string</span>
7277 <span class="json-property-range" title="Value limits"></span>
7278 </dt>
7279 <dt data-property-name="host">
7280 <span class="json-property-name">host:</span>
7281 <span class="json-property-type">string</span>
7282 <span class="json-property-range" title="Value limits"></span>
7283 </dt>
7284 <dt data-property-name="followingCount">
7285 <span class="json-property-name">followingCount:</span>
7286 <span class="json-property-type">number</span>
7287 <span class="json-property-range" title="Value limits"></span>
7288 </dt>
7289 <dt data-property-name="followersCount">
7290 <span class="json-property-name">followersCount:</span>
7291 <span class="json-property-type">number</span>
7292 <span class="json-property-range" title="Value limits"></span>
7293 </dt>
7294 <dt data-property-name="createdAt">
7295 <span class="json-property-name">createdAt:</span>
7296 <span class="json-property-type">string</span>
7297 <span class="json-property-range" title="Value limits"></span>
7298 </dt>
7299 <dt data-property-name="updatedAt">
7300 <span class="json-property-name">updatedAt:</span>
7301 <span class="json-property-type">string</span>
7302 <span class="json-property-range" title="Value limits"></span>
7303 </dt>
7304 <dt data-property-name="avatar">
7305 <span class="json-property-name">avatar:</span>
7306 <span class="json-property-type">
7307 <span class="">
7308 <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
7309 </span>
7310 </span>
7311 <span class="json-property-range" title="Value limits"></span>
7312 </dt>
7313 </dl>
7314 </section>
7315 </div>
7316 <div class="doc-examples">
7317 <section>
7318 <h5>Example</h5>
7319 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7320 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7321 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7322 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7323 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7324 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7325 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7326 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7327 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7328 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7329 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7330 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7331 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7332 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7333 }
7334 }
7335 </code></pre>
7336 <!-- </div> -->
7337 </section>
7338 </div>
7339 </div>
7340 </div>
7341 <div id="definition-Account" class="definition panel" data-traverse-target="definition-Account">
7342 <h2 class="panel-title">
7343 <a name="/definitions/Account"></a>Account:
7344 <!-- <span class="json-property-type">
7345 <span class="json-property-type"></span>
7346 <span class="json-property-range" title="Value limits"></span>
7347
7348
7349 </span> -->
7350 </h2>
7351 <div class="doc-row">
7352 <div class="doc-copy">
7353 <section class="json-schema-allOf">
7354 <section class="json-schema-allOf-inherited">
7355 <ul>
7356 <span class="">
7357 <a class="json-schema-ref" href="#/definitions/Actor">Actor</a>
7358 </span>
7359 </ul>
7360 </section>
7361 <section class="json-schema-allOf-additional">
7362 <section class="json-schema-properties">
7363 <dl>
7364 <dt data-property-name="displayName">
7365 <span class="json-property-name">displayName:</span>
7366 <span class="json-property-type">string</span>
7367 <span class="json-property-range" title="Value limits"></span>
7368 </dt>
7369 </dl>
7370 </section>
7371 </section>
7372 </section>
7373 </div>
7374 <div class="doc-examples">
7375 <section>
7376 <h5>Example</h5>
7377 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7378 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7379 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7380 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7381 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7382 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7383 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7384 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7385 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7386 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7387 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7388 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7389 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7390 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7391 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7392 }
7393 }
7394 </code></pre>
7395 <!-- </div> -->
7396 </section>
7397 </div>
7398 </div>
7399 </div>
7400 <div id="definition-User" class="definition panel" data-traverse-target="definition-User">
7401 <h2 class="panel-title">
7402 <a name="/definitions/User"></a>User:
7403 <!-- <span class="json-property-type">
7404 <span class="json-property-type">object</span>
7405 <span class="json-property-range" title="Value limits"></span>
7406
7407
7408 </span> -->
7409 </h2>
7410 <div class="doc-row">
7411 <div class="doc-copy">
7412 <section class="json-schema-properties">
7413 <dl>
7414 <dt data-property-name="id">
7415 <span class="json-property-name">id:</span>
7416 <span class="json-property-type">number</span>
7417 <span class="json-property-range" title="Value limits"></span>
7418 </dt>
7419 <dt data-property-name="username">
7420 <span class="json-property-name">username:</span>
7421 <span class="json-property-type">string</span>
7422 <span class="json-property-range" title="Value limits"></span>
7423 </dt>
7424 <dt data-property-name="email">
7425 <span class="json-property-name">email:</span>
7426 <span class="json-property-type">string</span>
7427 <span class="json-property-range" title="Value limits"></span>
7428 </dt>
7429 <dt data-property-name="displayNSFW">
7430 <span class="json-property-name">displayNSFW:</span>
7431 <span class="json-property-type">boolean</span>
7432 <span class="json-property-range" title="Value limits"></span>
7433 </dt>
7434 <dt data-property-name="autoPlayVideo">
7435 <span class="json-property-name">autoPlayVideo:</span>
7436 <span class="json-property-type">boolean</span>
7437 <span class="json-property-range" title="Value limits"></span>
7438 </dt>
7439 <dt data-property-name="role">
7440 <span class="json-property-name">role:</span>
7441 <span class="json-property-type">string</span>
7442 <span class="json-property-enum" title="Possible values">
7443 <span class="json-property-enum-item">User</span>,
7444 <span class="json-property-enum-item">Moderator</span>,
7445 <span class="json-property-enum-item">Administrator</span>
7446 </span>
7447 <span class="json-property-range" title="Value limits"></span>
7448 </dt>
7449 <dt data-property-name="videoQuota">
7450 <span class="json-property-name">videoQuota:</span>
7451 <span class="json-property-type">number</span>
7452 <span class="json-property-range" title="Value limits"></span>
7453 </dt>
7454 <dt data-property-name="createdAt">
7455 <span class="json-property-name">createdAt:</span>
7456 <span class="json-property-type">string</span>
7457 <span class="json-property-range" title="Value limits"></span>
7458 </dt>
7459 <dt data-property-name="account">
7460 <span class="json-property-name">account:</span>
7461 <span class="json-property-type">
7462 <span class="">
7463 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
7464 </span>
7465 </span>
7466 <span class="json-property-range" title="Value limits"></span>
7467 </dt>
7468 <dt data-property-name="videoChannels">
7469 <span class="json-property-name">videoChannels:</span>
7470 <span class="json-property-type">
7471 <span class="json-schema-ref-array">
7472 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
7473 </span>
7474 </span>
7475 <span class="json-property-range" title="Value limits"></span>
7476 </dt>
7477 <dt class="json-inner-schema">
7478 <section class="json-schema-array-items">
7479 <span class="json-property-type">
7480 <span class="">
7481 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
7482 </span>
7483 </span>
7484 <span class="json-property-range" title="Value limits"></span>
7485 <div class="json-inner-schema"> </div>
7486 </section>
7487 </dt>
7488 </dl>
7489 </section>
7490 </div>
7491 <div class="doc-examples">
7492 <section>
7493 <h5>Example</h5>
7494 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7495 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7496 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7497 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7498 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
7499 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
7500 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7501 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7502 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7503 <span class="hljs-attr">&quot;account&quot;</span>: {
7504 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7505 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7506 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7507 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7508 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7509 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7510 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7511 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&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 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7515 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7516 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7517 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7518 }
7519 },
7520 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
7521 {
7522 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7523 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7524 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
7525 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
7526 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7527 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7528 }
7529 }
7530 ]
7531 }
7532 </code></pre>
7533 <!-- </div> -->
7534 </section>
7535 </div>
7536 </div>
7537 </div>
7538 <div id="definition-ServerConfig" class="definition panel" data-traverse-target="definition-ServerConfig">
7539 <h2 class="panel-title">
7540 <a name="/definitions/ServerConfig"></a>ServerConfig:
7541 <!-- <span class="json-property-type">
7542 <span class="json-property-type">object</span>
7543 <span class="json-property-range" title="Value limits"></span>
7544
7545
7546 </span> -->
7547 </h2>
7548 <div class="doc-row">
7549 <div class="doc-copy">
7550 <section class="json-schema-properties">
7551 <dl>
7552 <dt data-property-name="signup">
7553 <span class="json-property-name">signup:</span>
7554 <span class="json-property-type">object</span>
7555 <span class="json-property-range" title="Value limits"></span>
7556 </dt>
7557 <dt class="json-inner-schema">
7558 <section class="json-schema-properties">
7559 <dl>
7560 <dt data-property-name="allowed">
7561 <span class="json-property-name">allowed:</span>
7562 <span class="json-property-type">boolean</span>
7563 <span class="json-property-range" title="Value limits"></span>
7564 </dt>
7565 </dl>
7566 </section>
7567 </dt>
7568 <dt data-property-name="transcoding">
7569 <span class="json-property-name">transcoding:</span>
7570 <span class="json-property-type">object</span>
7571 <span class="json-property-range" title="Value limits"></span>
7572 </dt>
7573 <dt class="json-inner-schema">
7574 <section class="json-schema-properties">
7575 <dl>
7576 <dt data-property-name="enabledResolutions">
7577 <span class="json-property-name">enabledResolutions:</span>
7578 <span class="json-property-type">number[]</span>
7579 <span class="json-property-range" title="Value limits"></span>
7580 </dt>
7581 <dt class="json-inner-schema">
7582 <section class="json-schema-array-items">
7583 <span class="json-property-type">number</span>
7584 <span class="json-property-range" title="Value limits"></span>
7585 <div class="json-inner-schema"> </div>
7586 </section>
7587 </dt>
7588 </dl>
7589 </section>
7590 </dt>
7591 <dt data-property-name="avatar">
7592 <span class="json-property-name">avatar:</span>
7593 <span class="json-property-type">object</span>
7594 <span class="json-property-range" title="Value limits"></span>
7595 </dt>
7596 <dt class="json-inner-schema">
7597 <section class="json-schema-properties">
7598 <dl>
7599 <dt data-property-name="file">
7600 <span class="json-property-name">file:</span>
7601 <span class="json-property-type">object</span>
7602 <span class="json-property-range" title="Value limits"></span>
7603 </dt>
7604 <dt class="json-inner-schema">
7605 <section class="json-schema-properties">
7606 <dl>
7607 <dt data-property-name="size">
7608 <span class="json-property-name">size:</span>
7609 <span class="json-property-type">object</span>
7610 <span class="json-property-range" title="Value limits"></span>
7611 </dt>
7612 <dt class="json-inner-schema">
7613 <section class="json-schema-properties">
7614 <dl>
7615 <dt data-property-name="max">
7616 <span class="json-property-name">max:</span>
7617 <span class="json-property-type">number</span>
7618 <span class="json-property-range" title="Value limits"></span>
7619 </dt>
7620 </dl>
7621 </section>
7622 </dt>
7623 </dl>
7624 </section>
7625 </dt>
7626 <dt data-property-name="extensions">
7627 <span class="json-property-name">extensions:</span>
7628 <span class="json-property-type">string[]</span>
7629 <span class="json-property-range" title="Value limits"></span>
7630 </dt>
7631 <dt class="json-inner-schema">
7632 <section class="json-schema-array-items">
7633 <span class="json-property-type">string</span>
7634 <span class="json-property-range" title="Value limits"></span>
7635 <div class="json-inner-schema"> </div>
7636 </section>
7637 </dt>
7638 </dl>
7639 </section>
7640 </dt>
7641 <dt data-property-name="video">
7642 <span class="json-property-name">video:</span>
7643 <span class="json-property-type">object</span>
7644 <span class="json-property-range" title="Value limits"></span>
7645 </dt>
7646 <dt class="json-inner-schema">
7647 <section class="json-schema-properties">
7648 <dl>
7649 <dt data-property-name="file">
7650 <span class="json-property-name">file:</span>
7651 <span class="json-property-type">object</span>
7652 <span class="json-property-range" title="Value limits"></span>
7653 </dt>
7654 <dt class="json-inner-schema">
7655 <section class="json-schema-properties">
7656 <dl>
7657 <dt data-property-name="extensions">
7658 <span class="json-property-name">extensions:</span>
7659 <span class="json-property-type">string[]</span>
7660 <span class="json-property-range" title="Value limits"></span>
7661 </dt>
7662 <dt class="json-inner-schema">
7663 <section class="json-schema-array-items">
7664 <span class="json-property-type">string</span>
7665 <span class="json-property-range" title="Value limits"></span>
7666 <div class="json-inner-schema"> </div>
7667 </section>
7668 </dt>
7669 </dl>
7670 </section>
7671 </dt>
7672 </dl>
7673 </section>
7674 </dt>
7675 </dl>
7676 </section>
7677 </div>
7678 <div class="doc-examples">
7679 <section>
7680 <h5>Example</h5>
7681 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7682 <span class="hljs-attr">&quot;signup&quot;</span>: {
7683 <span class="hljs-attr">&quot;allowed&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>
7684 },
7685 <span class="hljs-attr">&quot;transcoding&quot;</span>: {
7686 <span class="hljs-attr">&quot;enabledResolutions&quot;</span>: [
7687 <span class="hljs-string">&quot;number&quot;</span>
7688 ]
7689 },
7690 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7691 <span class="hljs-attr">&quot;file&quot;</span>: {
7692 <span class="hljs-attr">&quot;size&quot;</span>: {
7693 <span class="hljs-attr">&quot;max&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>
7694 }
7695 },
7696 <span class="hljs-attr">&quot;extensions&quot;</span>: [
7697 <span class="hljs-string">&quot;string&quot;</span>
7698 ]
7699 },
7700 <span class="hljs-attr">&quot;video&quot;</span>: {
7701 <span class="hljs-attr">&quot;file&quot;</span>: {
7702 <span class="hljs-attr">&quot;extensions&quot;</span>: [
7703 <span class="hljs-string">&quot;string&quot;</span>
7704 ]
7705 }
7706 }
7707 }
7708 </code></pre>
7709 <!-- </div> -->
7710 </section>
7711 </div>
7712 </div>
7713 </div>
7714 <div id="definition-Follow" class="definition panel" data-traverse-target="definition-Follow">
7715 <h2 class="panel-title">
7716 <a name="/definitions/Follow"></a>Follow:
7717 <!-- <span class="json-property-type">
7718 <span class="json-property-type">object</span>
7719 <span class="json-property-range" title="Value limits"></span>
7720
7721
7722 </span> -->
7723 </h2>
7724 <div class="doc-row">
7725 <div class="doc-copy">
7726 <section class="json-schema-properties">
7727 <dl>
7728 <dt data-property-name="id">
7729 <span class="json-property-name">id:</span>
7730 <span class="json-property-type">number</span>
7731 <span class="json-property-range" title="Value limits"></span>
7732 </dt>
7733 <dt data-property-name="follower">
7734 <span class="json-property-name">follower:</span>
7735 <span class="json-property-type">
7736 <span class="">
7737 <a class="json-schema-ref" href="#/definitions/Actor">Actor</a>
7738 </span>
7739 </span>
7740 <span class="json-property-range" title="Value limits"></span>
7741 </dt>
7742 <dt data-property-name="following">
7743 <span class="json-property-name">following:</span>
7744 <span class="json-property-type">
7745 <span class="">
7746 <a class="json-schema-ref" href="#/definitions/Actor">Actor</a>
7747 </span>
7748 </span>
7749 <span class="json-property-range" title="Value limits"></span>
7750 </dt>
7751 <dt data-property-name="score">
7752 <span class="json-property-name">score:</span>
7753 <span class="json-property-type">number</span>
7754 <span class="json-property-range" title="Value limits"></span>
7755 </dt>
7756 <dt data-property-name="state">
7757 <span class="json-property-name">state:</span>
7758 <span class="json-property-type">string</span>
7759 <span class="json-property-enum" title="Possible values">
7760 <span class="json-property-enum-item">pending</span>,
7761 <span class="json-property-enum-item">accepted</span>
7762 </span>
7763 <span class="json-property-range" title="Value limits"></span>
7764 </dt>
7765 <dt data-property-name="createdAt">
7766 <span class="json-property-name">createdAt:</span>
7767 <span class="json-property-type">string</span>
7768 <span class="json-property-range" title="Value limits"></span>
7769 </dt>
7770 <dt data-property-name="updatedAt">
7771 <span class="json-property-name">updatedAt:</span>
7772 <span class="json-property-type">string</span>
7773 <span class="json-property-range" title="Value limits"></span>
7774 </dt>
7775 </dl>
7776 </section>
7777 </div>
7778 <div class="doc-examples">
7779 <section>
7780 <h5>Example</h5>
7781 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7782 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7783 <span class="hljs-attr">&quot;follower&quot;</span>: {
7784 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7785 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7786 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7787 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7788 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7789 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7790 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7791 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7792 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7793 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7794 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7795 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7796 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7797 }
7798 },
7799 <span class="hljs-attr">&quot;following&quot;</span>: {
7800 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7801 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7802 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7803 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7804 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7805 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7806 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7807 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7808 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7809 <span class="hljs-attr">&quot;avatar&quot;</span>: {
7810 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7811 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7812 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7813 }
7814 },
7815 <span class="hljs-attr">&quot;score&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7816 <span class="hljs-attr">&quot;state&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7817 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7818 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7819 }
7820 </code></pre>
7821 <!-- </div> -->
7822 </section>
7823 </div>
7824 </div>
7825 </div>
7826 <div id="definition-Job" class="definition panel" data-traverse-target="definition-Job">
7827 <h2 class="panel-title">
7828 <a name="/definitions/Job"></a>Job:
7829 <!-- <span class="json-property-type">
7830 <span class="json-property-type">object</span>
7831 <span class="json-property-range" title="Value limits"></span>
7832
7833
7834 </span> -->
7835 </h2>
7836 <div class="doc-row">
7837 <div class="doc-copy">
7838 <section class="json-schema-properties">
7839 <dl>
7840 <dt data-property-name="id">
7841 <span class="json-property-name">id:</span>
7842 <span class="json-property-type">number</span>
7843 <span class="json-property-range" title="Value limits"></span>
7844 </dt>
7845 <dt data-property-name="state">
7846 <span class="json-property-name">state:</span>
7847 <span class="json-property-type">string</span>
7848 <span class="json-property-enum" title="Possible values">
7849 <span class="json-property-enum-item">pending</span>,
7850 <span class="json-property-enum-item">processing</span>,
7851 <span class="json-property-enum-item">error</span>,
7852 <span class="json-property-enum-item">success</span>
7853 </span>
7854 <span class="json-property-range" title="Value limits"></span>
7855 </dt>
7856 <dt data-property-name="category">
7857 <span class="json-property-name">category:</span>
7858 <span class="json-property-type">string</span>
7859 <span class="json-property-enum" title="Possible values">
7860 <span class="json-property-enum-item">transcoding</span>,
7861 <span class="json-property-enum-item">activitypub-http</span>
7862 </span>
7863 <span class="json-property-range" title="Value limits"></span>
7864 </dt>
7865 <dt data-property-name="handlerName">
7866 <span class="json-property-name">handlerName:</span>
7867 <span class="json-property-type">string</span>
7868 <span class="json-property-range" title="Value limits"></span>
7869 </dt>
7870 <dt data-property-name="handlerInputData">
7871 <span class="json-property-name">handlerInputData:</span>
7872 <span class="json-property-type">string</span>
7873 <span class="json-property-range" title="Value limits"></span>
7874 </dt>
7875 <dt data-property-name="createdAt">
7876 <span class="json-property-name">createdAt:</span>
7877 <span class="json-property-type">string</span>
7878 <span class="json-property-range" title="Value limits"></span>
7879 </dt>
7880 <dt data-property-name="updatedAt">
7881 <span class="json-property-name">updatedAt:</span>
7882 <span class="json-property-type">string</span>
7883 <span class="json-property-range" title="Value limits"></span>
7884 </dt>
7885 </dl>
7886 </section>
7887 </div>
7888 <div class="doc-examples">
7889 <section>
7890 <h5>Example</h5>
7891 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7892 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7893 <span class="hljs-attr">&quot;state&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7894 <span class="hljs-attr">&quot;category&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7895 <span class="hljs-attr">&quot;handlerName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7896 <span class="hljs-attr">&quot;handlerInputData&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7897 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
7898 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7899 }
7900 </code></pre>
7901 <!-- </div> -->
7902 </section>
7903 </div>
7904 </div>
7905 </div>
7906 <div id="definition-AddUserResponse" class="definition panel" data-traverse-target="definition-AddUserResponse">
7907 <h2 class="panel-title">
7908 <a name="/definitions/AddUserResponse"></a>AddUserResponse:
7909 <!-- <span class="json-property-type">
7910 <span class="json-property-type">object</span>
7911 <span class="json-property-range" title="Value limits"></span>
7912
7913
7914 </span> -->
7915 </h2>
7916 <div class="doc-row">
7917 <div class="doc-copy">
7918 <section class="json-schema-properties">
7919 <dl>
7920 <dt data-property-name="id">
7921 <span class="json-property-name">id:</span>
7922 <span class="json-property-type">number</span>
7923 <span class="json-property-range" title="Value limits"></span>
7924 </dt>
7925 <dt data-property-name="uuid">
7926 <span class="json-property-name">uuid:</span>
7927 <span class="json-property-type">string</span>
7928 <span class="json-property-range" title="Value limits"></span>
7929 </dt>
7930 </dl>
7931 </section>
7932 </div>
7933 <div class="doc-examples">
7934 <section>
7935 <h5>Example</h5>
7936 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7937 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7938 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7939 }
7940 </code></pre>
7941 <!-- </div> -->
7942 </section>
7943 </div>
7944 </div>
7945 </div>
7946 <div id="definition-VideoUploadResponse" class="definition panel" data-traverse-target="definition-VideoUploadResponse">
7947 <h2 class="panel-title">
7948 <a name="/definitions/VideoUploadResponse"></a>VideoUploadResponse:
7949 <!-- <span class="json-property-type">
7950 <span class="json-property-type">object</span>
7951 <span class="json-property-range" title="Value limits"></span>
7952
7953
7954 </span> -->
7955 </h2>
7956 <div class="doc-row">
7957 <div class="doc-copy">
7958 <section class="json-schema-properties">
7959 <dl>
7960 <dt data-property-name="video">
7961 <span class="json-property-name">video:</span>
7962 <span class="json-property-type">object</span>
7963 <span class="json-property-range" title="Value limits"></span>
7964 </dt>
7965 <dt class="json-inner-schema">
7966 <section class="json-schema-properties">
7967 <dl>
7968 <dt data-property-name="id">
7969 <span class="json-property-name">id:</span>
7970 <span class="json-property-type">number</span>
7971 <span class="json-property-range" title="Value limits"></span>
7972 </dt>
7973 <dt data-property-name="uuid">
7974 <span class="json-property-name">uuid:</span>
7975 <span class="json-property-type">string</span>
7976 <span class="json-property-range" title="Value limits"></span>
7977 </dt>
7978 </dl>
7979 </section>
7980 </dt>
7981 </dl>
7982 </section>
7983 </div>
7984 <div class="doc-examples">
7985 <section>
7986 <h5>Example</h5>
7987 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7988 <span class="hljs-attr">&quot;video&quot;</span>: {
7989 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
7990 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
7991 }
7992 }
7993 </code></pre>
7994 <!-- </div> -->
7995 </section>
7996 </div>
7997 </div>
7998 </div>
7999 <div id="definition-CommentThreadResponse" class="definition panel" data-traverse-target="definition-CommentThreadResponse">
8000 <h2 class="panel-title">
8001 <a name="/definitions/CommentThreadResponse"></a>CommentThreadResponse:
8002 <!-- <span class="json-property-type">
8003 <span class="json-property-type">object</span>
8004 <span class="json-property-range" title="Value limits"></span>
8005
8006
8007 </span> -->
8008 </h2>
8009 <div class="doc-row">
8010 <div class="doc-copy">
8011 <section class="json-schema-properties">
8012 <dl>
8013 <dt data-property-name="total">
8014 <span class="json-property-name">total:</span>
8015 <span class="json-property-type">number</span>
8016 <span class="json-property-range" title="Value limits"></span>
8017 </dt>
8018 <dt data-property-name="data">
8019 <span class="json-property-name">data:</span>
8020 <span class="json-property-type">
8021 <span class="json-schema-ref-array">
8022 <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
8023 </span>
8024 </span>
8025 <span class="json-property-range" title="Value limits"></span>
8026 </dt>
8027 <dt class="json-inner-schema">
8028 <section class="json-schema-array-items">
8029 <span class="json-property-type">
8030 <span class="">
8031 <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
8032 </span>
8033 </span>
8034 <span class="json-property-range" title="Value limits"></span>
8035 <div class="json-inner-schema"> </div>
8036 </section>
8037 </dt>
8038 </dl>
8039 </section>
8040 </div>
8041 <div class="doc-examples">
8042 <section>
8043 <h5>Example</h5>
8044 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8045 <span class="hljs-attr">&quot;total&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8046 <span class="hljs-attr">&quot;data&quot;</span>: [
8047 {
8048 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8049 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8050 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8051 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8052 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8053 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8054 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8055 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8056 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8057 <span class="hljs-attr">&quot;account&quot;</span>: {
8058 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8059 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8060 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8061 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8062 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8063 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8064 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8065 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8066 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8067 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8068 <span class="hljs-attr">&quot;avatar&quot;</span>: {
8069 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8070 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8071 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
8072 }
8073 }
8074 }
8075 ]
8076 }
8077 </code></pre>
8078 <!-- </div> -->
8079 </section>
8080 </div>
8081 </div>
8082 </div>
8083 <div id="definition-CommentThreadPostResponse" class="definition panel" data-traverse-target="definition-CommentThreadPostResponse">
8084 <h2 class="panel-title">
8085 <a name="/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse:
8086 <!-- <span class="json-property-type">
8087 <span class="json-property-type">object</span>
8088 <span class="json-property-range" title="Value limits"></span>
8089
8090
8091 </span> -->
8092 </h2>
8093 <div class="doc-row">
8094 <div class="doc-copy">
8095 <section class="json-schema-properties">
8096 <dl>
8097 <dt data-property-name="comment">
8098 <span class="json-property-name">comment:</span>
8099 <span class="json-property-type">
8100 <span class="">
8101 <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
8102 </span>
8103 </span>
8104 <span class="json-property-range" title="Value limits"></span>
8105 </dt>
8106 </dl>
8107 </section>
8108 </div>
8109 <div class="doc-examples">
8110 <section>
8111 <h5>Example</h5>
8112 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8113 <span class="hljs-attr">&quot;comment&quot;</span>: {
8114 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8115 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8116 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8117 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8118 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8119 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8120 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8121 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8122 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8123 <span class="hljs-attr">&quot;account&quot;</span>: {
8124 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8125 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8126 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8127 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8128 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8129 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8130 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8131 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
8132 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8133 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8134 <span class="hljs-attr">&quot;avatar&quot;</span>: {
8135 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8136 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8137 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
8138 }
8139 }
8140 }
8141 }
8142 </code></pre>
8143 <!-- </div> -->
8144 </section>
8145 </div>
8146 </div>
8147 </div>
8148 <div id="definition-AddUser" class="definition panel" data-traverse-target="definition-AddUser">
8149 <h2 class="panel-title">
8150 <a name="/definitions/AddUser"></a>AddUser:
8151 <!-- <span class="json-property-type">
8152 <span class="json-property-type">object</span>
8153 <span class="json-property-range" title="Value limits"></span>
8154
8155
8156 </span> -->
8157 </h2>
8158 <div class="doc-row">
8159 <div class="doc-copy">
8160 <section class="json-schema-properties">
8161 <dl>
8162 <dt data-property-name="username" class="has-description">
8163 <span class="json-property-name">username:</span>
8164 <span class="json-property-type">string</span>
8165 <span class="json-property-range" title="Value limits"></span>
8166 <span class="json-property-required"></span>
8167 </dt>
8168 <dd>
8169 <p>The user username </p>
8170 </dd>
8171 <dt data-property-name="password" class="has-description">
8172 <span class="json-property-name">password:</span>
8173 <span class="json-property-type">string</span>
8174 <span class="json-property-range" title="Value limits"></span>
8175 <span class="json-property-required"></span>
8176 </dt>
8177 <dd>
8178 <p>The user password </p>
8179 </dd>
8180 <dt data-property-name="email" class="has-description">
8181 <span class="json-property-name">email:</span>
8182 <span class="json-property-type">string</span>
8183 <span class="json-property-range" title="Value limits"></span>
8184 <span class="json-property-required"></span>
8185 </dt>
8186 <dd>
8187 <p>The user email </p>
8188 </dd>
8189 <dt data-property-name="videoQuota" class="has-description">
8190 <span class="json-property-name">videoQuota:</span>
8191 <span class="json-property-type">string</span>
8192 <span class="json-property-range" title="Value limits"></span>
8193 <span class="json-property-required"></span>
8194 </dt>
8195 <dd>
8196 <p>The user videoQuota </p>
8197 </dd>
8198 <dt data-property-name="role" class="has-description">
8199 <span class="json-property-name">role:</span>
8200 <span class="json-property-type">string</span>
8201 <span class="json-property-range" title="Value limits"></span>
8202 <span class="json-property-required"></span>
8203 </dt>
8204 <dd>
8205 <p>The user role </p>
8206 </dd>
8207 </dl>
8208 </section>
8209 </div>
8210 <div class="doc-examples">
8211 <section>
8212 <h5>Example</h5>
8213 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8214 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8215 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8216 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8217 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8218 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
8219 }
8220 </code></pre>
8221 <!-- </div> -->
8222 </section>
8223 </div>
8224 </div>
8225 </div>
8226 <div id="definition-UpdateUser" class="definition panel" data-traverse-target="definition-UpdateUser">
8227 <h2 class="panel-title">
8228 <a name="/definitions/UpdateUser"></a>UpdateUser:
8229 <!-- <span class="json-property-type">
8230 <span class="json-property-type">object</span>
8231 <span class="json-property-range" title="Value limits"></span>
8232
8233
8234 </span> -->
8235 </h2>
8236 <div class="doc-row">
8237 <div class="doc-copy">
8238 <section class="json-schema-properties">
8239 <dl>
8240 <dt data-property-name="id" class="has-description">
8241 <span class="json-property-name">id:</span>
8242 <span class="json-property-type">string</span>
8243 <span class="json-property-range" title="Value limits"></span>
8244 <span class="json-property-required"></span>
8245 </dt>
8246 <dd>
8247 <p>The user id </p>
8248 </dd>
8249 <dt data-property-name="email" class="has-description">
8250 <span class="json-property-name">email:</span>
8251 <span class="json-property-type">string</span>
8252 <span class="json-property-range" title="Value limits"></span>
8253 <span class="json-property-required"></span>
8254 </dt>
8255 <dd>
8256 <p>The updated email of the user </p>
8257 </dd>
8258 <dt data-property-name="videoQuota" class="has-description">
8259 <span class="json-property-name">videoQuota:</span>
8260 <span class="json-property-type">string</span>
8261 <span class="json-property-range" title="Value limits"></span>
8262 <span class="json-property-required"></span>
8263 </dt>
8264 <dd>
8265 <p>The updated videoQuota of the user </p>
8266 </dd>
8267 <dt data-property-name="role" class="has-description">
8268 <span class="json-property-name">role:</span>
8269 <span class="json-property-type">string</span>
8270 <span class="json-property-range" title="Value limits"></span>
8271 <span class="json-property-required"></span>
8272 </dt>
8273 <dd>
8274 <p>The updated role of the user </p>
8275 </dd>
8276 </dl>
8277 </section>
8278 </div>
8279 <div class="doc-examples">
8280 <section>
8281 <h5>Example</h5>
8282 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8283 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8284 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8285 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8286 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
8287 }
8288 </code></pre>
8289 <!-- </div> -->
8290 </section>
8291 </div>
8292 </div>
8293 </div>
8294 <div id="definition-UpdateMe" class="definition panel" data-traverse-target="definition-UpdateMe">
8295 <h2 class="panel-title">
8296 <a name="/definitions/UpdateMe"></a>UpdateMe:
8297 <!-- <span class="json-property-type">
8298 <span class="json-property-type">object</span>
8299 <span class="json-property-range" title="Value limits"></span>
8300
8301
8302 </span> -->
8303 </h2>
8304 <div class="doc-row">
8305 <div class="doc-copy">
8306 <section class="json-schema-properties">
8307 <dl>
8308 <dt data-property-name="password" class="has-description">
8309 <span class="json-property-name">password:</span>
8310 <span class="json-property-type">string</span>
8311 <span class="json-property-range" title="Value limits"></span>
8312 <span class="json-property-required"></span>
8313 </dt>
8314 <dd>
8315 <p>Your new password </p>
8316 </dd>
8317 <dt data-property-name="email" class="has-description">
8318 <span class="json-property-name">email:</span>
8319 <span class="json-property-type">string</span>
8320 <span class="json-property-range" title="Value limits"></span>
8321 <span class="json-property-required"></span>
8322 </dt>
8323 <dd>
8324 <p>Your new email </p>
8325 </dd>
8326 <dt data-property-name="displayNSFW" class="has-description">
8327 <span class="json-property-name">displayNSFW:</span>
8328 <span class="json-property-type">string</span>
8329 <span class="json-property-range" title="Value limits"></span>
8330 <span class="json-property-required"></span>
8331 </dt>
8332 <dd>
8333 <p>Your new displayNSFW </p>
8334 </dd>
8335 <dt data-property-name="autoPlayVideo" class="has-description">
8336 <span class="json-property-name">autoPlayVideo:</span>
8337 <span class="json-property-type">string</span>
8338 <span class="json-property-range" title="Value limits"></span>
8339 <span class="json-property-required"></span>
8340 </dt>
8341 <dd>
8342 <p>Your new autoPlayVideo </p>
8343 </dd>
8344 </dl>
8345 </section>
8346 </div>
8347 <div class="doc-examples">
8348 <section>
8349 <h5>Example</h5>
8350 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8351 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8352 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8353 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8354 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
8355 }
8356 </code></pre>
8357 <!-- </div> -->
8358 </section>
8359 </div>
8360 </div>
8361 </div>
8362 <div id="definition-GetMeVideoRating" class="definition panel" data-traverse-target="definition-GetMeVideoRating">
8363 <h2 class="panel-title">
8364 <a name="/definitions/GetMeVideoRating"></a>GetMeVideoRating:
8365 <!-- <span class="json-property-type">
8366 <span class="json-property-type">object</span>
8367 <span class="json-property-range" title="Value limits"></span>
8368
8369
8370 </span> -->
8371 </h2>
8372 <div class="doc-row">
8373 <div class="doc-copy">
8374 <section class="json-schema-properties">
8375 <dl>
8376 <dt data-property-name="id" class="has-description">
8377 <span class="json-property-name">id:</span>
8378 <span class="json-property-type">string</span>
8379 <span class="json-property-range" title="Value limits"></span>
8380 <span class="json-property-required"></span>
8381 </dt>
8382 <dd>
8383 <p>Id of the video </p>
8384 </dd>
8385 <dt data-property-name="rating" class="has-description">
8386 <span class="json-property-name">rating:</span>
8387 <span class="json-property-type">number</span>
8388 <span class="json-property-range" title="Value limits"></span>
8389 <span class="json-property-required"></span>
8390 </dt>
8391 <dd>
8392 <p>Rating of the video </p>
8393 </dd>
8394 </dl>
8395 </section>
8396 </div>
8397 <div class="doc-examples">
8398 <section>
8399 <h5>Example</h5>
8400 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8401 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8402 <span class="hljs-attr">&quot;rating&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>
8403 }
8404 </code></pre>
8405 <!-- </div> -->
8406 </section>
8407 </div>
8408 </div>
8409 </div>
8410 <div id="definition-RegisterUser" class="definition panel" data-traverse-target="definition-RegisterUser">
8411 <h2 class="panel-title">
8412 <a name="/definitions/RegisterUser"></a>RegisterUser:
8413 <!-- <span class="json-property-type">
8414 <span class="json-property-type">object</span>
8415 <span class="json-property-range" title="Value limits"></span>
8416
8417
8418 </span> -->
8419 </h2>
8420 <div class="doc-row">
8421 <div class="doc-copy">
8422 <section class="json-schema-properties">
8423 <dl>
8424 <dt data-property-name="username" class="has-description">
8425 <span class="json-property-name">username:</span>
8426 <span class="json-property-type">string</span>
8427 <span class="json-property-range" title="Value limits"></span>
8428 <span class="json-property-required"></span>
8429 </dt>
8430 <dd>
8431 <p>The username of the user </p>
8432 </dd>
8433 <dt data-property-name="password" class="has-description">
8434 <span class="json-property-name">password:</span>
8435 <span class="json-property-type">string</span>
8436 <span class="json-property-range" title="Value limits"></span>
8437 <span class="json-property-required"></span>
8438 </dt>
8439 <dd>
8440 <p>The password of the user </p>
8441 </dd>
8442 <dt data-property-name="email" class="has-description">
8443 <span class="json-property-name">email:</span>
8444 <span class="json-property-type">string</span>
8445 <span class="json-property-range" title="Value limits"></span>
8446 <span class="json-property-required"></span>
8447 </dt>
8448 <dd>
8449 <p>The email of the user </p>
8450 </dd>
8451 </dl>
8452 </section>
8453 </div>
8454 <div class="doc-examples">
8455 <section>
8456 <h5>Example</h5>
8457 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8458 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8459 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8460 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
8461 }
8462 </code></pre>
8463 <!-- </div> -->
8464 </section>
8465 </div>
8466 </div>
8467 </div>
8468 <div id="definition-VideoChannelInput" class="definition panel" data-traverse-target="definition-VideoChannelInput">
8469 <h2 class="panel-title">
8470 <a name="/definitions/VideoChannelInput"></a>VideoChannelInput:
8471 <!-- <span class="json-property-type">
8472 <span class="json-property-type">object</span>
8473 <span class="json-property-range" title="Value limits"></span>
8474
8475
8476 </span> -->
8477 </h2>
8478 <div class="doc-row">
8479 <div class="doc-copy">
8480 <section class="json-schema-properties">
8481 <dl>
8482 <dt data-property-name="name">
8483 <span class="json-property-name">name:</span>
8484 <span class="json-property-type">string</span>
8485 <span class="json-property-range" title="Value limits"></span>
8486 </dt>
8487 <dt data-property-name="description">
8488 <span class="json-property-name">description:</span>
8489 <span class="json-property-type">string</span>
8490 <span class="json-property-range" title="Value limits"></span>
8491 </dt>
8492 </dl>
8493 </section>
8494 </div>
8495 <div class="doc-examples">
8496 <section>
8497 <h5>Example</h5>
8498 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8499 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
8500 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
8501 }
8502 </code></pre>
8503 <!-- </div> -->
8504 </section>
8505 </div>
8506 </div>
8507 </div>
8508 <div class="doc-row no-margin">
8509 <div class="doc-copy doc-separator">
8510 <a class="powered-by" href="https://sourcey.com/spectacle">Documentation by
8511 <span>Spectacle</span>
8512 </a>
8513 </div>
8514 </div>
8515 </article>
8516 </div>
8517 </div>
8518 </body>
8519 </html>