2 <html class="no-js" lang="en">
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>
14 <div id="page" class="drawer-layout drawer-slide-right-large">
16 <button class="close-button" aria-label="Close menu" type="button" data-drawer-close>
17 <span aria-hidden="true">×</span>
19 <nav id="nav" role="navigation">
21 <a href="#introduction">Introduction</a>
22 <a href="#authentication">Authentication</a>
25 <a href="#tag-Accounts">Accounts</a>
28 <a href="#operation--accounts--name--get"> GET /accounts/{name} </a>
31 <a href="#operation--accounts--name--videos-get"> GET /accounts/{name}/videos </a>
34 <a href="#operation--accounts-get"> GET /accounts </a>
39 <a href="#tag-Config">Config</a>
42 <a href="#operation--config-get"> GET /config </a>
47 <a href="#tag-Feeds">Feeds</a>
50 <a href="#operation--feeds-videos.-format--get"> GET /feeds/videos.{format} </a>
55 <a href="#tag-Job">Job</a>
58 <a href="#operation--jobs-get"> GET /jobs </a>
63 <a href="#tag-ServerFollowing">ServerFollowing</a>
66 <a href="#operation--server-following--host--delete"> DELETE /server/following/{host} </a>
69 <a href="#operation--server-followers-get"> GET /server/followers </a>
72 <a href="#operation--server-following-get"> GET /server/following </a>
75 <a href="#operation--server-following-post"> POST /server/following </a>
80 <a href="#tag-User">User</a>
83 <a href="#operation--users-post"> POST /users </a>
86 <a href="#operation--users-get"> GET /users </a>
89 <a href="#operation--users--id--delete"> DELETE /users/{id} </a>
92 <a href="#operation--users--id--get"> GET /users/{id} </a>
95 <a href="#operation--users--id--put"> PUT /users/{id} </a>
98 <a href="#operation--users-me-get"> GET /users/me </a>
101 <a href="#operation--users-me-put"> PUT /users/me </a>
104 <a href="#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used </a>
107 <a href="#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating </a>
110 <a href="#operation--users-me-videos-get"> GET /users/me/videos </a>
113 <a href="#operation--users-register-post"> POST /users/register </a>
116 <a href="#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick </a>
121 <a href="#tag-Video">Video</a>
124 <a href="#operation--videos-get"> GET /videos </a>
127 <a href="#operation--videos-categories-get"> GET /videos/categories </a>
130 <a href="#operation--videos-licences-get"> GET /videos/licences </a>
133 <a href="#operation--videos-languages-get"> GET /videos/languages </a>
136 <a href="#operation--videos-privacies-get"> GET /videos/privacies </a>
139 <a href="#operation--videos-search-get"> GET /videos/search </a>
142 <a href="#operation--videos--id--put"> PUT /videos/{id} </a>
145 <a href="#operation--videos--id--get"> GET /videos/{id} </a>
148 <a href="#operation--videos--id--delete"> DELETE /videos/{id} </a>
151 <a href="#operation--videos--id--description-get"> GET /videos/{id}/description </a>
154 <a href="#operation--videos--id--views-post"> POST /videos/{id}/views </a>
157 <a href="#operation--videos-upload-post"> POST /videos/upload </a>
162 <a href="#tag-VideoAbuse">VideoAbuse</a>
165 <a href="#operation--videos-abuse-get"> GET /videos/abuse </a>
168 <a href="#operation--videos--id--abuse-post"> POST /videos/{id}/abuse </a>
173 <a href="#tag-VideoBlacklist">VideoBlacklist</a>
176 <a href="#operation--videos--videoId--blacklist-post"> POST /videos/{videoId}/blacklist </a>
179 <a href="#operation--videos--videoId--blacklist-delete"> DELETE /videos/{videoId}/blacklist </a>
182 <a href="#operation--videos-blacklist-get"> GET /videos/blacklist </a>
187 <a href="#tag-VideoChannel">VideoChannel</a>
190 <a href="#operation--video-channels-get"> GET /video-channels </a>
193 <a href="#operation--video-channels-post"> POST /video-channels </a>
196 <a href="#operation--video-channels--id--get"> GET /video-channels/{id} </a>
199 <a href="#operation--video-channels--id--put"> PUT /video-channels/{id} </a>
202 <a href="#operation--video-channels--id--delete"> DELETE /video-channels/{id} </a>
205 <a href="#operation--video-channels--id--videos-get"> GET /video-channels/{id}/videos </a>
208 <a href="#operation--accounts--name--video-channels-get"> GET /accounts/{name}/video-channels </a>
213 <a href="#tag-VideoComment">VideoComment</a>
216 <a href="#operation--videos--videoId--comment-threads-get"> GET /videos/{videoId}/comment-threads </a>
219 <a href="#operation--videos--videoId--comment-threads-post"> POST /videos/{videoId}/comment-threads </a>
222 <a href="#operation--videos--videoId--comment-threads--threadId--get"> GET /videos/{videoId}/comment-threads/{threadId} </a>
225 <a href="#operation--videos--videoId--comments--commentId--post"> POST /videos/{videoId}/comments/{commentId} </a>
228 <a href="#operation--videos--videoId--comments--commentId--delete"> DELETE /videos/{videoId}/comments/{commentId} </a>
233 <a href="#tag-VideoRate">VideoRate</a>
236 <a href="#operation--videos--id--rate-put"> PUT /videos/{id}/rate </a>
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 <a href="#definition-ScheduleVideoUpdate"> ScheduleVideoUpdate </a>
270 <div id="docs" class="row collapse expanded drawer" data-drawer>
271 <button class="floating-menu-icon" type="button" data-drawer-slide="right">
272 <span class="hamburger"></span>
274 <div class="example-box doc-content"></div>
276 <h1 class="doc-title">PeerTube
277 <span>API Reference</span>
279 <div id="introduction" data-traverse-target="introduction">
280 <div class="doc-row">
281 <div class="doc-copy">
282 <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.</p>
284 <div class="doc-examples">
286 <h5>API Endpoint</h5>
287 <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre>
293 <span>1.0.0-beta</span>
299 <!-- <h1 id="security" data-traverse-target="security">Security</h1> -->
300 <h1 id="authentication" data-traverse-target="authentication">Authentication</h1>
301 <div id="security-definition-OAuth2" class="panel">
302 <div class="doc-row">
303 <div class="doc-copy">
304 <h3 class="security-definition-title">
305 <span class="security-name">OAuth2</span>
306 <span class="swagger-security-definition-oauth2"></span>
308 <section class="security-definition-description">
310 <em>Authorization: Bearer mytoken</em>
313 <section class="swagger-security-definition-properties">
314 <div class="prop-row security-definition-property">
315 <div class="prop-name">
316 <div class="prop-title security-definition-property-name">type</div>
318 <div class="prop-value security-definition-property-type"> oauth2 </div>
320 <div class="prop-row security-definition-property">
321 <div class="prop-name">
322 <div class="prop-title security-definition-property-name">flow</div>
324 <div class="prop-value security-definition-property-type"> password </div>
326 <div class="prop-row security-definition-property">
327 <div class="prop-name">
328 <div class="prop-title security-definition-property-name">tokenUrl</div>
330 <div class="prop-value security-definition-property-type"> https://peertube.example.com/api/v1/users/token </div>
336 <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1>
337 <div id="operation--accounts--name--get" class="operation panel" data-traverse-target="operation--accounts--name--get">
338 <!-- <section class="operation-tags row"> -->
339 <!-- <div class="doc-copy"> -->
340 <div class="operation-tags">
341 <a class="label" href="#tag-Accounts">Accounts</a>
346 <h2 class="operation-title">
347 <span class="operation-name">
348 <span class="operation-name">GET</span>
349 <span class="operation-path">/accounts/{name}</span>
352 <div class="doc-row">
353 <div class="doc-copy">
354 <section class="swagger-request-params">
355 <div class="prop-row prop-group">
356 <div class="prop-name">
357 <div class="prop-title">name</div>
358 <span class="json-property-required"></span>
359 <div class="prop-subtitle"> in path </div>
360 <div class="prop-subtitle">
361 <span class="json-property-type">string</span>
362 <span class="json-property-range" title="Value limits"></span>
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>
370 <div class="prop-row prop-group">
371 <div class="prop-name">
372 <div class="prop-title">start</div>
373 <div class="prop-subtitle"> in query </div>
374 <div class="prop-subtitle">
375 <span class="json-property-type">number</span>
376 <span class="json-property-range" title="Value limits"></span>
379 <div class="prop-value">
383 <div class="prop-row prop-group">
384 <div class="prop-name">
385 <div class="prop-title">stop</div>
386 <div class="prop-subtitle"> in query </div>
387 <div class="prop-subtitle">
388 <span class="json-property-type">number</span>
389 <span class="json-property-range" title="Value limits"></span>
392 <div class="prop-value">
396 <div class="prop-row prop-group">
397 <div class="prop-name">
398 <div class="prop-title">sort</div>
399 <div class="prop-subtitle"> in query </div>
400 <div class="prop-subtitle">
401 <span class="json-property-type">number</span>
402 <span class="json-property-range" title="Value limits"></span>
405 <div class="prop-value">
411 <div class="doc-examples"></div>
413 <div class="doc-row">
414 <div class="doc-copy">
415 <section class="swagger-responses">
416 <div class="prop-row prop-group">
417 <div class="prop-name">
418 <div class="prop-title">200 OK</div>
419 <div class="prop-ref">
421 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
424 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
426 <div class="prop-value">
427 <p>successful operation</p>
432 <div class="doc-examples">
433 <h5>Response Content-Types:
434 <span>application/json</span>
438 <span>(200 OK)</span>
440 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
441 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
442 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
443 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
444 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
445 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
446 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
447 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
448 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
449 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
450 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
451 <span class="hljs-attr">"avatar"</span>: {
452 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
453 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
454 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
463 <div id="operation--accounts--name--videos-get" class="operation panel" data-traverse-target="operation--accounts--name--videos-get">
464 <!-- <section class="operation-tags row"> -->
465 <!-- <div class="doc-copy"> -->
466 <div class="operation-tags">
467 <a class="label" href="#tag-Accounts">Accounts</a>
472 <h2 class="operation-title">
473 <span class="operation-name">
474 <span class="operation-name">GET</span>
475 <span class="operation-path">/accounts/{name}/videos</span>
478 <div class="doc-row">
479 <div class="doc-copy">
480 <section class="swagger-request-params">
481 <div class="prop-row prop-group">
482 <div class="prop-name">
483 <div class="prop-title">name</div>
484 <span class="json-property-required"></span>
485 <div class="prop-subtitle"> in path </div>
486 <div class="prop-subtitle">
487 <span class="json-property-type">string</span>
488 <span class="json-property-range" title="Value limits"></span>
491 <div class="prop-value">
492 <p>The name of the account (chocobozzz or
493 <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p>
498 <div class="doc-examples"></div>
500 <div class="doc-row">
501 <div class="doc-copy">
502 <section class="swagger-responses">
503 <div class="prop-row prop-group">
504 <div class="prop-name">
505 <div class="prop-title">200 OK</div>
506 <div class="prop-ref">
508 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
511 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
513 <div class="prop-value">
514 <p>successful operation</p>
519 <div class="doc-examples">
520 <h5>Response Content-Types:
521 <span>application/json</span>
525 <span>(200 OK)</span>
527 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
528 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
529 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
530 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
531 <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
532 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
533 <span class="hljs-attr">"category"</span>: {
534 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
535 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
537 <span class="hljs-attr">"licence"</span>: {
538 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
539 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
541 <span class="hljs-attr">"language"</span>: {
542 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
543 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
545 <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
546 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
547 <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
548 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
549 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
550 <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
551 <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
552 <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
553 <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
554 <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
555 <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
556 <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
557 <span class="hljs-attr">"account"</span>: {
558 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
559 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
560 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
561 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
562 <span class="hljs-attr">"avatar"</span>: {
563 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
564 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
565 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
575 <div id="operation--accounts-get" class="operation panel" data-traverse-target="operation--accounts-get">
576 <!-- <section class="operation-tags row"> -->
577 <!-- <div class="doc-copy"> -->
578 <div class="operation-tags">
579 <a class="label" href="#tag-Accounts">Accounts</a>
584 <h2 class="operation-title">
585 <span class="operation-name">
586 <span class="operation-name">GET</span>
587 <span class="operation-path">/accounts</span>
590 <div class="doc-row">
591 <div class="doc-copy"> </div>
592 <div class="doc-examples"></div>
594 <div class="doc-row">
595 <div class="doc-copy">
596 <section class="swagger-responses">
597 <div class="prop-row prop-group">
598 <div class="prop-name">
599 <div class="prop-title">200 OK</div>
600 <div class="prop-ref">
601 <span class="json-schema-ref-array">
602 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
605 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
607 <div class="prop-value">
608 <p>successful operation</p>
611 <div class="prop-row prop-inner">
612 <div class="prop-name">type</div>
613 <div class="prop-value">
614 <span class="json-property-type">
615 <span class="json-schema-ref-array">
616 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
619 <span class="json-property-range" title="Value limits"></span>
624 <div class="doc-examples">
625 <h5>Response Content-Types:
626 <span>application/json</span>
630 <span>(200 OK)</span>
632 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
634 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
635 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
636 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
637 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
638 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
639 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
640 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
641 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
642 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
643 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
644 <span class="hljs-attr">"avatar"</span>: {
645 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
646 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
647 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
657 <h1 id="tag-Config" class="swagger-summary-tag" data-traverse-target="tag-Config">Config</h1>
658 <div id="operation--config-get" class="operation panel" data-traverse-target="operation--config-get">
659 <!-- <section class="operation-tags row"> -->
660 <!-- <div class="doc-copy"> -->
661 <div class="operation-tags">
662 <a class="label" href="#tag-Config">Config</a>
667 <h2 class="operation-title">
668 <span class="operation-name">
669 <span class="operation-name">GET</span>
670 <span class="operation-path">/config</span>
673 <div class="doc-row">
674 <div class="doc-copy"> </div>
675 <div class="doc-examples"></div>
677 <div class="doc-row">
678 <div class="doc-copy">
679 <section class="swagger-responses">
680 <div class="prop-row prop-group">
681 <div class="prop-name">
682 <div class="prop-title">200 OK</div>
683 <div class="prop-ref">
685 <a class="json-schema-ref" href="#/definitions/ServerConfig">ServerConfig</a>
688 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
690 <div class="prop-value">
691 <p>successful operation</p>
696 <div class="doc-examples">
697 <h5>Response Content-Types:
698 <span>application/json</span>
702 <span>(200 OK)</span>
704 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
705 <span class="hljs-attr">"signup"</span>: {
706 <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span>
708 <span class="hljs-attr">"transcoding"</span>: {
709 <span class="hljs-attr">"enabledResolutions"</span>: [
710 <span class="hljs-string">"number"</span>
713 <span class="hljs-attr">"avatar"</span>: {
714 <span class="hljs-attr">"file"</span>: {
715 <span class="hljs-attr">"size"</span>: {
716 <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span>
719 <span class="hljs-attr">"extensions"</span>: [
720 <span class="hljs-string">"string"</span>
723 <span class="hljs-attr">"video"</span>: {
724 <span class="hljs-attr">"file"</span>: {
725 <span class="hljs-attr">"extensions"</span>: [
726 <span class="hljs-string">"string"</span>
737 <h1 id="tag-Feeds" class="swagger-summary-tag" data-traverse-target="tag-Feeds">Feeds</h1>
738 <div id="operation--feeds-videos.-format--get" class="operation panel" data-traverse-target="operation--feeds-videos.-format--get">
739 <!-- <section class="operation-tags row"> -->
740 <!-- <div class="doc-copy"> -->
741 <div class="operation-tags">
742 <a class="label" href="#tag-Feeds">Feeds</a>
747 <h2 class="operation-title">
748 <span class="operation-name">
749 <span class="operation-name">GET</span>
750 <span class="operation-path">/feeds/videos.{format}</span>
753 <div class="doc-row">
754 <div class="doc-copy">
755 <section class="swagger-request-params">
756 <div class="prop-row prop-group">
757 <div class="prop-name">
758 <div class="prop-title">format</div>
759 <span class="json-property-required"></span>
760 <div class="prop-subtitle"> in path </div>
761 <div class="prop-subtitle">
762 <span class="json-property-type">string</span>
763 <span class="json-property-enum" title="Possible values">
764 <span class="json-property-enum-item json-property-enum-default-value">xml</span>,
765 <span class="json-property-enum-item">atom</span>,
766 <span class="json-property-enum-item">json</span>
768 <span class="json-property-range" title="Value limits"></span>
769 <span class="json-property-default-value" title="Default value">xml</span>
772 <div class="prop-value">
773 <p>The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0</p>
776 <div class="prop-row prop-group">
777 <div class="prop-name">
778 <div class="prop-title">accountId</div>
779 <div class="prop-subtitle"> in query </div>
780 <div class="prop-subtitle">
781 <span class="json-property-type">number</span>
782 <span class="json-property-range" title="Value limits"></span>
785 <div class="prop-value">
786 <p>The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds</p>
789 <div class="prop-row prop-group">
790 <div class="prop-name">
791 <div class="prop-title">accountName</div>
792 <div class="prop-subtitle"> in query </div>
793 <div class="prop-subtitle">
794 <span class="json-property-type">string</span>
795 <span class="json-property-range" title="Value limits"></span>
798 <div class="prop-value">
799 <p>The name of the local account to filter to</p>
804 <div class="doc-examples"></div>
806 <div class="doc-row">
807 <div class="doc-copy">
808 <section class="swagger-responses">
809 <div class="prop-row prop-group">
810 <div class="prop-name">
811 <div class="prop-title">200 OK</div>
813 <div class="prop-value">
814 <p>successful operation</p>
819 <div class="doc-examples">
820 <h5>Response Content-Types:
821 <span>application/atom+xml, application/rss+xml, application/json</span>
826 <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1>
827 <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get">
828 <!-- <section class="operation-tags row"> -->
829 <!-- <div class="doc-copy"> -->
830 <div class="operation-tags">
831 <a class="label" href="#tag-Job">Job</a>
836 <h2 class="operation-title">
837 <span class="operation-name">
838 <span class="operation-name">GET</span>
839 <span class="operation-path">/jobs</span>
842 <div class="doc-row">
843 <div class="doc-copy">
844 <section class="swagger-request-params">
845 <div class="prop-row prop-group">
846 <div class="prop-name">
847 <div class="prop-title">state</div>
848 <span class="json-property-required"></span>
849 <div class="prop-subtitle"> in path </div>
850 <div class="prop-subtitle">
851 <span class="json-property-type">string</span>
852 <span class="json-property-range" title="Value limits"></span>
855 <div class="prop-value">
856 <p>The id of the account</p>
859 <div class="prop-row prop-group">
860 <div class="prop-name">
861 <div class="prop-title">start</div>
862 <div class="prop-subtitle"> in query </div>
863 <div class="prop-subtitle">
864 <span class="json-property-type">number</span>
865 <span class="json-property-range" title="Value limits"></span>
868 <div class="prop-value">
872 <div class="prop-row prop-group">
873 <div class="prop-name">
874 <div class="prop-title">count</div>
875 <div class="prop-subtitle"> in query </div>
876 <div class="prop-subtitle">
877 <span class="json-property-type">number</span>
878 <span class="json-property-range" title="Value limits"></span>
881 <div class="prop-value">
882 <p class="no-description">(no description)</p>
885 <div class="prop-row prop-group">
886 <div class="prop-name">
887 <div class="prop-title">sort</div>
888 <div class="prop-subtitle"> in query </div>
889 <div class="prop-subtitle">
890 <span class="json-property-type">number</span>
891 <span class="json-property-range" title="Value limits"></span>
894 <div class="prop-value">
900 <div class="doc-examples"></div>
902 <div class="doc-row">
903 <div class="doc-copy">
904 <section class="swagger-responses">
905 <div class="prop-row prop-group">
906 <div class="prop-name">
907 <div class="prop-title">200 OK</div>
908 <div class="prop-ref">
909 <span class="json-schema-ref-array">
910 <a class="json-schema-ref" href="#/definitions/Job">Job</a>
913 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
915 <div class="prop-value">
916 <p>successful operation</p>
919 <div class="prop-row prop-inner">
920 <div class="prop-name">type</div>
921 <div class="prop-value">
922 <span class="json-property-type">
923 <span class="json-schema-ref-array">
924 <a class="json-schema-ref" href="#/definitions/Job">Job</a>
927 <span class="json-property-range" title="Value limits"></span>
932 <div class="doc-examples">
933 <h5>Response Content-Types:
934 <span>application/json</span>
938 <span>(200 OK)</span>
940 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
942 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
943 <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
944 <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>,
945 <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>,
946 <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>,
947 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
948 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
956 <div class="doc-row">
957 <div class="doc-copy">
958 <section class="swagger-request-security">
959 <table class="table">
962 <th class="swagger-request-security-schema"></th>
963 <th class="swagger-request-security-scopes"></th>
969 <a href="#security-definition-OAuth2">OAuth2</a>
979 <h1 id="tag-ServerFollowing" class="swagger-summary-tag" data-traverse-target="tag-ServerFollowing">ServerFollowing</h1>
980 <div id="operation--server-following--host--delete" class="operation panel" data-traverse-target="operation--server-following--host--delete">
981 <!-- <section class="operation-tags row"> -->
982 <!-- <div class="doc-copy"> -->
983 <div class="operation-tags">
984 <a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
989 <h2 class="operation-title">
990 <span class="operation-name">
991 <span class="operation-name">DELETE</span>
992 <span class="operation-path">/server/following/{host}</span>
995 <div class="doc-row">
996 <div class="doc-copy">
997 <section class="swagger-request-params">
998 <div class="prop-row prop-group">
999 <div class="prop-name">
1000 <div class="prop-title">host</div>
1001 <span class="json-property-required"></span>
1002 <div class="prop-subtitle"> in path </div>
1003 <div class="prop-subtitle">
1004 <span class="json-property-type">string</span>
1005 <span class="json-property-range" title="Value limits"></span>
1008 <div class="prop-value">
1009 <p>The host to unfollow </p>
1014 <div class="doc-examples"></div>
1016 <div class="doc-row">
1017 <div class="doc-copy">
1018 <section class="swagger-responses">
1019 <div class="prop-row prop-group">
1020 <div class="prop-name">
1021 <div class="prop-title">201 Created</div>
1023 <div class="prop-value">
1024 <p>successful operation</p>
1029 <div class="doc-examples">
1030 <h5>Response Content-Types:
1031 <span>application/json</span>
1035 <div class="doc-row">
1036 <div class="doc-copy">
1037 <section class="swagger-request-security">
1038 <table class="table">
1041 <th class="swagger-request-security-schema"></th>
1042 <th class="swagger-request-security-scopes"></th>
1048 <a href="#security-definition-OAuth2">OAuth2</a>
1058 <div id="operation--server-followers-get" class="operation panel" data-traverse-target="operation--server-followers-get">
1059 <!-- <section class="operation-tags row"> -->
1060 <!-- <div class="doc-copy"> -->
1061 <div class="operation-tags">
1062 <a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
1067 <h2 class="operation-title">
1068 <span class="operation-name">
1069 <span class="operation-name">GET</span>
1070 <span class="operation-path">/server/followers</span>
1073 <div class="doc-row">
1074 <div class="doc-copy">
1075 <section class="swagger-request-params">
1076 <div class="prop-row prop-group">
1077 <div class="prop-name">
1078 <div class="prop-title">start</div>
1079 <div class="prop-subtitle"> in query </div>
1080 <div class="prop-subtitle">
1081 <span class="json-property-type">number</span>
1082 <span class="json-property-range" title="Value limits"></span>
1085 <div class="prop-value">
1086 <p>starting page</p>
1089 <div class="prop-row prop-group">
1090 <div class="prop-name">
1091 <div class="prop-title">stop</div>
1092 <div class="prop-subtitle"> in query </div>
1093 <div class="prop-subtitle">
1094 <span class="json-property-type">number</span>
1095 <span class="json-property-range" title="Value limits"></span>
1098 <div class="prop-value">
1099 <p>stopping page</p>
1102 <div class="prop-row prop-group">
1103 <div class="prop-name">
1104 <div class="prop-title">sort</div>
1105 <div class="prop-subtitle"> in query </div>
1106 <div class="prop-subtitle">
1107 <span class="json-property-type">number</span>
1108 <span class="json-property-range" title="Value limits"></span>
1111 <div class="prop-value">
1117 <div class="doc-examples"></div>
1119 <div class="doc-row">
1120 <div class="doc-copy">
1121 <section class="swagger-responses">
1122 <div class="prop-row prop-group">
1123 <div class="prop-name">
1124 <div class="prop-title">200 OK</div>
1125 <div class="prop-ref">
1126 <span class="json-schema-ref-array">
1127 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1130 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1132 <div class="prop-value">
1133 <p>successful operation</p>
1136 <div class="prop-row prop-inner">
1137 <div class="prop-name">type</div>
1138 <div class="prop-value">
1139 <span class="json-property-type">
1140 <span class="json-schema-ref-array">
1141 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1144 <span class="json-property-range" title="Value limits"></span>
1149 <div class="doc-examples">
1150 <h5>Response Content-Types:
1151 <span>application/json</span>
1154 <h5>Response Example
1155 <span>(200 OK)</span>
1157 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
1159 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1160 <span class="hljs-attr">"follower"</span>: {
1161 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1162 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
1163 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
1164 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
1165 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
1166 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
1167 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
1168 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1169 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
1170 <span class="hljs-attr">"avatar"</span>: {
1171 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
1172 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1173 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
1176 <span class="hljs-attr">"following"</span>: {
1177 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1178 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
1179 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
1180 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
1181 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
1182 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
1183 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
1184 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1185 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
1186 <span class="hljs-attr">"avatar"</span>: {
1187 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
1188 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1189 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
1192 <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>,
1193 <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
1194 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1195 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
1204 <div id="operation--server-following-get" class="operation panel" data-traverse-target="operation--server-following-get">
1205 <!-- <section class="operation-tags row"> -->
1206 <!-- <div class="doc-copy"> -->
1207 <div class="operation-tags">
1208 <a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
1213 <h2 class="operation-title">
1214 <span class="operation-name">
1215 <span class="operation-name">GET</span>
1216 <span class="operation-path">/server/following</span>
1219 <div class="doc-row">
1220 <div class="doc-copy">
1221 <section class="swagger-request-params">
1222 <div class="prop-row prop-group">
1223 <div class="prop-name">
1224 <div class="prop-title">start</div>
1225 <div class="prop-subtitle"> in query </div>
1226 <div class="prop-subtitle">
1227 <span class="json-property-type">number</span>
1228 <span class="json-property-range" title="Value limits"></span>
1231 <div class="prop-value">
1232 <p>starting page</p>
1235 <div class="prop-row prop-group">
1236 <div class="prop-name">
1237 <div class="prop-title">stop</div>
1238 <div class="prop-subtitle"> in query </div>
1239 <div class="prop-subtitle">
1240 <span class="json-property-type">number</span>
1241 <span class="json-property-range" title="Value limits"></span>
1244 <div class="prop-value">
1245 <p>stopping page</p>
1248 <div class="prop-row prop-group">
1249 <div class="prop-name">
1250 <div class="prop-title">sort</div>
1251 <div class="prop-subtitle"> in query </div>
1252 <div class="prop-subtitle">
1253 <span class="json-property-type">number</span>
1254 <span class="json-property-range" title="Value limits"></span>
1257 <div class="prop-value">
1263 <div class="doc-examples"></div>
1265 <div class="doc-row">
1266 <div class="doc-copy">
1267 <section class="swagger-responses">
1268 <div class="prop-row prop-group">
1269 <div class="prop-name">
1270 <div class="prop-title">200 OK</div>
1271 <div class="prop-ref">
1272 <span class="json-schema-ref-array">
1273 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1276 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1278 <div class="prop-value">
1279 <p>successful operation</p>
1282 <div class="prop-row prop-inner">
1283 <div class="prop-name">type</div>
1284 <div class="prop-value">
1285 <span class="json-property-type">
1286 <span class="json-schema-ref-array">
1287 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1290 <span class="json-property-range" title="Value limits"></span>
1295 <div class="doc-examples">
1296 <h5>Response Content-Types:
1297 <span>application/json</span>
1300 <h5>Response Example
1301 <span>(200 OK)</span>
1303 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
1305 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1306 <span class="hljs-attr">"follower"</span>: {
1307 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1308 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
1309 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
1310 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
1311 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
1312 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
1313 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
1314 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1315 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
1316 <span class="hljs-attr">"avatar"</span>: {
1317 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
1318 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1319 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
1322 <span class="hljs-attr">"following"</span>: {
1323 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1324 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
1325 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
1326 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
1327 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
1328 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
1329 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
1330 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1331 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
1332 <span class="hljs-attr">"avatar"</span>: {
1333 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
1334 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1335 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
1338 <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>,
1339 <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
1340 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1341 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
1350 <div id="operation--server-following-post" class="operation panel" data-traverse-target="operation--server-following-post">
1351 <!-- <section class="operation-tags row"> -->
1352 <!-- <div class="doc-copy"> -->
1353 <div class="operation-tags">
1354 <a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
1359 <h2 class="operation-title">
1360 <span class="operation-name">
1361 <span class="operation-name">POST</span>
1362 <span class="operation-path">/server/following</span>
1365 <div class="doc-row">
1366 <div class="doc-copy">
1367 <section class="swagger-request-body">
1368 <div class="prop-row">
1369 <div class="prop-name">
1370 <div class="swagger-request-model">
1372 <a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
1376 <div class="prop-value columns small-6">
1377 <!-- <div class="swagger-request-description"> -->
1384 <div class="doc-examples">
1386 <h5>Request Content-Types:
1387 <span>application/json</span>
1389 <h5>Request Example</h5>
1390 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1391 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1392 <span class="hljs-attr">"follower"</span>: {
1393 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1394 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
1395 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
1396 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
1397 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
1398 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
1399 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
1400 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1401 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
1402 <span class="hljs-attr">"avatar"</span>: {
1403 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
1404 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1405 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
1408 <span class="hljs-attr">"following"</span>: {
1409 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1410 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
1411 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
1412 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
1413 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
1414 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
1415 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
1416 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1417 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
1418 <span class="hljs-attr">"avatar"</span>: {
1419 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
1420 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1421 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
1424 <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>,
1425 <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
1426 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1427 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
1434 <div class="doc-row">
1435 <div class="doc-copy">
1436 <section class="swagger-responses">
1437 <div class="prop-row prop-group">
1438 <div class="prop-name">
1439 <div class="prop-title">204 No Content</div>
1441 <div class="prop-value">
1442 <p>successful operation</p>
1447 <div class="doc-examples">
1448 <h5>Response Content-Types:
1449 <span>application/json</span>
1453 <div class="doc-row">
1454 <div class="doc-copy">
1455 <section class="swagger-request-security">
1456 <table class="table">
1459 <th class="swagger-request-security-schema"></th>
1460 <th class="swagger-request-security-scopes"></th>
1466 <a href="#security-definition-OAuth2">OAuth2</a>
1476 <h1 id="tag-User" class="swagger-summary-tag" data-traverse-target="tag-User">User</h1>
1477 <div id="operation--users-post" class="operation panel" data-traverse-target="operation--users-post">
1478 <!-- <section class="operation-tags row"> -->
1479 <!-- <div class="doc-copy"> -->
1480 <div class="operation-tags">
1481 <a class="label" href="#tag-User">User</a>
1486 <h2 class="operation-title">
1487 <span class="operation-name">
1488 <span class="operation-name">POST</span>
1489 <span class="operation-path">/users</span>
1492 <div class="doc-row">
1493 <div class="doc-copy">
1494 <section class="swagger-request-body">
1495 <div class="prop-row">
1496 <div class="prop-name">
1497 <div class="swagger-request-model">
1499 <a class="json-schema-ref" href="#/definitions/AddUser">AddUser</a>
1503 <div class="prop-value columns small-6">
1504 <!-- <div class="swagger-request-description"> -->
1505 <p>User to create</p>
1511 <div class="doc-examples">
1513 <h5>Request Content-Types:
1514 <span>application/json</span>
1516 <h5>Request Example</h5>
1517 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1518 <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
1519 <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>,
1520 <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
1521 <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>,
1522 <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
1529 <div class="doc-row">
1530 <div class="doc-copy">
1531 <section class="swagger-responses">
1532 <div class="prop-row prop-group">
1533 <div class="prop-name">
1534 <div class="prop-title">200 OK</div>
1535 <div class="prop-ref">
1537 <a class="json-schema-ref" href="#/definitions/AddUserResponse">AddUserResponse</a>
1540 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1542 <div class="prop-value">
1543 <p>successful operation</p>
1548 <div class="doc-examples">
1549 <h5>Response Content-Types:
1550 <span>application/json</span>
1553 <h5>Response Example
1554 <span>(200 OK)</span>
1556 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1557 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1558 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
1565 <div class="doc-row">
1566 <div class="doc-copy">
1567 <section class="swagger-request-security">
1568 <table class="table">
1571 <th class="swagger-request-security-schema"></th>
1572 <th class="swagger-request-security-scopes"></th>
1578 <a href="#security-definition-OAuth2">OAuth2</a>
1588 <div id="operation--users-get" class="operation panel" data-traverse-target="operation--users-get">
1589 <!-- <section class="operation-tags row"> -->
1590 <!-- <div class="doc-copy"> -->
1591 <div class="operation-tags">
1592 <a class="label" href="#tag-User">User</a>
1597 <h2 class="operation-title">
1598 <span class="operation-name">
1599 <span class="operation-name">GET</span>
1600 <span class="operation-path">/users</span>
1603 <div class="doc-row">
1604 <div class="doc-copy">
1605 <section class="swagger-request-params">
1606 <div class="prop-row prop-group">
1607 <div class="prop-name">
1608 <div class="prop-title">start</div>
1609 <div class="prop-subtitle"> in query </div>
1610 <div class="prop-subtitle">
1611 <span class="json-property-type">number</span>
1612 <span class="json-property-range" title="Value limits"></span>
1615 <div class="prop-value">
1616 <p>starting page</p>
1619 <div class="prop-row prop-group">
1620 <div class="prop-name">
1621 <div class="prop-title">stop</div>
1622 <div class="prop-subtitle"> in query </div>
1623 <div class="prop-subtitle">
1624 <span class="json-property-type">number</span>
1625 <span class="json-property-range" title="Value limits"></span>
1628 <div class="prop-value">
1629 <p>stopping page</p>
1632 <div class="prop-row prop-group">
1633 <div class="prop-name">
1634 <div class="prop-title">sort</div>
1635 <div class="prop-subtitle"> in query </div>
1636 <div class="prop-subtitle">
1637 <span class="json-property-type">number</span>
1638 <span class="json-property-range" title="Value limits"></span>
1641 <div class="prop-value">
1647 <div class="doc-examples"></div>
1649 <div class="doc-row">
1650 <div class="doc-copy">
1651 <section class="swagger-responses">
1652 <div class="prop-row prop-group">
1653 <div class="prop-name">
1654 <div class="prop-title">200 OK</div>
1655 <div class="prop-ref">
1656 <span class="json-schema-ref-array">
1657 <a class="json-schema-ref" href="#/definitions/User">User</a>
1660 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1662 <div class="prop-value">
1663 <p>successful operation</p>
1666 <div class="prop-row prop-inner">
1667 <div class="prop-name">type</div>
1668 <div class="prop-value">
1669 <span class="json-property-type">
1670 <span class="json-schema-ref-array">
1671 <a class="json-schema-ref" href="#/definitions/User">User</a>
1674 <span class="json-property-range" title="Value limits"></span>
1679 <div class="doc-examples">
1680 <h5>Response Content-Types:
1681 <span>application/json</span>
1684 <h5>Response Example
1685 <span>(200 OK)</span>
1687 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
1689 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1690 <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
1691 <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
1692 <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>,
1693 <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>,
1694 <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
1695 <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>,
1696 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1697 <span class="hljs-attr">"account"</span>: {
1698 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
1699 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1700 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
1701 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
1702 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
1703 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
1704 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
1705 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
1706 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1707 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
1708 <span class="hljs-attr">"avatar"</span>: {
1709 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
1710 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1711 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
1714 <span class="hljs-attr">"videoChannels"</span>: [
1716 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
1717 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
1718 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
1719 <span class="hljs-attr">"ownerAccount"</span>: {
1720 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1721 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
1732 <div class="doc-row">
1733 <div class="doc-copy">
1734 <section class="swagger-request-security">
1735 <table class="table">
1738 <th class="swagger-request-security-schema"></th>
1739 <th class="swagger-request-security-scopes"></th>
1745 <a href="#security-definition-OAuth2">OAuth2</a>
1755 <div id="operation--users--id--delete" class="operation panel" data-traverse-target="operation--users--id--delete">
1756 <!-- <section class="operation-tags row"> -->
1757 <!-- <div class="doc-copy"> -->
1758 <div class="operation-tags">
1759 <a class="label" href="#tag-User">User</a>
1764 <h2 class="operation-title">
1765 <span class="operation-name">
1766 <span class="operation-name">DELETE</span>
1767 <span class="operation-path">/users/{id}</span>
1770 <div class="doc-row">
1771 <div class="doc-copy">
1772 <section class="swagger-request-params">
1773 <div class="prop-row prop-group">
1774 <div class="prop-name">
1775 <div class="prop-title">id</div>
1776 <span class="json-property-required"></span>
1777 <div class="prop-subtitle"> in path </div>
1778 <div class="prop-subtitle">
1779 <span class="json-property-type">string</span>
1780 <span class="json-property-range" title="Value limits"></span>
1783 <div class="prop-value">
1789 <div class="doc-examples"></div>
1791 <div class="doc-row">
1792 <div class="doc-copy">
1793 <section class="swagger-responses">
1794 <div class="prop-row prop-group">
1795 <div class="prop-name">
1796 <div class="prop-title">204 No Content</div>
1798 <div class="prop-value">
1799 <p>successful operation</p>
1804 <div class="doc-examples">
1805 <h5>Response Content-Types:
1806 <span>application/json</span>
1810 <div class="doc-row">
1811 <div class="doc-copy">
1812 <section class="swagger-request-security">
1813 <table class="table">
1816 <th class="swagger-request-security-schema"></th>
1817 <th class="swagger-request-security-scopes"></th>
1823 <a href="#security-definition-OAuth2">OAuth2</a>
1833 <div id="operation--users--id--get" class="operation panel" data-traverse-target="operation--users--id--get">
1834 <!-- <section class="operation-tags row"> -->
1835 <!-- <div class="doc-copy"> -->
1836 <div class="operation-tags">
1837 <a class="label" href="#tag-User">User</a>
1842 <h2 class="operation-title">
1843 <span class="operation-name">
1844 <span class="operation-name">GET</span>
1845 <span class="operation-path">/users/{id}</span>
1848 <div class="doc-row">
1849 <div class="doc-copy">
1850 <section class="swagger-request-params">
1851 <div class="prop-row prop-group">
1852 <div class="prop-name">
1853 <div class="prop-title">id</div>
1854 <span class="json-property-required"></span>
1855 <div class="prop-subtitle"> in path </div>
1856 <div class="prop-subtitle">
1857 <span class="json-property-type">string</span>
1858 <span class="json-property-range" title="Value limits"></span>
1861 <div class="prop-value">
1867 <div class="doc-examples"></div>
1869 <div class="doc-row">
1870 <div class="doc-copy">
1871 <section class="swagger-responses">
1872 <div class="prop-row prop-group">
1873 <div class="prop-name">
1874 <div class="prop-title">200 OK</div>
1875 <div class="prop-ref">
1877 <a class="json-schema-ref" href="#/definitions/User">User</a>
1880 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1882 <div class="prop-value">
1883 <p>successful operation</p>
1888 <div class="doc-examples">
1889 <h5>Response Content-Types:
1890 <span>application/json</span>
1893 <h5>Response Example
1894 <span>(200 OK)</span>
1896 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1897 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1898 <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
1899 <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
1900 <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>,
1901 <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>,
1902 <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
1903 <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>,
1904 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1905 <span class="hljs-attr">"account"</span>: {
1906 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
1907 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1908 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
1909 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
1910 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
1911 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
1912 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
1913 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
1914 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1915 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
1916 <span class="hljs-attr">"avatar"</span>: {
1917 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
1918 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
1919 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
1922 <span class="hljs-attr">"videoChannels"</span>: [
1924 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
1925 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
1926 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
1927 <span class="hljs-attr">"ownerAccount"</span>: {
1928 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
1929 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
1939 <div class="doc-row">
1940 <div class="doc-copy">
1941 <section class="swagger-request-security">
1942 <table class="table">
1945 <th class="swagger-request-security-schema"></th>
1946 <th class="swagger-request-security-scopes"></th>
1952 <a href="#security-definition-OAuth2">OAuth2</a>
1962 <div id="operation--users--id--put" class="operation panel" data-traverse-target="operation--users--id--put">
1963 <!-- <section class="operation-tags row"> -->
1964 <!-- <div class="doc-copy"> -->
1965 <div class="operation-tags">
1966 <a class="label" href="#tag-User">User</a>
1971 <h2 class="operation-title">
1972 <span class="operation-name">
1973 <span class="operation-name">PUT</span>
1974 <span class="operation-path">/users/{id}</span>
1977 <div class="doc-row">
1978 <div class="doc-copy">
1979 <section class="swagger-request-body">
1980 <div class="prop-row">
1981 <div class="prop-name">
1982 <div class="swagger-request-model">
1984 <a class="json-schema-ref" href="#/definitions/UpdateUser">UpdateUser</a>
1988 <div class="prop-value columns small-6">
1989 <!-- <div class="swagger-request-description"> -->
1995 <section class="swagger-request-params">
1996 <div class="prop-row prop-group">
1997 <div class="prop-name">
1998 <div class="prop-title">id</div>
1999 <span class="json-property-required"></span>
2000 <div class="prop-subtitle"> in path </div>
2001 <div class="prop-subtitle">
2002 <span class="json-property-type">string</span>
2003 <span class="json-property-range" title="Value limits"></span>
2006 <div class="prop-value">
2012 <div class="doc-examples">
2014 <h5>Request Content-Types:
2015 <span>application/json</span>
2017 <h5>Request Example</h5>
2018 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2019 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
2020 <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
2021 <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>,
2022 <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
2029 <div class="doc-row">
2030 <div class="doc-copy">
2031 <section class="swagger-responses">
2032 <div class="prop-row prop-group">
2033 <div class="prop-name">
2034 <div class="prop-title">204 No Content</div>
2036 <div class="prop-value">
2037 <p>successful operation</p>
2042 <div class="doc-examples">
2043 <h5>Response Content-Types:
2044 <span>application/json</span>
2048 <div class="doc-row">
2049 <div class="doc-copy">
2050 <section class="swagger-request-security">
2051 <table class="table">
2054 <th class="swagger-request-security-schema"></th>
2055 <th class="swagger-request-security-scopes"></th>
2061 <a href="#security-definition-OAuth2">OAuth2</a>
2071 <div id="operation--users-me-get" class="operation panel" data-traverse-target="operation--users-me-get">
2072 <!-- <section class="operation-tags row"> -->
2073 <!-- <div class="doc-copy"> -->
2074 <div class="operation-tags">
2075 <a class="label" href="#tag-User">User</a>
2080 <h2 class="operation-title">
2081 <span class="operation-name">
2082 <span class="operation-name">GET</span>
2083 <span class="operation-path">/users/me</span>
2086 <div class="doc-row">
2087 <div class="doc-copy"> </div>
2088 <div class="doc-examples"></div>
2090 <div class="doc-row">
2091 <div class="doc-copy">
2092 <section class="swagger-responses">
2093 <div class="prop-row prop-group">
2094 <div class="prop-name">
2095 <div class="prop-title">200 OK</div>
2096 <div class="prop-ref">
2097 <span class="json-schema-ref-array">
2098 <a class="json-schema-ref" href="#/definitions/User">User</a>
2101 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2103 <div class="prop-value">
2104 <p>successful operation</p>
2107 <div class="prop-row prop-inner">
2108 <div class="prop-name">type</div>
2109 <div class="prop-value">
2110 <span class="json-property-type">
2111 <span class="json-schema-ref-array">
2112 <a class="json-schema-ref" href="#/definitions/User">User</a>
2115 <span class="json-property-range" title="Value limits"></span>
2120 <div class="doc-examples">
2121 <h5>Response Content-Types:
2122 <span>application/json</span>
2125 <h5>Response Example
2126 <span>(200 OK)</span>
2128 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
2130 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
2131 <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
2132 <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
2133 <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>,
2134 <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>,
2135 <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
2136 <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>,
2137 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
2138 <span class="hljs-attr">"account"</span>: {
2139 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
2140 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
2141 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
2142 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
2143 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
2144 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
2145 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
2146 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
2147 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
2148 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
2149 <span class="hljs-attr">"avatar"</span>: {
2150 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
2151 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
2152 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
2155 <span class="hljs-attr">"videoChannels"</span>: [
2157 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
2158 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
2159 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
2160 <span class="hljs-attr">"ownerAccount"</span>: {
2161 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
2162 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
2173 <div class="doc-row">
2174 <div class="doc-copy">
2175 <section class="swagger-request-security">
2176 <table class="table">
2179 <th class="swagger-request-security-schema"></th>
2180 <th class="swagger-request-security-scopes"></th>
2186 <a href="#security-definition-OAuth2">OAuth2</a>
2196 <div id="operation--users-me-put" class="operation panel" data-traverse-target="operation--users-me-put">
2197 <!-- <section class="operation-tags row"> -->
2198 <!-- <div class="doc-copy"> -->
2199 <div class="operation-tags">
2200 <a class="label" href="#tag-User">User</a>
2205 <h2 class="operation-title">
2206 <span class="operation-name">
2207 <span class="operation-name">PUT</span>
2208 <span class="operation-path">/users/me</span>
2211 <div class="doc-row">
2212 <div class="doc-copy">
2213 <section class="swagger-request-body">
2214 <div class="prop-row">
2215 <div class="prop-name">
2216 <div class="swagger-request-model">
2218 <a class="json-schema-ref" href="#/definitions/UpdateMe">UpdateMe</a>
2222 <div class="prop-value columns small-6">
2223 <!-- <div class="swagger-request-description"> -->
2230 <div class="doc-examples">
2232 <h5>Request Content-Types:
2233 <span>application/json</span>
2235 <h5>Request Example</h5>
2236 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2237 <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>,
2238 <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
2239 <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>,
2240 <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span>
2247 <div class="doc-row">
2248 <div class="doc-copy">
2249 <section class="swagger-responses">
2250 <div class="prop-row prop-group">
2251 <div class="prop-name">
2252 <div class="prop-title">204 No Content</div>
2254 <div class="prop-value">
2255 <p>successful operation</p>
2260 <div class="doc-examples">
2261 <h5>Response Content-Types:
2262 <span>application/json</span>
2266 <div class="doc-row">
2267 <div class="doc-copy">
2268 <section class="swagger-request-security">
2269 <table class="table">
2272 <th class="swagger-request-security-schema"></th>
2273 <th class="swagger-request-security-scopes"></th>
2279 <a href="#security-definition-OAuth2">OAuth2</a>
2289 <div id="operation--users-me-video-quota-used-get" class="operation panel" data-traverse-target="operation--users-me-video-quota-used-get">
2290 <!-- <section class="operation-tags row"> -->
2291 <!-- <div class="doc-copy"> -->
2292 <div class="operation-tags">
2293 <a class="label" href="#tag-User">User</a>
2298 <h2 class="operation-title">
2299 <span class="operation-name">
2300 <span class="operation-name">GET</span>
2301 <span class="operation-path">/users/me/video-quota-used</span>
2304 <div class="doc-row">
2305 <div class="doc-copy"> </div>
2306 <div class="doc-examples"></div>
2308 <div class="doc-row">
2309 <div class="doc-copy">
2310 <section class="swagger-responses">
2311 <div class="prop-row prop-group">
2312 <div class="prop-name">
2313 <div class="prop-title">200 OK</div>
2314 <div class="prop-ref"></div>
2315 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2317 <div class="prop-value">
2318 <p>successful operation</p>
2321 <div class="prop-row prop-inner">
2322 <div class="prop-name">type</div>
2323 <div class="prop-value">
2324 <span class="json-property-type">number</span>
2325 <span class="json-property-range" title="Value limits"></span>
2330 <div class="doc-examples">
2331 <h5>Response Content-Types:
2332 <span>application/json</span>
2335 <h5>Response Example
2336 <span>(200 OK)</span>
2338 <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"number"</span>
2344 <div class="doc-row">
2345 <div class="doc-copy">
2346 <section class="swagger-request-security">
2347 <table class="table">
2350 <th class="swagger-request-security-schema"></th>
2351 <th class="swagger-request-security-scopes"></th>
2357 <a href="#security-definition-OAuth2">OAuth2</a>
2367 <div id="operation--users-me-videos--videoId--rating-get" class="operation panel" data-traverse-target="operation--users-me-videos--videoId--rating-get">
2368 <!-- <section class="operation-tags row"> -->
2369 <!-- <div class="doc-copy"> -->
2370 <div class="operation-tags">
2371 <a class="label" href="#tag-User">User</a>
2376 <h2 class="operation-title">
2377 <span class="operation-name">
2378 <span class="operation-name">GET</span>
2379 <span class="operation-path">/users/me/videos/{videoId}/rating</span>
2382 <div class="doc-row">
2383 <div class="doc-copy">
2384 <section class="swagger-request-params">
2385 <div class="prop-row prop-group">
2386 <div class="prop-name">
2387 <div class="prop-title">videoId</div>
2388 <span class="json-property-required"></span>
2389 <div class="prop-subtitle"> in path </div>
2390 <div class="prop-subtitle">
2391 <span class="json-property-type">string</span>
2392 <span class="json-property-range" title="Value limits"></span>
2395 <div class="prop-value">
2396 <p>The video id </p>
2401 <div class="doc-examples"></div>
2403 <div class="doc-row">
2404 <div class="doc-copy">
2405 <section class="swagger-responses">
2406 <div class="prop-row prop-group">
2407 <div class="prop-name">
2408 <div class="prop-title">200 OK</div>
2409 <div class="prop-ref">
2411 <a class="json-schema-ref" href="#/definitions/GetMeVideoRating">GetMeVideoRating</a>
2414 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2416 <div class="prop-value">
2417 <p>successful operation</p>
2422 <div class="doc-examples">
2423 <h5>Response Content-Types:
2424 <span>application/json</span>
2427 <h5>Response Example
2428 <span>(200 OK)</span>
2430 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2431 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
2432 <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span>
2439 <div class="doc-row">
2440 <div class="doc-copy">
2441 <section class="swagger-request-security">
2442 <table class="table">
2445 <th class="swagger-request-security-schema"></th>
2446 <th class="swagger-request-security-scopes"></th>
2452 <a href="#security-definition-OAuth2">OAuth2</a>
2462 <div id="operation--users-me-videos-get" class="operation panel" data-traverse-target="operation--users-me-videos-get">
2463 <!-- <section class="operation-tags row"> -->
2464 <!-- <div class="doc-copy"> -->
2465 <div class="operation-tags">
2466 <a class="label" href="#tag-User">User</a>
2471 <h2 class="operation-title">
2472 <span class="operation-name">
2473 <span class="operation-name">GET</span>
2474 <span class="operation-path">/users/me/videos</span>
2477 <div class="doc-row">
2478 <div class="doc-copy">
2479 <section class="swagger-request-params">
2480 <div class="prop-row prop-group">
2481 <div class="prop-name">
2482 <div class="prop-title">start</div>
2483 <div class="prop-subtitle"> in query </div>
2484 <div class="prop-subtitle">
2485 <span class="json-property-type">number</span>
2486 <span class="json-property-range" title="Value limits"></span>
2489 <div class="prop-value">
2490 <p>starting page</p>
2493 <div class="prop-row prop-group">
2494 <div class="prop-name">
2495 <div class="prop-title">stop</div>
2496 <div class="prop-subtitle"> in query </div>
2497 <div class="prop-subtitle">
2498 <span class="json-property-type">number</span>
2499 <span class="json-property-range" title="Value limits"></span>
2502 <div class="prop-value">
2503 <p>stopping page</p>
2506 <div class="prop-row prop-group">
2507 <div class="prop-name">
2508 <div class="prop-title">sort</div>
2509 <div class="prop-subtitle"> in query </div>
2510 <div class="prop-subtitle">
2511 <span class="json-property-type">number</span>
2512 <span class="json-property-range" title="Value limits"></span>
2515 <div class="prop-value">
2521 <div class="doc-examples"></div>
2523 <div class="doc-row">
2524 <div class="doc-copy">
2525 <section class="swagger-responses">
2526 <div class="prop-row prop-group">
2527 <div class="prop-name">
2528 <div class="prop-title">200 OK</div>
2529 <div class="prop-ref">
2530 <span class="json-schema-ref-array">
2531 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2534 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2536 <div class="prop-value">
2537 <p>successful operation</p>
2540 <div class="prop-row prop-inner">
2541 <div class="prop-name">type</div>
2542 <div class="prop-value">
2543 <span class="json-property-type">
2544 <span class="json-schema-ref-array">
2545 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2548 <span class="json-property-range" title="Value limits"></span>
2553 <div class="doc-examples">
2554 <h5>Response Content-Types:
2555 <span>application/json</span>
2558 <h5>Response Example
2559 <span>(200 OK)</span>
2561 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
2563 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
2564 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
2565 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
2566 <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
2567 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
2568 <span class="hljs-attr">"category"</span>: {
2569 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
2570 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
2572 <span class="hljs-attr">"licence"</span>: {
2573 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
2574 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
2576 <span class="hljs-attr">"language"</span>: {
2577 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
2578 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
2580 <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
2581 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
2582 <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
2583 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
2584 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
2585 <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
2586 <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
2587 <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
2588 <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
2589 <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
2590 <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
2591 <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
2592 <span class="hljs-attr">"account"</span>: {
2593 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
2594 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
2595 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
2596 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
2597 <span class="hljs-attr">"avatar"</span>: {
2598 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
2599 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
2600 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
2610 <div class="doc-row">
2611 <div class="doc-copy">
2612 <section class="swagger-request-security">
2613 <table class="table">
2616 <th class="swagger-request-security-schema"></th>
2617 <th class="swagger-request-security-scopes"></th>
2623 <a href="#security-definition-OAuth2">OAuth2</a>
2633 <div id="operation--users-register-post" class="operation panel" data-traverse-target="operation--users-register-post">
2634 <!-- <section class="operation-tags row"> -->
2635 <!-- <div class="doc-copy"> -->
2636 <div class="operation-tags">
2637 <a class="label" href="#tag-User">User</a>
2642 <h2 class="operation-title">
2643 <span class="operation-name">
2644 <span class="operation-name">POST</span>
2645 <span class="operation-path">/users/register</span>
2648 <div class="doc-row">
2649 <div class="doc-copy">
2650 <section class="swagger-request-body">
2651 <div class="prop-row">
2652 <div class="prop-name">
2653 <div class="swagger-request-model">
2655 <a class="json-schema-ref" href="#/definitions/RegisterUser">RegisterUser</a>
2659 <div class="prop-value columns small-6">
2660 <!-- <div class="swagger-request-description"> -->
2667 <div class="doc-examples">
2669 <h5>Request Content-Types:
2670 <span>application/json</span>
2672 <h5>Request Example</h5>
2673 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2674 <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
2675 <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>,
2676 <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>
2683 <div class="doc-row">
2684 <div class="doc-copy">
2685 <section class="swagger-responses">
2686 <div class="prop-row prop-group">
2687 <div class="prop-name">
2688 <div class="prop-title">204 No Content</div>
2690 <div class="prop-value">
2691 <p>successful operation</p>
2696 <div class="doc-examples">
2697 <h5>Response Content-Types:
2698 <span>application/json</span>
2703 <div id="operation--users-me-avatar-pick-post" class="operation panel" data-traverse-target="operation--users-me-avatar-pick-post">
2704 <!-- <section class="operation-tags row"> -->
2705 <!-- <div class="doc-copy"> -->
2706 <div class="operation-tags">
2707 <a class="label" href="#tag-User">User</a>
2712 <h2 class="operation-title">
2713 <span class="operation-name">
2714 <span class="operation-name">POST</span>
2715 <span class="operation-path">/users/me/avatar/pick</span>
2718 <div class="doc-row">
2719 <div class="doc-copy">
2720 <section class="swagger-request-params">
2721 <div class="prop-row prop-group">
2722 <div class="prop-name">
2723 <div class="prop-title">avatarfile</div>
2724 <div class="prop-subtitle"> in formData </div>
2725 <div class="prop-subtitle">
2726 <span class="json-property-type">file</span>
2727 <span class="json-property-range" title="Value limits"></span>
2730 <div class="prop-value">
2731 <p>The file to upload.</p>
2736 <div class="doc-examples"></div>
2738 <div class="doc-row">
2739 <div class="doc-copy">
2740 <section class="swagger-responses">
2741 <div class="prop-row prop-group">
2742 <div class="prop-name">
2743 <div class="prop-title">200 OK</div>
2744 <div class="prop-ref">
2746 <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
2749 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2751 <div class="prop-value">
2752 <p>successful operation</p>
2757 <div class="doc-examples">
2758 <h5>Response Content-Types:
2759 <span>application/json</span>
2762 <h5>Response Example
2763 <span>(200 OK)</span>
2765 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2766 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
2767 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
2768 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
2775 <div class="doc-row">
2776 <div class="doc-copy">
2777 <section class="swagger-request-security">
2778 <table class="table">
2781 <th class="swagger-request-security-schema"></th>
2782 <th class="swagger-request-security-scopes"></th>
2788 <a href="#security-definition-OAuth2">OAuth2</a>
2798 <h1 id="tag-Video" class="swagger-summary-tag" data-traverse-target="tag-Video">Video</h1>
2799 <div id="operation--videos-get" class="operation panel" data-traverse-target="operation--videos-get">
2800 <!-- <section class="operation-tags row"> -->
2801 <!-- <div class="doc-copy"> -->
2802 <div class="operation-tags">
2803 <a class="label" href="#tag-Video">Video</a>
2808 <h2 class="operation-title">
2809 <span class="operation-name">
2810 <span class="operation-name">GET</span>
2811 <span class="operation-path">/videos</span>
2814 <div class="doc-row">
2815 <div class="doc-copy">
2816 <section class="swagger-request-params">
2817 <div class="prop-row prop-group">
2818 <div class="prop-name">
2819 <div class="prop-title">start</div>
2820 <div class="prop-subtitle"> in query </div>
2821 <div class="prop-subtitle">
2822 <span class="json-property-type">number</span>
2823 <span class="json-property-range" title="Value limits"></span>
2826 <div class="prop-value">
2827 <p>starting page</p>
2830 <div class="prop-row prop-group">
2831 <div class="prop-name">
2832 <div class="prop-title">stop</div>
2833 <div class="prop-subtitle"> in query </div>
2834 <div class="prop-subtitle">
2835 <span class="json-property-type">number</span>
2836 <span class="json-property-range" title="Value limits"></span>
2839 <div class="prop-value">
2840 <p>stopping page</p>
2843 <div class="prop-row prop-group">
2844 <div class="prop-name">
2845 <div class="prop-title">sort</div>
2846 <div class="prop-subtitle"> in query </div>
2847 <div class="prop-subtitle">
2848 <span class="json-property-type">number</span>
2849 <span class="json-property-range" title="Value limits"></span>
2852 <div class="prop-value">
2858 <div class="doc-examples"></div>
2860 <div class="doc-row">
2861 <div class="doc-copy">
2862 <section class="swagger-responses">
2863 <div class="prop-row prop-group">
2864 <div class="prop-name">
2865 <div class="prop-title">200 OK</div>
2866 <div class="prop-ref">
2867 <span class="json-schema-ref-array">
2868 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2871 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2873 <div class="prop-value">
2874 <p>successful operation</p>
2877 <div class="prop-row prop-inner">
2878 <div class="prop-name">type</div>
2879 <div class="prop-value">
2880 <span class="json-property-type">
2881 <span class="json-schema-ref-array">
2882 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2885 <span class="json-property-range" title="Value limits"></span>
2890 <div class="doc-examples">
2891 <h5>Response Content-Types:
2892 <span>application/json</span>
2895 <h5>Response Example
2896 <span>(200 OK)</span>
2898 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
2900 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
2901 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
2902 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
2903 <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
2904 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
2905 <span class="hljs-attr">"category"</span>: {
2906 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
2907 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
2909 <span class="hljs-attr">"licence"</span>: {
2910 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
2911 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
2913 <span class="hljs-attr">"language"</span>: {
2914 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
2915 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
2917 <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
2918 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
2919 <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
2920 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
2921 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
2922 <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
2923 <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
2924 <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
2925 <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
2926 <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
2927 <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
2928 <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
2929 <span class="hljs-attr">"account"</span>: {
2930 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
2931 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
2932 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
2933 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
2934 <span class="hljs-attr">"avatar"</span>: {
2935 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
2936 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
2937 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
2948 <div id="operation--videos-categories-get" class="operation panel" data-traverse-target="operation--videos-categories-get">
2949 <!-- <section class="operation-tags row"> -->
2950 <!-- <div class="doc-copy"> -->
2951 <div class="operation-tags">
2952 <a class="label" href="#tag-Video">Video</a>
2957 <h2 class="operation-title">
2958 <span class="operation-name">
2959 <span class="operation-name">GET</span>
2960 <span class="operation-path">/videos/categories</span>
2963 <div class="doc-row">
2964 <div class="doc-copy"> </div>
2965 <div class="doc-examples"></div>
2967 <div class="doc-row">
2968 <div class="doc-copy">
2969 <section class="swagger-responses">
2970 <div class="prop-row prop-group">
2971 <div class="prop-name">
2972 <div class="prop-title">200 OK</div>
2973 <div class="prop-ref"></div>
2974 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2976 <div class="prop-value">
2977 <p>successful operation</p>
2980 <div class="prop-row prop-inner">
2981 <div class="prop-name">type</div>
2982 <div class="prop-value">
2983 <span class="json-property-type">string[]</span>
2984 <span class="json-property-range" title="Value limits"></span>
2989 <div class="doc-examples">
2990 <h5>Response Content-Types:
2991 <span>application/json</span>
2994 <h5>Response Example
2995 <span>(200 OK)</span>
2997 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
2998 <span class="hljs-string">"string"</span>
3006 <div id="operation--videos-licences-get" class="operation panel" data-traverse-target="operation--videos-licences-get">
3007 <!-- <section class="operation-tags row"> -->
3008 <!-- <div class="doc-copy"> -->
3009 <div class="operation-tags">
3010 <a class="label" href="#tag-Video">Video</a>
3015 <h2 class="operation-title">
3016 <span class="operation-name">
3017 <span class="operation-name">GET</span>
3018 <span class="operation-path">/videos/licences</span>
3021 <div class="doc-row">
3022 <div class="doc-copy"> </div>
3023 <div class="doc-examples"></div>
3025 <div class="doc-row">
3026 <div class="doc-copy">
3027 <section class="swagger-responses">
3028 <div class="prop-row prop-group">
3029 <div class="prop-name">
3030 <div class="prop-title">200 OK</div>
3031 <div class="prop-ref"></div>
3032 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3034 <div class="prop-value">
3035 <p>successful operation</p>
3038 <div class="prop-row prop-inner">
3039 <div class="prop-name">type</div>
3040 <div class="prop-value">
3041 <span class="json-property-type">string[]</span>
3042 <span class="json-property-range" title="Value limits"></span>
3047 <div class="doc-examples">
3048 <h5>Response Content-Types:
3049 <span>application/json</span>
3052 <h5>Response Example
3053 <span>(200 OK)</span>
3055 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
3056 <span class="hljs-string">"string"</span>
3064 <div id="operation--videos-languages-get" class="operation panel" data-traverse-target="operation--videos-languages-get">
3065 <!-- <section class="operation-tags row"> -->
3066 <!-- <div class="doc-copy"> -->
3067 <div class="operation-tags">
3068 <a class="label" href="#tag-Video">Video</a>
3073 <h2 class="operation-title">
3074 <span class="operation-name">
3075 <span class="operation-name">GET</span>
3076 <span class="operation-path">/videos/languages</span>
3079 <div class="doc-row">
3080 <div class="doc-copy"> </div>
3081 <div class="doc-examples"></div>
3083 <div class="doc-row">
3084 <div class="doc-copy">
3085 <section class="swagger-responses">
3086 <div class="prop-row prop-group">
3087 <div class="prop-name">
3088 <div class="prop-title">200 OK</div>
3089 <div class="prop-ref"></div>
3090 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3092 <div class="prop-value">
3093 <p>successful operation</p>
3096 <div class="prop-row prop-inner">
3097 <div class="prop-name">type</div>
3098 <div class="prop-value">
3099 <span class="json-property-type">string[]</span>
3100 <span class="json-property-range" title="Value limits"></span>
3105 <div class="doc-examples">
3106 <h5>Response Content-Types:
3107 <span>application/json</span>
3110 <h5>Response Example
3111 <span>(200 OK)</span>
3113 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
3114 <span class="hljs-string">"string"</span>
3122 <div id="operation--videos-privacies-get" class="operation panel" data-traverse-target="operation--videos-privacies-get">
3123 <!-- <section class="operation-tags row"> -->
3124 <!-- <div class="doc-copy"> -->
3125 <div class="operation-tags">
3126 <a class="label" href="#tag-Video">Video</a>
3131 <h2 class="operation-title">
3132 <span class="operation-name">
3133 <span class="operation-name">GET</span>
3134 <span class="operation-path">/videos/privacies</span>
3137 <div class="doc-row">
3138 <div class="doc-copy"> </div>
3139 <div class="doc-examples"></div>
3141 <div class="doc-row">
3142 <div class="doc-copy">
3143 <section class="swagger-responses">
3144 <div class="prop-row prop-group">
3145 <div class="prop-name">
3146 <div class="prop-title">200 OK</div>
3147 <div class="prop-ref"></div>
3148 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3150 <div class="prop-value">
3151 <p>successful operation</p>
3154 <div class="prop-row prop-inner">
3155 <div class="prop-name">type</div>
3156 <div class="prop-value">
3157 <span class="json-property-type">string[]</span>
3158 <span class="json-property-range" title="Value limits"></span>
3163 <div class="doc-examples">
3164 <h5>Response Content-Types:
3165 <span>application/json</span>
3168 <h5>Response Example
3169 <span>(200 OK)</span>
3171 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
3172 <span class="hljs-string">"string"</span>
3180 <div id="operation--videos-search-get" class="operation panel" data-traverse-target="operation--videos-search-get">
3181 <!-- <section class="operation-tags row"> -->
3182 <!-- <div class="doc-copy"> -->
3183 <div class="operation-tags">
3184 <a class="label" href="#tag-Video">Video</a>
3189 <h2 class="operation-title">
3190 <span class="operation-name">
3191 <span class="operation-name">GET</span>
3192 <span class="operation-path">/videos/search</span>
3195 <div class="doc-row">
3196 <div class="doc-copy">
3197 <section class="swagger-request-params">
3198 <div class="prop-row prop-group">
3199 <div class="prop-name">
3200 <div class="prop-title">start</div>
3201 <div class="prop-subtitle"> in query </div>
3202 <div class="prop-subtitle">
3203 <span class="json-property-type">number</span>
3204 <span class="json-property-range" title="Value limits"></span>
3207 <div class="prop-value">
3208 <p>starting page</p>
3211 <div class="prop-row prop-group">
3212 <div class="prop-name">
3213 <div class="prop-title">stop</div>
3214 <div class="prop-subtitle"> in query </div>
3215 <div class="prop-subtitle">
3216 <span class="json-property-type">number</span>
3217 <span class="json-property-range" title="Value limits"></span>
3220 <div class="prop-value">
3221 <p>stopping page</p>
3224 <div class="prop-row prop-group">
3225 <div class="prop-name">
3226 <div class="prop-title">sort</div>
3227 <div class="prop-subtitle"> in query </div>
3228 <div class="prop-subtitle">
3229 <span class="json-property-type">number</span>
3230 <span class="json-property-range" title="Value limits"></span>
3233 <div class="prop-value">
3239 <div class="doc-examples"></div>
3241 <div class="doc-row">
3242 <div class="doc-copy">
3243 <section class="swagger-responses">
3244 <div class="prop-row prop-group">
3245 <div class="prop-name">
3246 <div class="prop-title">200 OK</div>
3247 <div class="prop-ref">
3248 <span class="json-schema-ref-array">
3249 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
3252 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3254 <div class="prop-value">
3255 <p>successful operation</p>
3258 <div class="prop-row prop-inner">
3259 <div class="prop-name">type</div>
3260 <div class="prop-value">
3261 <span class="json-property-type">
3262 <span class="json-schema-ref-array">
3263 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
3266 <span class="json-property-range" title="Value limits"></span>
3271 <div class="doc-examples">
3272 <h5>Response Content-Types:
3273 <span>application/json</span>
3276 <h5>Response Example
3277 <span>(200 OK)</span>
3279 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
3281 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
3282 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
3283 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
3284 <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
3285 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
3286 <span class="hljs-attr">"category"</span>: {
3287 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
3288 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
3290 <span class="hljs-attr">"licence"</span>: {
3291 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
3292 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
3294 <span class="hljs-attr">"language"</span>: {
3295 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
3296 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
3298 <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
3299 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
3300 <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
3301 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
3302 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
3303 <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
3304 <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
3305 <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
3306 <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
3307 <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
3308 <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
3309 <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
3310 <span class="hljs-attr">"account"</span>: {
3311 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
3312 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
3313 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
3314 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
3315 <span class="hljs-attr">"avatar"</span>: {
3316 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
3317 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
3318 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
3329 <div id="operation--videos--id--put" class="operation panel" data-traverse-target="operation--videos--id--put">
3330 <!-- <section class="operation-tags row"> -->
3331 <!-- <div class="doc-copy"> -->
3332 <div class="operation-tags">
3333 <a class="label" href="#tag-Video">Video</a>
3338 <h2 class="operation-title">
3339 <span class="operation-name">
3340 <span class="operation-name">PUT</span>
3341 <span class="operation-path">/videos/{id}</span>
3344 <div class="doc-row">
3345 <div class="doc-copy">
3346 <section class="swagger-request-params">
3347 <div class="prop-row prop-group">
3348 <div class="prop-name">
3349 <div class="prop-title">id</div>
3350 <span class="json-property-required"></span>
3351 <div class="prop-subtitle"> in path </div>
3352 <div class="prop-subtitle">
3353 <span class="json-property-type">string</span>
3354 <span class="json-property-range" title="Value limits"></span>
3357 <div class="prop-value">
3361 <div class="prop-row prop-group">
3362 <div class="prop-name">
3363 <div class="prop-title">thumbnailfile</div>
3364 <div class="prop-subtitle"> in formData </div>
3365 <div class="prop-subtitle">
3366 <span class="json-property-type">file</span>
3367 <span class="json-property-range" title="Value limits"></span>
3370 <div class="prop-value">
3371 <p>Video thumbnail file</p>
3374 <div class="prop-row prop-group">
3375 <div class="prop-name">
3376 <div class="prop-title">previewfile</div>
3377 <div class="prop-subtitle"> in formData </div>
3378 <div class="prop-subtitle">
3379 <span class="json-property-type">file</span>
3380 <span class="json-property-range" title="Value limits"></span>
3383 <div class="prop-value">
3384 <p>Video preview file</p>
3387 <div class="prop-row prop-group">
3388 <div class="prop-name">
3389 <div class="prop-title">category</div>
3390 <div class="prop-subtitle"> in formData </div>
3391 <div class="prop-subtitle">
3392 <span class="json-property-type">number</span>
3393 <span class="json-property-range" title="Value limits"></span>
3396 <div class="prop-value">
3397 <p>Video category</p>
3400 <div class="prop-row prop-group">
3401 <div class="prop-name">
3402 <div class="prop-title">licence</div>
3403 <div class="prop-subtitle"> in formData </div>
3404 <div class="prop-subtitle">
3405 <span class="json-property-type">number</span>
3406 <span class="json-property-range" title="Value limits"></span>
3409 <div class="prop-value">
3410 <p>Video licence</p>
3413 <div class="prop-row prop-group">
3414 <div class="prop-name">
3415 <div class="prop-title">language</div>
3416 <div class="prop-subtitle"> in formData </div>
3417 <div class="prop-subtitle">
3418 <span class="json-property-type">string</span>
3419 <span class="json-property-range" title="Value limits"></span>
3422 <div class="prop-value">
3423 <p>Video language</p>
3426 <div class="prop-row prop-group">
3427 <div class="prop-name">
3428 <div class="prop-title">description</div>
3429 <div class="prop-subtitle"> in formData </div>
3430 <div class="prop-subtitle">
3431 <span class="json-property-type">string</span>
3432 <span class="json-property-range" title="Value limits"></span>
3435 <div class="prop-value">
3436 <p>Video description</p>
3439 <div class="prop-row prop-group">
3440 <div class="prop-name">
3441 <div class="prop-title">waitTranscoding</div>
3442 <div class="prop-subtitle"> in formData </div>
3443 <div class="prop-subtitle">
3444 <span class="json-property-type">boolean</span>
3445 <span class="json-property-range" title="Value limits"></span>
3448 <div class="prop-value">
3449 <p>Whether or not we wait transcoding before publish the video</p>
3452 <div class="prop-row prop-group">
3453 <div class="prop-name">
3454 <div class="prop-title">support</div>
3455 <div class="prop-subtitle"> in formData </div>
3456 <div class="prop-subtitle">
3457 <span class="json-property-type">string</span>
3458 <span class="json-property-range" title="Value limits"></span>
3461 <div class="prop-value">
3462 <p>Text describing how to support the video uploader</p>
3465 <div class="prop-row prop-group">
3466 <div class="prop-name">
3467 <div class="prop-title">nsfw</div>
3468 <div class="prop-subtitle"> in formData </div>
3469 <div class="prop-subtitle">
3470 <span class="json-property-type">boolean</span>
3471 <span class="json-property-range" title="Value limits"></span>
3474 <div class="prop-value">
3475 <p>Whether or not this video contains sensitive content</p>
3478 <div class="prop-row prop-group">
3479 <div class="prop-name">
3480 <div class="prop-title">name</div>
3481 <div class="prop-subtitle"> in formData </div>
3482 <div class="prop-subtitle">
3483 <span class="json-property-type">string</span>
3484 <span class="json-property-range" title="Value limits"></span>
3487 <div class="prop-value">
3491 <div class="prop-row prop-group">
3492 <div class="prop-name">
3493 <div class="prop-title">tags</div>
3494 <div class="prop-subtitle"> in formData </div>
3495 <div class="prop-subtitle">
3496 <span class="json-property-type">string[]</span>
3497 <span class="json-property-range" title="Value limits"></span>
3500 <div class="prop-value">
3504 <div class="prop-row prop-group">
3505 <div class="prop-name">
3506 <div class="prop-title">commentsEnabled</div>
3507 <div class="prop-subtitle"> in formData </div>
3508 <div class="prop-subtitle">
3509 <span class="json-property-type">boolean</span>
3510 <span class="json-property-range" title="Value limits"></span>
3513 <div class="prop-value">
3514 <p>Enable or disable comments for this video</p>
3517 <div class="prop-row prop-group">
3518 <div class="prop-name">
3519 <div class="prop-title">privacy</div>
3520 <div class="prop-subtitle"> in formData </div>
3521 <div class="prop-subtitle">
3522 <span class="json-property-type">string</span>
3523 <span class="json-property-enum" title="Possible values">
3524 <span class="json-property-enum-item">Public</span>,
3525 <span class="json-property-enum-item">Unlisted</span>
3527 <span class="json-property-range" title="Value limits"></span>
3530 <div class="prop-value">
3531 <p>Video privacy</p>
3534 <div class="prop-row prop-group">
3535 <div class="prop-name">
3536 <div class="prop-title">scheduleUpdate</div>
3537 <div class="prop-subtitle"> in formData </div>
3538 <div class="prop-subtitle">
3539 <span class="json-property-type">[object Object]</span>
3540 <span class="json-property-range" title="Value limits"></span>
3543 <div class="prop-value">
3544 <p class="no-description">(no description)</p>
3549 <div class="doc-examples"></div>
3551 <div class="doc-row">
3552 <div class="doc-copy">
3553 <section class="swagger-responses">
3554 <div class="prop-row prop-group">
3555 <div class="prop-name">
3556 <div class="prop-title">200 OK</div>
3557 <div class="prop-ref">
3559 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
3562 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3564 <div class="prop-value">
3565 <p>successful operation</p>
3570 <div class="doc-examples">
3571 <h5>Response Content-Types:
3572 <span>application/json</span>
3575 <h5>Response Example
3576 <span>(200 OK)</span>
3578 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
3579 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
3580 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
3581 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
3582 <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
3583 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
3584 <span class="hljs-attr">"category"</span>: {
3585 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
3586 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
3588 <span class="hljs-attr">"licence"</span>: {
3589 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
3590 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
3592 <span class="hljs-attr">"language"</span>: {
3593 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
3594 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
3596 <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
3597 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
3598 <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
3599 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
3600 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
3601 <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
3602 <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
3603 <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
3604 <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
3605 <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
3606 <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
3607 <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
3608 <span class="hljs-attr">"account"</span>: {
3609 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
3610 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
3611 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
3612 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
3613 <span class="hljs-attr">"avatar"</span>: {
3614 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
3615 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
3616 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
3625 <div class="doc-row">
3626 <div class="doc-copy">
3627 <section class="swagger-request-security">
3628 <table class="table">
3631 <th class="swagger-request-security-schema"></th>
3632 <th class="swagger-request-security-scopes"></th>
3638 <a href="#security-definition-OAuth2">OAuth2</a>
3648 <div id="operation--videos--id--get" class="operation panel" data-traverse-target="operation--videos--id--get">
3649 <!-- <section class="operation-tags row"> -->
3650 <!-- <div class="doc-copy"> -->
3651 <div class="operation-tags">
3652 <a class="label" href="#tag-Video">Video</a>
3657 <h2 class="operation-title">
3658 <span class="operation-name">
3659 <span class="operation-name">GET</span>
3660 <span class="operation-path">/videos/{id}</span>
3663 <div class="doc-row">
3664 <div class="doc-copy">
3665 <section class="swagger-request-params">
3666 <div class="prop-row prop-group">
3667 <div class="prop-name">
3668 <div class="prop-title">id</div>
3669 <span class="json-property-required"></span>
3670 <div class="prop-subtitle"> in path </div>
3671 <div class="prop-subtitle">
3672 <span class="json-property-type">string</span>
3673 <span class="json-property-range" title="Value limits"></span>
3676 <div class="prop-value">
3677 <p>The video id </p>
3682 <div class="doc-examples"></div>
3684 <div class="doc-row">
3685 <div class="doc-copy">
3686 <section class="swagger-responses">
3687 <div class="prop-row prop-group">
3688 <div class="prop-name">
3689 <div class="prop-title">200 OK</div>
3690 <div class="prop-ref">
3692 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
3695 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3697 <div class="prop-value">
3698 <p>successful operation</p>
3703 <div class="doc-examples">
3704 <h5>Response Content-Types:
3705 <span>application/json</span>
3708 <h5>Response Example
3709 <span>(200 OK)</span>
3711 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
3712 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
3713 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
3714 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
3715 <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
3716 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
3717 <span class="hljs-attr">"category"</span>: {
3718 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
3719 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
3721 <span class="hljs-attr">"licence"</span>: {
3722 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
3723 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
3725 <span class="hljs-attr">"language"</span>: {
3726 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
3727 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
3729 <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
3730 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
3731 <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
3732 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
3733 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
3734 <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
3735 <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
3736 <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
3737 <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
3738 <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
3739 <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
3740 <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
3741 <span class="hljs-attr">"account"</span>: {
3742 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
3743 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
3744 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
3745 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
3746 <span class="hljs-attr">"avatar"</span>: {
3747 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
3748 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
3749 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
3759 <div id="operation--videos--id--delete" class="operation panel" data-traverse-target="operation--videos--id--delete">
3760 <!-- <section class="operation-tags row"> -->
3761 <!-- <div class="doc-copy"> -->
3762 <div class="operation-tags">
3763 <a class="label" href="#tag-Video">Video</a>
3768 <h2 class="operation-title">
3769 <span class="operation-name">
3770 <span class="operation-name">DELETE</span>
3771 <span class="operation-path">/videos/{id}</span>
3774 <div class="doc-row">
3775 <div class="doc-copy">
3776 <section class="swagger-request-params">
3777 <div class="prop-row prop-group">
3778 <div class="prop-name">
3779 <div class="prop-title">id</div>
3780 <span class="json-property-required"></span>
3781 <div class="prop-subtitle"> in path </div>
3782 <div class="prop-subtitle">
3783 <span class="json-property-type">string</span>
3784 <span class="json-property-range" title="Value limits"></span>
3787 <div class="prop-value">
3788 <p>The video id </p>
3793 <div class="doc-examples"></div>
3795 <div class="doc-row">
3796 <div class="doc-copy">
3797 <section class="swagger-responses">
3798 <div class="prop-row prop-group">
3799 <div class="prop-name">
3800 <div class="prop-title">204 No Content</div>
3802 <div class="prop-value">
3803 <p>successful operation</p>
3808 <div class="doc-examples">
3809 <h5>Response Content-Types:
3810 <span>application/json</span>
3814 <div class="doc-row">
3815 <div class="doc-copy">
3816 <section class="swagger-request-security">
3817 <table class="table">
3820 <th class="swagger-request-security-schema"></th>
3821 <th class="swagger-request-security-scopes"></th>
3827 <a href="#security-definition-OAuth2">OAuth2</a>
3837 <div id="operation--videos--id--description-get" class="operation panel" data-traverse-target="operation--videos--id--description-get">
3838 <!-- <section class="operation-tags row"> -->
3839 <!-- <div class="doc-copy"> -->
3840 <div class="operation-tags">
3841 <a class="label" href="#tag-Video">Video</a>
3846 <h2 class="operation-title">
3847 <span class="operation-name">
3848 <span class="operation-name">GET</span>
3849 <span class="operation-path">/videos/{id}/description</span>
3852 <div class="doc-row">
3853 <div class="doc-copy">
3854 <section class="swagger-request-params">
3855 <div class="prop-row prop-group">
3856 <div class="prop-name">
3857 <div class="prop-title">id</div>
3858 <span class="json-property-required"></span>
3859 <div class="prop-subtitle"> in path </div>
3860 <div class="prop-subtitle">
3861 <span class="json-property-type">string</span>
3862 <span class="json-property-range" title="Value limits"></span>
3865 <div class="prop-value">
3866 <p>The video id </p>
3871 <div class="doc-examples"></div>
3873 <div class="doc-row">
3874 <div class="doc-copy">
3875 <section class="swagger-responses">
3876 <div class="prop-row prop-group">
3877 <div class="prop-name">
3878 <div class="prop-title">200 OK</div>
3879 <div class="prop-ref"></div>
3880 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3882 <div class="prop-value">
3883 <p>successful operation</p>
3886 <div class="prop-row prop-inner">
3887 <div class="prop-name">type</div>
3888 <div class="prop-value">
3889 <span class="json-property-type">string</span>
3890 <span class="json-property-range" title="Value limits"></span>
3895 <div class="doc-examples">
3896 <h5>Response Content-Types:
3897 <span>application/json</span>
3900 <h5>Response Example
3901 <span>(200 OK)</span>
3903 <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"string"</span>
3910 <div id="operation--videos--id--views-post" class="operation panel" data-traverse-target="operation--videos--id--views-post">
3911 <!-- <section class="operation-tags row"> -->
3912 <!-- <div class="doc-copy"> -->
3913 <div class="operation-tags">
3914 <a class="label" href="#tag-Video">Video</a>
3919 <h2 class="operation-title">
3920 <span class="operation-name">
3921 <span class="operation-name">POST</span>
3922 <span class="operation-path">/videos/{id}/views</span>
3925 <div class="doc-row">
3926 <div class="doc-copy">
3927 <section class="swagger-request-params">
3928 <div class="prop-row prop-group">
3929 <div class="prop-name">
3930 <div class="prop-title">id</div>
3931 <span class="json-property-required"></span>
3932 <div class="prop-subtitle"> in path </div>
3933 <div class="prop-subtitle">
3934 <span class="json-property-type">string</span>
3935 <span class="json-property-range" title="Value limits"></span>
3938 <div class="prop-value">
3939 <p>The video id </p>
3944 <div class="doc-examples"></div>
3946 <div class="doc-row">
3947 <div class="doc-copy">
3948 <section class="swagger-responses">
3949 <div class="prop-row prop-group">
3950 <div class="prop-name">
3951 <div class="prop-title">204 No Content</div>
3953 <div class="prop-value">
3954 <p>successful operation</p>
3959 <div class="doc-examples">
3960 <h5>Response Content-Types:
3961 <span>application/json</span>
3966 <div id="operation--videos-upload-post" class="operation panel" data-traverse-target="operation--videos-upload-post">
3967 <!-- <section class="operation-tags row"> -->
3968 <!-- <div class="doc-copy"> -->
3969 <div class="operation-tags">
3970 <a class="label" href="#tag-Video">Video</a>
3975 <h2 class="operation-title">
3976 <span class="operation-name">
3977 <span class="operation-name">POST</span>
3978 <span class="operation-path">/videos/upload</span>
3981 <div class="doc-row">
3982 <div class="doc-copy">
3983 <section class="swagger-request-params">
3984 <div class="prop-row prop-group">
3985 <div class="prop-name">
3986 <div class="prop-title">videofile</div>
3987 <span class="json-property-required"></span>
3988 <div class="prop-subtitle"> in formData </div>
3989 <div class="prop-subtitle">
3990 <span class="json-property-type">file</span>
3991 <span class="json-property-range" title="Value limits"></span>
3994 <div class="prop-value">
3998 <div class="prop-row prop-group">
3999 <div class="prop-name">
4000 <div class="prop-title">thumbnailfile</div>
4001 <span class="json-property-required"></span>
4002 <div class="prop-subtitle"> in formData </div>
4003 <div class="prop-subtitle">
4004 <span class="json-property-type">file</span>
4005 <span class="json-property-range" title="Value limits"></span>
4008 <div class="prop-value">
4009 <p>Video thumbnail file</p>
4012 <div class="prop-row prop-group">
4013 <div class="prop-name">
4014 <div class="prop-title">previewfile</div>
4015 <span class="json-property-required"></span>
4016 <div class="prop-subtitle"> in formData </div>
4017 <div class="prop-subtitle">
4018 <span class="json-property-type">file</span>
4019 <span class="json-property-range" title="Value limits"></span>
4022 <div class="prop-value">
4023 <p>Video preview file</p>
4026 <div class="prop-row prop-group">
4027 <div class="prop-name">
4028 <div class="prop-title">category</div>
4029 <div class="prop-subtitle"> in formData </div>
4030 <div class="prop-subtitle">
4031 <span class="json-property-type">number</span>
4032 <span class="json-property-range" title="Value limits"></span>
4035 <div class="prop-value">
4036 <p>Video category</p>
4039 <div class="prop-row prop-group">
4040 <div class="prop-name">
4041 <div class="prop-title">waitTranscoding</div>
4042 <div class="prop-subtitle"> in formData </div>
4043 <div class="prop-subtitle">
4044 <span class="json-property-type">boolean</span>
4045 <span class="json-property-range" title="Value limits"></span>
4048 <div class="prop-value">
4049 <p>Whether or not we wait transcoding before publish the video</p>
4052 <div class="prop-row prop-group">
4053 <div class="prop-name">
4054 <div class="prop-title">licence</div>
4055 <div class="prop-subtitle"> in formData </div>
4056 <div class="prop-subtitle">
4057 <span class="json-property-type">number</span>
4058 <span class="json-property-range" title="Value limits"></span>
4061 <div class="prop-value">
4062 <p>Video licence</p>
4065 <div class="prop-row prop-group">
4066 <div class="prop-name">
4067 <div class="prop-title">language</div>
4068 <div class="prop-subtitle"> in formData </div>
4069 <div class="prop-subtitle">
4070 <span class="json-property-type">string</span>
4071 <span class="json-property-range" title="Value limits"></span>
4074 <div class="prop-value">
4075 <p>Video language</p>
4078 <div class="prop-row prop-group">
4079 <div class="prop-name">
4080 <div class="prop-title">description</div>
4081 <div class="prop-subtitle"> in formData </div>
4082 <div class="prop-subtitle">
4083 <span class="json-property-type">string</span>
4084 <span class="json-property-range" title="Value limits"></span>
4087 <div class="prop-value">
4088 <p>Video description</p>
4091 <div class="prop-row prop-group">
4092 <div class="prop-name">
4093 <div class="prop-title">support</div>
4094 <div class="prop-subtitle"> in formData </div>
4095 <div class="prop-subtitle">
4096 <span class="json-property-type">string</span>
4097 <span class="json-property-range" title="Value limits"></span>
4100 <div class="prop-value">
4101 <p>Text describing how to support the video uploader</p>
4104 <div class="prop-row prop-group">
4105 <div class="prop-name">
4106 <div class="prop-title">channelId</div>
4107 <span class="json-property-required"></span>
4108 <div class="prop-subtitle"> in formData </div>
4109 <div class="prop-subtitle">
4110 <span class="json-property-type">number</span>
4111 <span class="json-property-range" title="Value limits"></span>
4114 <div class="prop-value">
4115 <p>Channel id that will contain this video</p>
4118 <div class="prop-row prop-group">
4119 <div class="prop-name">
4120 <div class="prop-title">nsfw</div>
4121 <span class="json-property-required"></span>
4122 <div class="prop-subtitle"> in formData </div>
4123 <div class="prop-subtitle">
4124 <span class="json-property-type">boolean</span>
4125 <span class="json-property-range" title="Value limits"></span>
4128 <div class="prop-value">
4129 <p>Whether or not this video contains sensitive content</p>
4132 <div class="prop-row prop-group">
4133 <div class="prop-name">
4134 <div class="prop-title">name</div>
4135 <span class="json-property-required"></span>
4136 <div class="prop-subtitle"> in formData </div>
4137 <div class="prop-subtitle">
4138 <span class="json-property-type">string</span>
4139 <span class="json-property-range" title="Value limits"></span>
4142 <div class="prop-value">
4146 <div class="prop-row prop-group">
4147 <div class="prop-name">
4148 <div class="prop-title">tags</div>
4149 <div class="prop-subtitle"> in formData </div>
4150 <div class="prop-subtitle">
4151 <span class="json-property-type">string[]</span>
4152 <span class="json-property-range" title="Value limits"></span>
4155 <div class="prop-value">
4159 <div class="prop-row prop-group">
4160 <div class="prop-name">
4161 <div class="prop-title">commentsEnabled</div>
4162 <div class="prop-subtitle"> in formData </div>
4163 <div class="prop-subtitle">
4164 <span class="json-property-type">boolean</span>
4165 <span class="json-property-range" title="Value limits"></span>
4168 <div class="prop-value">
4169 <p>Enable or disable comments for this video</p>
4172 <div class="prop-row prop-group">
4173 <div class="prop-name">
4174 <div class="prop-title">privacy</div>
4175 <span class="json-property-required"></span>
4176 <div class="prop-subtitle"> in formData </div>
4177 <div class="prop-subtitle">
4178 <span class="json-property-type">[object Object]</span>
4179 <span class="json-property-range" title="Value limits"></span>
4182 <div class="prop-value">
4183 <p>Video privacy</p>
4186 <div class="prop-row prop-group">
4187 <div class="prop-name">
4188 <div class="prop-title">scheduleUpdate</div>
4189 <div class="prop-subtitle"> in formData </div>
4190 <div class="prop-subtitle">
4191 <span class="json-property-type">[object Object]</span>
4192 <span class="json-property-range" title="Value limits"></span>
4195 <div class="prop-value">
4196 <p class="no-description">(no description)</p>
4201 <div class="doc-examples"></div>
4203 <div class="doc-row">
4204 <div class="doc-copy">
4205 <section class="swagger-responses">
4206 <div class="prop-row prop-group">
4207 <div class="prop-name">
4208 <div class="prop-title">200 OK</div>
4209 <div class="prop-ref">
4211 <a class="json-schema-ref" href="#/definitions/VideoUploadResponse">VideoUploadResponse</a>
4214 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4216 <div class="prop-value">
4217 <p>successful operation</p>
4222 <div class="doc-examples">
4223 <h5>Response Content-Types:
4224 <span>application/json</span>
4227 <h5>Response Example
4228 <span>(200 OK)</span>
4230 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
4231 <span class="hljs-attr">"video"</span>: {
4232 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
4233 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
4241 <div class="doc-row">
4242 <div class="doc-copy">
4243 <section class="swagger-request-security">
4244 <table class="table">
4247 <th class="swagger-request-security-schema"></th>
4248 <th class="swagger-request-security-scopes"></th>
4254 <a href="#security-definition-OAuth2">OAuth2</a>
4264 <h1 id="tag-VideoAbuse" class="swagger-summary-tag" data-traverse-target="tag-VideoAbuse">VideoAbuse</h1>
4265 <div id="operation--videos-abuse-get" class="operation panel" data-traverse-target="operation--videos-abuse-get">
4266 <!-- <section class="operation-tags row"> -->
4267 <!-- <div class="doc-copy"> -->
4268 <div class="operation-tags">
4269 <a class="label" href="#tag-VideoAbuse">VideoAbuse</a>
4274 <h2 class="operation-title">
4275 <span class="operation-name">
4276 <span class="operation-name">GET</span>
4277 <span class="operation-path">/videos/abuse</span>
4280 <div class="doc-row">
4281 <div class="doc-copy">
4282 <section class="swagger-request-params">
4283 <div class="prop-row prop-group">
4284 <div class="prop-name">
4285 <div class="prop-title">start</div>
4286 <div class="prop-subtitle"> in query </div>
4287 <div class="prop-subtitle">
4288 <span class="json-property-type">number</span>
4289 <span class="json-property-range" title="Value limits"></span>
4292 <div class="prop-value">
4293 <p>starting page</p>
4296 <div class="prop-row prop-group">
4297 <div class="prop-name">
4298 <div class="prop-title">stop</div>
4299 <div class="prop-subtitle"> in query </div>
4300 <div class="prop-subtitle">
4301 <span class="json-property-type">number</span>
4302 <span class="json-property-range" title="Value limits"></span>
4305 <div class="prop-value">
4306 <p>stopping page</p>
4309 <div class="prop-row prop-group">
4310 <div class="prop-name">
4311 <div class="prop-title">sort</div>
4312 <div class="prop-subtitle"> in query </div>
4313 <div class="prop-subtitle">
4314 <span class="json-property-type">number</span>
4315 <span class="json-property-range" title="Value limits"></span>
4318 <div class="prop-value">
4324 <div class="doc-examples"></div>
4326 <div class="doc-row">
4327 <div class="doc-copy">
4328 <section class="swagger-responses">
4329 <div class="prop-row prop-group">
4330 <div class="prop-name">
4331 <div class="prop-title">200 OK</div>
4332 <div class="prop-ref">
4333 <span class="json-schema-ref-array">
4334 <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a>
4337 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4339 <div class="prop-value">
4340 <p>successful operation</p>
4343 <div class="prop-row prop-inner">
4344 <div class="prop-name">type</div>
4345 <div class="prop-value">
4346 <span class="json-property-type">
4347 <span class="json-schema-ref-array">
4348 <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a>
4351 <span class="json-property-range" title="Value limits"></span>
4356 <div class="doc-examples">
4357 <h5>Response Content-Types:
4358 <span>application/json</span>
4361 <h5>Response Example
4362 <span>(200 OK)</span>
4364 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
4366 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
4367 <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>,
4368 <span class="hljs-attr">"reporterAccount"</span>: {
4369 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
4370 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
4371 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
4372 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
4373 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
4374 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
4375 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
4376 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
4377 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
4378 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
4379 <span class="hljs-attr">"avatar"</span>: {
4380 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
4381 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
4382 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
4385 <span class="hljs-attr">"video"</span>: {
4386 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
4387 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
4388 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
4389 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>
4391 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>
4399 <div class="doc-row">
4400 <div class="doc-copy">
4401 <section class="swagger-request-security">
4402 <table class="table">
4405 <th class="swagger-request-security-schema"></th>
4406 <th class="swagger-request-security-scopes"></th>
4412 <a href="#security-definition-OAuth2">OAuth2</a>
4422 <div id="operation--videos--id--abuse-post" class="operation panel" data-traverse-target="operation--videos--id--abuse-post">
4423 <!-- <section class="operation-tags row"> -->
4424 <!-- <div class="doc-copy"> -->
4425 <div class="operation-tags">
4426 <a class="label" href="#tag-VideoAbuse">VideoAbuse</a>
4431 <h2 class="operation-title">
4432 <span class="operation-name">
4433 <span class="operation-name">POST</span>
4434 <span class="operation-path">/videos/{id}/abuse</span>
4437 <div class="doc-row">
4438 <div class="doc-copy">
4439 <section class="swagger-request-params">
4440 <div class="prop-row prop-group">
4441 <div class="prop-name">
4442 <div class="prop-title">id</div>
4443 <span class="json-property-required"></span>
4444 <div class="prop-subtitle"> in path </div>
4445 <div class="prop-subtitle">
4446 <span class="json-property-type">string</span>
4447 <span class="json-property-range" title="Value limits"></span>
4450 <div class="prop-value">
4451 <p>The video id </p>
4456 <div class="doc-examples"></div>
4458 <div class="doc-row">
4459 <div class="doc-copy">
4460 <section class="swagger-responses">
4461 <div class="prop-row prop-group">
4462 <div class="prop-name">
4463 <div class="prop-title">204 No Content</div>
4465 <div class="prop-value">
4466 <p>successful operation</p>
4471 <div class="doc-examples">
4472 <h5>Response Content-Types:
4473 <span>application/json</span>
4477 <div class="doc-row">
4478 <div class="doc-copy">
4479 <section class="swagger-request-security">
4480 <table class="table">
4483 <th class="swagger-request-security-schema"></th>
4484 <th class="swagger-request-security-scopes"></th>
4490 <a href="#security-definition-OAuth2">OAuth2</a>
4500 <h1 id="tag-VideoBlacklist" class="swagger-summary-tag" data-traverse-target="tag-VideoBlacklist">VideoBlacklist</h1>
4501 <div id="operation--videos--videoId--blacklist-post" class="operation panel" data-traverse-target="operation--videos--videoId--blacklist-post">
4502 <!-- <section class="operation-tags row"> -->
4503 <!-- <div class="doc-copy"> -->
4504 <div class="operation-tags">
4505 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
4510 <h2 class="operation-title">
4511 <span class="operation-name">
4512 <span class="operation-name">POST</span>
4513 <span class="operation-path">/videos/{videoId}/blacklist</span>
4516 <div class="doc-row">
4517 <div class="doc-copy">
4518 <section class="swagger-request-params">
4519 <div class="prop-row prop-group">
4520 <div class="prop-name">
4521 <div class="prop-title">videoId</div>
4522 <span class="json-property-required"></span>
4523 <div class="prop-subtitle"> in path </div>
4524 <div class="prop-subtitle">
4525 <span class="json-property-type">string</span>
4526 <span class="json-property-range" title="Value limits"></span>
4529 <div class="prop-value">
4530 <p>The video id </p>
4535 <div class="doc-examples"></div>
4537 <div class="doc-row">
4538 <div class="doc-copy">
4539 <section class="swagger-responses">
4540 <div class="prop-row prop-group">
4541 <div class="prop-name">
4542 <div class="prop-title">204 No Content</div>
4544 <div class="prop-value">
4545 <p>successful operation</p>
4550 <div class="doc-examples">
4551 <h5>Response Content-Types:
4552 <span>application/json</span>
4556 <div class="doc-row">
4557 <div class="doc-copy">
4558 <section class="swagger-request-security">
4559 <table class="table">
4562 <th class="swagger-request-security-schema"></th>
4563 <th class="swagger-request-security-scopes"></th>
4569 <a href="#security-definition-OAuth2">OAuth2</a>
4579 <div id="operation--videos--videoId--blacklist-delete" class="operation panel" data-traverse-target="operation--videos--videoId--blacklist-delete">
4580 <!-- <section class="operation-tags row"> -->
4581 <!-- <div class="doc-copy"> -->
4582 <div class="operation-tags">
4583 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
4588 <h2 class="operation-title">
4589 <span class="operation-name">
4590 <span class="operation-name">DELETE</span>
4591 <span class="operation-path">/videos/{videoId}/blacklist</span>
4594 <div class="doc-row">
4595 <div class="doc-copy">
4596 <section class="swagger-request-params">
4597 <div class="prop-row prop-group">
4598 <div class="prop-name">
4599 <div class="prop-title">videoId</div>
4600 <span class="json-property-required"></span>
4601 <div class="prop-subtitle"> in path </div>
4602 <div class="prop-subtitle">
4603 <span class="json-property-type">string</span>
4604 <span class="json-property-range" title="Value limits"></span>
4607 <div class="prop-value">
4608 <p>The video id </p>
4613 <div class="doc-examples"></div>
4615 <div class="doc-row">
4616 <div class="doc-copy">
4617 <section class="swagger-responses">
4618 <div class="prop-row prop-group">
4619 <div class="prop-name">
4620 <div class="prop-title">204 No Content</div>
4622 <div class="prop-value">
4623 <p>successful operation</p>
4628 <div class="doc-examples">
4629 <h5>Response Content-Types:
4630 <span>application/json</span>
4634 <div class="doc-row">
4635 <div class="doc-copy">
4636 <section class="swagger-request-security">
4637 <table class="table">
4640 <th class="swagger-request-security-schema"></th>
4641 <th class="swagger-request-security-scopes"></th>
4647 <a href="#security-definition-OAuth2">OAuth2</a>
4657 <div id="operation--videos-blacklist-get" class="operation panel" data-traverse-target="operation--videos-blacklist-get">
4658 <!-- <section class="operation-tags row"> -->
4659 <!-- <div class="doc-copy"> -->
4660 <div class="operation-tags">
4661 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
4666 <h2 class="operation-title">
4667 <span class="operation-name">
4668 <span class="operation-name">GET</span>
4669 <span class="operation-path">/videos/blacklist</span>
4672 <div class="doc-row">
4673 <div class="doc-copy">
4674 <section class="swagger-request-params">
4675 <div class="prop-row prop-group">
4676 <div class="prop-name">
4677 <div class="prop-title">start</div>
4678 <div class="prop-subtitle"> in query </div>
4679 <div class="prop-subtitle">
4680 <span class="json-property-type">number</span>
4681 <span class="json-property-range" title="Value limits"></span>
4684 <div class="prop-value">
4685 <p>starting page</p>
4688 <div class="prop-row prop-group">
4689 <div class="prop-name">
4690 <div class="prop-title">stop</div>
4691 <div class="prop-subtitle"> in query </div>
4692 <div class="prop-subtitle">
4693 <span class="json-property-type">number</span>
4694 <span class="json-property-range" title="Value limits"></span>
4697 <div class="prop-value">
4698 <p>stopping page</p>
4701 <div class="prop-row prop-group">
4702 <div class="prop-name">
4703 <div class="prop-title">sort</div>
4704 <div class="prop-subtitle"> in query </div>
4705 <div class="prop-subtitle">
4706 <span class="json-property-type">number</span>
4707 <span class="json-property-range" title="Value limits"></span>
4710 <div class="prop-value">
4716 <div class="doc-examples"></div>
4718 <div class="doc-row">
4719 <div class="doc-copy">
4720 <section class="swagger-responses">
4721 <div class="prop-row prop-group">
4722 <div class="prop-name">
4723 <div class="prop-title">200 OK</div>
4724 <div class="prop-ref">
4725 <span class="json-schema-ref-array">
4726 <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a>
4729 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4731 <div class="prop-value">
4732 <p>successful operation</p>
4735 <div class="prop-row prop-inner">
4736 <div class="prop-name">type</div>
4737 <div class="prop-value">
4738 <span class="json-property-type">
4739 <span class="json-schema-ref-array">
4740 <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a>
4743 <span class="json-property-range" title="Value limits"></span>
4748 <div class="doc-examples">
4749 <h5>Response Content-Types:
4750 <span>application/json</span>
4753 <h5>Response Example
4754 <span>(200 OK)</span>
4756 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
4758 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
4759 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
4760 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
4761 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
4762 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
4763 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
4764 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
4765 <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
4766 <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
4767 <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
4768 <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
4769 <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>
4777 <div class="doc-row">
4778 <div class="doc-copy">
4779 <section class="swagger-request-security">
4780 <table class="table">
4783 <th class="swagger-request-security-schema"></th>
4784 <th class="swagger-request-security-scopes"></th>
4790 <a href="#security-definition-OAuth2">OAuth2</a>
4800 <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1>
4801 <div id="operation--video-channels-get" class="operation panel" data-traverse-target="operation--video-channels-get">
4802 <!-- <section class="operation-tags row"> -->
4803 <!-- <div class="doc-copy"> -->
4804 <div class="operation-tags">
4805 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
4810 <h2 class="operation-title">
4811 <span class="operation-name">
4812 <span class="operation-name">GET</span>
4813 <span class="operation-path">/video-channels</span>
4816 <div class="doc-row">
4817 <div class="doc-copy">
4818 <section class="swagger-request-params">
4819 <div class="prop-row prop-group">
4820 <div class="prop-name">
4821 <div class="prop-title">start</div>
4822 <div class="prop-subtitle"> in query </div>
4823 <div class="prop-subtitle">
4824 <span class="json-property-type">number</span>
4825 <span class="json-property-range" title="Value limits"></span>
4828 <div class="prop-value">
4829 <p>starting page</p>
4832 <div class="prop-row prop-group">
4833 <div class="prop-name">
4834 <div class="prop-title">stop</div>
4835 <div class="prop-subtitle"> in query </div>
4836 <div class="prop-subtitle">
4837 <span class="json-property-type">number</span>
4838 <span class="json-property-range" title="Value limits"></span>
4841 <div class="prop-value">
4842 <p>stopping page</p>
4845 <div class="prop-row prop-group">
4846 <div class="prop-name">
4847 <div class="prop-title">sort</div>
4848 <div class="prop-subtitle"> in query </div>
4849 <div class="prop-subtitle">
4850 <span class="json-property-type">number</span>
4851 <span class="json-property-range" title="Value limits"></span>
4854 <div class="prop-value">
4860 <div class="doc-examples"></div>
4862 <div class="doc-row">
4863 <div class="doc-copy">
4864 <section class="swagger-responses">
4865 <div class="prop-row prop-group">
4866 <div class="prop-name">
4867 <div class="prop-title">200 OK</div>
4868 <div class="prop-ref">
4869 <span class="json-schema-ref-array">
4870 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
4873 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4875 <div class="prop-value">
4876 <p>successful operation</p>
4879 <div class="prop-row prop-inner">
4880 <div class="prop-name">type</div>
4881 <div class="prop-value">
4882 <span class="json-property-type">
4883 <span class="json-schema-ref-array">
4884 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
4887 <span class="json-property-range" title="Value limits"></span>
4892 <div class="doc-examples">
4893 <h5>Response Content-Types:
4894 <span>application/json</span>
4897 <h5>Response Example
4898 <span>(200 OK)</span>
4900 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
4902 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
4903 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
4904 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
4905 <span class="hljs-attr">"ownerAccount"</span>: {
4906 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
4907 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
4917 <div id="operation--video-channels-post" class="operation panel" data-traverse-target="operation--video-channels-post">
4918 <!-- <section class="operation-tags row"> -->
4919 <!-- <div class="doc-copy"> -->
4920 <div class="operation-tags">
4921 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
4926 <h2 class="operation-title">
4927 <span class="operation-name">
4928 <span class="operation-name">POST</span>
4929 <span class="operation-path">/video-channels</span>
4932 <div class="doc-row">
4933 <div class="doc-copy">
4934 <section class="swagger-request-body">
4935 <div class="prop-row">
4936 <div class="prop-name">
4937 <div class="swagger-request-model">
4939 <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a>
4943 <div class="prop-value columns small-6">
4944 <!-- <div class="swagger-request-description"> -->
4951 <div class="doc-examples">
4953 <h5>Request Content-Types:
4954 <span>application/json</span>
4956 <h5>Request Example</h5>
4957 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
4958 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
4959 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>
4966 <div class="doc-row">
4967 <div class="doc-copy">
4968 <section class="swagger-responses">
4969 <div class="prop-row prop-group">
4970 <div class="prop-name">
4971 <div class="prop-title">204 No Content</div>
4973 <div class="prop-value">
4974 <p>successful operation</p>
4979 <div class="doc-examples">
4980 <h5>Response Content-Types:
4981 <span>application/json</span>
4985 <div class="doc-row">
4986 <div class="doc-copy">
4987 <section class="swagger-request-security">
4988 <table class="table">
4991 <th class="swagger-request-security-schema"></th>
4992 <th class="swagger-request-security-scopes"></th>
4998 <a href="#security-definition-OAuth2">OAuth2</a>
5008 <div id="operation--video-channels--id--get" class="operation panel" data-traverse-target="operation--video-channels--id--get">
5009 <!-- <section class="operation-tags row"> -->
5010 <!-- <div class="doc-copy"> -->
5011 <div class="operation-tags">
5012 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5017 <h2 class="operation-title">
5018 <span class="operation-name">
5019 <span class="operation-name">GET</span>
5020 <span class="operation-path">/video-channels/{id}</span>
5023 <div class="doc-row">
5024 <div class="doc-copy">
5025 <section class="swagger-request-params">
5026 <div class="prop-row prop-group">
5027 <div class="prop-name">
5028 <div class="prop-title">id</div>
5029 <span class="json-property-required"></span>
5030 <div class="prop-subtitle"> in path </div>
5031 <div class="prop-subtitle">
5032 <span class="json-property-type">string</span>
5033 <span class="json-property-range" title="Value limits"></span>
5036 <div class="prop-value">
5037 <p>The video channel id </p>
5042 <div class="doc-examples"></div>
5044 <div class="doc-row">
5045 <div class="doc-copy">
5046 <section class="swagger-responses">
5047 <div class="prop-row prop-group">
5048 <div class="prop-name">
5049 <div class="prop-title">200 OK</div>
5050 <div class="prop-ref">
5052 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
5055 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5057 <div class="prop-value">
5058 <p>successful operation</p>
5063 <div class="doc-examples">
5064 <h5>Response Content-Types:
5065 <span>application/json</span>
5068 <h5>Response Example
5069 <span>(200 OK)</span>
5071 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5072 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
5073 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
5074 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
5075 <span class="hljs-attr">"ownerAccount"</span>: {
5076 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5077 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
5086 <div id="operation--video-channels--id--put" class="operation panel" data-traverse-target="operation--video-channels--id--put">
5087 <!-- <section class="operation-tags row"> -->
5088 <!-- <div class="doc-copy"> -->
5089 <div class="operation-tags">
5090 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5095 <h2 class="operation-title">
5096 <span class="operation-name">
5097 <span class="operation-name">PUT</span>
5098 <span class="operation-path">/video-channels/{id}</span>
5101 <div class="doc-row">
5102 <div class="doc-copy">
5103 <section class="swagger-request-body">
5104 <div class="prop-row">
5105 <div class="prop-name">
5106 <div class="swagger-request-model">
5108 <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a>
5112 <div class="prop-value columns small-6">
5113 <!-- <div class="swagger-request-description"> -->
5119 <section class="swagger-request-params">
5120 <div class="prop-row prop-group">
5121 <div class="prop-name">
5122 <div class="prop-title">id</div>
5123 <span class="json-property-required"></span>
5124 <div class="prop-subtitle"> in path </div>
5125 <div class="prop-subtitle">
5126 <span class="json-property-type">string</span>
5127 <span class="json-property-range" title="Value limits"></span>
5130 <div class="prop-value">
5131 <p>The video channel id </p>
5136 <div class="doc-examples">
5138 <h5>Request Content-Types:
5139 <span>application/json</span>
5141 <h5>Request Example</h5>
5142 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5143 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
5144 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>
5151 <div class="doc-row">
5152 <div class="doc-copy">
5153 <section class="swagger-responses">
5154 <div class="prop-row prop-group">
5155 <div class="prop-name">
5156 <div class="prop-title">204 No Content</div>
5158 <div class="prop-value">
5159 <p>successful operation</p>
5164 <div class="doc-examples">
5165 <h5>Response Content-Types:
5166 <span>application/json</span>
5170 <div class="doc-row">
5171 <div class="doc-copy">
5172 <section class="swagger-request-security">
5173 <table class="table">
5176 <th class="swagger-request-security-schema"></th>
5177 <th class="swagger-request-security-scopes"></th>
5183 <a href="#security-definition-OAuth2">OAuth2</a>
5193 <div id="operation--video-channels--id--delete" class="operation panel" data-traverse-target="operation--video-channels--id--delete">
5194 <!-- <section class="operation-tags row"> -->
5195 <!-- <div class="doc-copy"> -->
5196 <div class="operation-tags">
5197 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5202 <h2 class="operation-title">
5203 <span class="operation-name">
5204 <span class="operation-name">DELETE</span>
5205 <span class="operation-path">/video-channels/{id}</span>
5208 <div class="doc-row">
5209 <div class="doc-copy">
5210 <section class="swagger-request-params">
5211 <div class="prop-row prop-group">
5212 <div class="prop-name">
5213 <div class="prop-title">id</div>
5214 <span class="json-property-required"></span>
5215 <div class="prop-subtitle"> in path </div>
5216 <div class="prop-subtitle">
5217 <span class="json-property-type">string</span>
5218 <span class="json-property-range" title="Value limits"></span>
5221 <div class="prop-value">
5222 <p>The video channel id </p>
5227 <div class="doc-examples"></div>
5229 <div class="doc-row">
5230 <div class="doc-copy">
5231 <section class="swagger-responses">
5232 <div class="prop-row prop-group">
5233 <div class="prop-name">
5234 <div class="prop-title">204 No Content</div>
5236 <div class="prop-value">
5237 <p>successful operation</p>
5242 <div class="doc-examples">
5243 <h5>Response Content-Types:
5244 <span>application/json</span>
5248 <div class="doc-row">
5249 <div class="doc-copy">
5250 <section class="swagger-request-security">
5251 <table class="table">
5254 <th class="swagger-request-security-schema"></th>
5255 <th class="swagger-request-security-scopes"></th>
5261 <a href="#security-definition-OAuth2">OAuth2</a>
5271 <div id="operation--video-channels--id--videos-get" class="operation panel" data-traverse-target="operation--video-channels--id--videos-get">
5272 <!-- <section class="operation-tags row"> -->
5273 <!-- <div class="doc-copy"> -->
5274 <div class="operation-tags">
5275 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5280 <h2 class="operation-title">
5281 <span class="operation-name">
5282 <span class="operation-name">GET</span>
5283 <span class="operation-path">/video-channels/{id}/videos</span>
5286 <div class="doc-row">
5287 <div class="doc-copy">
5288 <section class="swagger-request-params">
5289 <div class="prop-row prop-group">
5290 <div class="prop-name">
5291 <div class="prop-title">id</div>
5292 <span class="json-property-required"></span>
5293 <div class="prop-subtitle"> in path </div>
5294 <div class="prop-subtitle">
5295 <span class="json-property-type">string</span>
5296 <span class="json-property-range" title="Value limits"></span>
5299 <div class="prop-value">
5300 <p>The video channel id </p>
5305 <div class="doc-examples"></div>
5307 <div class="doc-row">
5308 <div class="doc-copy">
5309 <section class="swagger-responses">
5310 <div class="prop-row prop-group">
5311 <div class="prop-name">
5312 <div class="prop-title">200 OK</div>
5313 <div class="prop-ref">
5315 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
5318 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5320 <div class="prop-value">
5321 <p>successful operation</p>
5326 <div class="doc-examples">
5327 <h5>Response Content-Types:
5328 <span>application/json</span>
5331 <h5>Response Example
5332 <span>(200 OK)</span>
5334 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5335 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5336 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
5337 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5338 <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
5339 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
5340 <span class="hljs-attr">"category"</span>: {
5341 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5342 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
5344 <span class="hljs-attr">"licence"</span>: {
5345 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5346 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
5348 <span class="hljs-attr">"language"</span>: {
5349 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
5350 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
5352 <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
5353 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
5354 <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
5355 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
5356 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
5357 <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
5358 <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
5359 <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
5360 <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
5361 <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
5362 <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
5363 <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
5364 <span class="hljs-attr">"account"</span>: {
5365 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
5366 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
5367 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
5368 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
5369 <span class="hljs-attr">"avatar"</span>: {
5370 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
5371 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5372 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
5382 <div id="operation--accounts--name--video-channels-get" class="operation panel" data-traverse-target="operation--accounts--name--video-channels-get">
5383 <!-- <section class="operation-tags row"> -->
5384 <!-- <div class="doc-copy"> -->
5385 <div class="operation-tags">
5386 <a class="label" href="#tag-VideoChannel">VideoChannel</a>
5391 <h2 class="operation-title">
5392 <span class="operation-name">
5393 <span class="operation-name">GET</span>
5394 <span class="operation-path">/accounts/{name}/video-channels</span>
5397 <div class="doc-row">
5398 <div class="doc-copy">
5399 <section class="swagger-request-params">
5400 <div class="prop-row prop-group">
5401 <div class="prop-name">
5402 <div class="prop-title">name</div>
5403 <span class="json-property-required"></span>
5404 <div class="prop-subtitle"> in path </div>
5405 <div class="prop-subtitle">
5406 <span class="json-property-type">string</span>
5407 <span class="json-property-range" title="Value limits"></span>
5410 <div class="prop-value">
5411 <p>The name of the account (chocobozzz or
5412 <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p>
5417 <div class="doc-examples"></div>
5419 <div class="doc-row">
5420 <div class="doc-copy">
5421 <section class="swagger-responses">
5422 <div class="prop-row prop-group">
5423 <div class="prop-name">
5424 <div class="prop-title">200 OK</div>
5425 <div class="prop-ref">
5426 <span class="json-schema-ref-array">
5427 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
5430 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5432 <div class="prop-value">
5433 <p>successful operation</p>
5436 <div class="prop-row prop-inner">
5437 <div class="prop-name">type</div>
5438 <div class="prop-value">
5439 <span class="json-property-type">
5440 <span class="json-schema-ref-array">
5441 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
5444 <span class="json-property-range" title="Value limits"></span>
5449 <div class="doc-examples">
5450 <h5>Response Content-Types:
5451 <span>application/json</span>
5454 <h5>Response Example
5455 <span>(200 OK)</span>
5457 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
5459 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
5460 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
5461 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
5462 <span class="hljs-attr">"ownerAccount"</span>: {
5463 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5464 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
5474 <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1>
5475 <div id="operation--videos--videoId--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-get">
5476 <!-- <section class="operation-tags row"> -->
5477 <!-- <div class="doc-copy"> -->
5478 <div class="operation-tags">
5479 <a class="label" href="#tag-VideoComment">VideoComment</a>
5484 <h2 class="operation-title">
5485 <span class="operation-name">
5486 <span class="operation-name">GET</span>
5487 <span class="operation-path">/videos/{videoId}/comment-threads</span>
5490 <div class="doc-row">
5491 <div class="doc-copy">
5492 <section class="swagger-request-params">
5493 <div class="prop-row prop-group">
5494 <div class="prop-name">
5495 <div class="prop-title">videoId</div>
5496 <span class="json-property-required"></span>
5497 <div class="prop-subtitle"> in path </div>
5498 <div class="prop-subtitle">
5499 <span class="json-property-type">string</span>
5500 <span class="json-property-range" title="Value limits"></span>
5503 <div class="prop-value">
5504 <p>The video id </p>
5507 <div class="prop-row prop-group">
5508 <div class="prop-name">
5509 <div class="prop-title">start</div>
5510 <div class="prop-subtitle"> in query </div>
5511 <div class="prop-subtitle">
5512 <span class="json-property-type">number</span>
5513 <span class="json-property-range" title="Value limits"></span>
5516 <div class="prop-value">
5517 <p>starting page</p>
5520 <div class="prop-row prop-group">
5521 <div class="prop-name">
5522 <div class="prop-title">stop</div>
5523 <div class="prop-subtitle"> in query </div>
5524 <div class="prop-subtitle">
5525 <span class="json-property-type">number</span>
5526 <span class="json-property-range" title="Value limits"></span>
5529 <div class="prop-value">
5530 <p>stopping page</p>
5533 <div class="prop-row prop-group">
5534 <div class="prop-name">
5535 <div class="prop-title">sort</div>
5536 <div class="prop-subtitle"> in query </div>
5537 <div class="prop-subtitle">
5538 <span class="json-property-type">number</span>
5539 <span class="json-property-range" title="Value limits"></span>
5542 <div class="prop-value">
5548 <div class="doc-examples"></div>
5550 <div class="doc-row">
5551 <div class="doc-copy">
5552 <section class="swagger-responses">
5553 <div class="prop-row prop-group">
5554 <div class="prop-name">
5555 <div class="prop-title">200 OK</div>
5556 <div class="prop-ref">
5558 <a class="json-schema-ref" href="#/definitions/CommentThreadResponse">CommentThreadResponse</a>
5561 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5563 <div class="prop-value">
5564 <p>successful operation</p>
5569 <div class="doc-examples">
5570 <h5>Response Content-Types:
5571 <span>application/json</span>
5574 <h5>Response Example
5575 <span>(200 OK)</span>
5577 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5578 <span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>,
5579 <span class="hljs-attr">"data"</span>: [
5581 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5582 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
5583 <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
5584 <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
5585 <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
5586 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
5587 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5588 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
5589 <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
5590 <span class="hljs-attr">"account"</span>: {
5591 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
5592 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5593 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
5594 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
5595 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
5596 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
5597 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
5598 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
5599 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5600 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
5601 <span class="hljs-attr">"avatar"</span>: {
5602 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
5603 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5604 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
5616 <div id="operation--videos--videoId--comment-threads-post" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-post">
5617 <!-- <section class="operation-tags row"> -->
5618 <!-- <div class="doc-copy"> -->
5619 <div class="operation-tags">
5620 <a class="label" href="#tag-VideoComment">VideoComment</a>
5625 <h2 class="operation-title">
5626 <span class="operation-name">
5627 <span class="operation-name">POST</span>
5628 <span class="operation-path">/videos/{videoId}/comment-threads</span>
5631 <div class="doc-row">
5632 <div class="doc-copy">
5633 <section class="swagger-request-params">
5634 <div class="prop-row prop-group">
5635 <div class="prop-name">
5636 <div class="prop-title">videoId</div>
5637 <span class="json-property-required"></span>
5638 <div class="prop-subtitle"> in path </div>
5639 <div class="prop-subtitle">
5640 <span class="json-property-type">string</span>
5641 <span class="json-property-range" title="Value limits"></span>
5644 <div class="prop-value">
5645 <p>The video id </p>
5650 <div class="doc-examples"></div>
5652 <div class="doc-row">
5653 <div class="doc-copy">
5654 <section class="swagger-responses">
5655 <div class="prop-row prop-group">
5656 <div class="prop-name">
5657 <div class="prop-title">200 OK</div>
5658 <div class="prop-ref">
5660 <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a>
5663 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5665 <div class="prop-value">
5666 <p>successful operation</p>
5671 <div class="doc-examples">
5672 <h5>Response Content-Types:
5673 <span>application/json</span>
5676 <h5>Response Example
5677 <span>(200 OK)</span>
5679 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5680 <span class="hljs-attr">"comment"</span>: {
5681 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5682 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
5683 <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
5684 <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
5685 <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
5686 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
5687 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5688 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
5689 <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
5690 <span class="hljs-attr">"account"</span>: {
5691 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
5692 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5693 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
5694 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
5695 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
5696 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
5697 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
5698 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
5699 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5700 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
5701 <span class="hljs-attr">"avatar"</span>: {
5702 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
5703 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5704 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
5714 <div class="doc-row">
5715 <div class="doc-copy">
5716 <section class="swagger-request-security">
5717 <table class="table">
5720 <th class="swagger-request-security-schema"></th>
5721 <th class="swagger-request-security-scopes"></th>
5727 <a href="#security-definition-OAuth2">OAuth2</a>
5737 <div id="operation--videos--videoId--comment-threads--threadId--get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads--threadId--get">
5738 <!-- <section class="operation-tags row"> -->
5739 <!-- <div class="doc-copy"> -->
5740 <div class="operation-tags">
5741 <a class="label" href="#tag-VideoComment">VideoComment</a>
5746 <h2 class="operation-title">
5747 <span class="operation-name">
5748 <span class="operation-name">GET</span>
5749 <span class="operation-path">/videos/{videoId}/comment-threads/{threadId}</span>
5752 <div class="doc-row">
5753 <div class="doc-copy">
5754 <section class="swagger-request-params">
5755 <div class="prop-row prop-group">
5756 <div class="prop-name">
5757 <div class="prop-title">videoId</div>
5758 <span class="json-property-required"></span>
5759 <div class="prop-subtitle"> in path </div>
5760 <div class="prop-subtitle">
5761 <span class="json-property-type">string</span>
5762 <span class="json-property-range" title="Value limits"></span>
5765 <div class="prop-value">
5766 <p>The video id </p>
5769 <div class="prop-row prop-group">
5770 <div class="prop-name">
5771 <div class="prop-title">threadId</div>
5772 <span class="json-property-required"></span>
5773 <div class="prop-subtitle"> in path </div>
5774 <div class="prop-subtitle">
5775 <span class="json-property-type">string</span>
5776 <span class="json-property-range" title="Value limits"></span>
5779 <div class="prop-value">
5780 <p>The thread id </p>
5785 <div class="doc-examples"></div>
5787 <div class="doc-row">
5788 <div class="doc-copy">
5789 <section class="swagger-responses">
5790 <div class="prop-row prop-group">
5791 <div class="prop-name">
5792 <div class="prop-title">200 OK</div>
5793 <div class="prop-ref">
5795 <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
5798 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5800 <div class="prop-value">
5801 <p>successful operation</p>
5806 <div class="doc-examples">
5807 <h5>Response Content-Types:
5808 <span>application/json</span>
5811 <h5>Response Example
5812 <span>(200 OK)</span>
5814 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5815 <span class="hljs-attr">"comment"</span>: {
5816 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5817 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
5818 <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
5819 <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
5820 <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
5821 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
5822 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5823 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
5824 <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
5825 <span class="hljs-attr">"account"</span>: {
5826 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
5827 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5828 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
5829 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
5830 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
5831 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
5832 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
5833 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
5834 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5835 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
5836 <span class="hljs-attr">"avatar"</span>: {
5837 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
5838 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5839 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
5843 <span class="hljs-attr">"children"</span>: [
5845 <span class="hljs-attr">"comment"</span>: {
5846 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5847 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
5848 <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
5849 <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
5850 <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
5851 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
5852 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5853 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
5854 <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
5855 <span class="hljs-attr">"account"</span>: {
5856 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
5857 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5858 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
5859 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
5860 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
5861 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
5862 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
5863 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
5864 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5865 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
5866 <span class="hljs-attr">"avatar"</span>: {
5867 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
5868 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5869 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
5873 <span class="hljs-attr">"children"</span>: [
5875 <span class="hljs-attr">"comment"</span>: {
5876 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5877 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
5878 <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
5879 <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
5880 <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
5881 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
5882 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5883 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
5884 <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
5885 <span class="hljs-attr">"account"</span>: {
5886 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5887 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
5888 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
5889 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
5890 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
5891 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
5892 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
5893 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5894 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
5895 <span class="hljs-attr">"avatar"</span>: {
5896 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
5897 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5898 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
5913 <div id="operation--videos--videoId--comments--commentId--post" class="operation panel" data-traverse-target="operation--videos--videoId--comments--commentId--post">
5914 <!-- <section class="operation-tags row"> -->
5915 <!-- <div class="doc-copy"> -->
5916 <div class="operation-tags">
5917 <a class="label" href="#tag-VideoComment">VideoComment</a>
5922 <h2 class="operation-title">
5923 <span class="operation-name">
5924 <span class="operation-name">POST</span>
5925 <span class="operation-path">/videos/{videoId}/comments/{commentId}</span>
5928 <div class="doc-row">
5929 <div class="doc-copy">
5930 <section class="swagger-request-params">
5931 <div class="prop-row prop-group">
5932 <div class="prop-name">
5933 <div class="prop-title">videoId</div>
5934 <span class="json-property-required"></span>
5935 <div class="prop-subtitle"> in path </div>
5936 <div class="prop-subtitle">
5937 <span class="json-property-type">string</span>
5938 <span class="json-property-range" title="Value limits"></span>
5941 <div class="prop-value">
5942 <p>The video id </p>
5945 <div class="prop-row prop-group">
5946 <div class="prop-name">
5947 <div class="prop-title">commentId</div>
5948 <span class="json-property-required"></span>
5949 <div class="prop-subtitle"> in path </div>
5950 <div class="prop-subtitle">
5951 <span class="json-property-type">string</span>
5952 <span class="json-property-range" title="Value limits"></span>
5955 <div class="prop-value">
5956 <p>The comment id </p>
5961 <div class="doc-examples"></div>
5963 <div class="doc-row">
5964 <div class="doc-copy">
5965 <section class="swagger-responses">
5966 <div class="prop-row prop-group">
5967 <div class="prop-name">
5968 <div class="prop-title">200 OK</div>
5969 <div class="prop-ref">
5971 <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a>
5974 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5976 <div class="prop-value">
5977 <p>successful operation</p>
5982 <div class="doc-examples">
5983 <h5>Response Content-Types:
5984 <span>application/json</span>
5987 <h5>Response Example
5988 <span>(200 OK)</span>
5990 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5991 <span class="hljs-attr">"comment"</span>: {
5992 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
5993 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
5994 <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
5995 <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
5996 <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
5997 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
5998 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
5999 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
6000 <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
6001 <span class="hljs-attr">"account"</span>: {
6002 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
6003 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6004 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
6005 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
6006 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
6007 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
6008 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
6009 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
6010 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
6011 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
6012 <span class="hljs-attr">"avatar"</span>: {
6013 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
6014 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
6015 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
6025 <div class="doc-row">
6026 <div class="doc-copy">
6027 <section class="swagger-request-security">
6028 <table class="table">
6031 <th class="swagger-request-security-schema"></th>
6032 <th class="swagger-request-security-scopes"></th>
6038 <a href="#security-definition-OAuth2">OAuth2</a>
6048 <div id="operation--videos--videoId--comments--commentId--delete" class="operation panel" data-traverse-target="operation--videos--videoId--comments--commentId--delete">
6049 <!-- <section class="operation-tags row"> -->
6050 <!-- <div class="doc-copy"> -->
6051 <div class="operation-tags">
6052 <a class="label" href="#tag-VideoComment">VideoComment</a>
6057 <h2 class="operation-title">
6058 <span class="operation-name">
6059 <span class="operation-name">DELETE</span>
6060 <span class="operation-path">/videos/{videoId}/comments/{commentId}</span>
6063 <div class="doc-row">
6064 <div class="doc-copy">
6065 <section class="swagger-request-params">
6066 <div class="prop-row prop-group">
6067 <div class="prop-name">
6068 <div class="prop-title">videoId</div>
6069 <span class="json-property-required"></span>
6070 <div class="prop-subtitle"> in path </div>
6071 <div class="prop-subtitle">
6072 <span class="json-property-type">string</span>
6073 <span class="json-property-range" title="Value limits"></span>
6076 <div class="prop-value">
6077 <p>The video id </p>
6080 <div class="prop-row prop-group">
6081 <div class="prop-name">
6082 <div class="prop-title">commentId</div>
6083 <span class="json-property-required"></span>
6084 <div class="prop-subtitle"> in path </div>
6085 <div class="prop-subtitle">
6086 <span class="json-property-type">string</span>
6087 <span class="json-property-range" title="Value limits"></span>
6090 <div class="prop-value">
6091 <p>The comment id </p>
6096 <div class="doc-examples"></div>
6098 <div class="doc-row">
6099 <div class="doc-copy">
6100 <section class="swagger-responses">
6101 <div class="prop-row prop-group">
6102 <div class="prop-name">
6103 <div class="prop-title">204 No Content</div>
6105 <div class="prop-value">
6106 <p>successful operation</p>
6111 <div class="doc-examples">
6112 <h5>Response Content-Types:
6113 <span>application/json</span>
6117 <div class="doc-row">
6118 <div class="doc-copy">
6119 <section class="swagger-request-security">
6120 <table class="table">
6123 <th class="swagger-request-security-schema"></th>
6124 <th class="swagger-request-security-scopes"></th>
6130 <a href="#security-definition-OAuth2">OAuth2</a>
6140 <h1 id="tag-VideoRate" class="swagger-summary-tag" data-traverse-target="tag-VideoRate">VideoRate</h1>
6141 <div id="operation--videos--id--rate-put" class="operation panel" data-traverse-target="operation--videos--id--rate-put">
6142 <!-- <section class="operation-tags row"> -->
6143 <!-- <div class="doc-copy"> -->
6144 <div class="operation-tags">
6145 <a class="label" href="#tag-VideoRate">VideoRate</a>
6150 <h2 class="operation-title">
6151 <span class="operation-name">
6152 <span class="operation-name">PUT</span>
6153 <span class="operation-path">/videos/{id}/rate</span>
6156 <div class="doc-row">
6157 <div class="doc-copy">
6158 <section class="swagger-request-params">
6159 <div class="prop-row prop-group">
6160 <div class="prop-name">
6161 <div class="prop-title">id</div>
6162 <span class="json-property-required"></span>
6163 <div class="prop-subtitle"> in path </div>
6164 <div class="prop-subtitle">
6165 <span class="json-property-type">string</span>
6166 <span class="json-property-range" title="Value limits"></span>
6169 <div class="prop-value">
6170 <p>The video id </p>
6175 <div class="doc-examples"></div>
6177 <div class="doc-row">
6178 <div class="doc-copy">
6179 <section class="swagger-responses">
6180 <div class="prop-row prop-group">
6181 <div class="prop-name">
6182 <div class="prop-title">204 No Content</div>
6184 <div class="prop-value">
6185 <p>successful operation</p>
6190 <div class="doc-examples">
6191 <h5>Response Content-Types:
6192 <span>application/json</span>
6196 <div class="doc-row">
6197 <div class="doc-copy">
6198 <section class="swagger-request-security">
6199 <table class="table">
6202 <th class="swagger-request-security-schema"></th>
6203 <th class="swagger-request-security-scopes"></th>
6209 <a href="#security-definition-OAuth2">OAuth2</a>
6219 <h1>Schema Definitions</h1>
6220 <div id="definition-VideoConstantNumber" class="definition panel" data-traverse-target="definition-VideoConstantNumber">
6221 <h2 class="panel-title">
6222 <a name="/definitions/VideoConstantNumber"></a>VideoConstantNumber:
6223 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6224 <span class="json-property-range" title="Value limits"></span>
6229 <div class="doc-row">
6230 <div class="doc-copy">
6231 <section class="json-schema-properties">
6233 <dt data-property-name="id">
6234 <span class="json-property-name">id:</span>
6235 <span class="json-property-type">number</span>
6236 <span class="json-property-range" title="Value limits"></span>
6238 <dt data-property-name="label">
6239 <span class="json-property-name">label:</span>
6240 <span class="json-property-type">string</span>
6241 <span class="json-property-range" title="Value limits"></span>
6246 <div class="doc-examples">
6249 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6250 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6251 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
6259 <div id="definition-VideoConstantString" class="definition panel" data-traverse-target="definition-VideoConstantString">
6260 <h2 class="panel-title">
6261 <a name="/definitions/VideoConstantString"></a>VideoConstantString:
6262 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6263 <span class="json-property-range" title="Value limits"></span>
6268 <div class="doc-row">
6269 <div class="doc-copy">
6270 <section class="json-schema-properties">
6272 <dt data-property-name="id">
6273 <span class="json-property-name">id:</span>
6274 <span class="json-property-type">string</span>
6275 <span class="json-property-range" title="Value limits"></span>
6277 <dt data-property-name="label">
6278 <span class="json-property-name">label:</span>
6279 <span class="json-property-type">string</span>
6280 <span class="json-property-range" title="Value limits"></span>
6285 <div class="doc-examples">
6288 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6289 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
6290 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
6298 <div id="definition-VideoPrivacy" class="definition panel" data-traverse-target="definition-VideoPrivacy">
6299 <h2 class="panel-title">
6300 <a name="/definitions/VideoPrivacy"></a>VideoPrivacy: string
6301 <!-- <span class="json-property-type"><span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values">
6302 <span class="json-property-enum-item">Public</span>,
6303 <span class="json-property-enum-item">Unlisted</span>,
6304 <span class="json-property-enum-item">Private</span>
6306 <span class="json-property-range" title="Value limits"></span>
6311 <div class="doc-row">
6312 <div class="doc-copy">
6313 <span class="json-property-type">string</span>
6314 <span class="json-property-enum" title="Possible values">
6315 <span class="json-property-enum-item">Public</span>,
6316 <span class="json-property-enum-item">Unlisted</span>,
6317 <span class="json-property-enum-item">Private</span>
6319 <span class="json-property-range" title="Value limits"></span>
6323 <div id="definition-Video" class="definition panel" data-traverse-target="definition-Video">
6324 <h2 class="panel-title">
6325 <a name="/definitions/Video"></a>Video:
6326 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6327 <span class="json-property-range" title="Value limits"></span>
6332 <div class="doc-row">
6333 <div class="doc-copy">
6334 <section class="json-schema-properties">
6336 <dt data-property-name="id">
6337 <span class="json-property-name">id:</span>
6338 <span class="json-property-type">number</span>
6339 <span class="json-property-range" title="Value limits"></span>
6341 <dt data-property-name="uuid">
6342 <span class="json-property-name">uuid:</span>
6343 <span class="json-property-type">string</span>
6344 <span class="json-property-range" title="Value limits"></span>
6346 <dt data-property-name="createdAt">
6347 <span class="json-property-name">createdAt:</span>
6348 <span class="json-property-type">string</span>
6349 <span class="json-property-range" title="Value limits"></span>
6351 <dt data-property-name="publishedAt">
6352 <span class="json-property-name">publishedAt:</span>
6353 <span class="json-property-type">string</span>
6354 <span class="json-property-range" title="Value limits"></span>
6356 <dt data-property-name="updatedAt">
6357 <span class="json-property-name">updatedAt:</span>
6358 <span class="json-property-type">string</span>
6359 <span class="json-property-range" title="Value limits"></span>
6361 <dt data-property-name="category">
6362 <span class="json-property-name">category:</span>
6363 <span class="json-property-type">
6365 <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a>
6368 <span class="json-property-range" title="Value limits"></span>
6370 <dt data-property-name="licence">
6371 <span class="json-property-name">licence:</span>
6372 <span class="json-property-type">
6374 <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a>
6377 <span class="json-property-range" title="Value limits"></span>
6379 <dt data-property-name="language">
6380 <span class="json-property-name">language:</span>
6381 <span class="json-property-type">
6383 <a class="json-schema-ref" href="#/definitions/VideoConstantString">VideoConstantString</a>
6386 <span class="json-property-range" title="Value limits"></span>
6388 <dt data-property-name="privacy">
6389 <span class="json-property-name">privacy:</span>
6390 <span class="json-property-type">
6392 <a class="json-schema-ref" href="#/definitions/VideoPrivacy">VideoPrivacy</a>
6395 <span class="json-property-range" title="Value limits"></span>
6397 <dt data-property-name="description">
6398 <span class="json-property-name">description:</span>
6399 <span class="json-property-type">string</span>
6400 <span class="json-property-range" title="Value limits"></span>
6402 <dt data-property-name="duration">
6403 <span class="json-property-name">duration:</span>
6404 <span class="json-property-type">number</span>
6405 <span class="json-property-range" title="Value limits"></span>
6407 <dt data-property-name="isLocal">
6408 <span class="json-property-name">isLocal:</span>
6409 <span class="json-property-type">boolean</span>
6410 <span class="json-property-range" title="Value limits"></span>
6412 <dt data-property-name="name">
6413 <span class="json-property-name">name:</span>
6414 <span class="json-property-type">string</span>
6415 <span class="json-property-range" title="Value limits"></span>
6417 <dt data-property-name="thumbnailPath">
6418 <span class="json-property-name">thumbnailPath:</span>
6419 <span class="json-property-type">string</span>
6420 <span class="json-property-range" title="Value limits"></span>
6422 <dt data-property-name="previewPath">
6423 <span class="json-property-name">previewPath:</span>
6424 <span class="json-property-type">string</span>
6425 <span class="json-property-range" title="Value limits"></span>
6427 <dt data-property-name="embedPath">
6428 <span class="json-property-name">embedPath:</span>
6429 <span class="json-property-type">string</span>
6430 <span class="json-property-range" title="Value limits"></span>
6432 <dt data-property-name="views">
6433 <span class="json-property-name">views:</span>
6434 <span class="json-property-type">number</span>
6435 <span class="json-property-range" title="Value limits"></span>
6437 <dt data-property-name="likes">
6438 <span class="json-property-name">likes:</span>
6439 <span class="json-property-type">number</span>
6440 <span class="json-property-range" title="Value limits"></span>
6442 <dt data-property-name="dislikes">
6443 <span class="json-property-name">dislikes:</span>
6444 <span class="json-property-type">number</span>
6445 <span class="json-property-range" title="Value limits"></span>
6447 <dt data-property-name="nsfw">
6448 <span class="json-property-name">nsfw:</span>
6449 <span class="json-property-type">boolean</span>
6450 <span class="json-property-range" title="Value limits"></span>
6452 <dt data-property-name="account">
6453 <span class="json-property-name">account:</span>
6454 <span class="json-property-type">object</span>
6455 <span class="json-property-range" title="Value limits"></span>
6457 <dt class="json-inner-schema">
6458 <section class="json-schema-properties">
6460 <dt data-property-name="name">
6461 <span class="json-property-name">name:</span>
6462 <span class="json-property-type">string</span>
6463 <span class="json-property-range" title="Value limits"></span>
6465 <dt data-property-name="displayName">
6466 <span class="json-property-name">displayName:</span>
6467 <span class="json-property-type">string</span>
6468 <span class="json-property-range" title="Value limits"></span>
6470 <dt data-property-name="url">
6471 <span class="json-property-name">url:</span>
6472 <span class="json-property-type">string</span>
6473 <span class="json-property-range" title="Value limits"></span>
6475 <dt data-property-name="host">
6476 <span class="json-property-name">host:</span>
6477 <span class="json-property-type">string</span>
6478 <span class="json-property-range" title="Value limits"></span>
6480 <dt data-property-name="avatar">
6481 <span class="json-property-name">avatar:</span>
6482 <span class="json-property-type">
6484 <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
6487 <span class="json-property-range" title="Value limits"></span>
6495 <div class="doc-examples">
6498 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6499 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6500 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
6501 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
6502 <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
6503 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
6504 <span class="hljs-attr">"category"</span>: {
6505 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6506 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
6508 <span class="hljs-attr">"licence"</span>: {
6509 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6510 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
6512 <span class="hljs-attr">"language"</span>: {
6513 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
6514 <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
6516 <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
6517 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
6518 <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
6519 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
6520 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
6521 <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
6522 <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
6523 <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
6524 <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
6525 <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
6526 <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
6527 <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
6528 <span class="hljs-attr">"account"</span>: {
6529 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
6530 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
6531 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
6532 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
6533 <span class="hljs-attr">"avatar"</span>: {
6534 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
6535 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
6536 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
6546 <div id="definition-VideoAbuse" class="definition panel" data-traverse-target="definition-VideoAbuse">
6547 <h2 class="panel-title">
6548 <a name="/definitions/VideoAbuse"></a>VideoAbuse:
6549 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6550 <span class="json-property-range" title="Value limits"></span>
6555 <div class="doc-row">
6556 <div class="doc-copy">
6557 <section class="json-schema-properties">
6559 <dt data-property-name="id">
6560 <span class="json-property-name">id:</span>
6561 <span class="json-property-type">number</span>
6562 <span class="json-property-range" title="Value limits"></span>
6564 <dt data-property-name="reason">
6565 <span class="json-property-name">reason:</span>
6566 <span class="json-property-type">string</span>
6567 <span class="json-property-range" title="Value limits"></span>
6569 <dt data-property-name="reporterAccount">
6570 <span class="json-property-name">reporterAccount:</span>
6571 <span class="json-property-type">
6573 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
6576 <span class="json-property-range" title="Value limits"></span>
6578 <dt data-property-name="video">
6579 <span class="json-property-name">video:</span>
6580 <span class="json-property-type">object</span>
6581 <span class="json-property-range" title="Value limits"></span>
6583 <dt class="json-inner-schema">
6584 <section class="json-schema-properties">
6586 <dt data-property-name="id">
6587 <span class="json-property-name">id:</span>
6588 <span class="json-property-type">number</span>
6589 <span class="json-property-range" title="Value limits"></span>
6591 <dt data-property-name="name">
6592 <span class="json-property-name">name:</span>
6593 <span class="json-property-type">string</span>
6594 <span class="json-property-range" title="Value limits"></span>
6596 <dt data-property-name="uuid">
6597 <span class="json-property-name">uuid:</span>
6598 <span class="json-property-type">string</span>
6599 <span class="json-property-range" title="Value limits"></span>
6601 <dt data-property-name="url">
6602 <span class="json-property-name">url:</span>
6603 <span class="json-property-type">string</span>
6604 <span class="json-property-range" title="Value limits"></span>
6609 <dt data-property-name="createdAt">
6610 <span class="json-property-name">createdAt:</span>
6611 <span class="json-property-type">string</span>
6612 <span class="json-property-range" title="Value limits"></span>
6617 <div class="doc-examples">
6620 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6621 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6622 <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>,
6623 <span class="hljs-attr">"reporterAccount"</span>: {
6624 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
6625 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6626 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
6627 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
6628 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
6629 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
6630 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
6631 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
6632 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
6633 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
6634 <span class="hljs-attr">"avatar"</span>: {
6635 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
6636 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
6637 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
6640 <span class="hljs-attr">"video"</span>: {
6641 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6642 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
6643 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
6644 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>
6646 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>
6654 <div id="definition-VideoBlacklist" class="definition panel" data-traverse-target="definition-VideoBlacklist">
6655 <h2 class="panel-title">
6656 <a name="/definitions/VideoBlacklist"></a>VideoBlacklist:
6657 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6658 <span class="json-property-range" title="Value limits"></span>
6663 <div class="doc-row">
6664 <div class="doc-copy">
6665 <section class="json-schema-properties">
6667 <dt data-property-name="id">
6668 <span class="json-property-name">id:</span>
6669 <span class="json-property-type">number</span>
6670 <span class="json-property-range" title="Value limits"></span>
6672 <dt data-property-name="videoId">
6673 <span class="json-property-name">videoId:</span>
6674 <span class="json-property-type">number</span>
6675 <span class="json-property-range" title="Value limits"></span>
6677 <dt data-property-name="createdAt">
6678 <span class="json-property-name">createdAt:</span>
6679 <span class="json-property-type">string</span>
6680 <span class="json-property-range" title="Value limits"></span>
6682 <dt data-property-name="updatedAt">
6683 <span class="json-property-name">updatedAt:</span>
6684 <span class="json-property-type">string</span>
6685 <span class="json-property-range" title="Value limits"></span>
6687 <dt data-property-name="name">
6688 <span class="json-property-name">name:</span>
6689 <span class="json-property-type">string</span>
6690 <span class="json-property-range" title="Value limits"></span>
6692 <dt data-property-name="uuid">
6693 <span class="json-property-name">uuid:</span>
6694 <span class="json-property-type">string</span>
6695 <span class="json-property-range" title="Value limits"></span>
6697 <dt data-property-name="description">
6698 <span class="json-property-name">description:</span>
6699 <span class="json-property-type">string</span>
6700 <span class="json-property-range" title="Value limits"></span>
6702 <dt data-property-name="duration">
6703 <span class="json-property-name">duration:</span>
6704 <span class="json-property-type">number</span>
6705 <span class="json-property-range" title="Value limits"></span>
6707 <dt data-property-name="views">
6708 <span class="json-property-name">views:</span>
6709 <span class="json-property-type">number</span>
6710 <span class="json-property-range" title="Value limits"></span>
6712 <dt data-property-name="likes">
6713 <span class="json-property-name">likes:</span>
6714 <span class="json-property-type">number</span>
6715 <span class="json-property-range" title="Value limits"></span>
6717 <dt data-property-name="dislikes">
6718 <span class="json-property-name">dislikes:</span>
6719 <span class="json-property-type">number</span>
6720 <span class="json-property-range" title="Value limits"></span>
6722 <dt data-property-name="nsfw">
6723 <span class="json-property-name">nsfw:</span>
6724 <span class="json-property-type">boolean</span>
6725 <span class="json-property-range" title="Value limits"></span>
6730 <div class="doc-examples">
6733 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6734 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6735 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
6736 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
6737 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
6738 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
6739 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
6740 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
6741 <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
6742 <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
6743 <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
6744 <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
6745 <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>
6753 <div id="definition-VideoChannel" class="definition panel" data-traverse-target="definition-VideoChannel">
6754 <h2 class="panel-title">
6755 <a name="/definitions/VideoChannel"></a>VideoChannel:
6756 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6757 <span class="json-property-range" title="Value limits"></span>
6762 <div class="doc-row">
6763 <div class="doc-copy">
6764 <section class="json-schema-properties">
6766 <dt data-property-name="displayName">
6767 <span class="json-property-name">displayName:</span>
6768 <span class="json-property-type">string</span>
6769 <span class="json-property-range" title="Value limits"></span>
6771 <dt data-property-name="description">
6772 <span class="json-property-name">description:</span>
6773 <span class="json-property-type">string</span>
6774 <span class="json-property-range" title="Value limits"></span>
6776 <dt data-property-name="isLocal">
6777 <span class="json-property-name">isLocal:</span>
6778 <span class="json-property-type">boolean</span>
6779 <span class="json-property-range" title="Value limits"></span>
6781 <dt data-property-name="ownerAccount">
6782 <span class="json-property-name">ownerAccount:</span>
6783 <span class="json-property-type">object</span>
6784 <span class="json-property-range" title="Value limits"></span>
6786 <dt class="json-inner-schema">
6787 <section class="json-schema-properties">
6789 <dt data-property-name="id">
6790 <span class="json-property-name">id:</span>
6791 <span class="json-property-type">number</span>
6792 <span class="json-property-range" title="Value limits"></span>
6794 <dt data-property-name="uuid">
6795 <span class="json-property-name">uuid:</span>
6796 <span class="json-property-type">string</span>
6797 <span class="json-property-range" title="Value limits"></span>
6805 <div class="doc-examples">
6808 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6809 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
6810 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
6811 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
6812 <span class="hljs-attr">"ownerAccount"</span>: {
6813 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6814 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
6823 <div id="definition-VideoComment" class="definition panel" data-traverse-target="definition-VideoComment">
6824 <h2 class="panel-title">
6825 <a name="/definitions/VideoComment"></a>VideoComment:
6826 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6827 <span class="json-property-range" title="Value limits"></span>
6832 <div class="doc-row">
6833 <div class="doc-copy">
6834 <section class="json-schema-properties">
6836 <dt data-property-name="id">
6837 <span class="json-property-name">id:</span>
6838 <span class="json-property-type">number</span>
6839 <span class="json-property-range" title="Value limits"></span>
6841 <dt data-property-name="url">
6842 <span class="json-property-name">url:</span>
6843 <span class="json-property-type">string</span>
6844 <span class="json-property-range" title="Value limits"></span>
6846 <dt data-property-name="text">
6847 <span class="json-property-name">text:</span>
6848 <span class="json-property-type">string</span>
6849 <span class="json-property-range" title="Value limits"></span>
6851 <dt data-property-name="threadId">
6852 <span class="json-property-name">threadId:</span>
6853 <span class="json-property-type">number</span>
6854 <span class="json-property-range" title="Value limits"></span>
6856 <dt data-property-name="inReplyToCommentId">
6857 <span class="json-property-name">inReplyToCommentId:</span>
6858 <span class="json-property-type">number</span>
6859 <span class="json-property-range" title="Value limits"></span>
6861 <dt data-property-name="videoId">
6862 <span class="json-property-name">videoId:</span>
6863 <span class="json-property-type">number</span>
6864 <span class="json-property-range" title="Value limits"></span>
6866 <dt data-property-name="createdAt">
6867 <span class="json-property-name">createdAt:</span>
6868 <span class="json-property-type">string</span>
6869 <span class="json-property-range" title="Value limits"></span>
6871 <dt data-property-name="updatedAt">
6872 <span class="json-property-name">updatedAt:</span>
6873 <span class="json-property-type">string</span>
6874 <span class="json-property-range" title="Value limits"></span>
6876 <dt data-property-name="totalReplies">
6877 <span class="json-property-name">totalReplies:</span>
6878 <span class="json-property-type">number</span>
6879 <span class="json-property-range" title="Value limits"></span>
6881 <dt data-property-name="account">
6882 <span class="json-property-name">account:</span>
6883 <span class="json-property-type">
6885 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
6888 <span class="json-property-range" title="Value limits"></span>
6893 <div class="doc-examples">
6896 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6897 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6898 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
6899 <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
6900 <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
6901 <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
6902 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
6903 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
6904 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
6905 <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
6906 <span class="hljs-attr">"account"</span>: {
6907 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
6908 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6909 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
6910 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
6911 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
6912 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
6913 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
6914 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
6915 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
6916 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
6917 <span class="hljs-attr">"avatar"</span>: {
6918 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
6919 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
6920 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
6930 <div id="definition-VideoCommentThreadTree" class="definition panel" data-traverse-target="definition-VideoCommentThreadTree">
6931 <h2 class="panel-title">
6932 <a name="/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree:
6933 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6934 <span class="json-property-range" title="Value limits"></span>
6939 <div class="doc-row">
6940 <div class="doc-copy">
6941 <section class="json-schema-properties">
6943 <dt data-property-name="comment">
6944 <span class="json-property-name">comment:</span>
6945 <span class="json-property-type">
6947 <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
6950 <span class="json-property-range" title="Value limits"></span>
6952 <dt data-property-name="children">
6953 <span class="json-property-name">children:</span>
6954 <span class="json-property-type">
6955 <span class="json-schema-ref-array">
6956 <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
6959 <span class="json-property-range" title="Value limits"></span>
6961 <dt class="json-inner-schema">
6962 <section class="json-schema-array-items">
6963 <span class="json-property-type">
6965 <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
6968 <span class="json-property-range" title="Value limits"></span>
6969 <div class="json-inner-schema"> </div>
6975 <div class="doc-examples">
6978 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6979 <span class="hljs-attr">"comment"</span>: {
6980 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6981 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
6982 <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
6983 <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
6984 <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
6985 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
6986 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
6987 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
6988 <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
6989 <span class="hljs-attr">"account"</span>: {
6990 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
6991 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
6992 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
6993 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
6994 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
6995 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
6996 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
6997 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
6998 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
6999 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7000 <span class="hljs-attr">"avatar"</span>: {
7001 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
7002 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7003 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
7007 <span class="hljs-attr">"children"</span>: [
7009 <span class="hljs-attr">"comment"</span>: {
7010 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7011 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7012 <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
7013 <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
7014 <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
7015 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
7016 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7017 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7018 <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
7019 <span class="hljs-attr">"account"</span>: {
7020 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
7021 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7022 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
7023 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7024 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
7025 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
7026 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
7027 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
7028 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7029 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7030 <span class="hljs-attr">"avatar"</span>: {
7031 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
7032 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7033 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
7037 <span class="hljs-attr">"children"</span>: [
7039 <span class="hljs-attr">"comment"</span>: {
7040 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7041 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7042 <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
7043 <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
7044 <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
7045 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
7046 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7047 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7048 <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
7049 <span class="hljs-attr">"account"</span>: {
7050 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
7051 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7052 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
7053 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7054 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
7055 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
7056 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
7057 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
7058 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7059 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7060 <span class="hljs-attr">"avatar"</span>: {
7061 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
7062 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7063 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
7078 <div id="definition-Avatar" class="definition panel" data-traverse-target="definition-Avatar">
7079 <h2 class="panel-title">
7080 <a name="/definitions/Avatar"></a>Avatar:
7081 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7082 <span class="json-property-range" title="Value limits"></span>
7087 <div class="doc-row">
7088 <div class="doc-copy">
7089 <section class="json-schema-properties">
7091 <dt data-property-name="path">
7092 <span class="json-property-name">path:</span>
7093 <span class="json-property-type">string</span>
7094 <span class="json-property-range" title="Value limits"></span>
7096 <dt data-property-name="createdAt">
7097 <span class="json-property-name">createdAt:</span>
7098 <span class="json-property-type">string</span>
7099 <span class="json-property-range" title="Value limits"></span>
7101 <dt data-property-name="updatedAt">
7102 <span class="json-property-name">updatedAt:</span>
7103 <span class="json-property-type">string</span>
7104 <span class="json-property-range" title="Value limits"></span>
7109 <div class="doc-examples">
7112 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7113 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
7114 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7115 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
7123 <div id="definition-Actor" class="definition panel" data-traverse-target="definition-Actor">
7124 <h2 class="panel-title">
7125 <a name="/definitions/Actor"></a>Actor:
7126 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7127 <span class="json-property-range" title="Value limits"></span>
7132 <div class="doc-row">
7133 <div class="doc-copy">
7134 <section class="json-schema-properties">
7136 <dt data-property-name="id">
7137 <span class="json-property-name">id:</span>
7138 <span class="json-property-type">number</span>
7139 <span class="json-property-range" title="Value limits"></span>
7141 <dt data-property-name="uuid">
7142 <span class="json-property-name">uuid:</span>
7143 <span class="json-property-type">string</span>
7144 <span class="json-property-range" title="Value limits"></span>
7146 <dt data-property-name="url">
7147 <span class="json-property-name">url:</span>
7148 <span class="json-property-type">string</span>
7149 <span class="json-property-range" title="Value limits"></span>
7151 <dt data-property-name="name">
7152 <span class="json-property-name">name:</span>
7153 <span class="json-property-type">string</span>
7154 <span class="json-property-range" title="Value limits"></span>
7156 <dt data-property-name="host">
7157 <span class="json-property-name">host:</span>
7158 <span class="json-property-type">string</span>
7159 <span class="json-property-range" title="Value limits"></span>
7161 <dt data-property-name="followingCount">
7162 <span class="json-property-name">followingCount:</span>
7163 <span class="json-property-type">number</span>
7164 <span class="json-property-range" title="Value limits"></span>
7166 <dt data-property-name="followersCount">
7167 <span class="json-property-name">followersCount:</span>
7168 <span class="json-property-type">number</span>
7169 <span class="json-property-range" title="Value limits"></span>
7171 <dt data-property-name="createdAt">
7172 <span class="json-property-name">createdAt:</span>
7173 <span class="json-property-type">string</span>
7174 <span class="json-property-range" title="Value limits"></span>
7176 <dt data-property-name="updatedAt">
7177 <span class="json-property-name">updatedAt:</span>
7178 <span class="json-property-type">string</span>
7179 <span class="json-property-range" title="Value limits"></span>
7181 <dt data-property-name="avatar">
7182 <span class="json-property-name">avatar:</span>
7183 <span class="json-property-type">
7185 <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
7188 <span class="json-property-range" title="Value limits"></span>
7193 <div class="doc-examples">
7196 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7197 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7198 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
7199 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7200 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
7201 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
7202 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
7203 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
7204 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7205 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7206 <span class="hljs-attr">"avatar"</span>: {
7207 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
7208 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7209 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
7218 <div id="definition-Account" class="definition panel" data-traverse-target="definition-Account">
7219 <h2 class="panel-title">
7220 <a name="/definitions/Account"></a>Account:
7221 <!-- <span class="json-property-type"><span class="json-property-type"></span>
7222 <span class="json-property-range" title="Value limits"></span>
7227 <div class="doc-row">
7228 <div class="doc-copy">
7229 <section class="json-schema-allOf">
7230 <section class="json-schema-allOf-inherited">
7233 <a class="json-schema-ref" href="#/definitions/Actor">Actor</a>
7237 <section class="json-schema-allOf-additional">
7238 <section class="json-schema-properties">
7240 <dt data-property-name="displayName">
7241 <span class="json-property-name">displayName:</span>
7242 <span class="json-property-type">string</span>
7243 <span class="json-property-range" title="Value limits"></span>
7250 <div class="doc-examples">
7253 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7254 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
7255 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7256 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
7257 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7258 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
7259 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
7260 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
7261 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
7262 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7263 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7264 <span class="hljs-attr">"avatar"</span>: {
7265 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
7266 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7267 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
7276 <div id="definition-User" class="definition panel" data-traverse-target="definition-User">
7277 <h2 class="panel-title">
7278 <a name="/definitions/User"></a>User:
7279 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7280 <span class="json-property-range" title="Value limits"></span>
7285 <div class="doc-row">
7286 <div class="doc-copy">
7287 <section class="json-schema-properties">
7289 <dt data-property-name="id">
7290 <span class="json-property-name">id:</span>
7291 <span class="json-property-type">number</span>
7292 <span class="json-property-range" title="Value limits"></span>
7294 <dt data-property-name="username">
7295 <span class="json-property-name">username:</span>
7296 <span class="json-property-type">string</span>
7297 <span class="json-property-range" title="Value limits"></span>
7299 <dt data-property-name="email">
7300 <span class="json-property-name">email:</span>
7301 <span class="json-property-type">string</span>
7302 <span class="json-property-range" title="Value limits"></span>
7304 <dt data-property-name="displayNSFW">
7305 <span class="json-property-name">displayNSFW:</span>
7306 <span class="json-property-type">boolean</span>
7307 <span class="json-property-range" title="Value limits"></span>
7309 <dt data-property-name="autoPlayVideo">
7310 <span class="json-property-name">autoPlayVideo:</span>
7311 <span class="json-property-type">boolean</span>
7312 <span class="json-property-range" title="Value limits"></span>
7314 <dt data-property-name="role">
7315 <span class="json-property-name">role:</span>
7316 <span class="json-property-type">string</span>
7317 <span class="json-property-enum" title="Possible values">
7318 <span class="json-property-enum-item">User</span>,
7319 <span class="json-property-enum-item">Moderator</span>,
7320 <span class="json-property-enum-item">Administrator</span>
7322 <span class="json-property-range" title="Value limits"></span>
7324 <dt data-property-name="videoQuota">
7325 <span class="json-property-name">videoQuota:</span>
7326 <span class="json-property-type">number</span>
7327 <span class="json-property-range" title="Value limits"></span>
7329 <dt data-property-name="createdAt">
7330 <span class="json-property-name">createdAt:</span>
7331 <span class="json-property-type">string</span>
7332 <span class="json-property-range" title="Value limits"></span>
7334 <dt data-property-name="account">
7335 <span class="json-property-name">account:</span>
7336 <span class="json-property-type">
7338 <a class="json-schema-ref" href="#/definitions/Account">Account</a>
7341 <span class="json-property-range" title="Value limits"></span>
7343 <dt data-property-name="videoChannels">
7344 <span class="json-property-name">videoChannels:</span>
7345 <span class="json-property-type">
7346 <span class="json-schema-ref-array">
7347 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
7350 <span class="json-property-range" title="Value limits"></span>
7352 <dt class="json-inner-schema">
7353 <section class="json-schema-array-items">
7354 <span class="json-property-type">
7356 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
7359 <span class="json-property-range" title="Value limits"></span>
7360 <div class="json-inner-schema"> </div>
7366 <div class="doc-examples">
7369 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7370 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7371 <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
7372 <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
7373 <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>,
7374 <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>,
7375 <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
7376 <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>,
7377 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7378 <span class="hljs-attr">"account"</span>: {
7379 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
7380 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7381 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
7382 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7383 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
7384 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
7385 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
7386 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
7387 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7388 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7389 <span class="hljs-attr">"avatar"</span>: {
7390 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
7391 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7392 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
7395 <span class="hljs-attr">"videoChannels"</span>: [
7397 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
7398 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
7399 <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
7400 <span class="hljs-attr">"ownerAccount"</span>: {
7401 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7402 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
7413 <div id="definition-ServerConfig" class="definition panel" data-traverse-target="definition-ServerConfig">
7414 <h2 class="panel-title">
7415 <a name="/definitions/ServerConfig"></a>ServerConfig:
7416 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7417 <span class="json-property-range" title="Value limits"></span>
7422 <div class="doc-row">
7423 <div class="doc-copy">
7424 <section class="json-schema-properties">
7426 <dt data-property-name="signup">
7427 <span class="json-property-name">signup:</span>
7428 <span class="json-property-type">object</span>
7429 <span class="json-property-range" title="Value limits"></span>
7431 <dt class="json-inner-schema">
7432 <section class="json-schema-properties">
7434 <dt data-property-name="allowed">
7435 <span class="json-property-name">allowed:</span>
7436 <span class="json-property-type">boolean</span>
7437 <span class="json-property-range" title="Value limits"></span>
7442 <dt data-property-name="transcoding">
7443 <span class="json-property-name">transcoding:</span>
7444 <span class="json-property-type">object</span>
7445 <span class="json-property-range" title="Value limits"></span>
7447 <dt class="json-inner-schema">
7448 <section class="json-schema-properties">
7450 <dt data-property-name="enabledResolutions">
7451 <span class="json-property-name">enabledResolutions:</span>
7452 <span class="json-property-type">number[]</span>
7453 <span class="json-property-range" title="Value limits"></span>
7455 <dt class="json-inner-schema">
7456 <section class="json-schema-array-items">
7457 <span class="json-property-type">number</span>
7458 <span class="json-property-range" title="Value limits"></span>
7459 <div class="json-inner-schema"> </div>
7465 <dt data-property-name="avatar">
7466 <span class="json-property-name">avatar:</span>
7467 <span class="json-property-type">object</span>
7468 <span class="json-property-range" title="Value limits"></span>
7470 <dt class="json-inner-schema">
7471 <section class="json-schema-properties">
7473 <dt data-property-name="file">
7474 <span class="json-property-name">file:</span>
7475 <span class="json-property-type">object</span>
7476 <span class="json-property-range" title="Value limits"></span>
7478 <dt class="json-inner-schema">
7479 <section class="json-schema-properties">
7481 <dt data-property-name="size">
7482 <span class="json-property-name">size:</span>
7483 <span class="json-property-type">object</span>
7484 <span class="json-property-range" title="Value limits"></span>
7486 <dt class="json-inner-schema">
7487 <section class="json-schema-properties">
7489 <dt data-property-name="max">
7490 <span class="json-property-name">max:</span>
7491 <span class="json-property-type">number</span>
7492 <span class="json-property-range" title="Value limits"></span>
7500 <dt data-property-name="extensions">
7501 <span class="json-property-name">extensions:</span>
7502 <span class="json-property-type">string[]</span>
7503 <span class="json-property-range" title="Value limits"></span>
7505 <dt class="json-inner-schema">
7506 <section class="json-schema-array-items">
7507 <span class="json-property-type">string</span>
7508 <span class="json-property-range" title="Value limits"></span>
7509 <div class="json-inner-schema"> </div>
7515 <dt data-property-name="video">
7516 <span class="json-property-name">video:</span>
7517 <span class="json-property-type">object</span>
7518 <span class="json-property-range" title="Value limits"></span>
7520 <dt class="json-inner-schema">
7521 <section class="json-schema-properties">
7523 <dt data-property-name="file">
7524 <span class="json-property-name">file:</span>
7525 <span class="json-property-type">object</span>
7526 <span class="json-property-range" title="Value limits"></span>
7528 <dt class="json-inner-schema">
7529 <section class="json-schema-properties">
7531 <dt data-property-name="extensions">
7532 <span class="json-property-name">extensions:</span>
7533 <span class="json-property-type">string[]</span>
7534 <span class="json-property-range" title="Value limits"></span>
7536 <dt class="json-inner-schema">
7537 <section class="json-schema-array-items">
7538 <span class="json-property-type">string</span>
7539 <span class="json-property-range" title="Value limits"></span>
7540 <div class="json-inner-schema"> </div>
7552 <div class="doc-examples">
7555 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7556 <span class="hljs-attr">"signup"</span>: {
7557 <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span>
7559 <span class="hljs-attr">"transcoding"</span>: {
7560 <span class="hljs-attr">"enabledResolutions"</span>: [
7561 <span class="hljs-string">"number"</span>
7564 <span class="hljs-attr">"avatar"</span>: {
7565 <span class="hljs-attr">"file"</span>: {
7566 <span class="hljs-attr">"size"</span>: {
7567 <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span>
7570 <span class="hljs-attr">"extensions"</span>: [
7571 <span class="hljs-string">"string"</span>
7574 <span class="hljs-attr">"video"</span>: {
7575 <span class="hljs-attr">"file"</span>: {
7576 <span class="hljs-attr">"extensions"</span>: [
7577 <span class="hljs-string">"string"</span>
7588 <div id="definition-Follow" class="definition panel" data-traverse-target="definition-Follow">
7589 <h2 class="panel-title">
7590 <a name="/definitions/Follow"></a>Follow:
7591 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7592 <span class="json-property-range" title="Value limits"></span>
7597 <div class="doc-row">
7598 <div class="doc-copy">
7599 <section class="json-schema-properties">
7601 <dt data-property-name="id">
7602 <span class="json-property-name">id:</span>
7603 <span class="json-property-type">number</span>
7604 <span class="json-property-range" title="Value limits"></span>
7606 <dt data-property-name="follower">
7607 <span class="json-property-name">follower:</span>
7608 <span class="json-property-type">
7610 <a class="json-schema-ref" href="#/definitions/Actor">Actor</a>
7613 <span class="json-property-range" title="Value limits"></span>
7615 <dt data-property-name="following">
7616 <span class="json-property-name">following:</span>
7617 <span class="json-property-type">
7619 <a class="json-schema-ref" href="#/definitions/Actor">Actor</a>
7622 <span class="json-property-range" title="Value limits"></span>
7624 <dt data-property-name="score">
7625 <span class="json-property-name">score:</span>
7626 <span class="json-property-type">number</span>
7627 <span class="json-property-range" title="Value limits"></span>
7629 <dt data-property-name="state">
7630 <span class="json-property-name">state:</span>
7631 <span class="json-property-type">string</span>
7632 <span class="json-property-enum" title="Possible values">
7633 <span class="json-property-enum-item">pending</span>,
7634 <span class="json-property-enum-item">accepted</span>
7636 <span class="json-property-range" title="Value limits"></span>
7638 <dt data-property-name="createdAt">
7639 <span class="json-property-name">createdAt:</span>
7640 <span class="json-property-type">string</span>
7641 <span class="json-property-range" title="Value limits"></span>
7643 <dt data-property-name="updatedAt">
7644 <span class="json-property-name">updatedAt:</span>
7645 <span class="json-property-type">string</span>
7646 <span class="json-property-range" title="Value limits"></span>
7651 <div class="doc-examples">
7654 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7655 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7656 <span class="hljs-attr">"follower"</span>: {
7657 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7658 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
7659 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7660 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
7661 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
7662 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
7663 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
7664 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7665 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7666 <span class="hljs-attr">"avatar"</span>: {
7667 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
7668 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7669 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
7672 <span class="hljs-attr">"following"</span>: {
7673 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7674 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
7675 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7676 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
7677 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
7678 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
7679 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
7680 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7681 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7682 <span class="hljs-attr">"avatar"</span>: {
7683 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
7684 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7685 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
7688 <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>,
7689 <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
7690 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7691 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
7699 <div id="definition-Job" class="definition panel" data-traverse-target="definition-Job">
7700 <h2 class="panel-title">
7701 <a name="/definitions/Job"></a>Job:
7702 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7703 <span class="json-property-range" title="Value limits"></span>
7708 <div class="doc-row">
7709 <div class="doc-copy">
7710 <section class="json-schema-properties">
7712 <dt data-property-name="id">
7713 <span class="json-property-name">id:</span>
7714 <span class="json-property-type">number</span>
7715 <span class="json-property-range" title="Value limits"></span>
7717 <dt data-property-name="state">
7718 <span class="json-property-name">state:</span>
7719 <span class="json-property-type">string</span>
7720 <span class="json-property-enum" title="Possible values">
7721 <span class="json-property-enum-item">pending</span>,
7722 <span class="json-property-enum-item">processing</span>,
7723 <span class="json-property-enum-item">error</span>,
7724 <span class="json-property-enum-item">success</span>
7726 <span class="json-property-range" title="Value limits"></span>
7728 <dt data-property-name="category">
7729 <span class="json-property-name">category:</span>
7730 <span class="json-property-type">string</span>
7731 <span class="json-property-enum" title="Possible values">
7732 <span class="json-property-enum-item">transcoding</span>,
7733 <span class="json-property-enum-item">activitypub-http</span>
7735 <span class="json-property-range" title="Value limits"></span>
7737 <dt data-property-name="handlerName">
7738 <span class="json-property-name">handlerName:</span>
7739 <span class="json-property-type">string</span>
7740 <span class="json-property-range" title="Value limits"></span>
7742 <dt data-property-name="handlerInputData">
7743 <span class="json-property-name">handlerInputData:</span>
7744 <span class="json-property-type">string</span>
7745 <span class="json-property-range" title="Value limits"></span>
7747 <dt data-property-name="createdAt">
7748 <span class="json-property-name">createdAt:</span>
7749 <span class="json-property-type">string</span>
7750 <span class="json-property-range" title="Value limits"></span>
7752 <dt data-property-name="updatedAt">
7753 <span class="json-property-name">updatedAt:</span>
7754 <span class="json-property-type">string</span>
7755 <span class="json-property-range" title="Value limits"></span>
7760 <div class="doc-examples">
7763 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7764 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7765 <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
7766 <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>,
7767 <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>,
7768 <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>,
7769 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7770 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
7778 <div id="definition-AddUserResponse" class="definition panel" data-traverse-target="definition-AddUserResponse">
7779 <h2 class="panel-title">
7780 <a name="/definitions/AddUserResponse"></a>AddUserResponse:
7781 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7782 <span class="json-property-range" title="Value limits"></span>
7787 <div class="doc-row">
7788 <div class="doc-copy">
7789 <section class="json-schema-properties">
7791 <dt data-property-name="id">
7792 <span class="json-property-name">id:</span>
7793 <span class="json-property-type">number</span>
7794 <span class="json-property-range" title="Value limits"></span>
7796 <dt data-property-name="uuid">
7797 <span class="json-property-name">uuid:</span>
7798 <span class="json-property-type">string</span>
7799 <span class="json-property-range" title="Value limits"></span>
7804 <div class="doc-examples">
7807 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7808 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7809 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
7817 <div id="definition-VideoUploadResponse" class="definition panel" data-traverse-target="definition-VideoUploadResponse">
7818 <h2 class="panel-title">
7819 <a name="/definitions/VideoUploadResponse"></a>VideoUploadResponse:
7820 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7821 <span class="json-property-range" title="Value limits"></span>
7826 <div class="doc-row">
7827 <div class="doc-copy">
7828 <section class="json-schema-properties">
7830 <dt data-property-name="video">
7831 <span class="json-property-name">video:</span>
7832 <span class="json-property-type">object</span>
7833 <span class="json-property-range" title="Value limits"></span>
7835 <dt class="json-inner-schema">
7836 <section class="json-schema-properties">
7838 <dt data-property-name="id">
7839 <span class="json-property-name">id:</span>
7840 <span class="json-property-type">number</span>
7841 <span class="json-property-range" title="Value limits"></span>
7843 <dt data-property-name="uuid">
7844 <span class="json-property-name">uuid:</span>
7845 <span class="json-property-type">string</span>
7846 <span class="json-property-range" title="Value limits"></span>
7854 <div class="doc-examples">
7857 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7858 <span class="hljs-attr">"video"</span>: {
7859 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7860 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
7869 <div id="definition-CommentThreadResponse" class="definition panel" data-traverse-target="definition-CommentThreadResponse">
7870 <h2 class="panel-title">
7871 <a name="/definitions/CommentThreadResponse"></a>CommentThreadResponse:
7872 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7873 <span class="json-property-range" title="Value limits"></span>
7878 <div class="doc-row">
7879 <div class="doc-copy">
7880 <section class="json-schema-properties">
7882 <dt data-property-name="total">
7883 <span class="json-property-name">total:</span>
7884 <span class="json-property-type">number</span>
7885 <span class="json-property-range" title="Value limits"></span>
7887 <dt data-property-name="data">
7888 <span class="json-property-name">data:</span>
7889 <span class="json-property-type">
7890 <span class="json-schema-ref-array">
7891 <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
7894 <span class="json-property-range" title="Value limits"></span>
7896 <dt class="json-inner-schema">
7897 <section class="json-schema-array-items">
7898 <span class="json-property-type">
7900 <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
7903 <span class="json-property-range" title="Value limits"></span>
7904 <div class="json-inner-schema"> </div>
7910 <div class="doc-examples">
7913 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7914 <span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>,
7915 <span class="hljs-attr">"data"</span>: [
7917 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7918 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7919 <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
7920 <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
7921 <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
7922 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
7923 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7924 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7925 <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
7926 <span class="hljs-attr">"account"</span>: {
7927 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
7928 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7929 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
7930 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7931 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
7932 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
7933 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
7934 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
7935 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7936 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7937 <span class="hljs-attr">"avatar"</span>: {
7938 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
7939 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7940 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
7952 <div id="definition-CommentThreadPostResponse" class="definition panel" data-traverse-target="definition-CommentThreadPostResponse">
7953 <h2 class="panel-title">
7954 <a name="/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse:
7955 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7956 <span class="json-property-range" title="Value limits"></span>
7961 <div class="doc-row">
7962 <div class="doc-copy">
7963 <section class="json-schema-properties">
7965 <dt data-property-name="comment">
7966 <span class="json-property-name">comment:</span>
7967 <span class="json-property-type">
7969 <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
7972 <span class="json-property-range" title="Value limits"></span>
7977 <div class="doc-examples">
7980 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
7981 <span class="hljs-attr">"comment"</span>: {
7982 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7983 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7984 <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
7985 <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
7986 <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
7987 <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
7988 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
7989 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
7990 <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
7991 <span class="hljs-attr">"account"</span>: {
7992 <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
7993 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
7994 <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
7995 <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
7996 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
7997 <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
7998 <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
7999 <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
8000 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
8001 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
8002 <span class="hljs-attr">"avatar"</span>: {
8003 <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
8004 <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
8005 <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
8016 <div id="definition-AddUser" class="definition panel" data-traverse-target="definition-AddUser">
8017 <h2 class="panel-title">
8018 <a name="/definitions/AddUser"></a>AddUser:
8019 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8020 <span class="json-property-range" title="Value limits"></span>
8025 <div class="doc-row">
8026 <div class="doc-copy">
8027 <section class="json-schema-properties">
8029 <dt data-property-name="username" class="has-description">
8030 <span class="json-property-name">username:</span>
8031 <span class="json-property-type">string</span>
8032 <span class="json-property-range" title="Value limits"></span>
8033 <span class="json-property-required"></span>
8036 <p>The user username </p>
8038 <dt data-property-name="password" class="has-description">
8039 <span class="json-property-name">password:</span>
8040 <span class="json-property-type">string</span>
8041 <span class="json-property-range" title="Value limits"></span>
8042 <span class="json-property-required"></span>
8045 <p>The user password </p>
8047 <dt data-property-name="email" class="has-description">
8048 <span class="json-property-name">email:</span>
8049 <span class="json-property-type">string</span>
8050 <span class="json-property-range" title="Value limits"></span>
8051 <span class="json-property-required"></span>
8054 <p>The user email </p>
8056 <dt data-property-name="videoQuota" class="has-description">
8057 <span class="json-property-name">videoQuota:</span>
8058 <span class="json-property-type">string</span>
8059 <span class="json-property-range" title="Value limits"></span>
8060 <span class="json-property-required"></span>
8063 <p>The user videoQuota </p>
8065 <dt data-property-name="role" class="has-description">
8066 <span class="json-property-name">role:</span>
8067 <span class="json-property-type">string</span>
8068 <span class="json-property-range" title="Value limits"></span>
8069 <span class="json-property-required"></span>
8072 <p>The user role </p>
8077 <div class="doc-examples">
8080 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8081 <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
8082 <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>,
8083 <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
8084 <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>,
8085 <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
8093 <div id="definition-UpdateUser" class="definition panel" data-traverse-target="definition-UpdateUser">
8094 <h2 class="panel-title">
8095 <a name="/definitions/UpdateUser"></a>UpdateUser:
8096 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8097 <span class="json-property-range" title="Value limits"></span>
8102 <div class="doc-row">
8103 <div class="doc-copy">
8104 <section class="json-schema-properties">
8106 <dt data-property-name="id" class="has-description">
8107 <span class="json-property-name">id:</span>
8108 <span class="json-property-type">string</span>
8109 <span class="json-property-range" title="Value limits"></span>
8110 <span class="json-property-required"></span>
8115 <dt data-property-name="email" class="has-description">
8116 <span class="json-property-name">email:</span>
8117 <span class="json-property-type">string</span>
8118 <span class="json-property-range" title="Value limits"></span>
8119 <span class="json-property-required"></span>
8122 <p>The updated email of the user </p>
8124 <dt data-property-name="videoQuota" class="has-description">
8125 <span class="json-property-name">videoQuota:</span>
8126 <span class="json-property-type">string</span>
8127 <span class="json-property-range" title="Value limits"></span>
8128 <span class="json-property-required"></span>
8131 <p>The updated videoQuota of the user </p>
8133 <dt data-property-name="role" class="has-description">
8134 <span class="json-property-name">role:</span>
8135 <span class="json-property-type">string</span>
8136 <span class="json-property-range" title="Value limits"></span>
8137 <span class="json-property-required"></span>
8140 <p>The updated role of the user </p>
8145 <div class="doc-examples">
8148 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8149 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
8150 <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
8151 <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>,
8152 <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
8160 <div id="definition-UpdateMe" class="definition panel" data-traverse-target="definition-UpdateMe">
8161 <h2 class="panel-title">
8162 <a name="/definitions/UpdateMe"></a>UpdateMe:
8163 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8164 <span class="json-property-range" title="Value limits"></span>
8169 <div class="doc-row">
8170 <div class="doc-copy">
8171 <section class="json-schema-properties">
8173 <dt data-property-name="password" class="has-description">
8174 <span class="json-property-name">password:</span>
8175 <span class="json-property-type">string</span>
8176 <span class="json-property-range" title="Value limits"></span>
8177 <span class="json-property-required"></span>
8180 <p>Your new password </p>
8182 <dt data-property-name="email" class="has-description">
8183 <span class="json-property-name">email:</span>
8184 <span class="json-property-type">string</span>
8185 <span class="json-property-range" title="Value limits"></span>
8186 <span class="json-property-required"></span>
8189 <p>Your new email </p>
8191 <dt data-property-name="displayNSFW" class="has-description">
8192 <span class="json-property-name">displayNSFW:</span>
8193 <span class="json-property-type">string</span>
8194 <span class="json-property-range" title="Value limits"></span>
8195 <span class="json-property-required"></span>
8198 <p>Your new displayNSFW </p>
8200 <dt data-property-name="autoPlayVideo" class="has-description">
8201 <span class="json-property-name">autoPlayVideo:</span>
8202 <span class="json-property-type">string</span>
8203 <span class="json-property-range" title="Value limits"></span>
8204 <span class="json-property-required"></span>
8207 <p>Your new autoPlayVideo </p>
8212 <div class="doc-examples">
8215 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8216 <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>,
8217 <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
8218 <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>,
8219 <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span>
8227 <div id="definition-GetMeVideoRating" class="definition panel" data-traverse-target="definition-GetMeVideoRating">
8228 <h2 class="panel-title">
8229 <a name="/definitions/GetMeVideoRating"></a>GetMeVideoRating:
8230 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8231 <span class="json-property-range" title="Value limits"></span>
8236 <div class="doc-row">
8237 <div class="doc-copy">
8238 <section class="json-schema-properties">
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>
8247 <p>Id of the video </p>
8249 <dt data-property-name="rating" class="has-description">
8250 <span class="json-property-name">rating:</span>
8251 <span class="json-property-type">number</span>
8252 <span class="json-property-range" title="Value limits"></span>
8253 <span class="json-property-required"></span>
8256 <p>Rating of the video </p>
8261 <div class="doc-examples">
8264 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8265 <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
8266 <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span>
8274 <div id="definition-RegisterUser" class="definition panel" data-traverse-target="definition-RegisterUser">
8275 <h2 class="panel-title">
8276 <a name="/definitions/RegisterUser"></a>RegisterUser:
8277 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8278 <span class="json-property-range" title="Value limits"></span>
8283 <div class="doc-row">
8284 <div class="doc-copy">
8285 <section class="json-schema-properties">
8287 <dt data-property-name="username" class="has-description">
8288 <span class="json-property-name">username:</span>
8289 <span class="json-property-type">string</span>
8290 <span class="json-property-range" title="Value limits"></span>
8291 <span class="json-property-required"></span>
8294 <p>The username of the user </p>
8296 <dt data-property-name="password" class="has-description">
8297 <span class="json-property-name">password:</span>
8298 <span class="json-property-type">string</span>
8299 <span class="json-property-range" title="Value limits"></span>
8300 <span class="json-property-required"></span>
8303 <p>The password of the user </p>
8305 <dt data-property-name="email" class="has-description">
8306 <span class="json-property-name">email:</span>
8307 <span class="json-property-type">string</span>
8308 <span class="json-property-range" title="Value limits"></span>
8309 <span class="json-property-required"></span>
8312 <p>The email of the user </p>
8317 <div class="doc-examples">
8320 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8321 <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
8322 <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>,
8323 <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>
8331 <div id="definition-VideoChannelInput" class="definition panel" data-traverse-target="definition-VideoChannelInput">
8332 <h2 class="panel-title">
8333 <a name="/definitions/VideoChannelInput"></a>VideoChannelInput:
8334 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8335 <span class="json-property-range" title="Value limits"></span>
8340 <div class="doc-row">
8341 <div class="doc-copy">
8342 <section class="json-schema-properties">
8344 <dt data-property-name="name">
8345 <span class="json-property-name">name:</span>
8346 <span class="json-property-type">string</span>
8347 <span class="json-property-range" title="Value limits"></span>
8349 <dt data-property-name="description">
8350 <span class="json-property-name">description:</span>
8351 <span class="json-property-type">string</span>
8352 <span class="json-property-range" title="Value limits"></span>
8357 <div class="doc-examples">
8360 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8361 <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
8362 <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>
8370 <div id="definition-ScheduleVideoUpdate" class="definition panel" data-traverse-target="definition-ScheduleVideoUpdate">
8371 <h2 class="panel-title">
8372 <a name="/definitions/ScheduleVideoUpdate"></a>ScheduleVideoUpdate:
8373 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8374 <span class="json-property-range" title="Value limits"></span>
8379 <div class="doc-row">
8380 <div class="doc-copy">
8381 <section class="json-schema-properties">
8383 <dt data-property-name="updateAt" class="has-description">
8384 <span class="json-property-name">updateAt:</span>
8385 <span class="json-property-type">dateTime</span>
8386 <span class="json-property-range" title="Value limits"></span>
8389 <p>When to update the video</p>
8391 <dt data-property-name="privacy">
8392 <span class="json-property-name">privacy:</span>
8393 <span class="json-property-type">
8395 <a class="json-schema-ref" href="#/definitions/VideoPrivacy">VideoPrivacy</a>
8398 <span class="json-property-range" title="Value limits"></span>
8403 <div class="doc-examples">
8406 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
8407 <span class="hljs-attr">"updateAt"</span>: <span class="hljs-string">"dateTime"</span>,
8408 <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>
8416 <div class="doc-row no-margin">
8417 <div class="doc-copy doc-separator">
8418 <a class="powered-by" href="https://sourcey.com/spectacle">Documentation by
8419 <span>Spectacle</span>