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">
20 <h5>API Reference
</h5>
21 <a href=
"#introduction">Introduction
</a>
24 <a href=
"#tag-Accounts">Accounts
</a>
27 <a href=
"#operation--accounts--id--get"> GET /accounts/{id}
</a>
30 <a href=
"#operation--accounts-get"> GET /accounts
</a>
35 <a href=
"#tag-Config">Config
</a>
38 <a href=
"#operation--config-get"> GET /config
</a>
43 <a href=
"#tag-Job">Job
</a>
46 <a href=
"#operation--jobs-get"> GET /jobs
</a>
51 <a href=
"#tag-ServerFollowing">ServerFollowing
</a>
54 <a href=
"#operation--server-following--host--delete"> DELETE /server/following/{host}
</a>
57 <a href=
"#operation--server-followers-get"> GET /server/followers
</a>
60 <a href=
"#operation--server-following-get"> GET /server/following
</a>
63 <a href=
"#operation--server-following-post"> POST /server/following
</a>
68 <a href=
"#tag-User">User
</a>
71 <a href=
"#operation--users-post"> POST /users
</a>
74 <a href=
"#operation--users-get"> GET /users
</a>
77 <a href=
"#operation--users--id--delete"> DELETE /users/{id}
</a>
80 <a href=
"#operation--users--id--get"> GET /users/{id}
</a>
83 <a href=
"#operation--users--id--put"> PUT /users/{id}
</a>
86 <a href=
"#operation--users-me-get"> GET /users/me
</a>
89 <a href=
"#operation--users-me-put"> PUT /users/me
</a>
92 <a href=
"#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used
</a>
95 <a href=
"#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating
</a>
98 <a href=
"#operation--users-me-videos-get"> GET /users/me/videos
</a>
101 <a href=
"#operation--users-register-post"> POST /users/register
</a>
104 <a href=
"#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick
</a>
109 <a href=
"#tag-Video">Video
</a>
112 <a href=
"#operation--videos-get"> GET /videos
</a>
115 <a href=
"#operation--videos-categories-get"> GET /videos/categories
</a>
118 <a href=
"#operation--videos-licences-get"> GET /videos/licences
</a>
121 <a href=
"#operation--videos-languages-get"> GET /videos/languages
</a>
124 <a href=
"#operation--videos-privacies-get"> GET /videos/privacies
</a>
127 <a href=
"#operation--videos-search-get"> GET /videos/search
</a>
130 <a href=
"#operation--videos--id--put"> PUT /videos/{id}
</a>
133 <a href=
"#operation--videos--id--get"> GET /videos/{id}
</a>
136 <a href=
"#operation--videos--id--delete"> DELETE /videos/{id}
</a>
139 <a href=
"#operation--videos--id--description-get"> GET /videos/{id}/description
</a>
142 <a href=
"#operation--videos--id--views-post"> POST /videos/{id}/views
</a>
145 <a href=
"#operation--videos-upload-post"> POST /videos/upload
</a>
150 <a href=
"#tag-VideoAbuse">VideoAbuse
</a>
153 <a href=
"#operation--videos-abuse-get"> GET /videos/abuse
</a>
156 <a href=
"#operation--videos--id--abuse-post"> POST /videos/{id}/abuse
</a>
161 <a href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
164 <a href=
"#operation--videos--videoId--blacklist-post"> POST /videos/{videoId}/blacklist
</a>
167 <a href=
"#operation--videos--videoId--blacklist-delete"> DELETE /videos/{videoId}/blacklist
</a>
170 <a href=
"#operation--videos-blacklist-get"> GET /videos/blacklist
</a>
175 <a href=
"#tag-VideoChannel">VideoChannel
</a>
178 <a href=
"#operation--videos-channels-get"> GET /videos/channels
</a>
181 <a href=
"#operation--videos-channels-post"> POST /videos/channels
</a>
184 <a href=
"#operation--videos-channels--id--get"> GET /videos/channels/{id}
</a>
187 <a href=
"#operation--videos-channels--id--put"> PUT /videos/channels/{id}
</a>
190 <a href=
"#operation--videos-channels--id--delete"> DELETE /videos/channels/{id}
</a>
193 <a href=
"#operation--videos-accounts--accountId--channels-get"> GET /videos/accounts/{accountId}/channels
</a>
198 <a href=
"#tag-VideoComment">VideoComment
</a>
201 <a href=
"#operation--videos--videoId--comment-threads-get"> GET /videos/{videoId}/comment-threads
</a>
204 <a href=
"#operation--videos--videoId--comment-threads-post"> POST /videos/{videoId}/comment-threads
</a>
207 <a href=
"#operation--videos--videoId--comment-threads--threadId--get"> GET /videos/{videoId}/comment-threads/{threadId}
</a>
210 <a href=
"#operation--videos--videoId--comments--commentId--post"> POST /videos/{videoId}/comments/{commentId}
</a>
213 <a href=
"#operation--videos--videoId--comments--commentId--delete"> DELETE /videos/{videoId}/comments/{commentId}
</a>
218 <a href=
"#tag-VideoRate">VideoRate
</a>
221 <a href=
"#operation--videos--id--rate-put"> PUT /videos/{id}/rate
</a>
225 <h5>Schema Definitions
</h5>
226 <a href=
"#definition-VideoConstant"> VideoConstant
</a>
227 <a href=
"#definition-VideoPrivacy"> VideoPrivacy
</a>
228 <a href=
"#definition-Video"> Video
</a>
229 <a href=
"#definition-VideoAbuse"> VideoAbuse
</a>
230 <a href=
"#definition-VideoBlacklist"> VideoBlacklist
</a>
231 <a href=
"#definition-VideoChannel"> VideoChannel
</a>
232 <a href=
"#definition-VideoComment"> VideoComment
</a>
233 <a href=
"#definition-VideoCommentThreadTree"> VideoCommentThreadTree
</a>
234 <a href=
"#definition-Avatar"> Avatar
</a>
235 <a href=
"#definition-Actor"> Actor
</a>
236 <a href=
"#definition-Account"> Account
</a>
237 <a href=
"#definition-User"> User
</a>
238 <a href=
"#definition-ServerConfig"> ServerConfig
</a>
239 <a href=
"#definition-Follow"> Follow
</a>
240 <a href=
"#definition-Job"> Job
</a>
241 <a href=
"#definition-AddUserResponse"> AddUserResponse
</a>
242 <a href=
"#definition-VideoUploadResponse"> VideoUploadResponse
</a>
243 <a href=
"#definition-CommentThreadResponse"> CommentThreadResponse
</a>
244 <a href=
"#definition-CommentThreadPostResponse"> CommentThreadPostResponse
</a>
245 <a href=
"#definition-AddUser"> AddUser
</a>
246 <a href=
"#definition-UpdateUser"> UpdateUser
</a>
247 <a href=
"#definition-UpdateMe"> UpdateMe
</a>
248 <a href=
"#definition-GetMeVideoRating"> GetMeVideoRating
</a>
249 <a href=
"#definition-RegisterUser"> RegisterUser
</a>
250 <a href=
"#definition-VideoChannelInput"> VideoChannelInput
</a>
253 <div id=
"docs" class=
"row collapse expanded drawer" data-drawer
>
254 <button class=
"floating-menu-icon" type=
"button" data-drawer-slide=
"right">
255 <span class=
"hamburger"></span>
257 <div class=
"example-box doc-content"></div>
259 <div id=
"introduction" data-traverse-target=
"introduction">
260 <h1 class=
"doc-title">PeerTube
261 <span>API Reference
</span>
263 <div class=
"doc-row">
264 <div class=
"doc-copy">
265 <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.
</p>
267 <div class=
"doc-examples">
269 <h5>API Endpoint
</h5>
270 <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1
</code></pre>
276 <span>1.0.0-beta
</span>
282 <h1 id=
"tag-Accounts" class=
"swagger-summary-tag" data-traverse-target=
"tag-Accounts">Accounts
</h1>
283 <div id=
"operation--accounts--id--get" class=
"operation panel" data-traverse-target=
"operation--accounts--id--get">
284 <!-- <section class="operation-tags row"> -->
285 <!-- <div class="doc-copy"> -->
286 <div class=
"operation-tags">
287 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
292 <h2 class=
"operation-title">
293 <span class=
"operation-name">
294 <span class=
"operation-name">GET
</span>
295 <span class=
"operation-path">/accounts/{id}
</span>
298 <div class=
"doc-row">
299 <div class=
"doc-copy">
300 <section class=
"swagger-request-params">
301 <div class=
"prop-row prop-group">
302 <div class=
"prop-name">
303 <div class=
"prop-title">id
</div>
304 <span class=
"json-property-required"></span>
306 <div class=
"prop-value">
307 <p>The id of the account
</p>
310 <div class=
"prop-row prop-inner">
311 <div class=
"prop-name param-label">type
</div>
312 <div class=
"prop-value">
313 <span class=
"json-property-type">string
</span>
314 <span class=
"json-property-range" title=
"Value limits"></span>
317 <div class=
"prop-row prop-inner">
318 <div class=
"prop-name param-label">in
</div>
319 <div class=
"prop-value">path
</div>
321 <div class=
"prop-row prop-group">
322 <div class=
"prop-name">
323 <div class=
"prop-title">start
</div>
325 <div class=
"prop-value">
329 <div class=
"prop-row prop-inner">
330 <div class=
"prop-name param-label">type
</div>
331 <div class=
"prop-value">
332 <span class=
"json-property-type">number
</span>
333 <span class=
"json-property-range" title=
"Value limits"></span>
336 <div class=
"prop-row prop-inner">
337 <div class=
"prop-name param-label">in
</div>
338 <div class=
"prop-value">query
</div>
340 <div class=
"prop-row prop-group">
341 <div class=
"prop-name">
342 <div class=
"prop-title">stop
</div>
344 <div class=
"prop-value">
348 <div class=
"prop-row prop-inner">
349 <div class=
"prop-name param-label">type
</div>
350 <div class=
"prop-value">
351 <span class=
"json-property-type">number
</span>
352 <span class=
"json-property-range" title=
"Value limits"></span>
355 <div class=
"prop-row prop-inner">
356 <div class=
"prop-name param-label">in
</div>
357 <div class=
"prop-value">query
</div>
359 <div class=
"prop-row prop-group">
360 <div class=
"prop-name">
361 <div class=
"prop-title">sort
</div>
363 <div class=
"prop-value">
367 <div class=
"prop-row prop-inner">
368 <div class=
"prop-name param-label">type
</div>
369 <div class=
"prop-value">
370 <span class=
"json-property-type">number
</span>
371 <span class=
"json-property-range" title=
"Value limits"></span>
374 <div class=
"prop-row prop-inner">
375 <div class=
"prop-name param-label">in
</div>
376 <div class=
"prop-value">query
</div>
380 <div class=
"doc-examples"></div>
382 <div class=
"doc-row">
383 <div class=
"doc-copy">
384 <section class=
"swagger-responses">
385 <div class=
"prop-row prop-group">
386 <div class=
"prop-name">
387 <div class=
"prop-title">200 OK
</div>
388 <div class=
"prop-ref">
390 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
393 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
395 <div class=
"prop-value">
396 <p>successful operation
</p>
401 <div class=
"doc-examples">
402 <h5>Response Content-Types:
403 <span>application/json
</span>
407 <span>(
200 OK)
</span>
409 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
410 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
411 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
412 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
413 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
414 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
415 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
416 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
417 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
418 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
419 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
420 <span class=
"hljs-attr">"avatar
"</span>: {
421 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
422 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
423 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
432 <div id=
"operation--accounts-get" class=
"operation panel" data-traverse-target=
"operation--accounts-get">
433 <!-- <section class="operation-tags row"> -->
434 <!-- <div class="doc-copy"> -->
435 <div class=
"operation-tags">
436 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
441 <h2 class=
"operation-title">
442 <span class=
"operation-name">
443 <span class=
"operation-name">GET
</span>
444 <span class=
"operation-path">/accounts
</span>
447 <div class=
"doc-row">
448 <div class=
"doc-copy"> </div>
449 <div class=
"doc-examples"></div>
451 <div class=
"doc-row">
452 <div class=
"doc-copy">
453 <section class=
"swagger-responses">
454 <div class=
"prop-row prop-group">
455 <div class=
"prop-name">
456 <div class=
"prop-title">200 OK
</div>
457 <div class=
"prop-ref">
458 <span class=
"json-schema-ref-array">
459 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
462 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
464 <div class=
"prop-value">
465 <p>successful operation
</p>
470 <div class=
"doc-examples">
471 <h5>Response Content-Types:
472 <span>application/json
</span>
476 <span>(
200 OK)
</span>
478 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
480 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
481 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
482 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
483 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
484 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
485 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
486 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
487 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
488 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
489 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
490 <span class=
"hljs-attr">"avatar
"</span>: {
491 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
492 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
493 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
503 <h1 id=
"tag-Config" class=
"swagger-summary-tag" data-traverse-target=
"tag-Config">Config
</h1>
504 <div id=
"operation--config-get" class=
"operation panel" data-traverse-target=
"operation--config-get">
505 <!-- <section class="operation-tags row"> -->
506 <!-- <div class="doc-copy"> -->
507 <div class=
"operation-tags">
508 <a class=
"label" href=
"#tag-Config">Config
</a>
513 <h2 class=
"operation-title">
514 <span class=
"operation-name">
515 <span class=
"operation-name">GET
</span>
516 <span class=
"operation-path">/config
</span>
519 <div class=
"doc-row">
520 <div class=
"doc-copy"> </div>
521 <div class=
"doc-examples"></div>
523 <div class=
"doc-row">
524 <div class=
"doc-copy">
525 <section class=
"swagger-responses">
526 <div class=
"prop-row prop-group">
527 <div class=
"prop-name">
528 <div class=
"prop-title">200 OK
</div>
529 <div class=
"prop-ref">
531 <a class=
"json-schema-ref" href=
"#/definitions/ServerConfig">ServerConfig
</a>
534 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
536 <div class=
"prop-value">
537 <p>successful operation
</p>
542 <div class=
"doc-examples">
543 <h5>Response Content-Types:
544 <span>application/json
</span>
548 <span>(
200 OK)
</span>
550 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
551 <span class=
"hljs-attr">"signup
"</span>: {
552 <span class=
"hljs-attr">"allowed
"</span>:
<span class=
"hljs-string">"boolean
"</span>
554 <span class=
"hljs-attr">"transcoding
"</span>: {
555 <span class=
"hljs-attr">"enabledResolutions
"</span>: [
556 <span class=
"hljs-string">"number
"</span>
559 <span class=
"hljs-attr">"avatar
"</span>: {
560 <span class=
"hljs-attr">"file
"</span>: {
561 <span class=
"hljs-attr">"size
"</span>: {
562 <span class=
"hljs-attr">"max
"</span>:
<span class=
"hljs-string">"number
"</span>
565 <span class=
"hljs-attr">"extensions
"</span>: [
566 <span class=
"hljs-string">"string
"</span>
569 <span class=
"hljs-attr">"video
"</span>: {
570 <span class=
"hljs-attr">"file
"</span>: {
571 <span class=
"hljs-attr">"extensions
"</span>: [
572 <span class=
"hljs-string">"string
"</span>
583 <h1 id=
"tag-Job" class=
"swagger-summary-tag" data-traverse-target=
"tag-Job">Job
</h1>
584 <div id=
"operation--jobs-get" class=
"operation panel" data-traverse-target=
"operation--jobs-get">
585 <!-- <section class="operation-tags row"> -->
586 <!-- <div class="doc-copy"> -->
587 <div class=
"operation-tags">
588 <a class=
"label" href=
"#tag-Job">Job
</a>
593 <h2 class=
"operation-title">
594 <span class=
"operation-name">
595 <span class=
"operation-name">GET
</span>
596 <span class=
"operation-path">/jobs
</span>
599 <div class=
"doc-row">
600 <div class=
"doc-copy">
601 <section class=
"swagger-request-params">
602 <div class=
"prop-row prop-group">
603 <div class=
"prop-name">
604 <div class=
"prop-title">state
</div>
605 <span class=
"json-property-required"></span>
607 <div class=
"prop-value">
608 <p>The id of the account
</p>
611 <div class=
"prop-row prop-inner">
612 <div class=
"prop-name param-label">type
</div>
613 <div class=
"prop-value">
614 <span class=
"json-property-type">string
</span>
615 <span class=
"json-property-range" title=
"Value limits"></span>
618 <div class=
"prop-row prop-inner">
619 <div class=
"prop-name param-label">in
</div>
620 <div class=
"prop-value">path
</div>
622 <div class=
"prop-row prop-group">
623 <div class=
"prop-name">
624 <div class=
"prop-title">start
</div>
626 <div class=
"prop-value">
630 <div class=
"prop-row prop-inner">
631 <div class=
"prop-name param-label">type
</div>
632 <div class=
"prop-value">
633 <span class=
"json-property-type">number
</span>
634 <span class=
"json-property-range" title=
"Value limits"></span>
637 <div class=
"prop-row prop-inner">
638 <div class=
"prop-name param-label">in
</div>
639 <div class=
"prop-value">query
</div>
641 <div class=
"prop-row prop-group">
642 <div class=
"prop-name">
643 <div class=
"prop-title">count
</div>
645 <div class=
"prop-value">
646 <p class=
"no-description">(no description)
</p>
649 <div class=
"prop-row prop-inner">
650 <div class=
"prop-name param-label">type
</div>
651 <div class=
"prop-value">
652 <span class=
"json-property-type">number
</span>
653 <span class=
"json-property-range" title=
"Value limits"></span>
656 <div class=
"prop-row prop-inner">
657 <div class=
"prop-name param-label">in
</div>
658 <div class=
"prop-value">query
</div>
660 <div class=
"prop-row prop-group">
661 <div class=
"prop-name">
662 <div class=
"prop-title">sort
</div>
664 <div class=
"prop-value">
668 <div class=
"prop-row prop-inner">
669 <div class=
"prop-name param-label">type
</div>
670 <div class=
"prop-value">
671 <span class=
"json-property-type">number
</span>
672 <span class=
"json-property-range" title=
"Value limits"></span>
675 <div class=
"prop-row prop-inner">
676 <div class=
"prop-name param-label">in
</div>
677 <div class=
"prop-value">query
</div>
681 <div class=
"doc-examples"></div>
683 <div class=
"doc-row">
684 <div class=
"doc-copy">
685 <section class=
"swagger-responses">
686 <div class=
"prop-row prop-group">
687 <div class=
"prop-name">
688 <div class=
"prop-title">200 OK
</div>
689 <div class=
"prop-ref">
690 <span class=
"json-schema-ref-array">
691 <a class=
"json-schema-ref" href=
"#/definitions/Job">Job
</a>
694 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
696 <div class=
"prop-value">
697 <p>successful operation
</p>
702 <div class=
"doc-examples">
703 <h5>Response Content-Types:
704 <span>application/json
</span>
708 <span>(
200 OK)
</span>
710 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
712 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
713 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
714 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"string
"</span>,
715 <span class=
"hljs-attr">"handlerName
"</span>:
<span class=
"hljs-string">"string
"</span>,
716 <span class=
"hljs-attr">"handlerInputData
"</span>:
<span class=
"hljs-string">"string
"</span>,
717 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
718 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
727 <h1 id=
"tag-ServerFollowing" class=
"swagger-summary-tag" data-traverse-target=
"tag-ServerFollowing">ServerFollowing
</h1>
728 <div id=
"operation--server-following--host--delete" class=
"operation panel" data-traverse-target=
"operation--server-following--host--delete">
729 <!-- <section class="operation-tags row"> -->
730 <!-- <div class="doc-copy"> -->
731 <div class=
"operation-tags">
732 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
737 <h2 class=
"operation-title">
738 <span class=
"operation-name">
739 <span class=
"operation-name">DELETE
</span>
740 <span class=
"operation-path">/server/following/{host}
</span>
743 <div class=
"doc-row">
744 <div class=
"doc-copy">
745 <section class=
"swagger-request-params">
746 <div class=
"prop-row prop-group">
747 <div class=
"prop-name">
748 <div class=
"prop-title">host
</div>
749 <span class=
"json-property-required"></span>
751 <div class=
"prop-value">
752 <p>The host to unfollow
</p>
755 <div class=
"prop-row prop-inner">
756 <div class=
"prop-name param-label">type
</div>
757 <div class=
"prop-value">
758 <span class=
"json-property-type">string
</span>
759 <span class=
"json-property-range" title=
"Value limits"></span>
762 <div class=
"prop-row prop-inner">
763 <div class=
"prop-name param-label">in
</div>
764 <div class=
"prop-value">path
</div>
768 <div class=
"doc-examples"></div>
770 <div class=
"doc-row">
771 <div class=
"doc-copy">
772 <section class=
"swagger-responses">
773 <div class=
"prop-row prop-group">
774 <div class=
"prop-name">
775 <div class=
"prop-title">201 Created
</div>
777 <div class=
"prop-value">
778 <p>successful operation
</p>
783 <div class=
"doc-examples">
784 <h5>Response Content-Types:
785 <span>application/json
</span>
790 <div id=
"operation--server-followers-get" class=
"operation panel" data-traverse-target=
"operation--server-followers-get">
791 <!-- <section class="operation-tags row"> -->
792 <!-- <div class="doc-copy"> -->
793 <div class=
"operation-tags">
794 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
799 <h2 class=
"operation-title">
800 <span class=
"operation-name">
801 <span class=
"operation-name">GET
</span>
802 <span class=
"operation-path">/server/followers
</span>
805 <div class=
"doc-row">
806 <div class=
"doc-copy">
807 <section class=
"swagger-request-params">
808 <div class=
"prop-row prop-group">
809 <div class=
"prop-name">
810 <div class=
"prop-title">start
</div>
812 <div class=
"prop-value">
816 <div class=
"prop-row prop-inner">
817 <div class=
"prop-name param-label">type
</div>
818 <div class=
"prop-value">
819 <span class=
"json-property-type">number
</span>
820 <span class=
"json-property-range" title=
"Value limits"></span>
823 <div class=
"prop-row prop-inner">
824 <div class=
"prop-name param-label">in
</div>
825 <div class=
"prop-value">query
</div>
827 <div class=
"prop-row prop-group">
828 <div class=
"prop-name">
829 <div class=
"prop-title">stop
</div>
831 <div class=
"prop-value">
835 <div class=
"prop-row prop-inner">
836 <div class=
"prop-name param-label">type
</div>
837 <div class=
"prop-value">
838 <span class=
"json-property-type">number
</span>
839 <span class=
"json-property-range" title=
"Value limits"></span>
842 <div class=
"prop-row prop-inner">
843 <div class=
"prop-name param-label">in
</div>
844 <div class=
"prop-value">query
</div>
846 <div class=
"prop-row prop-group">
847 <div class=
"prop-name">
848 <div class=
"prop-title">sort
</div>
850 <div class=
"prop-value">
854 <div class=
"prop-row prop-inner">
855 <div class=
"prop-name param-label">type
</div>
856 <div class=
"prop-value">
857 <span class=
"json-property-type">number
</span>
858 <span class=
"json-property-range" title=
"Value limits"></span>
861 <div class=
"prop-row prop-inner">
862 <div class=
"prop-name param-label">in
</div>
863 <div class=
"prop-value">query
</div>
867 <div class=
"doc-examples"></div>
869 <div class=
"doc-row">
870 <div class=
"doc-copy">
871 <section class=
"swagger-responses">
872 <div class=
"prop-row prop-group">
873 <div class=
"prop-name">
874 <div class=
"prop-title">200 OK
</div>
875 <div class=
"prop-ref">
876 <span class=
"json-schema-ref-array">
877 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
880 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
882 <div class=
"prop-value">
883 <p>successful operation
</p>
888 <div class=
"doc-examples">
889 <h5>Response Content-Types:
890 <span>application/json
</span>
894 <span>(
200 OK)
</span>
896 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
898 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
899 <span class=
"hljs-attr">"follower
"</span>: {
900 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
901 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
902 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
903 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
904 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
905 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
906 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
907 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
908 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
909 <span class=
"hljs-attr">"avatar
"</span>: {
910 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
911 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
912 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
915 <span class=
"hljs-attr">"following
"</span>: {
916 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
917 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
918 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
919 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
920 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
921 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
922 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
923 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
924 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
925 <span class=
"hljs-attr">"avatar
"</span>: {
926 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
927 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
928 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
931 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
932 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
933 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
934 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
943 <div id=
"operation--server-following-get" class=
"operation panel" data-traverse-target=
"operation--server-following-get">
944 <!-- <section class="operation-tags row"> -->
945 <!-- <div class="doc-copy"> -->
946 <div class=
"operation-tags">
947 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
952 <h2 class=
"operation-title">
953 <span class=
"operation-name">
954 <span class=
"operation-name">GET
</span>
955 <span class=
"operation-path">/server/following
</span>
958 <div class=
"doc-row">
959 <div class=
"doc-copy">
960 <section class=
"swagger-request-params">
961 <div class=
"prop-row prop-group">
962 <div class=
"prop-name">
963 <div class=
"prop-title">start
</div>
965 <div class=
"prop-value">
969 <div class=
"prop-row prop-inner">
970 <div class=
"prop-name param-label">type
</div>
971 <div class=
"prop-value">
972 <span class=
"json-property-type">number
</span>
973 <span class=
"json-property-range" title=
"Value limits"></span>
976 <div class=
"prop-row prop-inner">
977 <div class=
"prop-name param-label">in
</div>
978 <div class=
"prop-value">query
</div>
980 <div class=
"prop-row prop-group">
981 <div class=
"prop-name">
982 <div class=
"prop-title">stop
</div>
984 <div class=
"prop-value">
988 <div class=
"prop-row prop-inner">
989 <div class=
"prop-name param-label">type
</div>
990 <div class=
"prop-value">
991 <span class=
"json-property-type">number
</span>
992 <span class=
"json-property-range" title=
"Value limits"></span>
995 <div class=
"prop-row prop-inner">
996 <div class=
"prop-name param-label">in
</div>
997 <div class=
"prop-value">query
</div>
999 <div class=
"prop-row prop-group">
1000 <div class=
"prop-name">
1001 <div class=
"prop-title">sort
</div>
1003 <div class=
"prop-value">
1007 <div class=
"prop-row prop-inner">
1008 <div class=
"prop-name param-label">type
</div>
1009 <div class=
"prop-value">
1010 <span class=
"json-property-type">number
</span>
1011 <span class=
"json-property-range" title=
"Value limits"></span>
1014 <div class=
"prop-row prop-inner">
1015 <div class=
"prop-name param-label">in
</div>
1016 <div class=
"prop-value">query
</div>
1020 <div class=
"doc-examples"></div>
1022 <div class=
"doc-row">
1023 <div class=
"doc-copy">
1024 <section class=
"swagger-responses">
1025 <div class=
"prop-row prop-group">
1026 <div class=
"prop-name">
1027 <div class=
"prop-title">200 OK
</div>
1028 <div class=
"prop-ref">
1029 <span class=
"json-schema-ref-array">
1030 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1033 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1035 <div class=
"prop-value">
1036 <p>successful operation
</p>
1041 <div class=
"doc-examples">
1042 <h5>Response Content-Types:
1043 <span>application/json
</span>
1046 <h5>Response Example
1047 <span>(
200 OK)
</span>
1049 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1051 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1052 <span class=
"hljs-attr">"follower
"</span>: {
1053 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1054 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1055 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1056 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1057 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1058 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1059 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1060 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1061 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1062 <span class=
"hljs-attr">"avatar
"</span>: {
1063 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1064 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1065 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1068 <span class=
"hljs-attr">"following
"</span>: {
1069 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1070 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1071 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1072 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1073 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1074 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1075 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1076 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1077 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1078 <span class=
"hljs-attr">"avatar
"</span>: {
1079 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1080 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1081 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1084 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1085 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1086 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1087 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1096 <div id=
"operation--server-following-post" class=
"operation panel" data-traverse-target=
"operation--server-following-post">
1097 <!-- <section class="operation-tags row"> -->
1098 <!-- <div class="doc-copy"> -->
1099 <div class=
"operation-tags">
1100 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1105 <h2 class=
"operation-title">
1106 <span class=
"operation-name">
1107 <span class=
"operation-name">POST
</span>
1108 <span class=
"operation-path">/server/following
</span>
1111 <div class=
"doc-row">
1112 <div class=
"doc-copy">
1113 <section class=
"swagger-request-body">
1114 <div class=
"prop-row">
1115 <div class=
"prop-name">
1116 <div class=
"swagger-request-model">
1118 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1122 <div class=
"prop-value columns small-6">
1123 <!-- <div class="swagger-request-description"> -->undefined
1129 <div class=
"doc-examples">
1131 <h5>Request Content-Types:
1132 <span>application/json
</span>
1134 <h5>Request Example
</h5>
1135 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1136 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1137 <span class=
"hljs-attr">"follower
"</span>: {
1138 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1139 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1140 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1141 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1142 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1143 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1144 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1145 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1146 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1147 <span class=
"hljs-attr">"avatar
"</span>: {
1148 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1149 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1150 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1153 <span class=
"hljs-attr">"following
"</span>: {
1154 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1155 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1156 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1157 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1158 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1159 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1160 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1161 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1162 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1163 <span class=
"hljs-attr">"avatar
"</span>: {
1164 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1165 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1166 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1169 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1170 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1171 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1172 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1179 <div class=
"doc-row">
1180 <div class=
"doc-copy">
1181 <section class=
"swagger-responses">
1182 <div class=
"prop-row prop-group">
1183 <div class=
"prop-name">
1184 <div class=
"prop-title">204 No Content
</div>
1186 <div class=
"prop-value">
1187 <p>successful operation
</p>
1192 <div class=
"doc-examples">
1193 <h5>Response Content-Types:
1194 <span>application/json
</span>
1199 <h1 id=
"tag-User" class=
"swagger-summary-tag" data-traverse-target=
"tag-User">User
</h1>
1200 <div id=
"operation--users-post" class=
"operation panel" data-traverse-target=
"operation--users-post">
1201 <!-- <section class="operation-tags row"> -->
1202 <!-- <div class="doc-copy"> -->
1203 <div class=
"operation-tags">
1204 <a class=
"label" href=
"#tag-User">User
</a>
1209 <h2 class=
"operation-title">
1210 <span class=
"operation-name">
1211 <span class=
"operation-name">POST
</span>
1212 <span class=
"operation-path">/users
</span>
1215 <div class=
"doc-row">
1216 <div class=
"doc-copy">
1217 <section class=
"swagger-request-body">
1218 <div class=
"prop-row">
1219 <div class=
"prop-name">
1220 <div class=
"swagger-request-model">
1222 <a class=
"json-schema-ref" href=
"#/definitions/AddUser">AddUser
</a>
1226 <div class=
"prop-value columns small-6">
1227 <!-- <div class="swagger-request-description"> -->
1228 <p>User to create
</p>
1234 <div class=
"doc-examples">
1236 <h5>Request Content-Types:
1237 <span>application/json
</span>
1239 <h5>Request Example
</h5>
1240 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1241 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1242 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
1243 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1244 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
1245 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
1252 <div class=
"doc-row">
1253 <div class=
"doc-copy">
1254 <section class=
"swagger-responses">
1255 <div class=
"prop-row prop-group">
1256 <div class=
"prop-name">
1257 <div class=
"prop-title">200 OK
</div>
1258 <div class=
"prop-ref">
1260 <a class=
"json-schema-ref" href=
"#/definitions/AddUserResponse">AddUserResponse
</a>
1263 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1265 <div class=
"prop-value">
1266 <p>successful operation
</p>
1271 <div class=
"doc-examples">
1272 <h5>Response Content-Types:
1273 <span>application/json
</span>
1276 <h5>Response Example
1277 <span>(
200 OK)
</span>
1279 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1280 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1281 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1289 <div id=
"operation--users-get" class=
"operation panel" data-traverse-target=
"operation--users-get">
1290 <!-- <section class="operation-tags row"> -->
1291 <!-- <div class="doc-copy"> -->
1292 <div class=
"operation-tags">
1293 <a class=
"label" href=
"#tag-User">User
</a>
1298 <h2 class=
"operation-title">
1299 <span class=
"operation-name">
1300 <span class=
"operation-name">GET
</span>
1301 <span class=
"operation-path">/users
</span>
1304 <div class=
"doc-row">
1305 <div class=
"doc-copy">
1306 <section class=
"swagger-request-params">
1307 <div class=
"prop-row prop-group">
1308 <div class=
"prop-name">
1309 <div class=
"prop-title">start
</div>
1311 <div class=
"prop-value">
1312 <p>starting page
</p>
1315 <div class=
"prop-row prop-inner">
1316 <div class=
"prop-name param-label">type
</div>
1317 <div class=
"prop-value">
1318 <span class=
"json-property-type">number
</span>
1319 <span class=
"json-property-range" title=
"Value limits"></span>
1322 <div class=
"prop-row prop-inner">
1323 <div class=
"prop-name param-label">in
</div>
1324 <div class=
"prop-value">query
</div>
1326 <div class=
"prop-row prop-group">
1327 <div class=
"prop-name">
1328 <div class=
"prop-title">stop
</div>
1330 <div class=
"prop-value">
1331 <p>stopping page
</p>
1334 <div class=
"prop-row prop-inner">
1335 <div class=
"prop-name param-label">type
</div>
1336 <div class=
"prop-value">
1337 <span class=
"json-property-type">number
</span>
1338 <span class=
"json-property-range" title=
"Value limits"></span>
1341 <div class=
"prop-row prop-inner">
1342 <div class=
"prop-name param-label">in
</div>
1343 <div class=
"prop-value">query
</div>
1345 <div class=
"prop-row prop-group">
1346 <div class=
"prop-name">
1347 <div class=
"prop-title">sort
</div>
1349 <div class=
"prop-value">
1353 <div class=
"prop-row prop-inner">
1354 <div class=
"prop-name param-label">type
</div>
1355 <div class=
"prop-value">
1356 <span class=
"json-property-type">number
</span>
1357 <span class=
"json-property-range" title=
"Value limits"></span>
1360 <div class=
"prop-row prop-inner">
1361 <div class=
"prop-name param-label">in
</div>
1362 <div class=
"prop-value">query
</div>
1366 <div class=
"doc-examples"></div>
1368 <div class=
"doc-row">
1369 <div class=
"doc-copy">
1370 <section class=
"swagger-responses">
1371 <div class=
"prop-row prop-group">
1372 <div class=
"prop-name">
1373 <div class=
"prop-title">200 OK
</div>
1374 <div class=
"prop-ref">
1375 <span class=
"json-schema-ref-array">
1376 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1379 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1381 <div class=
"prop-value">
1382 <p>successful operation
</p>
1387 <div class=
"doc-examples">
1388 <h5>Response Content-Types:
1389 <span>application/json
</span>
1392 <h5>Response Example
1393 <span>(
200 OK)
</span>
1395 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1397 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1398 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1399 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1400 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1401 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1402 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1403 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1404 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1405 <span class=
"hljs-attr">"account
"</span>: {
1406 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1407 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1408 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1409 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1410 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1411 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1412 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1413 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1414 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1415 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1416 <span class=
"hljs-attr">"avatar
"</span>: {
1417 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1418 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1419 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1422 <span class=
"hljs-attr">"videoChannels
"</span>: [
1424 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1425 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1426 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1427 <span class=
"hljs-attr">"owner
"</span>: {
1428 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1429 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1431 <span class=
"hljs-attr">"videos
"</span>: [
1433 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1434 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1435 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1436 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1437 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1438 <span class=
"hljs-attr">"category
"</span>: {
1439 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1440 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1442 <span class=
"hljs-attr">"licence
"</span>: {
1443 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1444 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1446 <span class=
"hljs-attr">"language
"</span>: {
1447 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1448 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1450 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
1451 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1452 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
1453 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1454 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1455 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1456 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1457 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1458 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
1459 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1460 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1461 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1462 <span class=
"hljs-attr">"account
"</span>: {
1463 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1464 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1465 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1466 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1467 <span class=
"hljs-attr">"avatar
"</span>: {
1468 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1469 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1470 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1485 <div id=
"operation--users--id--delete" class=
"operation panel" data-traverse-target=
"operation--users--id--delete">
1486 <!-- <section class="operation-tags row"> -->
1487 <!-- <div class="doc-copy"> -->
1488 <div class=
"operation-tags">
1489 <a class=
"label" href=
"#tag-User">User
</a>
1494 <h2 class=
"operation-title">
1495 <span class=
"operation-name">
1496 <span class=
"operation-name">DELETE
</span>
1497 <span class=
"operation-path">/users/{id}
</span>
1500 <div class=
"doc-row">
1501 <div class=
"doc-copy">
1502 <section class=
"swagger-request-params">
1503 <div class=
"prop-row prop-group">
1504 <div class=
"prop-name">
1505 <div class=
"prop-title">id
</div>
1506 <span class=
"json-property-required"></span>
1508 <div class=
"prop-value">
1512 <div class=
"prop-row prop-inner">
1513 <div class=
"prop-name param-label">type
</div>
1514 <div class=
"prop-value">
1515 <span class=
"json-property-type">string
</span>
1516 <span class=
"json-property-range" title=
"Value limits"></span>
1519 <div class=
"prop-row prop-inner">
1520 <div class=
"prop-name param-label">in
</div>
1521 <div class=
"prop-value">path
</div>
1525 <div class=
"doc-examples"></div>
1527 <div class=
"doc-row">
1528 <div class=
"doc-copy">
1529 <section class=
"swagger-responses">
1530 <div class=
"prop-row prop-group">
1531 <div class=
"prop-name">
1532 <div class=
"prop-title">204 No Content
</div>
1534 <div class=
"prop-value">
1535 <p>successful operation
</p>
1540 <div class=
"doc-examples">
1541 <h5>Response Content-Types:
1542 <span>application/json
</span>
1547 <div id=
"operation--users--id--get" class=
"operation panel" data-traverse-target=
"operation--users--id--get">
1548 <!-- <section class="operation-tags row"> -->
1549 <!-- <div class="doc-copy"> -->
1550 <div class=
"operation-tags">
1551 <a class=
"label" href=
"#tag-User">User
</a>
1556 <h2 class=
"operation-title">
1557 <span class=
"operation-name">
1558 <span class=
"operation-name">GET
</span>
1559 <span class=
"operation-path">/users/{id}
</span>
1562 <div class=
"doc-row">
1563 <div class=
"doc-copy">
1564 <section class=
"swagger-request-params">
1565 <div class=
"prop-row prop-group">
1566 <div class=
"prop-name">
1567 <div class=
"prop-title">id
</div>
1568 <span class=
"json-property-required"></span>
1570 <div class=
"prop-value">
1574 <div class=
"prop-row prop-inner">
1575 <div class=
"prop-name param-label">type
</div>
1576 <div class=
"prop-value">
1577 <span class=
"json-property-type">string
</span>
1578 <span class=
"json-property-range" title=
"Value limits"></span>
1581 <div class=
"prop-row prop-inner">
1582 <div class=
"prop-name param-label">in
</div>
1583 <div class=
"prop-value">path
</div>
1587 <div class=
"doc-examples"></div>
1589 <div class=
"doc-row">
1590 <div class=
"doc-copy">
1591 <section class=
"swagger-responses">
1592 <div class=
"prop-row prop-group">
1593 <div class=
"prop-name">
1594 <div class=
"prop-title">200 OK
</div>
1595 <div class=
"prop-ref">
1597 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1600 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1602 <div class=
"prop-value">
1603 <p>successful operation
</p>
1608 <div class=
"doc-examples">
1609 <h5>Response Content-Types:
1610 <span>application/json
</span>
1613 <h5>Response Example
1614 <span>(
200 OK)
</span>
1616 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1617 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1618 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1619 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1620 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1621 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1622 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1623 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1624 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1625 <span class=
"hljs-attr">"account
"</span>: {
1626 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1627 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1628 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1629 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1630 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1631 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1632 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1633 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1634 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1635 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1636 <span class=
"hljs-attr">"avatar
"</span>: {
1637 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1638 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1639 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1642 <span class=
"hljs-attr">"videoChannels
"</span>: [
1644 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1645 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1646 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1647 <span class=
"hljs-attr">"owner
"</span>: {
1648 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1649 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1651 <span class=
"hljs-attr">"videos
"</span>: [
1653 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1654 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1655 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1656 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1657 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1658 <span class=
"hljs-attr">"category
"</span>: {
1659 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1660 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1662 <span class=
"hljs-attr">"licence
"</span>: {
1663 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1664 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1666 <span class=
"hljs-attr">"language
"</span>: {
1667 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1668 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1670 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
1671 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1672 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
1673 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1674 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1675 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1676 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1677 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1678 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
1679 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1680 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1681 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1682 <span class=
"hljs-attr">"account
"</span>: {
1683 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1684 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1685 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1686 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1687 <span class=
"hljs-attr">"avatar
"</span>: {
1688 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1689 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1690 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1704 <div id=
"operation--users--id--put" class=
"operation panel" data-traverse-target=
"operation--users--id--put">
1705 <!-- <section class="operation-tags row"> -->
1706 <!-- <div class="doc-copy"> -->
1707 <div class=
"operation-tags">
1708 <a class=
"label" href=
"#tag-User">User
</a>
1713 <h2 class=
"operation-title">
1714 <span class=
"operation-name">
1715 <span class=
"operation-name">PUT
</span>
1716 <span class=
"operation-path">/users/{id}
</span>
1719 <div class=
"doc-row">
1720 <div class=
"doc-copy">
1721 <section class=
"swagger-request-body">
1722 <div class=
"prop-row">
1723 <div class=
"prop-name">
1724 <div class=
"swagger-request-model">
1726 <a class=
"json-schema-ref" href=
"#/definitions/UpdateUser">UpdateUser
</a>
1730 <div class=
"prop-value columns small-6">
1731 <!-- <div class="swagger-request-description"> -->undefined
1736 <section class=
"swagger-request-params">
1737 <div class=
"prop-row prop-group">
1738 <div class=
"prop-name">
1739 <div class=
"prop-title">id
</div>
1740 <span class=
"json-property-required"></span>
1742 <div class=
"prop-value">
1746 <div class=
"prop-row prop-inner">
1747 <div class=
"prop-name param-label">type
</div>
1748 <div class=
"prop-value">
1749 <span class=
"json-property-type">string
</span>
1750 <span class=
"json-property-range" title=
"Value limits"></span>
1753 <div class=
"prop-row prop-inner">
1754 <div class=
"prop-name param-label">in
</div>
1755 <div class=
"prop-value">path
</div>
1759 <div class=
"doc-examples">
1761 <h5>Request Content-Types:
1762 <span>application/json
</span>
1764 <h5>Request Example
</h5>
1765 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1766 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
1767 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1768 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
1769 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
1776 <div class=
"doc-row">
1777 <div class=
"doc-copy">
1778 <section class=
"swagger-responses">
1779 <div class=
"prop-row prop-group">
1780 <div class=
"prop-name">
1781 <div class=
"prop-title">204 No Content
</div>
1783 <div class=
"prop-value">
1784 <p>successful operation
</p>
1789 <div class=
"doc-examples">
1790 <h5>Response Content-Types:
1791 <span>application/json
</span>
1796 <div id=
"operation--users-me-get" class=
"operation panel" data-traverse-target=
"operation--users-me-get">
1797 <!-- <section class="operation-tags row"> -->
1798 <!-- <div class="doc-copy"> -->
1799 <div class=
"operation-tags">
1800 <a class=
"label" href=
"#tag-User">User
</a>
1805 <h2 class=
"operation-title">
1806 <span class=
"operation-name">
1807 <span class=
"operation-name">GET
</span>
1808 <span class=
"operation-path">/users/me
</span>
1811 <div class=
"doc-row">
1812 <div class=
"doc-copy"> </div>
1813 <div class=
"doc-examples"></div>
1815 <div class=
"doc-row">
1816 <div class=
"doc-copy">
1817 <section class=
"swagger-responses">
1818 <div class=
"prop-row prop-group">
1819 <div class=
"prop-name">
1820 <div class=
"prop-title">200 OK
</div>
1821 <div class=
"prop-ref">
1822 <span class=
"json-schema-ref-array">
1823 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1826 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1828 <div class=
"prop-value">
1829 <p>successful operation
</p>
1834 <div class=
"doc-examples">
1835 <h5>Response Content-Types:
1836 <span>application/json
</span>
1839 <h5>Response Example
1840 <span>(
200 OK)
</span>
1842 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1844 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1845 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1846 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1847 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1848 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1849 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1850 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1851 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1852 <span class=
"hljs-attr">"account
"</span>: {
1853 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1854 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1855 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1856 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1857 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1858 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1859 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1860 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1861 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1862 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1863 <span class=
"hljs-attr">"avatar
"</span>: {
1864 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1865 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1866 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1869 <span class=
"hljs-attr">"videoChannels
"</span>: [
1871 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1872 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1873 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1874 <span class=
"hljs-attr">"owner
"</span>: {
1875 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1876 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1878 <span class=
"hljs-attr">"videos
"</span>: [
1880 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1881 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1882 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1883 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1884 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1885 <span class=
"hljs-attr">"category
"</span>: {
1886 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1887 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1889 <span class=
"hljs-attr">"licence
"</span>: {
1890 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1891 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1893 <span class=
"hljs-attr">"language
"</span>: {
1894 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1895 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1897 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
1898 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1899 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
1900 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1901 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1902 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1903 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1904 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1905 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
1906 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1907 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1908 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1909 <span class=
"hljs-attr">"account
"</span>: {
1910 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1911 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1912 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1913 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1914 <span class=
"hljs-attr">"avatar
"</span>: {
1915 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1916 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1917 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1932 <div id=
"operation--users-me-put" class=
"operation panel" data-traverse-target=
"operation--users-me-put">
1933 <!-- <section class="operation-tags row"> -->
1934 <!-- <div class="doc-copy"> -->
1935 <div class=
"operation-tags">
1936 <a class=
"label" href=
"#tag-User">User
</a>
1941 <h2 class=
"operation-title">
1942 <span class=
"operation-name">
1943 <span class=
"operation-name">PUT
</span>
1944 <span class=
"operation-path">/users/me
</span>
1947 <div class=
"doc-row">
1948 <div class=
"doc-copy">
1949 <section class=
"swagger-request-body">
1950 <div class=
"prop-row">
1951 <div class=
"prop-name">
1952 <div class=
"swagger-request-model">
1954 <a class=
"json-schema-ref" href=
"#/definitions/UpdateMe">UpdateMe
</a>
1958 <div class=
"prop-value columns small-6">
1959 <!-- <div class="swagger-request-description"> -->undefined
1965 <div class=
"doc-examples">
1967 <h5>Request Content-Types:
1968 <span>application/json
</span>
1970 <h5>Request Example
</h5>
1971 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1972 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
1973 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1974 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"string
"</span>,
1975 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"string
"</span>
1982 <div class=
"doc-row">
1983 <div class=
"doc-copy">
1984 <section class=
"swagger-responses">
1985 <div class=
"prop-row prop-group">
1986 <div class=
"prop-name">
1987 <div class=
"prop-title">204 No Content
</div>
1989 <div class=
"prop-value">
1990 <p>successful operation
</p>
1995 <div class=
"doc-examples">
1996 <h5>Response Content-Types:
1997 <span>application/json
</span>
2002 <div id=
"operation--users-me-video-quota-used-get" class=
"operation panel" data-traverse-target=
"operation--users-me-video-quota-used-get">
2003 <!-- <section class="operation-tags row"> -->
2004 <!-- <div class="doc-copy"> -->
2005 <div class=
"operation-tags">
2006 <a class=
"label" href=
"#tag-User">User
</a>
2011 <h2 class=
"operation-title">
2012 <span class=
"operation-name">
2013 <span class=
"operation-name">GET
</span>
2014 <span class=
"operation-path">/users/me/video-quota-used
</span>
2017 <div class=
"doc-row">
2018 <div class=
"doc-copy"> </div>
2019 <div class=
"doc-examples"></div>
2021 <div class=
"doc-row">
2022 <div class=
"doc-copy">
2023 <section class=
"swagger-responses">
2024 <div class=
"prop-row prop-group">
2025 <div class=
"prop-name">
2026 <div class=
"prop-title">200 OK
</div>
2027 <div class=
"prop-ref"></div>
2028 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2030 <div class=
"prop-value">
2031 <p>successful operation
</p>
2036 <div class=
"doc-examples">
2037 <h5>Response Content-Types:
2038 <span>application/json
</span>
2041 <h5>Response Example
2042 <span>(
200 OK)
</span>
2044 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json"><span class=
"hljs-string">"number
"</span>
2051 <div id=
"operation--users-me-videos--videoId--rating-get" class=
"operation panel" data-traverse-target=
"operation--users-me-videos--videoId--rating-get">
2052 <!-- <section class="operation-tags row"> -->
2053 <!-- <div class="doc-copy"> -->
2054 <div class=
"operation-tags">
2055 <a class=
"label" href=
"#tag-User">User
</a>
2060 <h2 class=
"operation-title">
2061 <span class=
"operation-name">
2062 <span class=
"operation-name">GET
</span>
2063 <span class=
"operation-path">/users/me/videos/{videoId}/rating
</span>
2066 <div class=
"doc-row">
2067 <div class=
"doc-copy">
2068 <section class=
"swagger-request-params">
2069 <div class=
"prop-row prop-group">
2070 <div class=
"prop-name">
2071 <div class=
"prop-title">videoId
</div>
2072 <span class=
"json-property-required"></span>
2074 <div class=
"prop-value">
2075 <p>The video id
</p>
2078 <div class=
"prop-row prop-inner">
2079 <div class=
"prop-name param-label">type
</div>
2080 <div class=
"prop-value">
2081 <span class=
"json-property-type">string
</span>
2082 <span class=
"json-property-range" title=
"Value limits"></span>
2085 <div class=
"prop-row prop-inner">
2086 <div class=
"prop-name param-label">in
</div>
2087 <div class=
"prop-value">path
</div>
2091 <div class=
"doc-examples"></div>
2093 <div class=
"doc-row">
2094 <div class=
"doc-copy">
2095 <section class=
"swagger-responses">
2096 <div class=
"prop-row prop-group">
2097 <div class=
"prop-name">
2098 <div class=
"prop-title">200 OK
</div>
2099 <div class=
"prop-ref">
2101 <a class=
"json-schema-ref" href=
"#/definitions/GetMeVideoRating">GetMeVideoRating
</a>
2104 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2106 <div class=
"prop-value">
2107 <p>successful operation
</p>
2112 <div class=
"doc-examples">
2113 <h5>Response Content-Types:
2114 <span>application/json
</span>
2117 <h5>Response Example
2118 <span>(
200 OK)
</span>
2120 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2121 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2122 <span class=
"hljs-attr">"rating
"</span>:
<span class=
"hljs-string">"number
"</span>
2130 <div id=
"operation--users-me-videos-get" class=
"operation panel" data-traverse-target=
"operation--users-me-videos-get">
2131 <!-- <section class="operation-tags row"> -->
2132 <!-- <div class="doc-copy"> -->
2133 <div class=
"operation-tags">
2134 <a class=
"label" href=
"#tag-User">User
</a>
2139 <h2 class=
"operation-title">
2140 <span class=
"operation-name">
2141 <span class=
"operation-name">GET
</span>
2142 <span class=
"operation-path">/users/me/videos
</span>
2145 <div class=
"doc-row">
2146 <div class=
"doc-copy">
2147 <section class=
"swagger-request-params">
2148 <div class=
"prop-row prop-group">
2149 <div class=
"prop-name">
2150 <div class=
"prop-title">start
</div>
2152 <div class=
"prop-value">
2153 <p>starting page
</p>
2156 <div class=
"prop-row prop-inner">
2157 <div class=
"prop-name param-label">type
</div>
2158 <div class=
"prop-value">
2159 <span class=
"json-property-type">number
</span>
2160 <span class=
"json-property-range" title=
"Value limits"></span>
2163 <div class=
"prop-row prop-inner">
2164 <div class=
"prop-name param-label">in
</div>
2165 <div class=
"prop-value">query
</div>
2167 <div class=
"prop-row prop-group">
2168 <div class=
"prop-name">
2169 <div class=
"prop-title">stop
</div>
2171 <div class=
"prop-value">
2172 <p>stopping page
</p>
2175 <div class=
"prop-row prop-inner">
2176 <div class=
"prop-name param-label">type
</div>
2177 <div class=
"prop-value">
2178 <span class=
"json-property-type">number
</span>
2179 <span class=
"json-property-range" title=
"Value limits"></span>
2182 <div class=
"prop-row prop-inner">
2183 <div class=
"prop-name param-label">in
</div>
2184 <div class=
"prop-value">query
</div>
2186 <div class=
"prop-row prop-group">
2187 <div class=
"prop-name">
2188 <div class=
"prop-title">sort
</div>
2190 <div class=
"prop-value">
2194 <div class=
"prop-row prop-inner">
2195 <div class=
"prop-name param-label">type
</div>
2196 <div class=
"prop-value">
2197 <span class=
"json-property-type">number
</span>
2198 <span class=
"json-property-range" title=
"Value limits"></span>
2201 <div class=
"prop-row prop-inner">
2202 <div class=
"prop-name param-label">in
</div>
2203 <div class=
"prop-value">query
</div>
2207 <div class=
"doc-examples"></div>
2209 <div class=
"doc-row">
2210 <div class=
"doc-copy">
2211 <section class=
"swagger-responses">
2212 <div class=
"prop-row prop-group">
2213 <div class=
"prop-name">
2214 <div class=
"prop-title">200 OK
</div>
2215 <div class=
"prop-ref">
2216 <span class=
"json-schema-ref-array">
2217 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2220 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2222 <div class=
"prop-value">
2223 <p>successful operation
</p>
2228 <div class=
"doc-examples">
2229 <h5>Response Content-Types:
2230 <span>application/json
</span>
2233 <h5>Response Example
2234 <span>(
200 OK)
</span>
2236 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2238 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2239 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2240 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2241 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2242 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2243 <span class=
"hljs-attr">"category
"</span>: {
2244 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2245 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2247 <span class=
"hljs-attr">"licence
"</span>: {
2248 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2249 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2251 <span class=
"hljs-attr">"language
"</span>: {
2252 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2253 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2255 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
2256 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2257 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2258 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2259 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2260 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2261 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2262 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2263 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2264 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2265 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2266 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2267 <span class=
"hljs-attr">"account
"</span>: {
2268 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2269 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2270 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2271 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2272 <span class=
"hljs-attr">"avatar
"</span>: {
2273 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2274 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2275 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2286 <div id=
"operation--users-register-post" class=
"operation panel" data-traverse-target=
"operation--users-register-post">
2287 <!-- <section class="operation-tags row"> -->
2288 <!-- <div class="doc-copy"> -->
2289 <div class=
"operation-tags">
2290 <a class=
"label" href=
"#tag-User">User
</a>
2295 <h2 class=
"operation-title">
2296 <span class=
"operation-name">
2297 <span class=
"operation-name">POST
</span>
2298 <span class=
"operation-path">/users/register
</span>
2301 <div class=
"doc-row">
2302 <div class=
"doc-copy">
2303 <section class=
"swagger-request-body">
2304 <div class=
"prop-row">
2305 <div class=
"prop-name">
2306 <div class=
"swagger-request-model">
2308 <a class=
"json-schema-ref" href=
"#/definitions/RegisterUser">RegisterUser
</a>
2312 <div class=
"prop-value columns small-6">
2313 <!-- <div class="swagger-request-description"> -->undefined
2319 <div class=
"doc-examples">
2321 <h5>Request Content-Types:
2322 <span>application/json
</span>
2324 <h5>Request Example
</h5>
2325 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2326 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
2327 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
2328 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>
2335 <div class=
"doc-row">
2336 <div class=
"doc-copy">
2337 <section class=
"swagger-responses">
2338 <div class=
"prop-row prop-group">
2339 <div class=
"prop-name">
2340 <div class=
"prop-title">204 No Content
</div>
2342 <div class=
"prop-value">
2343 <p>successful operation
</p>
2348 <div class=
"doc-examples">
2349 <h5>Response Content-Types:
2350 <span>application/json
</span>
2355 <div id=
"operation--users-me-avatar-pick-post" class=
"operation panel" data-traverse-target=
"operation--users-me-avatar-pick-post">
2356 <!-- <section class="operation-tags row"> -->
2357 <!-- <div class="doc-copy"> -->
2358 <div class=
"operation-tags">
2359 <a class=
"label" href=
"#tag-User">User
</a>
2364 <h2 class=
"operation-title">
2365 <span class=
"operation-name">
2366 <span class=
"operation-name">POST
</span>
2367 <span class=
"operation-path">/users/me/avatar/pick
</span>
2370 <div class=
"doc-row">
2371 <div class=
"doc-copy">
2372 <section class=
"swagger-request-params">
2373 <div class=
"prop-row prop-group">
2374 <div class=
"prop-name">
2375 <div class=
"prop-title">avatarfile
</div>
2377 <div class=
"prop-value">
2378 <p>The file to upload.
</p>
2381 <div class=
"prop-row prop-inner">
2382 <div class=
"prop-name param-label">type
</div>
2383 <div class=
"prop-value">
2384 <span class=
"json-property-type">file
</span>
2385 <span class=
"json-property-range" title=
"Value limits"></span>
2388 <div class=
"prop-row prop-inner">
2389 <div class=
"prop-name param-label">in
</div>
2390 <div class=
"prop-value">formData
</div>
2394 <div class=
"doc-examples"></div>
2396 <div class=
"doc-row">
2397 <div class=
"doc-copy">
2398 <section class=
"swagger-responses">
2399 <div class=
"prop-row prop-group">
2400 <div class=
"prop-name">
2401 <div class=
"prop-title">200 OK
</div>
2402 <div class=
"prop-ref">
2404 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
2407 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2409 <div class=
"prop-value">
2410 <p>successful operation
</p>
2415 <div class=
"doc-examples">
2416 <h5>Response Content-Types:
2417 <span>application/json
</span>
2420 <h5>Response Example
2421 <span>(
200 OK)
</span>
2423 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2424 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2425 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2426 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2434 <h1 id=
"tag-Video" class=
"swagger-summary-tag" data-traverse-target=
"tag-Video">Video
</h1>
2435 <div id=
"operation--videos-get" class=
"operation panel" data-traverse-target=
"operation--videos-get">
2436 <!-- <section class="operation-tags row"> -->
2437 <!-- <div class="doc-copy"> -->
2438 <div class=
"operation-tags">
2439 <a class=
"label" href=
"#tag-Video">Video
</a>
2444 <h2 class=
"operation-title">
2445 <span class=
"operation-name">
2446 <span class=
"operation-name">GET
</span>
2447 <span class=
"operation-path">/videos
</span>
2450 <div class=
"doc-row">
2451 <div class=
"doc-copy">
2452 <section class=
"swagger-request-params">
2453 <div class=
"prop-row prop-group">
2454 <div class=
"prop-name">
2455 <div class=
"prop-title">start
</div>
2457 <div class=
"prop-value">
2458 <p>starting page
</p>
2461 <div class=
"prop-row prop-inner">
2462 <div class=
"prop-name param-label">type
</div>
2463 <div class=
"prop-value">
2464 <span class=
"json-property-type">number
</span>
2465 <span class=
"json-property-range" title=
"Value limits"></span>
2468 <div class=
"prop-row prop-inner">
2469 <div class=
"prop-name param-label">in
</div>
2470 <div class=
"prop-value">query
</div>
2472 <div class=
"prop-row prop-group">
2473 <div class=
"prop-name">
2474 <div class=
"prop-title">stop
</div>
2476 <div class=
"prop-value">
2477 <p>stopping page
</p>
2480 <div class=
"prop-row prop-inner">
2481 <div class=
"prop-name param-label">type
</div>
2482 <div class=
"prop-value">
2483 <span class=
"json-property-type">number
</span>
2484 <span class=
"json-property-range" title=
"Value limits"></span>
2487 <div class=
"prop-row prop-inner">
2488 <div class=
"prop-name param-label">in
</div>
2489 <div class=
"prop-value">query
</div>
2491 <div class=
"prop-row prop-group">
2492 <div class=
"prop-name">
2493 <div class=
"prop-title">sort
</div>
2495 <div class=
"prop-value">
2499 <div class=
"prop-row prop-inner">
2500 <div class=
"prop-name param-label">type
</div>
2501 <div class=
"prop-value">
2502 <span class=
"json-property-type">number
</span>
2503 <span class=
"json-property-range" title=
"Value limits"></span>
2506 <div class=
"prop-row prop-inner">
2507 <div class=
"prop-name param-label">in
</div>
2508 <div class=
"prop-value">query
</div>
2512 <div class=
"doc-examples"></div>
2514 <div class=
"doc-row">
2515 <div class=
"doc-copy">
2516 <section class=
"swagger-responses">
2517 <div class=
"prop-row prop-group">
2518 <div class=
"prop-name">
2519 <div class=
"prop-title">200 OK
</div>
2520 <div class=
"prop-ref">
2521 <span class=
"json-schema-ref-array">
2522 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2525 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2527 <div class=
"prop-value">
2528 <p>successful operation
</p>
2533 <div class=
"doc-examples">
2534 <h5>Response Content-Types:
2535 <span>application/json
</span>
2538 <h5>Response Example
2539 <span>(
200 OK)
</span>
2541 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2543 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2544 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2545 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2546 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2547 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2548 <span class=
"hljs-attr">"category
"</span>: {
2549 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2550 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2552 <span class=
"hljs-attr">"licence
"</span>: {
2553 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2554 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2556 <span class=
"hljs-attr">"language
"</span>: {
2557 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2558 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2560 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
2561 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2562 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2563 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2564 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2565 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2566 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2567 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2568 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2569 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2570 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2571 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2572 <span class=
"hljs-attr">"account
"</span>: {
2573 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2574 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2575 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2576 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2577 <span class=
"hljs-attr">"avatar
"</span>: {
2578 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2579 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2580 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2591 <div id=
"operation--videos-categories-get" class=
"operation panel" data-traverse-target=
"operation--videos-categories-get">
2592 <!-- <section class="operation-tags row"> -->
2593 <!-- <div class="doc-copy"> -->
2594 <div class=
"operation-tags">
2595 <a class=
"label" href=
"#tag-Video">Video
</a>
2600 <h2 class=
"operation-title">
2601 <span class=
"operation-name">
2602 <span class=
"operation-name">GET
</span>
2603 <span class=
"operation-path">/videos/categories
</span>
2606 <div class=
"doc-row">
2607 <div class=
"doc-copy"> </div>
2608 <div class=
"doc-examples"></div>
2610 <div class=
"doc-row">
2611 <div class=
"doc-copy">
2612 <section class=
"swagger-responses">
2613 <div class=
"prop-row prop-group">
2614 <div class=
"prop-name">
2615 <div class=
"prop-title">200 OK
</div>
2616 <div class=
"prop-ref"></div>
2617 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2619 <div class=
"prop-value">
2620 <p>successful operation
</p>
2625 <div class=
"doc-examples">
2626 <h5>Response Content-Types:
2627 <span>application/json
</span>
2630 <h5>Response Example
2631 <span>(
200 OK)
</span>
2633 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2634 <span class=
"hljs-string">"string
"</span>
2642 <div id=
"operation--videos-licences-get" class=
"operation panel" data-traverse-target=
"operation--videos-licences-get">
2643 <!-- <section class="operation-tags row"> -->
2644 <!-- <div class="doc-copy"> -->
2645 <div class=
"operation-tags">
2646 <a class=
"label" href=
"#tag-Video">Video
</a>
2651 <h2 class=
"operation-title">
2652 <span class=
"operation-name">
2653 <span class=
"operation-name">GET
</span>
2654 <span class=
"operation-path">/videos/licences
</span>
2657 <div class=
"doc-row">
2658 <div class=
"doc-copy"> </div>
2659 <div class=
"doc-examples"></div>
2661 <div class=
"doc-row">
2662 <div class=
"doc-copy">
2663 <section class=
"swagger-responses">
2664 <div class=
"prop-row prop-group">
2665 <div class=
"prop-name">
2666 <div class=
"prop-title">200 OK
</div>
2667 <div class=
"prop-ref"></div>
2668 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2670 <div class=
"prop-value">
2671 <p>successful operation
</p>
2676 <div class=
"doc-examples">
2677 <h5>Response Content-Types:
2678 <span>application/json
</span>
2681 <h5>Response Example
2682 <span>(
200 OK)
</span>
2684 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2685 <span class=
"hljs-string">"string
"</span>
2693 <div id=
"operation--videos-languages-get" class=
"operation panel" data-traverse-target=
"operation--videos-languages-get">
2694 <!-- <section class="operation-tags row"> -->
2695 <!-- <div class="doc-copy"> -->
2696 <div class=
"operation-tags">
2697 <a class=
"label" href=
"#tag-Video">Video
</a>
2702 <h2 class=
"operation-title">
2703 <span class=
"operation-name">
2704 <span class=
"operation-name">GET
</span>
2705 <span class=
"operation-path">/videos/languages
</span>
2708 <div class=
"doc-row">
2709 <div class=
"doc-copy"> </div>
2710 <div class=
"doc-examples"></div>
2712 <div class=
"doc-row">
2713 <div class=
"doc-copy">
2714 <section class=
"swagger-responses">
2715 <div class=
"prop-row prop-group">
2716 <div class=
"prop-name">
2717 <div class=
"prop-title">200 OK
</div>
2718 <div class=
"prop-ref"></div>
2719 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2721 <div class=
"prop-value">
2722 <p>successful operation
</p>
2727 <div class=
"doc-examples">
2728 <h5>Response Content-Types:
2729 <span>application/json
</span>
2732 <h5>Response Example
2733 <span>(
200 OK)
</span>
2735 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2736 <span class=
"hljs-string">"string
"</span>
2744 <div id=
"operation--videos-privacies-get" class=
"operation panel" data-traverse-target=
"operation--videos-privacies-get">
2745 <!-- <section class="operation-tags row"> -->
2746 <!-- <div class="doc-copy"> -->
2747 <div class=
"operation-tags">
2748 <a class=
"label" href=
"#tag-Video">Video
</a>
2753 <h2 class=
"operation-title">
2754 <span class=
"operation-name">
2755 <span class=
"operation-name">GET
</span>
2756 <span class=
"operation-path">/videos/privacies
</span>
2759 <div class=
"doc-row">
2760 <div class=
"doc-copy"> </div>
2761 <div class=
"doc-examples"></div>
2763 <div class=
"doc-row">
2764 <div class=
"doc-copy">
2765 <section class=
"swagger-responses">
2766 <div class=
"prop-row prop-group">
2767 <div class=
"prop-name">
2768 <div class=
"prop-title">200 OK
</div>
2769 <div class=
"prop-ref"></div>
2770 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2772 <div class=
"prop-value">
2773 <p>successful operation
</p>
2778 <div class=
"doc-examples">
2779 <h5>Response Content-Types:
2780 <span>application/json
</span>
2783 <h5>Response Example
2784 <span>(
200 OK)
</span>
2786 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2787 <span class=
"hljs-string">"string
"</span>
2795 <div id=
"operation--videos-search-get" class=
"operation panel" data-traverse-target=
"operation--videos-search-get">
2796 <!-- <section class="operation-tags row"> -->
2797 <!-- <div class="doc-copy"> -->
2798 <div class=
"operation-tags">
2799 <a class=
"label" href=
"#tag-Video">Video
</a>
2804 <h2 class=
"operation-title">
2805 <span class=
"operation-name">
2806 <span class=
"operation-name">GET
</span>
2807 <span class=
"operation-path">/videos/search
</span>
2810 <div class=
"doc-row">
2811 <div class=
"doc-copy">
2812 <section class=
"swagger-request-params">
2813 <div class=
"prop-row prop-group">
2814 <div class=
"prop-name">
2815 <div class=
"prop-title">start
</div>
2817 <div class=
"prop-value">
2818 <p>starting page
</p>
2821 <div class=
"prop-row prop-inner">
2822 <div class=
"prop-name param-label">type
</div>
2823 <div class=
"prop-value">
2824 <span class=
"json-property-type">number
</span>
2825 <span class=
"json-property-range" title=
"Value limits"></span>
2828 <div class=
"prop-row prop-inner">
2829 <div class=
"prop-name param-label">in
</div>
2830 <div class=
"prop-value">query
</div>
2832 <div class=
"prop-row prop-group">
2833 <div class=
"prop-name">
2834 <div class=
"prop-title">stop
</div>
2836 <div class=
"prop-value">
2837 <p>stopping page
</p>
2840 <div class=
"prop-row prop-inner">
2841 <div class=
"prop-name param-label">type
</div>
2842 <div class=
"prop-value">
2843 <span class=
"json-property-type">number
</span>
2844 <span class=
"json-property-range" title=
"Value limits"></span>
2847 <div class=
"prop-row prop-inner">
2848 <div class=
"prop-name param-label">in
</div>
2849 <div class=
"prop-value">query
</div>
2851 <div class=
"prop-row prop-group">
2852 <div class=
"prop-name">
2853 <div class=
"prop-title">sort
</div>
2855 <div class=
"prop-value">
2859 <div class=
"prop-row prop-inner">
2860 <div class=
"prop-name param-label">type
</div>
2861 <div class=
"prop-value">
2862 <span class=
"json-property-type">number
</span>
2863 <span class=
"json-property-range" title=
"Value limits"></span>
2866 <div class=
"prop-row prop-inner">
2867 <div class=
"prop-name param-label">in
</div>
2868 <div class=
"prop-value">query
</div>
2872 <div class=
"doc-examples"></div>
2874 <div class=
"doc-row">
2875 <div class=
"doc-copy">
2876 <section class=
"swagger-responses">
2877 <div class=
"prop-row prop-group">
2878 <div class=
"prop-name">
2879 <div class=
"prop-title">200 OK
</div>
2880 <div class=
"prop-ref">
2881 <span class=
"json-schema-ref-array">
2882 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2885 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2887 <div class=
"prop-value">
2888 <p>successful operation
</p>
2893 <div class=
"doc-examples">
2894 <h5>Response Content-Types:
2895 <span>application/json
</span>
2898 <h5>Response Example
2899 <span>(
200 OK)
</span>
2901 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2903 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2904 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2905 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2906 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2907 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2908 <span class=
"hljs-attr">"category
"</span>: {
2909 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2910 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2912 <span class=
"hljs-attr">"licence
"</span>: {
2913 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2914 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2916 <span class=
"hljs-attr">"language
"</span>: {
2917 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2918 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2920 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
2921 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2922 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2923 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2924 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2925 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2926 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2927 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2928 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2929 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2930 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2931 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2932 <span class=
"hljs-attr">"account
"</span>: {
2933 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2934 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2935 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2936 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2937 <span class=
"hljs-attr">"avatar
"</span>: {
2938 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2939 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2940 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2951 <div id=
"operation--videos--id--put" class=
"operation panel" data-traverse-target=
"operation--videos--id--put">
2952 <!-- <section class="operation-tags row"> -->
2953 <!-- <div class="doc-copy"> -->
2954 <div class=
"operation-tags">
2955 <a class=
"label" href=
"#tag-Video">Video
</a>
2960 <h2 class=
"operation-title">
2961 <span class=
"operation-name">
2962 <span class=
"operation-name">PUT
</span>
2963 <span class=
"operation-path">/videos/{id}
</span>
2966 <div class=
"doc-row">
2967 <div class=
"doc-copy">
2968 <section class=
"swagger-request-params">
2969 <div class=
"prop-row prop-group">
2970 <div class=
"prop-name">
2971 <div class=
"prop-title">id
</div>
2972 <span class=
"json-property-required"></span>
2974 <div class=
"prop-value">
2978 <div class=
"prop-row prop-inner">
2979 <div class=
"prop-name param-label">type
</div>
2980 <div class=
"prop-value">
2981 <span class=
"json-property-type">string
</span>
2982 <span class=
"json-property-range" title=
"Value limits"></span>
2985 <div class=
"prop-row prop-inner">
2986 <div class=
"prop-name param-label">in
</div>
2987 <div class=
"prop-value">path
</div>
2989 <div class=
"prop-row prop-group">
2990 <div class=
"prop-name">
2991 <div class=
"prop-title">thumbnailfile
</div>
2993 <div class=
"prop-value">
2994 <p>Video thumbnail file
</p>
2997 <div class=
"prop-row prop-inner">
2998 <div class=
"prop-name param-label">type
</div>
2999 <div class=
"prop-value">
3000 <span class=
"json-property-type">file
</span>
3001 <span class=
"json-property-range" title=
"Value limits"></span>
3004 <div class=
"prop-row prop-inner">
3005 <div class=
"prop-name param-label">in
</div>
3006 <div class=
"prop-value">formData
</div>
3008 <div class=
"prop-row prop-group">
3009 <div class=
"prop-name">
3010 <div class=
"prop-title">previewfile
</div>
3012 <div class=
"prop-value">
3013 <p>Video preview file
</p>
3016 <div class=
"prop-row prop-inner">
3017 <div class=
"prop-name param-label">type
</div>
3018 <div class=
"prop-value">
3019 <span class=
"json-property-type">file
</span>
3020 <span class=
"json-property-range" title=
"Value limits"></span>
3023 <div class=
"prop-row prop-inner">
3024 <div class=
"prop-name param-label">in
</div>
3025 <div class=
"prop-value">formData
</div>
3027 <div class=
"prop-row prop-group">
3028 <div class=
"prop-name">
3029 <div class=
"prop-title">category
</div>
3031 <div class=
"prop-value">
3032 <p>Video category
</p>
3035 <div class=
"prop-row prop-inner">
3036 <div class=
"prop-name param-label">type
</div>
3037 <div class=
"prop-value">
3038 <span class=
"json-property-type">number
</span>
3039 <span class=
"json-property-range" title=
"Value limits"></span>
3042 <div class=
"prop-row prop-inner">
3043 <div class=
"prop-name param-label">in
</div>
3044 <div class=
"prop-value">formData
</div>
3046 <div class=
"prop-row prop-group">
3047 <div class=
"prop-name">
3048 <div class=
"prop-title">licence
</div>
3050 <div class=
"prop-value">
3051 <p>Video licence
</p>
3054 <div class=
"prop-row prop-inner">
3055 <div class=
"prop-name param-label">type
</div>
3056 <div class=
"prop-value">
3057 <span class=
"json-property-type">number
</span>
3058 <span class=
"json-property-range" title=
"Value limits"></span>
3061 <div class=
"prop-row prop-inner">
3062 <div class=
"prop-name param-label">in
</div>
3063 <div class=
"prop-value">formData
</div>
3065 <div class=
"prop-row prop-group">
3066 <div class=
"prop-name">
3067 <div class=
"prop-title">language
</div>
3069 <div class=
"prop-value">
3070 <p>Video language
</p>
3073 <div class=
"prop-row prop-inner">
3074 <div class=
"prop-name param-label">type
</div>
3075 <div class=
"prop-value">
3076 <span class=
"json-property-type">number
</span>
3077 <span class=
"json-property-range" title=
"Value limits"></span>
3080 <div class=
"prop-row prop-inner">
3081 <div class=
"prop-name param-label">in
</div>
3082 <div class=
"prop-value">formData
</div>
3084 <div class=
"prop-row prop-group">
3085 <div class=
"prop-name">
3086 <div class=
"prop-title">description
</div>
3088 <div class=
"prop-value">
3089 <p>Video description
</p>
3092 <div class=
"prop-row prop-inner">
3093 <div class=
"prop-name param-label">type
</div>
3094 <div class=
"prop-value">
3095 <span class=
"json-property-type">string
</span>
3096 <span class=
"json-property-range" title=
"Value limits"></span>
3099 <div class=
"prop-row prop-inner">
3100 <div class=
"prop-name param-label">in
</div>
3101 <div class=
"prop-value">formData
</div>
3103 <div class=
"prop-row prop-group">
3104 <div class=
"prop-name">
3105 <div class=
"prop-title">support
</div>
3107 <div class=
"prop-value">
3108 <p>Text describing how to support the video uploader
</p>
3111 <div class=
"prop-row prop-inner">
3112 <div class=
"prop-name param-label">type
</div>
3113 <div class=
"prop-value">
3114 <span class=
"json-property-type">string
</span>
3115 <span class=
"json-property-range" title=
"Value limits"></span>
3118 <div class=
"prop-row prop-inner">
3119 <div class=
"prop-name param-label">in
</div>
3120 <div class=
"prop-value">formData
</div>
3122 <div class=
"prop-row prop-group">
3123 <div class=
"prop-name">
3124 <div class=
"prop-title">nsfw
</div>
3126 <div class=
"prop-value">
3127 <p>Whether or not this video contains sensitive content
</p>
3130 <div class=
"prop-row prop-inner">
3131 <div class=
"prop-name param-label">type
</div>
3132 <div class=
"prop-value">
3133 <span class=
"json-property-type">boolean
</span>
3134 <span class=
"json-property-range" title=
"Value limits"></span>
3137 <div class=
"prop-row prop-inner">
3138 <div class=
"prop-name param-label">in
</div>
3139 <div class=
"prop-value">formData
</div>
3141 <div class=
"prop-row prop-group">
3142 <div class=
"prop-name">
3143 <div class=
"prop-title">name
</div>
3145 <div class=
"prop-value">
3149 <div class=
"prop-row prop-inner">
3150 <div class=
"prop-name param-label">type
</div>
3151 <div class=
"prop-value">
3152 <span class=
"json-property-type">string
</span>
3153 <span class=
"json-property-range" title=
"Value limits"></span>
3156 <div class=
"prop-row prop-inner">
3157 <div class=
"prop-name param-label">in
</div>
3158 <div class=
"prop-value">formData
</div>
3160 <div class=
"prop-row prop-group">
3161 <div class=
"prop-name">
3162 <div class=
"prop-title">tags
</div>
3164 <div class=
"prop-value">
3168 <div class=
"prop-row prop-inner">
3169 <div class=
"prop-name param-label">type
</div>
3170 <div class=
"prop-value">
3171 <span class=
"json-property-type">string[]
</span>
3172 <span class=
"json-property-range" title=
"Value limits"></span>
3175 <div class=
"prop-row prop-inner">
3176 <div class=
"prop-name param-label">in
</div>
3177 <div class=
"prop-value">formData
</div>
3179 <div class=
"prop-row prop-group">
3180 <div class=
"prop-name">
3181 <div class=
"prop-title">commentsEnabled
</div>
3183 <div class=
"prop-value">
3184 <p>Enable or disable comments for this video
</p>
3187 <div class=
"prop-row prop-inner">
3188 <div class=
"prop-name param-label">type
</div>
3189 <div class=
"prop-value">
3190 <span class=
"json-property-type">boolean
</span>
3191 <span class=
"json-property-range" title=
"Value limits"></span>
3194 <div class=
"prop-row prop-inner">
3195 <div class=
"prop-name param-label">in
</div>
3196 <div class=
"prop-value">formData
</div>
3198 <div class=
"prop-row prop-group">
3199 <div class=
"prop-name">
3200 <div class=
"prop-title">privacy
</div>
3202 <div class=
"prop-value">
3203 <p>Video privacy
</p>
3206 <div class=
"prop-row prop-inner">
3207 <div class=
"prop-name param-label">type
</div>
3208 <div class=
"prop-value">
3209 <span class=
"json-property-type">string
</span>
3210 <span class=
"json-property-enum" title=
"Possible values">
3211 <span class=
"json-property-enum-item">Public
</span>,
3212 <span class=
"json-property-enum-item">Unlisted
</span>
3214 <span class=
"json-property-range" title=
"Value limits"></span>
3217 <div class=
"prop-row prop-inner">
3218 <div class=
"prop-name param-label">in
</div>
3219 <div class=
"prop-value">formData
</div>
3223 <div class=
"doc-examples"></div>
3225 <div class=
"doc-row">
3226 <div class=
"doc-copy">
3227 <section class=
"swagger-responses">
3228 <div class=
"prop-row prop-group">
3229 <div class=
"prop-name">
3230 <div class=
"prop-title">200 OK
</div>
3231 <div class=
"prop-ref">
3233 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3236 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3238 <div class=
"prop-value">
3239 <p>successful operation
</p>
3244 <div class=
"doc-examples">
3245 <h5>Response Content-Types:
3246 <span>application/json
</span>
3249 <h5>Response Example
3250 <span>(
200 OK)
</span>
3252 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3253 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3254 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3255 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3256 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3257 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3258 <span class=
"hljs-attr">"category
"</span>: {
3259 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3260 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3262 <span class=
"hljs-attr">"licence
"</span>: {
3263 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3264 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3266 <span class=
"hljs-attr">"language
"</span>: {
3267 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3268 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3270 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3271 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3272 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3273 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3274 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3275 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3276 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3277 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3278 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3279 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3280 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3281 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3282 <span class=
"hljs-attr">"account
"</span>: {
3283 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3284 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3285 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3286 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3287 <span class=
"hljs-attr">"avatar
"</span>: {
3288 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3289 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3290 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3300 <div id=
"operation--videos--id--get" class=
"operation panel" data-traverse-target=
"operation--videos--id--get">
3301 <!-- <section class="operation-tags row"> -->
3302 <!-- <div class="doc-copy"> -->
3303 <div class=
"operation-tags">
3304 <a class=
"label" href=
"#tag-Video">Video
</a>
3309 <h2 class=
"operation-title">
3310 <span class=
"operation-name">
3311 <span class=
"operation-name">GET
</span>
3312 <span class=
"operation-path">/videos/{id}
</span>
3315 <div class=
"doc-row">
3316 <div class=
"doc-copy">
3317 <section class=
"swagger-request-params">
3318 <div class=
"prop-row prop-group">
3319 <div class=
"prop-name">
3320 <div class=
"prop-title">id
</div>
3321 <span class=
"json-property-required"></span>
3323 <div class=
"prop-value">
3324 <p>The video id
</p>
3327 <div class=
"prop-row prop-inner">
3328 <div class=
"prop-name param-label">type
</div>
3329 <div class=
"prop-value">
3330 <span class=
"json-property-type">string
</span>
3331 <span class=
"json-property-range" title=
"Value limits"></span>
3334 <div class=
"prop-row prop-inner">
3335 <div class=
"prop-name param-label">in
</div>
3336 <div class=
"prop-value">path
</div>
3340 <div class=
"doc-examples"></div>
3342 <div class=
"doc-row">
3343 <div class=
"doc-copy">
3344 <section class=
"swagger-responses">
3345 <div class=
"prop-row prop-group">
3346 <div class=
"prop-name">
3347 <div class=
"prop-title">200 OK
</div>
3348 <div class=
"prop-ref">
3350 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3353 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3355 <div class=
"prop-value">
3356 <p>successful operation
</p>
3361 <div class=
"doc-examples">
3362 <h5>Response Content-Types:
3363 <span>application/json
</span>
3366 <h5>Response Example
3367 <span>(
200 OK)
</span>
3369 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3370 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3371 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3372 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3373 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3374 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3375 <span class=
"hljs-attr">"category
"</span>: {
3376 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3377 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3379 <span class=
"hljs-attr">"licence
"</span>: {
3380 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3381 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3383 <span class=
"hljs-attr">"language
"</span>: {
3384 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3385 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3387 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3388 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3389 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3390 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3391 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3392 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3393 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3394 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3395 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3396 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3397 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3398 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3399 <span class=
"hljs-attr">"account
"</span>: {
3400 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3401 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3402 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3403 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3404 <span class=
"hljs-attr">"avatar
"</span>: {
3405 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3406 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3407 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3417 <div id=
"operation--videos--id--delete" class=
"operation panel" data-traverse-target=
"operation--videos--id--delete">
3418 <!-- <section class="operation-tags row"> -->
3419 <!-- <div class="doc-copy"> -->
3420 <div class=
"operation-tags">
3421 <a class=
"label" href=
"#tag-Video">Video
</a>
3426 <h2 class=
"operation-title">
3427 <span class=
"operation-name">
3428 <span class=
"operation-name">DELETE
</span>
3429 <span class=
"operation-path">/videos/{id}
</span>
3432 <div class=
"doc-row">
3433 <div class=
"doc-copy">
3434 <section class=
"swagger-request-params">
3435 <div class=
"prop-row prop-group">
3436 <div class=
"prop-name">
3437 <div class=
"prop-title">id
</div>
3438 <span class=
"json-property-required"></span>
3440 <div class=
"prop-value">
3441 <p>The video id
</p>
3444 <div class=
"prop-row prop-inner">
3445 <div class=
"prop-name param-label">type
</div>
3446 <div class=
"prop-value">
3447 <span class=
"json-property-type">string
</span>
3448 <span class=
"json-property-range" title=
"Value limits"></span>
3451 <div class=
"prop-row prop-inner">
3452 <div class=
"prop-name param-label">in
</div>
3453 <div class=
"prop-value">path
</div>
3457 <div class=
"doc-examples"></div>
3459 <div class=
"doc-row">
3460 <div class=
"doc-copy">
3461 <section class=
"swagger-responses">
3462 <div class=
"prop-row prop-group">
3463 <div class=
"prop-name">
3464 <div class=
"prop-title">204 No Content
</div>
3466 <div class=
"prop-value">
3467 <p>successful operation
</p>
3472 <div class=
"doc-examples">
3473 <h5>Response Content-Types:
3474 <span>application/json
</span>
3479 <div id=
"operation--videos--id--description-get" class=
"operation panel" data-traverse-target=
"operation--videos--id--description-get">
3480 <!-- <section class="operation-tags row"> -->
3481 <!-- <div class="doc-copy"> -->
3482 <div class=
"operation-tags">
3483 <a class=
"label" href=
"#tag-Video">Video
</a>
3488 <h2 class=
"operation-title">
3489 <span class=
"operation-name">
3490 <span class=
"operation-name">GET
</span>
3491 <span class=
"operation-path">/videos/{id}/description
</span>
3494 <div class=
"doc-row">
3495 <div class=
"doc-copy">
3496 <section class=
"swagger-request-params">
3497 <div class=
"prop-row prop-group">
3498 <div class=
"prop-name">
3499 <div class=
"prop-title">id
</div>
3500 <span class=
"json-property-required"></span>
3502 <div class=
"prop-value">
3503 <p>The video id
</p>
3506 <div class=
"prop-row prop-inner">
3507 <div class=
"prop-name param-label">type
</div>
3508 <div class=
"prop-value">
3509 <span class=
"json-property-type">string
</span>
3510 <span class=
"json-property-range" title=
"Value limits"></span>
3513 <div class=
"prop-row prop-inner">
3514 <div class=
"prop-name param-label">in
</div>
3515 <div class=
"prop-value">path
</div>
3519 <div class=
"doc-examples"></div>
3521 <div class=
"doc-row">
3522 <div class=
"doc-copy">
3523 <section class=
"swagger-responses">
3524 <div class=
"prop-row prop-group">
3525 <div class=
"prop-name">
3526 <div class=
"prop-title">200 OK
</div>
3527 <div class=
"prop-ref"></div>
3528 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3530 <div class=
"prop-value">
3531 <p>successful operation
</p>
3536 <div class=
"doc-examples">
3537 <h5>Response Content-Types:
3538 <span>application/json
</span>
3541 <h5>Response Example
3542 <span>(
200 OK)
</span>
3544 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json"><span class=
"hljs-string">"string
"</span>
3551 <div id=
"operation--videos--id--views-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--views-post">
3552 <!-- <section class="operation-tags row"> -->
3553 <!-- <div class="doc-copy"> -->
3554 <div class=
"operation-tags">
3555 <a class=
"label" href=
"#tag-Video">Video
</a>
3560 <h2 class=
"operation-title">
3561 <span class=
"operation-name">
3562 <span class=
"operation-name">POST
</span>
3563 <span class=
"operation-path">/videos/{id}/views
</span>
3566 <div class=
"doc-row">
3567 <div class=
"doc-copy">
3568 <section class=
"swagger-request-params">
3569 <div class=
"prop-row prop-group">
3570 <div class=
"prop-name">
3571 <div class=
"prop-title">id
</div>
3572 <span class=
"json-property-required"></span>
3574 <div class=
"prop-value">
3575 <p>The video id
</p>
3578 <div class=
"prop-row prop-inner">
3579 <div class=
"prop-name param-label">type
</div>
3580 <div class=
"prop-value">
3581 <span class=
"json-property-type">string
</span>
3582 <span class=
"json-property-range" title=
"Value limits"></span>
3585 <div class=
"prop-row prop-inner">
3586 <div class=
"prop-name param-label">in
</div>
3587 <div class=
"prop-value">path
</div>
3591 <div class=
"doc-examples"></div>
3593 <div class=
"doc-row">
3594 <div class=
"doc-copy">
3595 <section class=
"swagger-responses">
3596 <div class=
"prop-row prop-group">
3597 <div class=
"prop-name">
3598 <div class=
"prop-title">204 No Content
</div>
3600 <div class=
"prop-value">
3601 <p>successful operation
</p>
3606 <div class=
"doc-examples">
3607 <h5>Response Content-Types:
3608 <span>application/json
</span>
3613 <div id=
"operation--videos-upload-post" class=
"operation panel" data-traverse-target=
"operation--videos-upload-post">
3614 <!-- <section class="operation-tags row"> -->
3615 <!-- <div class="doc-copy"> -->
3616 <div class=
"operation-tags">
3617 <a class=
"label" href=
"#tag-Video">Video
</a>
3622 <h2 class=
"operation-title">
3623 <span class=
"operation-name">
3624 <span class=
"operation-name">POST
</span>
3625 <span class=
"operation-path">/videos/upload
</span>
3628 <div class=
"doc-row">
3629 <div class=
"doc-copy">
3630 <section class=
"swagger-request-params">
3631 <div class=
"prop-row prop-group">
3632 <div class=
"prop-name">
3633 <div class=
"prop-title">videofile
</div>
3634 <span class=
"json-property-required"></span>
3636 <div class=
"prop-value">
3640 <div class=
"prop-row prop-inner">
3641 <div class=
"prop-name param-label">type
</div>
3642 <div class=
"prop-value">
3643 <span class=
"json-property-type">file
</span>
3644 <span class=
"json-property-range" title=
"Value limits"></span>
3647 <div class=
"prop-row prop-inner">
3648 <div class=
"prop-name param-label">in
</div>
3649 <div class=
"prop-value">formData
</div>
3651 <div class=
"prop-row prop-group">
3652 <div class=
"prop-name">
3653 <div class=
"prop-title">thumbnailfile
</div>
3654 <span class=
"json-property-required"></span>
3656 <div class=
"prop-value">
3657 <p>Video thumbnail file
</p>
3660 <div class=
"prop-row prop-inner">
3661 <div class=
"prop-name param-label">type
</div>
3662 <div class=
"prop-value">
3663 <span class=
"json-property-type">file
</span>
3664 <span class=
"json-property-range" title=
"Value limits"></span>
3667 <div class=
"prop-row prop-inner">
3668 <div class=
"prop-name param-label">in
</div>
3669 <div class=
"prop-value">formData
</div>
3671 <div class=
"prop-row prop-group">
3672 <div class=
"prop-name">
3673 <div class=
"prop-title">previewfile
</div>
3674 <span class=
"json-property-required"></span>
3676 <div class=
"prop-value">
3677 <p>Video preview file
</p>
3680 <div class=
"prop-row prop-inner">
3681 <div class=
"prop-name param-label">type
</div>
3682 <div class=
"prop-value">
3683 <span class=
"json-property-type">file
</span>
3684 <span class=
"json-property-range" title=
"Value limits"></span>
3687 <div class=
"prop-row prop-inner">
3688 <div class=
"prop-name param-label">in
</div>
3689 <div class=
"prop-value">formData
</div>
3691 <div class=
"prop-row prop-group">
3692 <div class=
"prop-name">
3693 <div class=
"prop-title">category
</div>
3695 <div class=
"prop-value">
3696 <p>Video category
</p>
3699 <div class=
"prop-row prop-inner">
3700 <div class=
"prop-name param-label">type
</div>
3701 <div class=
"prop-value">
3702 <span class=
"json-property-type">number
</span>
3703 <span class=
"json-property-range" title=
"Value limits"></span>
3706 <div class=
"prop-row prop-inner">
3707 <div class=
"prop-name param-label">in
</div>
3708 <div class=
"prop-value">formData
</div>
3710 <div class=
"prop-row prop-group">
3711 <div class=
"prop-name">
3712 <div class=
"prop-title">licence
</div>
3714 <div class=
"prop-value">
3715 <p>Video licence
</p>
3718 <div class=
"prop-row prop-inner">
3719 <div class=
"prop-name param-label">type
</div>
3720 <div class=
"prop-value">
3721 <span class=
"json-property-type">number
</span>
3722 <span class=
"json-property-range" title=
"Value limits"></span>
3725 <div class=
"prop-row prop-inner">
3726 <div class=
"prop-name param-label">in
</div>
3727 <div class=
"prop-value">formData
</div>
3729 <div class=
"prop-row prop-group">
3730 <div class=
"prop-name">
3731 <div class=
"prop-title">language
</div>
3733 <div class=
"prop-value">
3734 <p>Video language
</p>
3737 <div class=
"prop-row prop-inner">
3738 <div class=
"prop-name param-label">type
</div>
3739 <div class=
"prop-value">
3740 <span class=
"json-property-type">number
</span>
3741 <span class=
"json-property-range" title=
"Value limits"></span>
3744 <div class=
"prop-row prop-inner">
3745 <div class=
"prop-name param-label">in
</div>
3746 <div class=
"prop-value">formData
</div>
3748 <div class=
"prop-row prop-group">
3749 <div class=
"prop-name">
3750 <div class=
"prop-title">description
</div>
3752 <div class=
"prop-value">
3753 <p>Video description
</p>
3756 <div class=
"prop-row prop-inner">
3757 <div class=
"prop-name param-label">type
</div>
3758 <div class=
"prop-value">
3759 <span class=
"json-property-type">string
</span>
3760 <span class=
"json-property-range" title=
"Value limits"></span>
3763 <div class=
"prop-row prop-inner">
3764 <div class=
"prop-name param-label">in
</div>
3765 <div class=
"prop-value">formData
</div>
3767 <div class=
"prop-row prop-group">
3768 <div class=
"prop-name">
3769 <div class=
"prop-title">support
</div>
3771 <div class=
"prop-value">
3772 <p>Text describing how to support the video uploader
</p>
3775 <div class=
"prop-row prop-inner">
3776 <div class=
"prop-name param-label">type
</div>
3777 <div class=
"prop-value">
3778 <span class=
"json-property-type">string
</span>
3779 <span class=
"json-property-range" title=
"Value limits"></span>
3782 <div class=
"prop-row prop-inner">
3783 <div class=
"prop-name param-label">in
</div>
3784 <div class=
"prop-value">formData
</div>
3786 <div class=
"prop-row prop-group">
3787 <div class=
"prop-name">
3788 <div class=
"prop-title">channelId
</div>
3789 <span class=
"json-property-required"></span>
3791 <div class=
"prop-value">
3792 <p>Channel id that will contain this video
</p>
3795 <div class=
"prop-row prop-inner">
3796 <div class=
"prop-name param-label">type
</div>
3797 <div class=
"prop-value">
3798 <span class=
"json-property-type">number
</span>
3799 <span class=
"json-property-range" title=
"Value limits"></span>
3802 <div class=
"prop-row prop-inner">
3803 <div class=
"prop-name param-label">in
</div>
3804 <div class=
"prop-value">formData
</div>
3806 <div class=
"prop-row prop-group">
3807 <div class=
"prop-name">
3808 <div class=
"prop-title">nsfw
</div>
3809 <span class=
"json-property-required"></span>
3811 <div class=
"prop-value">
3812 <p>Whether or not this video contains sensitive content
</p>
3815 <div class=
"prop-row prop-inner">
3816 <div class=
"prop-name param-label">type
</div>
3817 <div class=
"prop-value">
3818 <span class=
"json-property-type">boolean
</span>
3819 <span class=
"json-property-range" title=
"Value limits"></span>
3822 <div class=
"prop-row prop-inner">
3823 <div class=
"prop-name param-label">in
</div>
3824 <div class=
"prop-value">formData
</div>
3826 <div class=
"prop-row prop-group">
3827 <div class=
"prop-name">
3828 <div class=
"prop-title">name
</div>
3829 <span class=
"json-property-required"></span>
3831 <div class=
"prop-value">
3835 <div class=
"prop-row prop-inner">
3836 <div class=
"prop-name param-label">type
</div>
3837 <div class=
"prop-value">
3838 <span class=
"json-property-type">string
</span>
3839 <span class=
"json-property-range" title=
"Value limits"></span>
3842 <div class=
"prop-row prop-inner">
3843 <div class=
"prop-name param-label">in
</div>
3844 <div class=
"prop-value">formData
</div>
3846 <div class=
"prop-row prop-group">
3847 <div class=
"prop-name">
3848 <div class=
"prop-title">tags
</div>
3850 <div class=
"prop-value">
3854 <div class=
"prop-row prop-inner">
3855 <div class=
"prop-name param-label">type
</div>
3856 <div class=
"prop-value">
3857 <span class=
"json-property-type">string[]
</span>
3858 <span class=
"json-property-range" title=
"Value limits"></span>
3861 <div class=
"prop-row prop-inner">
3862 <div class=
"prop-name param-label">in
</div>
3863 <div class=
"prop-value">formData
</div>
3865 <div class=
"prop-row prop-group">
3866 <div class=
"prop-name">
3867 <div class=
"prop-title">commentsEnabled
</div>
3869 <div class=
"prop-value">
3870 <p>Enable or disable comments for this video
</p>
3873 <div class=
"prop-row prop-inner">
3874 <div class=
"prop-name param-label">type
</div>
3875 <div class=
"prop-value">
3876 <span class=
"json-property-type">boolean
</span>
3877 <span class=
"json-property-range" title=
"Value limits"></span>
3880 <div class=
"prop-row prop-inner">
3881 <div class=
"prop-name param-label">in
</div>
3882 <div class=
"prop-value">formData
</div>
3884 <div class=
"prop-row prop-group">
3885 <div class=
"prop-name">
3886 <div class=
"prop-title">privacy
</div>
3887 <span class=
"json-property-required"></span>
3889 <div class=
"prop-value">
3890 <p>Video privacy
</p>
3893 <div class=
"prop-row prop-inner">
3894 <div class=
"prop-name param-label">type
</div>
3895 <div class=
"prop-value">
3896 <span class=
"json-property-type">string
</span>
3897 <span class=
"json-property-enum" title=
"Possible values">
3898 <span class=
"json-property-enum-item">Public
</span>,
3899 <span class=
"json-property-enum-item">Unlisted
</span>,
3900 <span class=
"json-property-enum-item">Private
</span>
3902 <span class=
"json-property-range" title=
"Value limits"></span>
3905 <div class=
"prop-row prop-inner">
3906 <div class=
"prop-name param-label">in
</div>
3907 <div class=
"prop-value">formData
</div>
3911 <div class=
"doc-examples"></div>
3913 <div class=
"doc-row">
3914 <div class=
"doc-copy">
3915 <section class=
"swagger-responses">
3916 <div class=
"prop-row prop-group">
3917 <div class=
"prop-name">
3918 <div class=
"prop-title">200 OK
</div>
3919 <div class=
"prop-ref">
3921 <a class=
"json-schema-ref" href=
"#/definitions/VideoUploadResponse">VideoUploadResponse
</a>
3924 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3926 <div class=
"prop-value">
3927 <p>successful operation
</p>
3932 <div class=
"doc-examples">
3933 <h5>Response Content-Types:
3934 <span>application/json
</span>
3937 <h5>Response Example
3938 <span>(
200 OK)
</span>
3940 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3941 <span class=
"hljs-attr">"video
"</span>: {
3942 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3943 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
3952 <h1 id=
"tag-VideoAbuse" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoAbuse">VideoAbuse
</h1>
3953 <div id=
"operation--videos-abuse-get" class=
"operation panel" data-traverse-target=
"operation--videos-abuse-get">
3954 <!-- <section class="operation-tags row"> -->
3955 <!-- <div class="doc-copy"> -->
3956 <div class=
"operation-tags">
3957 <a class=
"label" href=
"#tag-VideoAbuse">VideoAbuse
</a>
3962 <h2 class=
"operation-title">
3963 <span class=
"operation-name">
3964 <span class=
"operation-name">GET
</span>
3965 <span class=
"operation-path">/videos/abuse
</span>
3968 <div class=
"doc-row">
3969 <div class=
"doc-copy">
3970 <section class=
"swagger-request-params">
3971 <div class=
"prop-row prop-group">
3972 <div class=
"prop-name">
3973 <div class=
"prop-title">start
</div>
3975 <div class=
"prop-value">
3976 <p>starting page
</p>
3979 <div class=
"prop-row prop-inner">
3980 <div class=
"prop-name param-label">type
</div>
3981 <div class=
"prop-value">
3982 <span class=
"json-property-type">number
</span>
3983 <span class=
"json-property-range" title=
"Value limits"></span>
3986 <div class=
"prop-row prop-inner">
3987 <div class=
"prop-name param-label">in
</div>
3988 <div class=
"prop-value">query
</div>
3990 <div class=
"prop-row prop-group">
3991 <div class=
"prop-name">
3992 <div class=
"prop-title">stop
</div>
3994 <div class=
"prop-value">
3995 <p>stopping page
</p>
3998 <div class=
"prop-row prop-inner">
3999 <div class=
"prop-name param-label">type
</div>
4000 <div class=
"prop-value">
4001 <span class=
"json-property-type">number
</span>
4002 <span class=
"json-property-range" title=
"Value limits"></span>
4005 <div class=
"prop-row prop-inner">
4006 <div class=
"prop-name param-label">in
</div>
4007 <div class=
"prop-value">query
</div>
4009 <div class=
"prop-row prop-group">
4010 <div class=
"prop-name">
4011 <div class=
"prop-title">sort
</div>
4013 <div class=
"prop-value">
4017 <div class=
"prop-row prop-inner">
4018 <div class=
"prop-name param-label">type
</div>
4019 <div class=
"prop-value">
4020 <span class=
"json-property-type">number
</span>
4021 <span class=
"json-property-range" title=
"Value limits"></span>
4024 <div class=
"prop-row prop-inner">
4025 <div class=
"prop-name param-label">in
</div>
4026 <div class=
"prop-value">query
</div>
4030 <div class=
"doc-examples"></div>
4032 <div class=
"doc-row">
4033 <div class=
"doc-copy">
4034 <section class=
"swagger-responses">
4035 <div class=
"prop-row prop-group">
4036 <div class=
"prop-name">
4037 <div class=
"prop-title">200 OK
</div>
4038 <div class=
"prop-ref">
4039 <span class=
"json-schema-ref-array">
4040 <a class=
"json-schema-ref" href=
"#/definitions/VideoAbuse">VideoAbuse
</a>
4043 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4045 <div class=
"prop-value">
4046 <p>successful operation
</p>
4051 <div class=
"doc-examples">
4052 <h5>Response Content-Types:
4053 <span>application/json
</span>
4056 <h5>Response Example
4057 <span>(
200 OK)
</span>
4059 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4061 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4062 <span class=
"hljs-attr">"reason
"</span>:
<span class=
"hljs-string">"string
"</span>,
4063 <span class=
"hljs-attr">"reporterAccount
"</span>: {
4064 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4065 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4066 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4067 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4068 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4069 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4070 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4071 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4072 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4073 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4074 <span class=
"hljs-attr">"avatar
"</span>: {
4075 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4076 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4077 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4080 <span class=
"hljs-attr">"video
"</span>: {
4081 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4082 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4083 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4084 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>
4086 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4095 <div id=
"operation--videos--id--abuse-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--abuse-post">
4096 <!-- <section class="operation-tags row"> -->
4097 <!-- <div class="doc-copy"> -->
4098 <div class=
"operation-tags">
4099 <a class=
"label" href=
"#tag-VideoAbuse">VideoAbuse
</a>
4104 <h2 class=
"operation-title">
4105 <span class=
"operation-name">
4106 <span class=
"operation-name">POST
</span>
4107 <span class=
"operation-path">/videos/{id}/abuse
</span>
4110 <div class=
"doc-row">
4111 <div class=
"doc-copy">
4112 <section class=
"swagger-request-params">
4113 <div class=
"prop-row prop-group">
4114 <div class=
"prop-name">
4115 <div class=
"prop-title">id
</div>
4116 <span class=
"json-property-required"></span>
4118 <div class=
"prop-value">
4119 <p>The video id
</p>
4122 <div class=
"prop-row prop-inner">
4123 <div class=
"prop-name param-label">type
</div>
4124 <div class=
"prop-value">
4125 <span class=
"json-property-type">string
</span>
4126 <span class=
"json-property-range" title=
"Value limits"></span>
4129 <div class=
"prop-row prop-inner">
4130 <div class=
"prop-name param-label">in
</div>
4131 <div class=
"prop-value">path
</div>
4135 <div class=
"doc-examples"></div>
4137 <div class=
"doc-row">
4138 <div class=
"doc-copy">
4139 <section class=
"swagger-responses">
4140 <div class=
"prop-row prop-group">
4141 <div class=
"prop-name">
4142 <div class=
"prop-title">204 No Content
</div>
4144 <div class=
"prop-value">
4145 <p>successful operation
</p>
4150 <div class=
"doc-examples">
4151 <h5>Response Content-Types:
4152 <span>application/json
</span>
4157 <h1 id=
"tag-VideoBlacklist" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoBlacklist">VideoBlacklist
</h1>
4158 <div id=
"operation--videos--videoId--blacklist-post" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--blacklist-post">
4159 <!-- <section class="operation-tags row"> -->
4160 <!-- <div class="doc-copy"> -->
4161 <div class=
"operation-tags">
4162 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4167 <h2 class=
"operation-title">
4168 <span class=
"operation-name">
4169 <span class=
"operation-name">POST
</span>
4170 <span class=
"operation-path">/videos/{videoId}/blacklist
</span>
4173 <div class=
"doc-row">
4174 <div class=
"doc-copy">
4175 <section class=
"swagger-request-params">
4176 <div class=
"prop-row prop-group">
4177 <div class=
"prop-name">
4178 <div class=
"prop-title">videoId
</div>
4179 <span class=
"json-property-required"></span>
4181 <div class=
"prop-value">
4182 <p>The video id
</p>
4185 <div class=
"prop-row prop-inner">
4186 <div class=
"prop-name param-label">type
</div>
4187 <div class=
"prop-value">
4188 <span class=
"json-property-type">string
</span>
4189 <span class=
"json-property-range" title=
"Value limits"></span>
4192 <div class=
"prop-row prop-inner">
4193 <div class=
"prop-name param-label">in
</div>
4194 <div class=
"prop-value">path
</div>
4198 <div class=
"doc-examples"></div>
4200 <div class=
"doc-row">
4201 <div class=
"doc-copy">
4202 <section class=
"swagger-responses">
4203 <div class=
"prop-row prop-group">
4204 <div class=
"prop-name">
4205 <div class=
"prop-title">204 No Content
</div>
4207 <div class=
"prop-value">
4208 <p>successful operation
</p>
4213 <div class=
"doc-examples">
4214 <h5>Response Content-Types:
4215 <span>application/json
</span>
4220 <div id=
"operation--videos--videoId--blacklist-delete" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--blacklist-delete">
4221 <!-- <section class="operation-tags row"> -->
4222 <!-- <div class="doc-copy"> -->
4223 <div class=
"operation-tags">
4224 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4229 <h2 class=
"operation-title">
4230 <span class=
"operation-name">
4231 <span class=
"operation-name">DELETE
</span>
4232 <span class=
"operation-path">/videos/{videoId}/blacklist
</span>
4235 <div class=
"doc-row">
4236 <div class=
"doc-copy">
4237 <section class=
"swagger-request-params">
4238 <div class=
"prop-row prop-group">
4239 <div class=
"prop-name">
4240 <div class=
"prop-title">videoId
</div>
4241 <span class=
"json-property-required"></span>
4243 <div class=
"prop-value">
4244 <p>The video id
</p>
4247 <div class=
"prop-row prop-inner">
4248 <div class=
"prop-name param-label">type
</div>
4249 <div class=
"prop-value">
4250 <span class=
"json-property-type">string
</span>
4251 <span class=
"json-property-range" title=
"Value limits"></span>
4254 <div class=
"prop-row prop-inner">
4255 <div class=
"prop-name param-label">in
</div>
4256 <div class=
"prop-value">path
</div>
4260 <div class=
"doc-examples"></div>
4262 <div class=
"doc-row">
4263 <div class=
"doc-copy">
4264 <section class=
"swagger-responses">
4265 <div class=
"prop-row prop-group">
4266 <div class=
"prop-name">
4267 <div class=
"prop-title">204 No Content
</div>
4269 <div class=
"prop-value">
4270 <p>successful operation
</p>
4275 <div class=
"doc-examples">
4276 <h5>Response Content-Types:
4277 <span>application/json
</span>
4282 <div id=
"operation--videos-blacklist-get" class=
"operation panel" data-traverse-target=
"operation--videos-blacklist-get">
4283 <!-- <section class="operation-tags row"> -->
4284 <!-- <div class="doc-copy"> -->
4285 <div class=
"operation-tags">
4286 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4291 <h2 class=
"operation-title">
4292 <span class=
"operation-name">
4293 <span class=
"operation-name">GET
</span>
4294 <span class=
"operation-path">/videos/blacklist
</span>
4297 <div class=
"doc-row">
4298 <div class=
"doc-copy">
4299 <section class=
"swagger-request-params">
4300 <div class=
"prop-row prop-group">
4301 <div class=
"prop-name">
4302 <div class=
"prop-title">start
</div>
4304 <div class=
"prop-value">
4305 <p>starting page
</p>
4308 <div class=
"prop-row prop-inner">
4309 <div class=
"prop-name param-label">type
</div>
4310 <div class=
"prop-value">
4311 <span class=
"json-property-type">number
</span>
4312 <span class=
"json-property-range" title=
"Value limits"></span>
4315 <div class=
"prop-row prop-inner">
4316 <div class=
"prop-name param-label">in
</div>
4317 <div class=
"prop-value">query
</div>
4319 <div class=
"prop-row prop-group">
4320 <div class=
"prop-name">
4321 <div class=
"prop-title">stop
</div>
4323 <div class=
"prop-value">
4324 <p>stopping page
</p>
4327 <div class=
"prop-row prop-inner">
4328 <div class=
"prop-name param-label">type
</div>
4329 <div class=
"prop-value">
4330 <span class=
"json-property-type">number
</span>
4331 <span class=
"json-property-range" title=
"Value limits"></span>
4334 <div class=
"prop-row prop-inner">
4335 <div class=
"prop-name param-label">in
</div>
4336 <div class=
"prop-value">query
</div>
4338 <div class=
"prop-row prop-group">
4339 <div class=
"prop-name">
4340 <div class=
"prop-title">sort
</div>
4342 <div class=
"prop-value">
4346 <div class=
"prop-row prop-inner">
4347 <div class=
"prop-name param-label">type
</div>
4348 <div class=
"prop-value">
4349 <span class=
"json-property-type">number
</span>
4350 <span class=
"json-property-range" title=
"Value limits"></span>
4353 <div class=
"prop-row prop-inner">
4354 <div class=
"prop-name param-label">in
</div>
4355 <div class=
"prop-value">query
</div>
4359 <div class=
"doc-examples"></div>
4361 <div class=
"doc-row">
4362 <div class=
"doc-copy">
4363 <section class=
"swagger-responses">
4364 <div class=
"prop-row prop-group">
4365 <div class=
"prop-name">
4366 <div class=
"prop-title">200 OK
</div>
4367 <div class=
"prop-ref">
4368 <span class=
"json-schema-ref-array">
4369 <a class=
"json-schema-ref" href=
"#/definitions/VideoBlacklist">VideoBlacklist
</a>
4372 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4374 <div class=
"prop-value">
4375 <p>successful operation
</p>
4380 <div class=
"doc-examples">
4381 <h5>Response Content-Types:
4382 <span>application/json
</span>
4385 <h5>Response Example
4386 <span>(
200 OK)
</span>
4388 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4390 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4391 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4392 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4393 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4394 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4395 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4396 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4397 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
4398 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
4399 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4400 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4401 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
4410 <h1 id=
"tag-VideoChannel" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoChannel">VideoChannel
</h1>
4411 <div id=
"operation--videos-channels-get" class=
"operation panel" data-traverse-target=
"operation--videos-channels-get">
4412 <!-- <section class="operation-tags row"> -->
4413 <!-- <div class="doc-copy"> -->
4414 <div class=
"operation-tags">
4415 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4420 <h2 class=
"operation-title">
4421 <span class=
"operation-name">
4422 <span class=
"operation-name">GET
</span>
4423 <span class=
"operation-path">/videos/channels
</span>
4426 <div class=
"doc-row">
4427 <div class=
"doc-copy">
4428 <section class=
"swagger-request-params">
4429 <div class=
"prop-row prop-group">
4430 <div class=
"prop-name">
4431 <div class=
"prop-title">start
</div>
4433 <div class=
"prop-value">
4434 <p>starting page
</p>
4437 <div class=
"prop-row prop-inner">
4438 <div class=
"prop-name param-label">type
</div>
4439 <div class=
"prop-value">
4440 <span class=
"json-property-type">number
</span>
4441 <span class=
"json-property-range" title=
"Value limits"></span>
4444 <div class=
"prop-row prop-inner">
4445 <div class=
"prop-name param-label">in
</div>
4446 <div class=
"prop-value">query
</div>
4448 <div class=
"prop-row prop-group">
4449 <div class=
"prop-name">
4450 <div class=
"prop-title">stop
</div>
4452 <div class=
"prop-value">
4453 <p>stopping page
</p>
4456 <div class=
"prop-row prop-inner">
4457 <div class=
"prop-name param-label">type
</div>
4458 <div class=
"prop-value">
4459 <span class=
"json-property-type">number
</span>
4460 <span class=
"json-property-range" title=
"Value limits"></span>
4463 <div class=
"prop-row prop-inner">
4464 <div class=
"prop-name param-label">in
</div>
4465 <div class=
"prop-value">query
</div>
4467 <div class=
"prop-row prop-group">
4468 <div class=
"prop-name">
4469 <div class=
"prop-title">sort
</div>
4471 <div class=
"prop-value">
4475 <div class=
"prop-row prop-inner">
4476 <div class=
"prop-name param-label">type
</div>
4477 <div class=
"prop-value">
4478 <span class=
"json-property-type">number
</span>
4479 <span class=
"json-property-range" title=
"Value limits"></span>
4482 <div class=
"prop-row prop-inner">
4483 <div class=
"prop-name param-label">in
</div>
4484 <div class=
"prop-value">query
</div>
4488 <div class=
"doc-examples"></div>
4490 <div class=
"doc-row">
4491 <div class=
"doc-copy">
4492 <section class=
"swagger-responses">
4493 <div class=
"prop-row prop-group">
4494 <div class=
"prop-name">
4495 <div class=
"prop-title">200 OK
</div>
4496 <div class=
"prop-ref">
4497 <span class=
"json-schema-ref-array">
4498 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4501 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4503 <div class=
"prop-value">
4504 <p>successful operation
</p>
4509 <div class=
"doc-examples">
4510 <h5>Response Content-Types:
4511 <span>application/json
</span>
4514 <h5>Response Example
4515 <span>(
200 OK)
</span>
4517 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4519 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4520 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4521 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4522 <span class=
"hljs-attr">"owner
"</span>: {
4523 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4524 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
4526 <span class=
"hljs-attr">"videos
"</span>: [
4528 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4529 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4530 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4531 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4532 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4533 <span class=
"hljs-attr">"category
"</span>: {
4534 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4535 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
4537 <span class=
"hljs-attr">"licence
"</span>: {
4538 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4539 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
4541 <span class=
"hljs-attr">"language
"</span>: {
4542 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4543 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
4545 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
4546 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4547 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
4548 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4549 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4550 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4551 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4552 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4553 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
4554 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4555 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4556 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4557 <span class=
"hljs-attr">"account
"</span>: {
4558 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4559 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4560 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4561 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4562 <span class=
"hljs-attr">"avatar
"</span>: {
4563 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4564 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4565 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4578 <div id=
"operation--videos-channels-post" class=
"operation panel" data-traverse-target=
"operation--videos-channels-post">
4579 <!-- <section class="operation-tags row"> -->
4580 <!-- <div class="doc-copy"> -->
4581 <div class=
"operation-tags">
4582 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4587 <h2 class=
"operation-title">
4588 <span class=
"operation-name">
4589 <span class=
"operation-name">POST
</span>
4590 <span class=
"operation-path">/videos/channels
</span>
4593 <div class=
"doc-row">
4594 <div class=
"doc-copy">
4595 <section class=
"swagger-request-body">
4596 <div class=
"prop-row">
4597 <div class=
"prop-name">
4598 <div class=
"swagger-request-model">
4600 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannelInput">VideoChannelInput
</a>
4604 <div class=
"prop-value columns small-6">
4605 <!-- <div class="swagger-request-description"> -->undefined
4611 <div class=
"doc-examples">
4613 <h5>Request Content-Types:
4614 <span>application/json
</span>
4616 <h5>Request Example
</h5>
4617 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4618 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4619 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
4626 <div class=
"doc-row">
4627 <div class=
"doc-copy">
4628 <section class=
"swagger-responses">
4629 <div class=
"prop-row prop-group">
4630 <div class=
"prop-name">
4631 <div class=
"prop-title">204 No Content
</div>
4633 <div class=
"prop-value">
4634 <p>successful operation
</p>
4639 <div class=
"doc-examples">
4640 <h5>Response Content-Types:
4641 <span>application/json
</span>
4646 <div id=
"operation--videos-channels--id--get" class=
"operation panel" data-traverse-target=
"operation--videos-channels--id--get">
4647 <!-- <section class="operation-tags row"> -->
4648 <!-- <div class="doc-copy"> -->
4649 <div class=
"operation-tags">
4650 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4655 <h2 class=
"operation-title">
4656 <span class=
"operation-name">
4657 <span class=
"operation-name">GET
</span>
4658 <span class=
"operation-path">/videos/channels/{id}
</span>
4661 <div class=
"doc-row">
4662 <div class=
"doc-copy">
4663 <section class=
"swagger-request-params">
4664 <div class=
"prop-row prop-group">
4665 <div class=
"prop-name">
4666 <div class=
"prop-title">id
</div>
4667 <span class=
"json-property-required"></span>
4669 <div class=
"prop-value">
4670 <p>The video id
</p>
4673 <div class=
"prop-row prop-inner">
4674 <div class=
"prop-name param-label">type
</div>
4675 <div class=
"prop-value">
4676 <span class=
"json-property-type">string
</span>
4677 <span class=
"json-property-range" title=
"Value limits"></span>
4680 <div class=
"prop-row prop-inner">
4681 <div class=
"prop-name param-label">in
</div>
4682 <div class=
"prop-value">path
</div>
4686 <div class=
"doc-examples"></div>
4688 <div class=
"doc-row">
4689 <div class=
"doc-copy">
4690 <section class=
"swagger-responses">
4691 <div class=
"prop-row prop-group">
4692 <div class=
"prop-name">
4693 <div class=
"prop-title">200 OK
</div>
4694 <div class=
"prop-ref">
4696 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4699 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4701 <div class=
"prop-value">
4702 <p>successful operation
</p>
4707 <div class=
"doc-examples">
4708 <h5>Response Content-Types:
4709 <span>application/json
</span>
4712 <h5>Response Example
4713 <span>(
200 OK)
</span>
4715 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4716 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4717 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4718 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4719 <span class=
"hljs-attr">"owner
"</span>: {
4720 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4721 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
4723 <span class=
"hljs-attr">"videos
"</span>: [
4725 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4726 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4727 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4728 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4729 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4730 <span class=
"hljs-attr">"category
"</span>: {
4731 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4732 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
4734 <span class=
"hljs-attr">"licence
"</span>: {
4735 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4736 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
4738 <span class=
"hljs-attr">"language
"</span>: {
4739 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4740 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
4742 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
4743 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4744 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
4745 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4746 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4747 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4748 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4749 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4750 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
4751 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4752 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4753 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4754 <span class=
"hljs-attr">"account
"</span>: {
4755 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4756 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4757 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4758 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4759 <span class=
"hljs-attr">"avatar
"</span>: {
4760 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4761 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4762 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4774 <div id=
"operation--videos-channels--id--put" class=
"operation panel" data-traverse-target=
"operation--videos-channels--id--put">
4775 <!-- <section class="operation-tags row"> -->
4776 <!-- <div class="doc-copy"> -->
4777 <div class=
"operation-tags">
4778 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4783 <h2 class=
"operation-title">
4784 <span class=
"operation-name">
4785 <span class=
"operation-name">PUT
</span>
4786 <span class=
"operation-path">/videos/channels/{id}
</span>
4789 <div class=
"doc-row">
4790 <div class=
"doc-copy">
4791 <section class=
"swagger-request-body">
4792 <div class=
"prop-row">
4793 <div class=
"prop-name">
4794 <div class=
"swagger-request-model">
4796 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannelInput">VideoChannelInput
</a>
4800 <div class=
"prop-value columns small-6">
4801 <!-- <div class="swagger-request-description"> -->undefined
4806 <section class=
"swagger-request-params">
4807 <div class=
"prop-row prop-group">
4808 <div class=
"prop-name">
4809 <div class=
"prop-title">id
</div>
4810 <span class=
"json-property-required"></span>
4812 <div class=
"prop-value">
4813 <p>The video id
</p>
4816 <div class=
"prop-row prop-inner">
4817 <div class=
"prop-name param-label">type
</div>
4818 <div class=
"prop-value">
4819 <span class=
"json-property-type">string
</span>
4820 <span class=
"json-property-range" title=
"Value limits"></span>
4823 <div class=
"prop-row prop-inner">
4824 <div class=
"prop-name param-label">in
</div>
4825 <div class=
"prop-value">path
</div>
4829 <div class=
"doc-examples">
4831 <h5>Request Content-Types:
4832 <span>application/json
</span>
4834 <h5>Request Example
</h5>
4835 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4836 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4837 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
4844 <div class=
"doc-row">
4845 <div class=
"doc-copy">
4846 <section class=
"swagger-responses">
4847 <div class=
"prop-row prop-group">
4848 <div class=
"prop-name">
4849 <div class=
"prop-title">204 No Content
</div>
4851 <div class=
"prop-value">
4852 <p>successful operation
</p>
4857 <div class=
"doc-examples">
4858 <h5>Response Content-Types:
4859 <span>application/json
</span>
4864 <div id=
"operation--videos-channels--id--delete" class=
"operation panel" data-traverse-target=
"operation--videos-channels--id--delete">
4865 <!-- <section class="operation-tags row"> -->
4866 <!-- <div class="doc-copy"> -->
4867 <div class=
"operation-tags">
4868 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4873 <h2 class=
"operation-title">
4874 <span class=
"operation-name">
4875 <span class=
"operation-name">DELETE
</span>
4876 <span class=
"operation-path">/videos/channels/{id}
</span>
4879 <div class=
"doc-row">
4880 <div class=
"doc-copy">
4881 <section class=
"swagger-request-params">
4882 <div class=
"prop-row prop-group">
4883 <div class=
"prop-name">
4884 <div class=
"prop-title">id
</div>
4885 <span class=
"json-property-required"></span>
4887 <div class=
"prop-value">
4888 <p>The video id
</p>
4891 <div class=
"prop-row prop-inner">
4892 <div class=
"prop-name param-label">type
</div>
4893 <div class=
"prop-value">
4894 <span class=
"json-property-type">string
</span>
4895 <span class=
"json-property-range" title=
"Value limits"></span>
4898 <div class=
"prop-row prop-inner">
4899 <div class=
"prop-name param-label">in
</div>
4900 <div class=
"prop-value">path
</div>
4904 <div class=
"doc-examples"></div>
4906 <div class=
"doc-row">
4907 <div class=
"doc-copy">
4908 <section class=
"swagger-responses">
4909 <div class=
"prop-row prop-group">
4910 <div class=
"prop-name">
4911 <div class=
"prop-title">204 No Content
</div>
4913 <div class=
"prop-value">
4914 <p>successful operation
</p>
4919 <div class=
"doc-examples">
4920 <h5>Response Content-Types:
4921 <span>application/json
</span>
4926 <div id=
"operation--videos-accounts--accountId--channels-get" class=
"operation panel" data-traverse-target=
"operation--videos-accounts--accountId--channels-get">
4927 <!-- <section class="operation-tags row"> -->
4928 <!-- <div class="doc-copy"> -->
4929 <div class=
"operation-tags">
4930 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4935 <h2 class=
"operation-title">
4936 <span class=
"operation-name">
4937 <span class=
"operation-name">GET
</span>
4938 <span class=
"operation-path">/videos/accounts/{accountId}/channels
</span>
4941 <div class=
"doc-row">
4942 <div class=
"doc-copy">
4943 <section class=
"swagger-request-params">
4944 <div class=
"prop-row prop-group">
4945 <div class=
"prop-name">
4946 <div class=
"prop-title">accountId
</div>
4947 <span class=
"json-property-required"></span>
4949 <div class=
"prop-value">
4950 <p>The account id
</p>
4953 <div class=
"prop-row prop-inner">
4954 <div class=
"prop-name param-label">type
</div>
4955 <div class=
"prop-value">
4956 <span class=
"json-property-type">string
</span>
4957 <span class=
"json-property-range" title=
"Value limits"></span>
4960 <div class=
"prop-row prop-inner">
4961 <div class=
"prop-name param-label">in
</div>
4962 <div class=
"prop-value">path
</div>
4966 <div class=
"doc-examples"></div>
4968 <div class=
"doc-row">
4969 <div class=
"doc-copy">
4970 <section class=
"swagger-responses">
4971 <div class=
"prop-row prop-group">
4972 <div class=
"prop-name">
4973 <div class=
"prop-title">200 OK
</div>
4974 <div class=
"prop-ref">
4975 <span class=
"json-schema-ref-array">
4976 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4979 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4981 <div class=
"prop-value">
4982 <p>successful operation
</p>
4987 <div class=
"doc-examples">
4988 <h5>Response Content-Types:
4989 <span>application/json
</span>
4992 <h5>Response Example
4993 <span>(
200 OK)
</span>
4995 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4997 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4998 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4999 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5000 <span class=
"hljs-attr">"owner
"</span>: {
5001 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5002 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
5004 <span class=
"hljs-attr">"videos
"</span>: [
5006 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5007 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5008 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5009 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5010 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5011 <span class=
"hljs-attr">"category
"</span>: {
5012 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5013 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5015 <span class=
"hljs-attr">"licence
"</span>: {
5016 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5017 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5019 <span class=
"hljs-attr">"language
"</span>: {
5020 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5021 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5023 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
5024 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5025 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
5026 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5027 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5028 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5029 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5030 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5031 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
5032 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5033 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5034 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5035 <span class=
"hljs-attr">"account
"</span>: {
5036 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5037 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5038 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5039 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5040 <span class=
"hljs-attr">"avatar
"</span>: {
5041 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5042 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5043 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5056 <h1 id=
"tag-VideoComment" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoComment">VideoComment
</h1>
5057 <div id=
"operation--videos--videoId--comment-threads-get" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comment-threads-get">
5058 <!-- <section class="operation-tags row"> -->
5059 <!-- <div class="doc-copy"> -->
5060 <div class=
"operation-tags">
5061 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5066 <h2 class=
"operation-title">
5067 <span class=
"operation-name">
5068 <span class=
"operation-name">GET
</span>
5069 <span class=
"operation-path">/videos/{videoId}/comment-threads
</span>
5072 <div class=
"doc-row">
5073 <div class=
"doc-copy">
5074 <section class=
"swagger-request-params">
5075 <div class=
"prop-row prop-group">
5076 <div class=
"prop-name">
5077 <div class=
"prop-title">videoId
</div>
5078 <span class=
"json-property-required"></span>
5080 <div class=
"prop-value">
5081 <p>The video id
</p>
5084 <div class=
"prop-row prop-inner">
5085 <div class=
"prop-name param-label">type
</div>
5086 <div class=
"prop-value">
5087 <span class=
"json-property-type">string
</span>
5088 <span class=
"json-property-range" title=
"Value limits"></span>
5091 <div class=
"prop-row prop-inner">
5092 <div class=
"prop-name param-label">in
</div>
5093 <div class=
"prop-value">path
</div>
5095 <div class=
"prop-row prop-group">
5096 <div class=
"prop-name">
5097 <div class=
"prop-title">start
</div>
5099 <div class=
"prop-value">
5100 <p>starting page
</p>
5103 <div class=
"prop-row prop-inner">
5104 <div class=
"prop-name param-label">type
</div>
5105 <div class=
"prop-value">
5106 <span class=
"json-property-type">number
</span>
5107 <span class=
"json-property-range" title=
"Value limits"></span>
5110 <div class=
"prop-row prop-inner">
5111 <div class=
"prop-name param-label">in
</div>
5112 <div class=
"prop-value">query
</div>
5114 <div class=
"prop-row prop-group">
5115 <div class=
"prop-name">
5116 <div class=
"prop-title">stop
</div>
5118 <div class=
"prop-value">
5119 <p>stopping page
</p>
5122 <div class=
"prop-row prop-inner">
5123 <div class=
"prop-name param-label">type
</div>
5124 <div class=
"prop-value">
5125 <span class=
"json-property-type">number
</span>
5126 <span class=
"json-property-range" title=
"Value limits"></span>
5129 <div class=
"prop-row prop-inner">
5130 <div class=
"prop-name param-label">in
</div>
5131 <div class=
"prop-value">query
</div>
5133 <div class=
"prop-row prop-group">
5134 <div class=
"prop-name">
5135 <div class=
"prop-title">sort
</div>
5137 <div class=
"prop-value">
5141 <div class=
"prop-row prop-inner">
5142 <div class=
"prop-name param-label">type
</div>
5143 <div class=
"prop-value">
5144 <span class=
"json-property-type">number
</span>
5145 <span class=
"json-property-range" title=
"Value limits"></span>
5148 <div class=
"prop-row prop-inner">
5149 <div class=
"prop-name param-label">in
</div>
5150 <div class=
"prop-value">query
</div>
5154 <div class=
"doc-examples"></div>
5156 <div class=
"doc-row">
5157 <div class=
"doc-copy">
5158 <section class=
"swagger-responses">
5159 <div class=
"prop-row prop-group">
5160 <div class=
"prop-name">
5161 <div class=
"prop-title">200 OK
</div>
5162 <div class=
"prop-ref">
5164 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadResponse">CommentThreadResponse
</a>
5167 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5169 <div class=
"prop-value">
5170 <p>successful operation
</p>
5175 <div class=
"doc-examples">
5176 <h5>Response Content-Types:
5177 <span>application/json
</span>
5180 <h5>Response Example
5181 <span>(
200 OK)
</span>
5183 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5184 <span class=
"hljs-attr">"total
"</span>:
<span class=
"hljs-string">"number
"</span>,
5185 <span class=
"hljs-attr">"data
"</span>: [
5187 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5188 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5189 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5190 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5191 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5192 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5193 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5194 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5195 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5196 <span class=
"hljs-attr">"account
"</span>: {
5197 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5198 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5199 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5200 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5201 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5202 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5203 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5204 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5205 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5206 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5207 <span class=
"hljs-attr">"avatar
"</span>: {
5208 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5209 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5210 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5222 <div id=
"operation--videos--videoId--comment-threads-post" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comment-threads-post">
5223 <!-- <section class="operation-tags row"> -->
5224 <!-- <div class="doc-copy"> -->
5225 <div class=
"operation-tags">
5226 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5231 <h2 class=
"operation-title">
5232 <span class=
"operation-name">
5233 <span class=
"operation-name">POST
</span>
5234 <span class=
"operation-path">/videos/{videoId}/comment-threads
</span>
5237 <div class=
"doc-row">
5238 <div class=
"doc-copy">
5239 <section class=
"swagger-request-params">
5240 <div class=
"prop-row prop-group">
5241 <div class=
"prop-name">
5242 <div class=
"prop-title">videoId
</div>
5243 <span class=
"json-property-required"></span>
5245 <div class=
"prop-value">
5246 <p>The video id
</p>
5249 <div class=
"prop-row prop-inner">
5250 <div class=
"prop-name param-label">type
</div>
5251 <div class=
"prop-value">
5252 <span class=
"json-property-type">string
</span>
5253 <span class=
"json-property-range" title=
"Value limits"></span>
5256 <div class=
"prop-row prop-inner">
5257 <div class=
"prop-name param-label">in
</div>
5258 <div class=
"prop-value">path
</div>
5262 <div class=
"doc-examples"></div>
5264 <div class=
"doc-row">
5265 <div class=
"doc-copy">
5266 <section class=
"swagger-responses">
5267 <div class=
"prop-row prop-group">
5268 <div class=
"prop-name">
5269 <div class=
"prop-title">200 OK
</div>
5270 <div class=
"prop-ref">
5272 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadPostResponse">CommentThreadPostResponse
</a>
5275 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5277 <div class=
"prop-value">
5278 <p>successful operation
</p>
5283 <div class=
"doc-examples">
5284 <h5>Response Content-Types:
5285 <span>application/json
</span>
5288 <h5>Response Example
5289 <span>(
200 OK)
</span>
5291 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5292 <span class=
"hljs-attr">"comment
"</span>: {
5293 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5294 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5295 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5296 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5297 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5298 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5299 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5300 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5301 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5302 <span class=
"hljs-attr">"account
"</span>: {
5303 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5304 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5305 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5306 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5307 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5308 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5309 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5310 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5311 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5312 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5313 <span class=
"hljs-attr">"avatar
"</span>: {
5314 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5315 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5316 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5327 <div id=
"operation--videos--videoId--comment-threads--threadId--get" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comment-threads--threadId--get">
5328 <!-- <section class="operation-tags row"> -->
5329 <!-- <div class="doc-copy"> -->
5330 <div class=
"operation-tags">
5331 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5336 <h2 class=
"operation-title">
5337 <span class=
"operation-name">
5338 <span class=
"operation-name">GET
</span>
5339 <span class=
"operation-path">/videos/{videoId}/comment-threads/{threadId}
</span>
5342 <div class=
"doc-row">
5343 <div class=
"doc-copy">
5344 <section class=
"swagger-request-params">
5345 <div class=
"prop-row prop-group">
5346 <div class=
"prop-name">
5347 <div class=
"prop-title">videoId
</div>
5348 <span class=
"json-property-required"></span>
5350 <div class=
"prop-value">
5351 <p>The video id
</p>
5354 <div class=
"prop-row prop-inner">
5355 <div class=
"prop-name param-label">type
</div>
5356 <div class=
"prop-value">
5357 <span class=
"json-property-type">string
</span>
5358 <span class=
"json-property-range" title=
"Value limits"></span>
5361 <div class=
"prop-row prop-inner">
5362 <div class=
"prop-name param-label">in
</div>
5363 <div class=
"prop-value">path
</div>
5365 <div class=
"prop-row prop-group">
5366 <div class=
"prop-name">
5367 <div class=
"prop-title">threadId
</div>
5368 <span class=
"json-property-required"></span>
5370 <div class=
"prop-value">
5371 <p>The thread id
</p>
5374 <div class=
"prop-row prop-inner">
5375 <div class=
"prop-name param-label">type
</div>
5376 <div class=
"prop-value">
5377 <span class=
"json-property-type">string
</span>
5378 <span class=
"json-property-range" title=
"Value limits"></span>
5381 <div class=
"prop-row prop-inner">
5382 <div class=
"prop-name param-label">in
</div>
5383 <div class=
"prop-value">path
</div>
5387 <div class=
"doc-examples"></div>
5389 <div class=
"doc-row">
5390 <div class=
"doc-copy">
5391 <section class=
"swagger-responses">
5392 <div class=
"prop-row prop-group">
5393 <div class=
"prop-name">
5394 <div class=
"prop-title">200 OK
</div>
5395 <div class=
"prop-ref">
5397 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
5400 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5402 <div class=
"prop-value">
5403 <p>successful operation
</p>
5408 <div class=
"doc-examples">
5409 <h5>Response Content-Types:
5410 <span>application/json
</span>
5413 <h5>Response Example
5414 <span>(
200 OK)
</span>
5416 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5417 <span class=
"hljs-attr">"comment
"</span>: {
5418 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5419 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5420 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5421 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5422 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5423 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5424 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5425 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5426 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5427 <span class=
"hljs-attr">"account
"</span>: {
5428 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5429 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5430 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5431 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5432 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5433 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5434 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5435 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5436 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5437 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5438 <span class=
"hljs-attr">"avatar
"</span>: {
5439 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5440 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5441 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5445 <span class=
"hljs-attr">"children
"</span>: [
5447 <span class=
"hljs-attr">"comment
"</span>: {
5448 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5449 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5450 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5451 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5452 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5453 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5454 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5455 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5456 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5457 <span class=
"hljs-attr">"account
"</span>: {
5458 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5459 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5460 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5461 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5462 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5463 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5464 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5465 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5466 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5467 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5468 <span class=
"hljs-attr">"avatar
"</span>: {
5469 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5470 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5471 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5475 <span class=
"hljs-attr">"children
"</span>: [
5477 <span class=
"hljs-attr">"comment
"</span>: {
5478 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5479 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5480 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5481 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5482 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5483 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5484 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5485 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5486 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5487 <span class=
"hljs-attr">"account
"</span>: {
5488 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5489 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5490 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5491 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5492 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5493 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5494 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5495 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5496 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5497 <span class=
"hljs-attr">"avatar
"</span>: {
5498 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5499 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5500 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5515 <div id=
"operation--videos--videoId--comments--commentId--post" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comments--commentId--post">
5516 <!-- <section class="operation-tags row"> -->
5517 <!-- <div class="doc-copy"> -->
5518 <div class=
"operation-tags">
5519 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5524 <h2 class=
"operation-title">
5525 <span class=
"operation-name">
5526 <span class=
"operation-name">POST
</span>
5527 <span class=
"operation-path">/videos/{videoId}/comments/{commentId}
</span>
5530 <div class=
"doc-row">
5531 <div class=
"doc-copy">
5532 <section class=
"swagger-request-params">
5533 <div class=
"prop-row prop-group">
5534 <div class=
"prop-name">
5535 <div class=
"prop-title">videoId
</div>
5536 <span class=
"json-property-required"></span>
5538 <div class=
"prop-value">
5539 <p>The video id
</p>
5542 <div class=
"prop-row prop-inner">
5543 <div class=
"prop-name param-label">type
</div>
5544 <div class=
"prop-value">
5545 <span class=
"json-property-type">string
</span>
5546 <span class=
"json-property-range" title=
"Value limits"></span>
5549 <div class=
"prop-row prop-inner">
5550 <div class=
"prop-name param-label">in
</div>
5551 <div class=
"prop-value">path
</div>
5553 <div class=
"prop-row prop-group">
5554 <div class=
"prop-name">
5555 <div class=
"prop-title">commentId
</div>
5556 <span class=
"json-property-required"></span>
5558 <div class=
"prop-value">
5559 <p>The comment id
</p>
5562 <div class=
"prop-row prop-inner">
5563 <div class=
"prop-name param-label">type
</div>
5564 <div class=
"prop-value">
5565 <span class=
"json-property-type">string
</span>
5566 <span class=
"json-property-range" title=
"Value limits"></span>
5569 <div class=
"prop-row prop-inner">
5570 <div class=
"prop-name param-label">in
</div>
5571 <div class=
"prop-value">path
</div>
5575 <div class=
"doc-examples"></div>
5577 <div class=
"doc-row">
5578 <div class=
"doc-copy">
5579 <section class=
"swagger-responses">
5580 <div class=
"prop-row prop-group">
5581 <div class=
"prop-name">
5582 <div class=
"prop-title">200 OK
</div>
5583 <div class=
"prop-ref">
5585 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadPostResponse">CommentThreadPostResponse
</a>
5588 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5590 <div class=
"prop-value">
5591 <p>successful operation
</p>
5596 <div class=
"doc-examples">
5597 <h5>Response Content-Types:
5598 <span>application/json
</span>
5601 <h5>Response Example
5602 <span>(
200 OK)
</span>
5604 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5605 <span class=
"hljs-attr">"comment
"</span>: {
5606 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5607 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5608 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5609 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5610 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5611 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5612 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5613 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5614 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5615 <span class=
"hljs-attr">"account
"</span>: {
5616 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5617 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5618 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5619 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5620 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5621 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5622 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5623 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5624 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5625 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5626 <span class=
"hljs-attr">"avatar
"</span>: {
5627 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5628 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5629 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5640 <div id=
"operation--videos--videoId--comments--commentId--delete" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comments--commentId--delete">
5641 <!-- <section class="operation-tags row"> -->
5642 <!-- <div class="doc-copy"> -->
5643 <div class=
"operation-tags">
5644 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5649 <h2 class=
"operation-title">
5650 <span class=
"operation-name">
5651 <span class=
"operation-name">DELETE
</span>
5652 <span class=
"operation-path">/videos/{videoId}/comments/{commentId}
</span>
5655 <div class=
"doc-row">
5656 <div class=
"doc-copy">
5657 <section class=
"swagger-request-params">
5658 <div class=
"prop-row prop-group">
5659 <div class=
"prop-name">
5660 <div class=
"prop-title">videoId
</div>
5661 <span class=
"json-property-required"></span>
5663 <div class=
"prop-value">
5664 <p>The video id
</p>
5667 <div class=
"prop-row prop-inner">
5668 <div class=
"prop-name param-label">type
</div>
5669 <div class=
"prop-value">
5670 <span class=
"json-property-type">string
</span>
5671 <span class=
"json-property-range" title=
"Value limits"></span>
5674 <div class=
"prop-row prop-inner">
5675 <div class=
"prop-name param-label">in
</div>
5676 <div class=
"prop-value">path
</div>
5678 <div class=
"prop-row prop-group">
5679 <div class=
"prop-name">
5680 <div class=
"prop-title">commentId
</div>
5681 <span class=
"json-property-required"></span>
5683 <div class=
"prop-value">
5684 <p>The comment id
</p>
5687 <div class=
"prop-row prop-inner">
5688 <div class=
"prop-name param-label">type
</div>
5689 <div class=
"prop-value">
5690 <span class=
"json-property-type">string
</span>
5691 <span class=
"json-property-range" title=
"Value limits"></span>
5694 <div class=
"prop-row prop-inner">
5695 <div class=
"prop-name param-label">in
</div>
5696 <div class=
"prop-value">path
</div>
5700 <div class=
"doc-examples"></div>
5702 <div class=
"doc-row">
5703 <div class=
"doc-copy">
5704 <section class=
"swagger-responses">
5705 <div class=
"prop-row prop-group">
5706 <div class=
"prop-name">
5707 <div class=
"prop-title">204 No Content
</div>
5709 <div class=
"prop-value">
5710 <p>successful operation
</p>
5715 <div class=
"doc-examples">
5716 <h5>Response Content-Types:
5717 <span>application/json
</span>
5722 <h1 id=
"tag-VideoRate" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoRate">VideoRate
</h1>
5723 <div id=
"operation--videos--id--rate-put" class=
"operation panel" data-traverse-target=
"operation--videos--id--rate-put">
5724 <!-- <section class="operation-tags row"> -->
5725 <!-- <div class="doc-copy"> -->
5726 <div class=
"operation-tags">
5727 <a class=
"label" href=
"#tag-VideoRate">VideoRate
</a>
5732 <h2 class=
"operation-title">
5733 <span class=
"operation-name">
5734 <span class=
"operation-name">PUT
</span>
5735 <span class=
"operation-path">/videos/{id}/rate
</span>
5738 <div class=
"doc-row">
5739 <div class=
"doc-copy">
5740 <section class=
"swagger-request-params">
5741 <div class=
"prop-row prop-group">
5742 <div class=
"prop-name">
5743 <div class=
"prop-title">id
</div>
5744 <span class=
"json-property-required"></span>
5746 <div class=
"prop-value">
5747 <p>The video id
</p>
5750 <div class=
"prop-row prop-inner">
5751 <div class=
"prop-name param-label">type
</div>
5752 <div class=
"prop-value">
5753 <span class=
"json-property-type">string
</span>
5754 <span class=
"json-property-range" title=
"Value limits"></span>
5757 <div class=
"prop-row prop-inner">
5758 <div class=
"prop-name param-label">in
</div>
5759 <div class=
"prop-value">path
</div>
5763 <div class=
"doc-examples"></div>
5765 <div class=
"doc-row">
5766 <div class=
"doc-copy">
5767 <section class=
"swagger-responses">
5768 <div class=
"prop-row prop-group">
5769 <div class=
"prop-name">
5770 <div class=
"prop-title">204 No Content
</div>
5772 <div class=
"prop-value">
5773 <p>successful operation
</p>
5778 <div class=
"doc-examples">
5779 <h5>Response Content-Types:
5780 <span>application/json
</span>
5785 <h1>Schema Definitions
</h1>
5786 <div id=
"definition-VideoConstant" class=
"definition panel" data-traverse-target=
"definition-VideoConstant">
5787 <h2 class=
"panel-title">
5788 <a name=
"/definitions/VideoConstant"></a>VideoConstant:
5789 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
5790 <span class="json-property-range" title="Value limits"></span>
5795 <div class=
"doc-row">
5796 <div class=
"doc-copy">
5797 <section class=
"json-schema-properties">
5799 <dt data-property-name=
"id">
5800 <span class=
"json-property-name">id:
</span>
5801 <span class=
"json-property-type">number
</span>
5802 <span class=
"json-property-range" title=
"Value limits"></span>
5804 <dt data-property-name=
"label">
5805 <span class=
"json-property-name">label:
</span>
5806 <span class=
"json-property-type">string
</span>
5807 <span class=
"json-property-range" title=
"Value limits"></span>
5812 <div class=
"doc-examples">
5815 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5816 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5817 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5825 <div id=
"definition-VideoPrivacy" class=
"definition panel" data-traverse-target=
"definition-VideoPrivacy">
5826 <h2 class=
"panel-title">
5827 <a name=
"/definitions/VideoPrivacy"></a>VideoPrivacy: string
5828 <!-- <span class="json-property-type"><span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values">
5829 <span class="json-property-enum-item">Public</span>,
5830 <span class="json-property-enum-item">Unlisted</span>,
5831 <span class="json-property-enum-item">Private</span>
5833 <span class="json-property-range" title="Value limits"></span>
5838 <div class=
"doc-row">
5839 <div class=
"doc-copy">
5840 <span class=
"json-property-type">string
</span>
5841 <span class=
"json-property-enum" title=
"Possible values">
5842 <span class=
"json-property-enum-item">Public
</span>,
5843 <span class=
"json-property-enum-item">Unlisted
</span>,
5844 <span class=
"json-property-enum-item">Private
</span>
5846 <span class=
"json-property-range" title=
"Value limits"></span>
5850 <div id=
"definition-Video" class=
"definition panel" data-traverse-target=
"definition-Video">
5851 <h2 class=
"panel-title">
5852 <a name=
"/definitions/Video"></a>Video:
5853 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
5854 <span class="json-property-range" title="Value limits"></span>
5859 <div class=
"doc-row">
5860 <div class=
"doc-copy">
5861 <section class=
"json-schema-properties">
5863 <dt data-property-name=
"id">
5864 <span class=
"json-property-name">id:
</span>
5865 <span class=
"json-property-type">number
</span>
5866 <span class=
"json-property-range" title=
"Value limits"></span>
5868 <dt data-property-name=
"uuid">
5869 <span class=
"json-property-name">uuid:
</span>
5870 <span class=
"json-property-type">string
</span>
5871 <span class=
"json-property-range" title=
"Value limits"></span>
5873 <dt data-property-name=
"createdAt">
5874 <span class=
"json-property-name">createdAt:
</span>
5875 <span class=
"json-property-type">string
</span>
5876 <span class=
"json-property-range" title=
"Value limits"></span>
5878 <dt data-property-name=
"publishedAt">
5879 <span class=
"json-property-name">publishedAt:
</span>
5880 <span class=
"json-property-type">string
</span>
5881 <span class=
"json-property-range" title=
"Value limits"></span>
5883 <dt data-property-name=
"updatedAt">
5884 <span class=
"json-property-name">updatedAt:
</span>
5885 <span class=
"json-property-type">string
</span>
5886 <span class=
"json-property-range" title=
"Value limits"></span>
5888 <dt data-property-name=
"category">
5889 <span class=
"json-property-name">category:
</span>
5890 <span class=
"json-property-type">
5892 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstant">VideoConstant
</a>
5895 <span class=
"json-property-range" title=
"Value limits"></span>
5897 <dt data-property-name=
"licence">
5898 <span class=
"json-property-name">licence:
</span>
5899 <span class=
"json-property-type">
5901 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstant">VideoConstant
</a>
5904 <span class=
"json-property-range" title=
"Value limits"></span>
5906 <dt data-property-name=
"language">
5907 <span class=
"json-property-name">language:
</span>
5908 <span class=
"json-property-type">
5910 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstant">VideoConstant
</a>
5913 <span class=
"json-property-range" title=
"Value limits"></span>
5915 <dt data-property-name=
"privacy">
5916 <span class=
"json-property-name">privacy:
</span>
5917 <span class=
"json-property-type">
5919 <a class=
"json-schema-ref" href=
"#/definitions/VideoPrivacy">VideoPrivacy
</a>
5922 <span class=
"json-property-range" title=
"Value limits"></span>
5924 <dt data-property-name=
"description">
5925 <span class=
"json-property-name">description:
</span>
5926 <span class=
"json-property-type">string
</span>
5927 <span class=
"json-property-range" title=
"Value limits"></span>
5929 <dt data-property-name=
"duration">
5930 <span class=
"json-property-name">duration:
</span>
5931 <span class=
"json-property-type">number
</span>
5932 <span class=
"json-property-range" title=
"Value limits"></span>
5934 <dt data-property-name=
"isLocal">
5935 <span class=
"json-property-name">isLocal:
</span>
5936 <span class=
"json-property-type">boolean
</span>
5937 <span class=
"json-property-range" title=
"Value limits"></span>
5939 <dt data-property-name=
"name">
5940 <span class=
"json-property-name">name:
</span>
5941 <span class=
"json-property-type">string
</span>
5942 <span class=
"json-property-range" title=
"Value limits"></span>
5944 <dt data-property-name=
"thumbnailPath">
5945 <span class=
"json-property-name">thumbnailPath:
</span>
5946 <span class=
"json-property-type">string
</span>
5947 <span class=
"json-property-range" title=
"Value limits"></span>
5949 <dt data-property-name=
"previewPath">
5950 <span class=
"json-property-name">previewPath:
</span>
5951 <span class=
"json-property-type">string
</span>
5952 <span class=
"json-property-range" title=
"Value limits"></span>
5954 <dt data-property-name=
"embedPath">
5955 <span class=
"json-property-name">embedPath:
</span>
5956 <span class=
"json-property-type">string
</span>
5957 <span class=
"json-property-range" title=
"Value limits"></span>
5959 <dt data-property-name=
"views">
5960 <span class=
"json-property-name">views:
</span>
5961 <span class=
"json-property-type">number
</span>
5962 <span class=
"json-property-range" title=
"Value limits"></span>
5964 <dt data-property-name=
"likes">
5965 <span class=
"json-property-name">likes:
</span>
5966 <span class=
"json-property-type">number
</span>
5967 <span class=
"json-property-range" title=
"Value limits"></span>
5969 <dt data-property-name=
"dislikes">
5970 <span class=
"json-property-name">dislikes:
</span>
5971 <span class=
"json-property-type">number
</span>
5972 <span class=
"json-property-range" title=
"Value limits"></span>
5974 <dt data-property-name=
"nsfw">
5975 <span class=
"json-property-name">nsfw:
</span>
5976 <span class=
"json-property-type">boolean
</span>
5977 <span class=
"json-property-range" title=
"Value limits"></span>
5979 <dt data-property-name=
"account">
5980 <span class=
"json-property-name">account:
</span>
5981 <span class=
"json-property-type">object
</span>
5982 <span class=
"json-property-range" title=
"Value limits"></span>
5987 <div class=
"doc-examples">
5990 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5991 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5992 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5993 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5994 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5995 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5996 <span class=
"hljs-attr">"category
"</span>: {
5997 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5998 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6000 <span class=
"hljs-attr">"licence
"</span>: {
6001 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6002 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6004 <span class=
"hljs-attr">"language
"</span>: {
6005 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6006 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6008 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
6009 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6010 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6011 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6012 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6013 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6014 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6015 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6016 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6017 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6018 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6019 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6020 <span class=
"hljs-attr">"account
"</span>: {
6021 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6022 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6023 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6024 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6025 <span class=
"hljs-attr">"avatar
"</span>: {
6026 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6027 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6028 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6038 <div id=
"definition-VideoAbuse" class=
"definition panel" data-traverse-target=
"definition-VideoAbuse">
6039 <h2 class=
"panel-title">
6040 <a name=
"/definitions/VideoAbuse"></a>VideoAbuse:
6041 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6042 <span class="json-property-range" title="Value limits"></span>
6047 <div class=
"doc-row">
6048 <div class=
"doc-copy">
6049 <section class=
"json-schema-properties">
6051 <dt data-property-name=
"id">
6052 <span class=
"json-property-name">id:
</span>
6053 <span class=
"json-property-type">number
</span>
6054 <span class=
"json-property-range" title=
"Value limits"></span>
6056 <dt data-property-name=
"reason">
6057 <span class=
"json-property-name">reason:
</span>
6058 <span class=
"json-property-type">string
</span>
6059 <span class=
"json-property-range" title=
"Value limits"></span>
6061 <dt data-property-name=
"reporterAccount">
6062 <span class=
"json-property-name">reporterAccount:
</span>
6063 <span class=
"json-property-type">
6065 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
6068 <span class=
"json-property-range" title=
"Value limits"></span>
6070 <dt data-property-name=
"video">
6071 <span class=
"json-property-name">video:
</span>
6072 <span class=
"json-property-type">object
</span>
6073 <span class=
"json-property-range" title=
"Value limits"></span>
6075 <dt data-property-name=
"createdAt">
6076 <span class=
"json-property-name">createdAt:
</span>
6077 <span class=
"json-property-type">string
</span>
6078 <span class=
"json-property-range" title=
"Value limits"></span>
6083 <div class=
"doc-examples">
6086 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6087 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6088 <span class=
"hljs-attr">"reason
"</span>:
<span class=
"hljs-string">"string
"</span>,
6089 <span class=
"hljs-attr">"reporterAccount
"</span>: {
6090 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6091 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6092 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6093 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6094 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6095 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6096 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6097 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6098 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6099 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6100 <span class=
"hljs-attr">"avatar
"</span>: {
6101 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6102 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6103 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6106 <span class=
"hljs-attr">"video
"</span>: {
6107 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6108 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6109 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6110 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>
6112 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6120 <div id=
"definition-VideoBlacklist" class=
"definition panel" data-traverse-target=
"definition-VideoBlacklist">
6121 <h2 class=
"panel-title">
6122 <a name=
"/definitions/VideoBlacklist"></a>VideoBlacklist:
6123 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6124 <span class="json-property-range" title="Value limits"></span>
6129 <div class=
"doc-row">
6130 <div class=
"doc-copy">
6131 <section class=
"json-schema-properties">
6133 <dt data-property-name=
"id">
6134 <span class=
"json-property-name">id:
</span>
6135 <span class=
"json-property-type">number
</span>
6136 <span class=
"json-property-range" title=
"Value limits"></span>
6138 <dt data-property-name=
"videoId">
6139 <span class=
"json-property-name">videoId:
</span>
6140 <span class=
"json-property-type">number
</span>
6141 <span class=
"json-property-range" title=
"Value limits"></span>
6143 <dt data-property-name=
"createdAt">
6144 <span class=
"json-property-name">createdAt:
</span>
6145 <span class=
"json-property-type">string
</span>
6146 <span class=
"json-property-range" title=
"Value limits"></span>
6148 <dt data-property-name=
"updatedAt">
6149 <span class=
"json-property-name">updatedAt:
</span>
6150 <span class=
"json-property-type">string
</span>
6151 <span class=
"json-property-range" title=
"Value limits"></span>
6153 <dt data-property-name=
"name">
6154 <span class=
"json-property-name">name:
</span>
6155 <span class=
"json-property-type">string
</span>
6156 <span class=
"json-property-range" title=
"Value limits"></span>
6158 <dt data-property-name=
"uuid">
6159 <span class=
"json-property-name">uuid:
</span>
6160 <span class=
"json-property-type">string
</span>
6161 <span class=
"json-property-range" title=
"Value limits"></span>
6163 <dt data-property-name=
"description">
6164 <span class=
"json-property-name">description:
</span>
6165 <span class=
"json-property-type">string
</span>
6166 <span class=
"json-property-range" title=
"Value limits"></span>
6168 <dt data-property-name=
"duration">
6169 <span class=
"json-property-name">duration:
</span>
6170 <span class=
"json-property-type">number
</span>
6171 <span class=
"json-property-range" title=
"Value limits"></span>
6173 <dt data-property-name=
"views">
6174 <span class=
"json-property-name">views:
</span>
6175 <span class=
"json-property-type">number
</span>
6176 <span class=
"json-property-range" title=
"Value limits"></span>
6178 <dt data-property-name=
"likes">
6179 <span class=
"json-property-name">likes:
</span>
6180 <span class=
"json-property-type">number
</span>
6181 <span class=
"json-property-range" title=
"Value limits"></span>
6183 <dt data-property-name=
"dislikes">
6184 <span class=
"json-property-name">dislikes:
</span>
6185 <span class=
"json-property-type">number
</span>
6186 <span class=
"json-property-range" title=
"Value limits"></span>
6188 <dt data-property-name=
"nsfw">
6189 <span class=
"json-property-name">nsfw:
</span>
6190 <span class=
"json-property-type">boolean
</span>
6191 <span class=
"json-property-range" title=
"Value limits"></span>
6196 <div class=
"doc-examples">
6199 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6200 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6201 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6202 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6203 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6204 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6205 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6206 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6207 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6208 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6209 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6210 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6211 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
6219 <div id=
"definition-VideoChannel" class=
"definition panel" data-traverse-target=
"definition-VideoChannel">
6220 <h2 class=
"panel-title">
6221 <a name=
"/definitions/VideoChannel"></a>VideoChannel:
6222 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6223 <span class="json-property-range" title="Value limits"></span>
6228 <div class=
"doc-row">
6229 <div class=
"doc-copy">
6230 <section class=
"json-schema-properties">
6232 <dt data-property-name=
"displayName">
6233 <span class=
"json-property-name">displayName:
</span>
6234 <span class=
"json-property-type">string
</span>
6235 <span class=
"json-property-range" title=
"Value limits"></span>
6237 <dt data-property-name=
"description">
6238 <span class=
"json-property-name">description:
</span>
6239 <span class=
"json-property-type">string
</span>
6240 <span class=
"json-property-range" title=
"Value limits"></span>
6242 <dt data-property-name=
"isLocal">
6243 <span class=
"json-property-name">isLocal:
</span>
6244 <span class=
"json-property-type">boolean
</span>
6245 <span class=
"json-property-range" title=
"Value limits"></span>
6247 <dt data-property-name=
"owner">
6248 <span class=
"json-property-name">owner:
</span>
6249 <span class=
"json-property-type">object
</span>
6250 <span class=
"json-property-range" title=
"Value limits"></span>
6252 <dt data-property-name=
"videos">
6253 <span class=
"json-property-name">videos:
</span>
6254 <span class=
"json-property-type">
6255 <span class=
"json-schema-ref-array">
6256 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
6259 <span class=
"json-property-range" title=
"Value limits"></span>
6264 <div class=
"doc-examples">
6267 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6268 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6269 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6270 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6271 <span class=
"hljs-attr">"owner
"</span>: {
6272 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6273 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
6275 <span class=
"hljs-attr">"videos
"</span>: [
6277 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6278 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6279 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6280 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6281 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6282 <span class=
"hljs-attr">"category
"</span>: {
6283 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6284 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6286 <span class=
"hljs-attr">"licence
"</span>: {
6287 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6288 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6290 <span class=
"hljs-attr">"language
"</span>: {
6291 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6292 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6294 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
6295 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6296 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6297 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6298 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6299 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6300 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6301 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6302 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6303 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6304 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6305 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6306 <span class=
"hljs-attr">"account
"</span>: {
6307 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6308 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6309 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6310 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6311 <span class=
"hljs-attr">"avatar
"</span>: {
6312 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6313 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6314 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6326 <div id=
"definition-VideoComment" class=
"definition panel" data-traverse-target=
"definition-VideoComment">
6327 <h2 class=
"panel-title">
6328 <a name=
"/definitions/VideoComment"></a>VideoComment:
6329 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6330 <span class="json-property-range" title="Value limits"></span>
6335 <div class=
"doc-row">
6336 <div class=
"doc-copy">
6337 <section class=
"json-schema-properties">
6339 <dt data-property-name=
"id">
6340 <span class=
"json-property-name">id:
</span>
6341 <span class=
"json-property-type">number
</span>
6342 <span class=
"json-property-range" title=
"Value limits"></span>
6344 <dt data-property-name=
"url">
6345 <span class=
"json-property-name">url:
</span>
6346 <span class=
"json-property-type">string
</span>
6347 <span class=
"json-property-range" title=
"Value limits"></span>
6349 <dt data-property-name=
"text">
6350 <span class=
"json-property-name">text:
</span>
6351 <span class=
"json-property-type">string
</span>
6352 <span class=
"json-property-range" title=
"Value limits"></span>
6354 <dt data-property-name=
"threadId">
6355 <span class=
"json-property-name">threadId:
</span>
6356 <span class=
"json-property-type">number
</span>
6357 <span class=
"json-property-range" title=
"Value limits"></span>
6359 <dt data-property-name=
"inReplyToCommentId">
6360 <span class=
"json-property-name">inReplyToCommentId:
</span>
6361 <span class=
"json-property-type">number
</span>
6362 <span class=
"json-property-range" title=
"Value limits"></span>
6364 <dt data-property-name=
"videoId">
6365 <span class=
"json-property-name">videoId:
</span>
6366 <span class=
"json-property-type">number
</span>
6367 <span class=
"json-property-range" title=
"Value limits"></span>
6369 <dt data-property-name=
"createdAt">
6370 <span class=
"json-property-name">createdAt:
</span>
6371 <span class=
"json-property-type">string
</span>
6372 <span class=
"json-property-range" title=
"Value limits"></span>
6374 <dt data-property-name=
"updatedAt">
6375 <span class=
"json-property-name">updatedAt:
</span>
6376 <span class=
"json-property-type">string
</span>
6377 <span class=
"json-property-range" title=
"Value limits"></span>
6379 <dt data-property-name=
"totalReplies">
6380 <span class=
"json-property-name">totalReplies:
</span>
6381 <span class=
"json-property-type">number
</span>
6382 <span class=
"json-property-range" title=
"Value limits"></span>
6384 <dt data-property-name=
"account">
6385 <span class=
"json-property-name">account:
</span>
6386 <span class=
"json-property-type">
6388 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
6391 <span class=
"json-property-range" title=
"Value limits"></span>
6396 <div class=
"doc-examples">
6399 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6400 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6401 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6402 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6403 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6404 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6405 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6406 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6407 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6408 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6409 <span class=
"hljs-attr">"account
"</span>: {
6410 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6411 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6412 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6413 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6414 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6415 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6416 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6417 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6418 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6419 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6420 <span class=
"hljs-attr">"avatar
"</span>: {
6421 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6422 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6423 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6433 <div id=
"definition-VideoCommentThreadTree" class=
"definition panel" data-traverse-target=
"definition-VideoCommentThreadTree">
6434 <h2 class=
"panel-title">
6435 <a name=
"/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree:
6436 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6437 <span class="json-property-range" title="Value limits"></span>
6442 <div class=
"doc-row">
6443 <div class=
"doc-copy">
6444 <section class=
"json-schema-properties">
6446 <dt data-property-name=
"comment">
6447 <span class=
"json-property-name">comment:
</span>
6448 <span class=
"json-property-type">
6450 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
6453 <span class=
"json-property-range" title=
"Value limits"></span>
6455 <dt data-property-name=
"children">
6456 <span class=
"json-property-name">children:
</span>
6457 <span class=
"json-property-type">
6458 <span class=
"json-schema-ref-array">
6459 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
6462 <span class=
"json-property-range" title=
"Value limits"></span>
6467 <div class=
"doc-examples">
6470 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6471 <span class=
"hljs-attr">"comment
"</span>: {
6472 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6473 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6474 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6475 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6476 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6477 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6478 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6479 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6480 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6481 <span class=
"hljs-attr">"account
"</span>: {
6482 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6483 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6484 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6485 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6486 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6487 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6488 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6489 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6490 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6491 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6492 <span class=
"hljs-attr">"avatar
"</span>: {
6493 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6494 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6495 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6499 <span class=
"hljs-attr">"children
"</span>: [
6501 <span class=
"hljs-attr">"comment
"</span>: {
6502 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6503 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6504 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6505 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6506 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6507 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6508 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6509 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6510 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6511 <span class=
"hljs-attr">"account
"</span>: {
6512 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6513 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6514 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6515 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6516 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6517 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6518 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6519 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6520 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6521 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6522 <span class=
"hljs-attr">"avatar
"</span>: {
6523 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6524 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6525 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6529 <span class=
"hljs-attr">"children
"</span>: [
6531 <span class=
"hljs-attr">"comment
"</span>: {
6532 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6533 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6534 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6535 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6536 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6537 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6538 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6539 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6540 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6541 <span class=
"hljs-attr">"account
"</span>: {
6542 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6543 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6544 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6545 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6546 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6547 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6548 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6549 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6550 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6551 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6552 <span class=
"hljs-attr">"avatar
"</span>: {
6553 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6554 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6555 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6570 <div id=
"definition-Avatar" class=
"definition panel" data-traverse-target=
"definition-Avatar">
6571 <h2 class=
"panel-title">
6572 <a name=
"/definitions/Avatar"></a>Avatar:
6573 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6574 <span class="json-property-range" title="Value limits"></span>
6579 <div class=
"doc-row">
6580 <div class=
"doc-copy">
6581 <section class=
"json-schema-properties">
6583 <dt data-property-name=
"path">
6584 <span class=
"json-property-name">path:
</span>
6585 <span class=
"json-property-type">string
</span>
6586 <span class=
"json-property-range" title=
"Value limits"></span>
6588 <dt data-property-name=
"createdAt">
6589 <span class=
"json-property-name">createdAt:
</span>
6590 <span class=
"json-property-type">string
</span>
6591 <span class=
"json-property-range" title=
"Value limits"></span>
6593 <dt data-property-name=
"updatedAt">
6594 <span class=
"json-property-name">updatedAt:
</span>
6595 <span class=
"json-property-type">string
</span>
6596 <span class=
"json-property-range" title=
"Value limits"></span>
6601 <div class=
"doc-examples">
6604 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6605 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6606 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6607 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6615 <div id=
"definition-Actor" class=
"definition panel" data-traverse-target=
"definition-Actor">
6616 <h2 class=
"panel-title">
6617 <a name=
"/definitions/Actor"></a>Actor:
6618 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6619 <span class="json-property-range" title="Value limits"></span>
6624 <div class=
"doc-row">
6625 <div class=
"doc-copy">
6626 <section class=
"json-schema-properties">
6628 <dt data-property-name=
"id">
6629 <span class=
"json-property-name">id:
</span>
6630 <span class=
"json-property-type">number
</span>
6631 <span class=
"json-property-range" title=
"Value limits"></span>
6633 <dt data-property-name=
"uuid">
6634 <span class=
"json-property-name">uuid:
</span>
6635 <span class=
"json-property-type">string
</span>
6636 <span class=
"json-property-range" title=
"Value limits"></span>
6638 <dt data-property-name=
"url">
6639 <span class=
"json-property-name">url:
</span>
6640 <span class=
"json-property-type">string
</span>
6641 <span class=
"json-property-range" title=
"Value limits"></span>
6643 <dt data-property-name=
"name">
6644 <span class=
"json-property-name">name:
</span>
6645 <span class=
"json-property-type">string
</span>
6646 <span class=
"json-property-range" title=
"Value limits"></span>
6648 <dt data-property-name=
"host">
6649 <span class=
"json-property-name">host:
</span>
6650 <span class=
"json-property-type">string
</span>
6651 <span class=
"json-property-range" title=
"Value limits"></span>
6653 <dt data-property-name=
"followingCount">
6654 <span class=
"json-property-name">followingCount:
</span>
6655 <span class=
"json-property-type">number
</span>
6656 <span class=
"json-property-range" title=
"Value limits"></span>
6658 <dt data-property-name=
"followersCount">
6659 <span class=
"json-property-name">followersCount:
</span>
6660 <span class=
"json-property-type">number
</span>
6661 <span class=
"json-property-range" title=
"Value limits"></span>
6663 <dt data-property-name=
"createdAt">
6664 <span class=
"json-property-name">createdAt:
</span>
6665 <span class=
"json-property-type">string
</span>
6666 <span class=
"json-property-range" title=
"Value limits"></span>
6668 <dt data-property-name=
"updatedAt">
6669 <span class=
"json-property-name">updatedAt:
</span>
6670 <span class=
"json-property-type">string
</span>
6671 <span class=
"json-property-range" title=
"Value limits"></span>
6673 <dt data-property-name=
"avatar">
6674 <span class=
"json-property-name">avatar:
</span>
6675 <span class=
"json-property-type">
6677 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
6680 <span class=
"json-property-range" title=
"Value limits"></span>
6685 <div class=
"doc-examples">
6688 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6689 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6690 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6691 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6692 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6693 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6694 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6695 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6696 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6697 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6698 <span class=
"hljs-attr">"avatar
"</span>: {
6699 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6700 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6701 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6710 <div id=
"definition-Account" class=
"definition panel" data-traverse-target=
"definition-Account">
6711 <h2 class=
"panel-title">
6712 <a name=
"/definitions/Account"></a>Account:
6713 <!-- <span class="json-property-type"><span class="json-property-type"></span>
6714 <span class="json-property-range" title="Value limits"></span>
6719 <div class=
"doc-row">
6720 <div class=
"doc-copy">
6721 <section class=
"json-schema-allOf">
6722 <section class=
"json-schema-allOf-inherited">
6725 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
6729 <section class=
"json-schema-allOf-additional">
6730 <section class=
"json-schema-properties">
6732 <dt data-property-name=
"displayName">
6733 <span class=
"json-property-name">displayName:
</span>
6734 <span class=
"json-property-type">string
</span>
6735 <span class=
"json-property-range" title=
"Value limits"></span>
6742 <div class=
"doc-examples">
6745 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6746 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6747 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6748 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6749 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6750 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6751 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6752 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6753 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6754 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6755 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6756 <span class=
"hljs-attr">"avatar
"</span>: {
6757 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6758 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6759 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6768 <div id=
"definition-User" class=
"definition panel" data-traverse-target=
"definition-User">
6769 <h2 class=
"panel-title">
6770 <a name=
"/definitions/User"></a>User:
6771 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6772 <span class="json-property-range" title="Value limits"></span>
6777 <div class=
"doc-row">
6778 <div class=
"doc-copy">
6779 <section class=
"json-schema-properties">
6781 <dt data-property-name=
"id">
6782 <span class=
"json-property-name">id:
</span>
6783 <span class=
"json-property-type">number
</span>
6784 <span class=
"json-property-range" title=
"Value limits"></span>
6786 <dt data-property-name=
"username">
6787 <span class=
"json-property-name">username:
</span>
6788 <span class=
"json-property-type">string
</span>
6789 <span class=
"json-property-range" title=
"Value limits"></span>
6791 <dt data-property-name=
"email">
6792 <span class=
"json-property-name">email:
</span>
6793 <span class=
"json-property-type">string
</span>
6794 <span class=
"json-property-range" title=
"Value limits"></span>
6796 <dt data-property-name=
"displayNSFW">
6797 <span class=
"json-property-name">displayNSFW:
</span>
6798 <span class=
"json-property-type">boolean
</span>
6799 <span class=
"json-property-range" title=
"Value limits"></span>
6801 <dt data-property-name=
"autoPlayVideo">
6802 <span class=
"json-property-name">autoPlayVideo:
</span>
6803 <span class=
"json-property-type">boolean
</span>
6804 <span class=
"json-property-range" title=
"Value limits"></span>
6806 <dt data-property-name=
"role">
6807 <span class=
"json-property-name">role:
</span>
6808 <span class=
"json-property-type">string
</span>
6809 <span class=
"json-property-enum" title=
"Possible values">
6810 <span class=
"json-property-enum-item">User
</span>,
6811 <span class=
"json-property-enum-item">Moderator
</span>,
6812 <span class=
"json-property-enum-item">Administrator
</span>
6814 <span class=
"json-property-range" title=
"Value limits"></span>
6816 <dt data-property-name=
"videoQuota">
6817 <span class=
"json-property-name">videoQuota:
</span>
6818 <span class=
"json-property-type">number
</span>
6819 <span class=
"json-property-range" title=
"Value limits"></span>
6821 <dt data-property-name=
"createdAt">
6822 <span class=
"json-property-name">createdAt:
</span>
6823 <span class=
"json-property-type">string
</span>
6824 <span class=
"json-property-range" title=
"Value limits"></span>
6826 <dt data-property-name=
"account">
6827 <span class=
"json-property-name">account:
</span>
6828 <span class=
"json-property-type">
6830 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
6833 <span class=
"json-property-range" title=
"Value limits"></span>
6835 <dt data-property-name=
"videoChannels">
6836 <span class=
"json-property-name">videoChannels:
</span>
6837 <span class=
"json-property-type">
6838 <span class=
"json-schema-ref-array">
6839 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
6842 <span class=
"json-property-range" title=
"Value limits"></span>
6847 <div class=
"doc-examples">
6850 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6851 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6852 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
6853 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
6854 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6855 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6856 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
6857 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
6858 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6859 <span class=
"hljs-attr">"account
"</span>: {
6860 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6861 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6862 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6863 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6864 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6865 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6866 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6867 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6868 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6869 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6870 <span class=
"hljs-attr">"avatar
"</span>: {
6871 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6872 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6873 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6876 <span class=
"hljs-attr">"videoChannels
"</span>: [
6878 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6879 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6880 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6881 <span class=
"hljs-attr">"owner
"</span>: {
6882 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6883 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
6885 <span class=
"hljs-attr">"videos
"</span>: [
6887 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6888 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6889 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6890 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6891 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6892 <span class=
"hljs-attr">"category
"</span>: {
6893 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6894 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6896 <span class=
"hljs-attr">"licence
"</span>: {
6897 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6898 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6900 <span class=
"hljs-attr">"language
"</span>: {
6901 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6902 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6904 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
6905 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6906 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6907 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6908 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6909 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6910 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6911 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6912 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6913 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6914 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6915 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6916 <span class=
"hljs-attr">"account
"</span>: {
6917 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6918 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6919 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6920 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6921 <span class=
"hljs-attr">"avatar
"</span>: {
6922 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6923 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6924 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6938 <div id=
"definition-ServerConfig" class=
"definition panel" data-traverse-target=
"definition-ServerConfig">
6939 <h2 class=
"panel-title">
6940 <a name=
"/definitions/ServerConfig"></a>ServerConfig:
6941 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6942 <span class="json-property-range" title="Value limits"></span>
6947 <div class=
"doc-row">
6948 <div class=
"doc-copy">
6949 <section class=
"json-schema-properties">
6951 <dt data-property-name=
"signup">
6952 <span class=
"json-property-name">signup:
</span>
6953 <span class=
"json-property-type">object
</span>
6954 <span class=
"json-property-range" title=
"Value limits"></span>
6956 <dt data-property-name=
"transcoding">
6957 <span class=
"json-property-name">transcoding:
</span>
6958 <span class=
"json-property-type">object
</span>
6959 <span class=
"json-property-range" title=
"Value limits"></span>
6961 <dt data-property-name=
"avatar">
6962 <span class=
"json-property-name">avatar:
</span>
6963 <span class=
"json-property-type">object
</span>
6964 <span class=
"json-property-range" title=
"Value limits"></span>
6966 <dt data-property-name=
"video">
6967 <span class=
"json-property-name">video:
</span>
6968 <span class=
"json-property-type">object
</span>
6969 <span class=
"json-property-range" title=
"Value limits"></span>
6974 <div class=
"doc-examples">
6977 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6978 <span class=
"hljs-attr">"signup
"</span>: {
6979 <span class=
"hljs-attr">"allowed
"</span>:
<span class=
"hljs-string">"boolean
"</span>
6981 <span class=
"hljs-attr">"transcoding
"</span>: {
6982 <span class=
"hljs-attr">"enabledResolutions
"</span>: [
6983 <span class=
"hljs-string">"number
"</span>
6986 <span class=
"hljs-attr">"avatar
"</span>: {
6987 <span class=
"hljs-attr">"file
"</span>: {
6988 <span class=
"hljs-attr">"size
"</span>: {
6989 <span class=
"hljs-attr">"max
"</span>:
<span class=
"hljs-string">"number
"</span>
6992 <span class=
"hljs-attr">"extensions
"</span>: [
6993 <span class=
"hljs-string">"string
"</span>
6996 <span class=
"hljs-attr">"video
"</span>: {
6997 <span class=
"hljs-attr">"file
"</span>: {
6998 <span class=
"hljs-attr">"extensions
"</span>: [
6999 <span class=
"hljs-string">"string
"</span>
7010 <div id=
"definition-Follow" class=
"definition panel" data-traverse-target=
"definition-Follow">
7011 <h2 class=
"panel-title">
7012 <a name=
"/definitions/Follow"></a>Follow:
7013 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7014 <span class="json-property-range" title="Value limits"></span>
7019 <div class=
"doc-row">
7020 <div class=
"doc-copy">
7021 <section class=
"json-schema-properties">
7023 <dt data-property-name=
"id">
7024 <span class=
"json-property-name">id:
</span>
7025 <span class=
"json-property-type">number
</span>
7026 <span class=
"json-property-range" title=
"Value limits"></span>
7028 <dt data-property-name=
"follower">
7029 <span class=
"json-property-name">follower:
</span>
7030 <span class=
"json-property-type">
7032 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7035 <span class=
"json-property-range" title=
"Value limits"></span>
7037 <dt data-property-name=
"following">
7038 <span class=
"json-property-name">following:
</span>
7039 <span class=
"json-property-type">
7041 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7044 <span class=
"json-property-range" title=
"Value limits"></span>
7046 <dt data-property-name=
"score">
7047 <span class=
"json-property-name">score:
</span>
7048 <span class=
"json-property-type">number
</span>
7049 <span class=
"json-property-range" title=
"Value limits"></span>
7051 <dt data-property-name=
"state">
7052 <span class=
"json-property-name">state:
</span>
7053 <span class=
"json-property-type">string
</span>
7054 <span class=
"json-property-enum" title=
"Possible values">
7055 <span class=
"json-property-enum-item">pending
</span>,
7056 <span class=
"json-property-enum-item">accepted
</span>
7058 <span class=
"json-property-range" title=
"Value limits"></span>
7060 <dt data-property-name=
"createdAt">
7061 <span class=
"json-property-name">createdAt:
</span>
7062 <span class=
"json-property-type">string
</span>
7063 <span class=
"json-property-range" title=
"Value limits"></span>
7065 <dt data-property-name=
"updatedAt">
7066 <span class=
"json-property-name">updatedAt:
</span>
7067 <span class=
"json-property-type">string
</span>
7068 <span class=
"json-property-range" title=
"Value limits"></span>
7073 <div class=
"doc-examples">
7076 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7077 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7078 <span class=
"hljs-attr">"follower
"</span>: {
7079 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7080 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7081 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7082 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7083 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7084 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7085 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7086 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7087 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7088 <span class=
"hljs-attr">"avatar
"</span>: {
7089 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7090 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7091 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7094 <span class=
"hljs-attr">"following
"</span>: {
7095 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7096 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7097 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7098 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7099 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7100 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7101 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7102 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7103 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7104 <span class=
"hljs-attr">"avatar
"</span>: {
7105 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7106 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7107 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7110 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
7111 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
7112 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7113 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7121 <div id=
"definition-Job" class=
"definition panel" data-traverse-target=
"definition-Job">
7122 <h2 class=
"panel-title">
7123 <a name=
"/definitions/Job"></a>Job:
7124 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7125 <span class="json-property-range" title="Value limits"></span>
7130 <div class=
"doc-row">
7131 <div class=
"doc-copy">
7132 <section class=
"json-schema-properties">
7134 <dt data-property-name=
"id">
7135 <span class=
"json-property-name">id:
</span>
7136 <span class=
"json-property-type">number
</span>
7137 <span class=
"json-property-range" title=
"Value limits"></span>
7139 <dt data-property-name=
"state">
7140 <span class=
"json-property-name">state:
</span>
7141 <span class=
"json-property-type">string
</span>
7142 <span class=
"json-property-enum" title=
"Possible values">
7143 <span class=
"json-property-enum-item">pending
</span>,
7144 <span class=
"json-property-enum-item">processing
</span>,
7145 <span class=
"json-property-enum-item">error
</span>,
7146 <span class=
"json-property-enum-item">success
</span>
7148 <span class=
"json-property-range" title=
"Value limits"></span>
7150 <dt data-property-name=
"category">
7151 <span class=
"json-property-name">category:
</span>
7152 <span class=
"json-property-type">string
</span>
7153 <span class=
"json-property-enum" title=
"Possible values">
7154 <span class=
"json-property-enum-item">transcoding
</span>,
7155 <span class=
"json-property-enum-item">activitypub-http
</span>
7157 <span class=
"json-property-range" title=
"Value limits"></span>
7159 <dt data-property-name=
"handlerName">
7160 <span class=
"json-property-name">handlerName:
</span>
7161 <span class=
"json-property-type">string
</span>
7162 <span class=
"json-property-range" title=
"Value limits"></span>
7164 <dt data-property-name=
"handlerInputData">
7165 <span class=
"json-property-name">handlerInputData:
</span>
7166 <span class=
"json-property-type">string
</span>
7167 <span class=
"json-property-range" title=
"Value limits"></span>
7169 <dt data-property-name=
"createdAt">
7170 <span class=
"json-property-name">createdAt:
</span>
7171 <span class=
"json-property-type">string
</span>
7172 <span class=
"json-property-range" title=
"Value limits"></span>
7174 <dt data-property-name=
"updatedAt">
7175 <span class=
"json-property-name">updatedAt:
</span>
7176 <span class=
"json-property-type">string
</span>
7177 <span class=
"json-property-range" title=
"Value limits"></span>
7182 <div class=
"doc-examples">
7185 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7186 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7187 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
7188 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"string
"</span>,
7189 <span class=
"hljs-attr">"handlerName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7190 <span class=
"hljs-attr">"handlerInputData
"</span>:
<span class=
"hljs-string">"string
"</span>,
7191 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7192 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7200 <div id=
"definition-AddUserResponse" class=
"definition panel" data-traverse-target=
"definition-AddUserResponse">
7201 <h2 class=
"panel-title">
7202 <a name=
"/definitions/AddUserResponse"></a>AddUserResponse:
7203 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7204 <span class="json-property-range" title="Value limits"></span>
7209 <div class=
"doc-row">
7210 <div class=
"doc-copy">
7211 <section class=
"json-schema-properties">
7213 <dt data-property-name=
"id">
7214 <span class=
"json-property-name">id:
</span>
7215 <span class=
"json-property-type">number
</span>
7216 <span class=
"json-property-range" title=
"Value limits"></span>
7218 <dt data-property-name=
"uuid">
7219 <span class=
"json-property-name">uuid:
</span>
7220 <span class=
"json-property-type">string
</span>
7221 <span class=
"json-property-range" title=
"Value limits"></span>
7226 <div class=
"doc-examples">
7229 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7230 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7231 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
7239 <div id=
"definition-VideoUploadResponse" class=
"definition panel" data-traverse-target=
"definition-VideoUploadResponse">
7240 <h2 class=
"panel-title">
7241 <a name=
"/definitions/VideoUploadResponse"></a>VideoUploadResponse:
7242 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7243 <span class="json-property-range" title="Value limits"></span>
7248 <div class=
"doc-row">
7249 <div class=
"doc-copy">
7250 <section class=
"json-schema-properties">
7252 <dt data-property-name=
"video">
7253 <span class=
"json-property-name">video:
</span>
7254 <span class=
"json-property-type">object
</span>
7255 <span class=
"json-property-range" title=
"Value limits"></span>
7260 <div class=
"doc-examples">
7263 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7264 <span class=
"hljs-attr">"video
"</span>: {
7265 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7266 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
7275 <div id=
"definition-CommentThreadResponse" class=
"definition panel" data-traverse-target=
"definition-CommentThreadResponse">
7276 <h2 class=
"panel-title">
7277 <a name=
"/definitions/CommentThreadResponse"></a>CommentThreadResponse:
7278 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7279 <span class="json-property-range" title="Value limits"></span>
7284 <div class=
"doc-row">
7285 <div class=
"doc-copy">
7286 <section class=
"json-schema-properties">
7288 <dt data-property-name=
"total">
7289 <span class=
"json-property-name">total:
</span>
7290 <span class=
"json-property-type">number
</span>
7291 <span class=
"json-property-range" title=
"Value limits"></span>
7293 <dt data-property-name=
"data">
7294 <span class=
"json-property-name">data:
</span>
7295 <span class=
"json-property-type">
7296 <span class=
"json-schema-ref-array">
7297 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
7300 <span class=
"json-property-range" title=
"Value limits"></span>
7305 <div class=
"doc-examples">
7308 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7309 <span class=
"hljs-attr">"total
"</span>:
<span class=
"hljs-string">"number
"</span>,
7310 <span class=
"hljs-attr">"data
"</span>: [
7312 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7313 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7314 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7315 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7316 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7317 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7318 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7319 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7320 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7321 <span class=
"hljs-attr">"account
"</span>: {
7322 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7323 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7324 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7325 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7326 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7327 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7328 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7329 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7330 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7331 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7332 <span class=
"hljs-attr">"avatar
"</span>: {
7333 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7334 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7335 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7347 <div id=
"definition-CommentThreadPostResponse" class=
"definition panel" data-traverse-target=
"definition-CommentThreadPostResponse">
7348 <h2 class=
"panel-title">
7349 <a name=
"/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse:
7350 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7351 <span class="json-property-range" title="Value limits"></span>
7356 <div class=
"doc-row">
7357 <div class=
"doc-copy">
7358 <section class=
"json-schema-properties">
7360 <dt data-property-name=
"comment">
7361 <span class=
"json-property-name">comment:
</span>
7362 <span class=
"json-property-type">
7364 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
7367 <span class=
"json-property-range" title=
"Value limits"></span>
7372 <div class=
"doc-examples">
7375 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7376 <span class=
"hljs-attr">"comment
"</span>: {
7377 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7378 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7379 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7380 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7381 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7382 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7383 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7384 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7385 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7386 <span class=
"hljs-attr">"account
"</span>: {
7387 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7388 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7389 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7390 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7391 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7392 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7393 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7394 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7395 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7396 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7397 <span class=
"hljs-attr">"avatar
"</span>: {
7398 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7399 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7400 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7411 <div id=
"definition-AddUser" class=
"definition panel" data-traverse-target=
"definition-AddUser">
7412 <h2 class=
"panel-title">
7413 <a name=
"/definitions/AddUser"></a>AddUser:
7414 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7415 <span class="json-property-range" title="Value limits"></span>
7420 <div class=
"doc-row">
7421 <div class=
"doc-copy">
7422 <section class=
"json-schema-properties">
7424 <dt data-property-name=
"username" class=
"has-description">
7425 <span class=
"json-property-name">username:
</span>
7426 <span class=
"json-property-type">string
</span>
7427 <span class=
"json-property-range" title=
"Value limits"></span>
7428 <span class=
"json-property-required"></span>
7431 <p>The user username
</p>
7433 <dt data-property-name=
"password" class=
"has-description">
7434 <span class=
"json-property-name">password:
</span>
7435 <span class=
"json-property-type">string
</span>
7436 <span class=
"json-property-range" title=
"Value limits"></span>
7437 <span class=
"json-property-required"></span>
7440 <p>The user password
</p>
7442 <dt data-property-name=
"email" class=
"has-description">
7443 <span class=
"json-property-name">email:
</span>
7444 <span class=
"json-property-type">string
</span>
7445 <span class=
"json-property-range" title=
"Value limits"></span>
7446 <span class=
"json-property-required"></span>
7449 <p>The user email
</p>
7451 <dt data-property-name=
"videoQuota" class=
"has-description">
7452 <span class=
"json-property-name">videoQuota:
</span>
7453 <span class=
"json-property-type">string
</span>
7454 <span class=
"json-property-range" title=
"Value limits"></span>
7455 <span class=
"json-property-required"></span>
7458 <p>The user videoQuota
</p>
7460 <dt data-property-name=
"role" class=
"has-description">
7461 <span class=
"json-property-name">role:
</span>
7462 <span class=
"json-property-type">string
</span>
7463 <span class=
"json-property-range" title=
"Value limits"></span>
7464 <span class=
"json-property-required"></span>
7467 <p>The user role
</p>
7472 <div class=
"doc-examples">
7475 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7476 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
7477 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
7478 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
7479 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
7480 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
7488 <div id=
"definition-UpdateUser" class=
"definition panel" data-traverse-target=
"definition-UpdateUser">
7489 <h2 class=
"panel-title">
7490 <a name=
"/definitions/UpdateUser"></a>UpdateUser:
7491 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7492 <span class="json-property-range" title="Value limits"></span>
7497 <div class=
"doc-row">
7498 <div class=
"doc-copy">
7499 <section class=
"json-schema-properties">
7501 <dt data-property-name=
"id" class=
"has-description">
7502 <span class=
"json-property-name">id:
</span>
7503 <span class=
"json-property-type">string
</span>
7504 <span class=
"json-property-range" title=
"Value limits"></span>
7505 <span class=
"json-property-required"></span>
7510 <dt data-property-name=
"email" class=
"has-description">
7511 <span class=
"json-property-name">email:
</span>
7512 <span class=
"json-property-type">string
</span>
7513 <span class=
"json-property-range" title=
"Value limits"></span>
7514 <span class=
"json-property-required"></span>
7517 <p>The updated email of the user
</p>
7519 <dt data-property-name=
"videoQuota" class=
"has-description">
7520 <span class=
"json-property-name">videoQuota:
</span>
7521 <span class=
"json-property-type">string
</span>
7522 <span class=
"json-property-range" title=
"Value limits"></span>
7523 <span class=
"json-property-required"></span>
7526 <p>The updated videoQuota of the user
</p>
7528 <dt data-property-name=
"role" class=
"has-description">
7529 <span class=
"json-property-name">role:
</span>
7530 <span class=
"json-property-type">string
</span>
7531 <span class=
"json-property-range" title=
"Value limits"></span>
7532 <span class=
"json-property-required"></span>
7535 <p>The updated role of the user
</p>
7540 <div class=
"doc-examples">
7543 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7544 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
7545 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
7546 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
7547 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
7555 <div id=
"definition-UpdateMe" class=
"definition panel" data-traverse-target=
"definition-UpdateMe">
7556 <h2 class=
"panel-title">
7557 <a name=
"/definitions/UpdateMe"></a>UpdateMe:
7558 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7559 <span class="json-property-range" title="Value limits"></span>
7564 <div class=
"doc-row">
7565 <div class=
"doc-copy">
7566 <section class=
"json-schema-properties">
7568 <dt data-property-name=
"password" class=
"has-description">
7569 <span class=
"json-property-name">password:
</span>
7570 <span class=
"json-property-type">string
</span>
7571 <span class=
"json-property-range" title=
"Value limits"></span>
7572 <span class=
"json-property-required"></span>
7575 <p>Your new password
</p>
7577 <dt data-property-name=
"email" class=
"has-description">
7578 <span class=
"json-property-name">email:
</span>
7579 <span class=
"json-property-type">string
</span>
7580 <span class=
"json-property-range" title=
"Value limits"></span>
7581 <span class=
"json-property-required"></span>
7584 <p>Your new email
</p>
7586 <dt data-property-name=
"displayNSFW" class=
"has-description">
7587 <span class=
"json-property-name">displayNSFW:
</span>
7588 <span class=
"json-property-type">string
</span>
7589 <span class=
"json-property-range" title=
"Value limits"></span>
7590 <span class=
"json-property-required"></span>
7593 <p>Your new displayNSFW
</p>
7595 <dt data-property-name=
"autoPlayVideo" class=
"has-description">
7596 <span class=
"json-property-name">autoPlayVideo:
</span>
7597 <span class=
"json-property-type">string
</span>
7598 <span class=
"json-property-range" title=
"Value limits"></span>
7599 <span class=
"json-property-required"></span>
7602 <p>Your new autoPlayVideo
</p>
7607 <div class=
"doc-examples">
7610 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7611 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
7612 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
7613 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"string
"</span>,
7614 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"string
"</span>
7622 <div id=
"definition-GetMeVideoRating" class=
"definition panel" data-traverse-target=
"definition-GetMeVideoRating">
7623 <h2 class=
"panel-title">
7624 <a name=
"/definitions/GetMeVideoRating"></a>GetMeVideoRating:
7625 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7626 <span class="json-property-range" title="Value limits"></span>
7631 <div class=
"doc-row">
7632 <div class=
"doc-copy">
7633 <section class=
"json-schema-properties">
7635 <dt data-property-name=
"id" class=
"has-description">
7636 <span class=
"json-property-name">id:
</span>
7637 <span class=
"json-property-type">string
</span>
7638 <span class=
"json-property-range" title=
"Value limits"></span>
7639 <span class=
"json-property-required"></span>
7642 <p>Id of the video
</p>
7644 <dt data-property-name=
"rating" class=
"has-description">
7645 <span class=
"json-property-name">rating:
</span>
7646 <span class=
"json-property-type">number
</span>
7647 <span class=
"json-property-range" title=
"Value limits"></span>
7648 <span class=
"json-property-required"></span>
7651 <p>Rating of the video
</p>
7656 <div class=
"doc-examples">
7659 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7660 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
7661 <span class=
"hljs-attr">"rating
"</span>:
<span class=
"hljs-string">"number
"</span>
7669 <div id=
"definition-RegisterUser" class=
"definition panel" data-traverse-target=
"definition-RegisterUser">
7670 <h2 class=
"panel-title">
7671 <a name=
"/definitions/RegisterUser"></a>RegisterUser:
7672 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7673 <span class="json-property-range" title="Value limits"></span>
7678 <div class=
"doc-row">
7679 <div class=
"doc-copy">
7680 <section class=
"json-schema-properties">
7682 <dt data-property-name=
"username" class=
"has-description">
7683 <span class=
"json-property-name">username:
</span>
7684 <span class=
"json-property-type">string
</span>
7685 <span class=
"json-property-range" title=
"Value limits"></span>
7686 <span class=
"json-property-required"></span>
7689 <p>The username of the user
</p>
7691 <dt data-property-name=
"password" class=
"has-description">
7692 <span class=
"json-property-name">password:
</span>
7693 <span class=
"json-property-type">string
</span>
7694 <span class=
"json-property-range" title=
"Value limits"></span>
7695 <span class=
"json-property-required"></span>
7698 <p>The password of the user
</p>
7700 <dt data-property-name=
"email" class=
"has-description">
7701 <span class=
"json-property-name">email:
</span>
7702 <span class=
"json-property-type">string
</span>
7703 <span class=
"json-property-range" title=
"Value limits"></span>
7704 <span class=
"json-property-required"></span>
7707 <p>The email of the user
</p>
7712 <div class=
"doc-examples">
7715 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7716 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
7717 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
7718 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>
7726 <div id=
"definition-VideoChannelInput" class=
"definition panel" data-traverse-target=
"definition-VideoChannelInput">
7727 <h2 class=
"panel-title">
7728 <a name=
"/definitions/VideoChannelInput"></a>VideoChannelInput:
7729 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7730 <span class="json-property-range" title="Value limits"></span>
7735 <div class=
"doc-row">
7736 <div class=
"doc-copy">
7737 <section class=
"json-schema-properties">
7739 <dt data-property-name=
"name">
7740 <span class=
"json-property-name">name:
</span>
7741 <span class=
"json-property-type">string
</span>
7742 <span class=
"json-property-range" title=
"Value limits"></span>
7744 <dt data-property-name=
"description">
7745 <span class=
"json-property-name">description:
</span>
7746 <span class=
"json-property-type">string
</span>
7747 <span class=
"json-property-range" title=
"Value limits"></span>
7752 <div class=
"doc-examples">
7755 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7756 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7757 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
7765 <div class=
"doc-row no-margin">
7766 <div class=
"doc-copy doc-separator">
7767 <a class=
"powered-by" href=
"https://sourcey.com/spectacle">Documentation by
7768 <span>Spectacle
</span>