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-Video"> Video
</a>
227 <a href=
"#definition-VideoAbuse"> VideoAbuse
</a>
228 <a href=
"#definition-VideoBlacklist"> VideoBlacklist
</a>
229 <a href=
"#definition-VideoChannel"> VideoChannel
</a>
230 <a href=
"#definition-VideoComment"> VideoComment
</a>
231 <a href=
"#definition-VideoCommentThreadTree"> VideoCommentThreadTree
</a>
232 <a href=
"#definition-Avatar"> Avatar
</a>
233 <a href=
"#definition-Actor"> Actor
</a>
234 <a href=
"#definition-Account"> Account
</a>
235 <a href=
"#definition-User"> User
</a>
236 <a href=
"#definition-ServerConfig"> ServerConfig
</a>
237 <a href=
"#definition-Follow"> Follow
</a>
238 <a href=
"#definition-Job"> Job
</a>
239 <a href=
"#definition-AddUserResponse"> AddUserResponse
</a>
240 <a href=
"#definition-VideoUploadResponse"> VideoUploadResponse
</a>
241 <a href=
"#definition-CommentThreadResponse"> CommentThreadResponse
</a>
242 <a href=
"#definition-CommentThreadPostResponse"> CommentThreadPostResponse
</a>
243 <a href=
"#definition-AddUser"> AddUser
</a>
244 <a href=
"#definition-UpdateUser"> UpdateUser
</a>
245 <a href=
"#definition-UpdateMe"> UpdateMe
</a>
246 <a href=
"#definition-GetMeVideoRating"> GetMeVideoRating
</a>
247 <a href=
"#definition-RegisterUser"> RegisterUser
</a>
248 <a href=
"#definition-VideoChannelInput"> VideoChannelInput
</a>
251 <div id=
"docs" class=
"row collapse expanded drawer" data-drawer
>
252 <button class=
"floating-menu-icon" type=
"button" data-drawer-slide=
"right">
253 <span class=
"hamburger"></span>
255 <div class=
"example-box doc-content"></div>
257 <div id=
"introduction" data-traverse-target=
"introduction">
258 <h1 class=
"doc-title">PeerTube
259 <span>API Reference
</span>
261 <div class=
"doc-row">
262 <div class=
"doc-copy">
263 <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.
</p>
265 <div class=
"doc-examples">
267 <h5>API Endpoint
</h5>
268 <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1
</code></pre>
274 <span>1.0.0-alpha
</span>
280 <h1 id=
"tag-Accounts" class=
"swagger-summary-tag" data-traverse-target=
"tag-Accounts">Accounts
</h1>
281 <div id=
"operation--accounts--id--get" class=
"operation panel" data-traverse-target=
"operation--accounts--id--get">
282 <!-- <section class="operation-tags row"> -->
283 <!-- <div class="doc-copy"> -->
284 <div class=
"operation-tags">
285 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
290 <h2 class=
"operation-title">
291 <span class=
"operation-name">
292 <span class=
"operation-name">GET
</span>
293 <span class=
"operation-path">/accounts/{id}
</span>
296 <div class=
"doc-row">
297 <div class=
"doc-copy">
298 <section class=
"swagger-request-params">
299 <div class=
"prop-row prop-group">
300 <div class=
"prop-name">
301 <div class=
"prop-title">id
</div>
302 <span class=
"json-property-required"></span>
304 <div class=
"prop-value">
305 <p>The id of the account
</p>
308 <div class=
"prop-row prop-inner">
309 <div class=
"prop-name param-label">type
</div>
310 <div class=
"prop-value">
311 <span class=
"json-property-type">string
</span>
312 <span class=
"json-property-range" title=
"Value limits"></span>
315 <div class=
"prop-row prop-inner">
316 <div class=
"prop-name param-label">in
</div>
317 <div class=
"prop-value">path
</div>
319 <div class=
"prop-row prop-group">
320 <div class=
"prop-name">
321 <div class=
"prop-title">start
</div>
323 <div class=
"prop-value">
327 <div class=
"prop-row prop-inner">
328 <div class=
"prop-name param-label">type
</div>
329 <div class=
"prop-value">
330 <span class=
"json-property-type">number
</span>
331 <span class=
"json-property-range" title=
"Value limits"></span>
334 <div class=
"prop-row prop-inner">
335 <div class=
"prop-name param-label">in
</div>
336 <div class=
"prop-value">query
</div>
338 <div class=
"prop-row prop-group">
339 <div class=
"prop-name">
340 <div class=
"prop-title">stop
</div>
342 <div class=
"prop-value">
346 <div class=
"prop-row prop-inner">
347 <div class=
"prop-name param-label">type
</div>
348 <div class=
"prop-value">
349 <span class=
"json-property-type">number
</span>
350 <span class=
"json-property-range" title=
"Value limits"></span>
353 <div class=
"prop-row prop-inner">
354 <div class=
"prop-name param-label">in
</div>
355 <div class=
"prop-value">query
</div>
357 <div class=
"prop-row prop-group">
358 <div class=
"prop-name">
359 <div class=
"prop-title">sort
</div>
361 <div class=
"prop-value">
365 <div class=
"prop-row prop-inner">
366 <div class=
"prop-name param-label">type
</div>
367 <div class=
"prop-value">
368 <span class=
"json-property-type">number
</span>
369 <span class=
"json-property-range" title=
"Value limits"></span>
372 <div class=
"prop-row prop-inner">
373 <div class=
"prop-name param-label">in
</div>
374 <div class=
"prop-value">query
</div>
378 <div class=
"doc-examples"></div>
380 <div class=
"doc-row">
381 <div class=
"doc-copy">
382 <section class=
"swagger-responses">
383 <div class=
"prop-row prop-group">
384 <div class=
"prop-name">
385 <div class=
"prop-title">200 OK
</div>
386 <div class=
"prop-ref">
388 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
391 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
393 <div class=
"prop-value">
394 <p>successful operation
</p>
399 <div class=
"doc-examples">
400 <h5>Response Content-Types:
401 <span>application/json
</span>
405 <span>(
200 OK)
</span>
407 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
408 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
409 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
410 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
411 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
412 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
413 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
414 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
415 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
416 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
417 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
418 <span class=
"hljs-attr">"avatar
"</span>: {
419 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
420 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
421 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
430 <div id=
"operation--accounts-get" class=
"operation panel" data-traverse-target=
"operation--accounts-get">
431 <!-- <section class="operation-tags row"> -->
432 <!-- <div class="doc-copy"> -->
433 <div class=
"operation-tags">
434 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
439 <h2 class=
"operation-title">
440 <span class=
"operation-name">
441 <span class=
"operation-name">GET
</span>
442 <span class=
"operation-path">/accounts
</span>
445 <div class=
"doc-row">
446 <div class=
"doc-copy"> </div>
447 <div class=
"doc-examples"></div>
449 <div class=
"doc-row">
450 <div class=
"doc-copy">
451 <section class=
"swagger-responses">
452 <div class=
"prop-row prop-group">
453 <div class=
"prop-name">
454 <div class=
"prop-title">200 OK
</div>
455 <div class=
"prop-ref">
456 <span class=
"json-schema-ref-array">
457 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
460 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
462 <div class=
"prop-value">
463 <p>successful operation
</p>
468 <div class=
"doc-examples">
469 <h5>Response Content-Types:
470 <span>application/json
</span>
474 <span>(
200 OK)
</span>
476 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
478 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
479 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
480 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
481 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
482 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
483 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
484 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
485 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
486 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
487 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
488 <span class=
"hljs-attr">"avatar
"</span>: {
489 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
490 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
491 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
501 <h1 id=
"tag-Config" class=
"swagger-summary-tag" data-traverse-target=
"tag-Config">Config
</h1>
502 <div id=
"operation--config-get" class=
"operation panel" data-traverse-target=
"operation--config-get">
503 <!-- <section class="operation-tags row"> -->
504 <!-- <div class="doc-copy"> -->
505 <div class=
"operation-tags">
506 <a class=
"label" href=
"#tag-Config">Config
</a>
511 <h2 class=
"operation-title">
512 <span class=
"operation-name">
513 <span class=
"operation-name">GET
</span>
514 <span class=
"operation-path">/config
</span>
517 <div class=
"doc-row">
518 <div class=
"doc-copy"> </div>
519 <div class=
"doc-examples"></div>
521 <div class=
"doc-row">
522 <div class=
"doc-copy">
523 <section class=
"swagger-responses">
524 <div class=
"prop-row prop-group">
525 <div class=
"prop-name">
526 <div class=
"prop-title">200 OK
</div>
527 <div class=
"prop-ref">
529 <a class=
"json-schema-ref" href=
"#/definitions/ServerConfig">ServerConfig
</a>
532 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
534 <div class=
"prop-value">
535 <p>successful operation
</p>
540 <div class=
"doc-examples">
541 <h5>Response Content-Types:
542 <span>application/json
</span>
546 <span>(
200 OK)
</span>
548 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
549 <span class=
"hljs-attr">"signup
"</span>: {
550 <span class=
"hljs-attr">"allowed
"</span>:
<span class=
"hljs-string">"boolean
"</span>
552 <span class=
"hljs-attr">"transcoding
"</span>: {
553 <span class=
"hljs-attr">"enabledResolutions
"</span>: [
554 <span class=
"hljs-string">"number
"</span>
557 <span class=
"hljs-attr">"avatar
"</span>: {
558 <span class=
"hljs-attr">"file
"</span>: {
559 <span class=
"hljs-attr">"size
"</span>: {
560 <span class=
"hljs-attr">"max
"</span>:
<span class=
"hljs-string">"number
"</span>
563 <span class=
"hljs-attr">"extensions
"</span>: [
564 <span class=
"hljs-string">"string
"</span>
567 <span class=
"hljs-attr">"video
"</span>: {
568 <span class=
"hljs-attr">"file
"</span>: {
569 <span class=
"hljs-attr">"extensions
"</span>: [
570 <span class=
"hljs-string">"string
"</span>
581 <h1 id=
"tag-Job" class=
"swagger-summary-tag" data-traverse-target=
"tag-Job">Job
</h1>
582 <div id=
"operation--jobs-get" class=
"operation panel" data-traverse-target=
"operation--jobs-get">
583 <!-- <section class="operation-tags row"> -->
584 <!-- <div class="doc-copy"> -->
585 <div class=
"operation-tags">
586 <a class=
"label" href=
"#tag-Job">Job
</a>
591 <h2 class=
"operation-title">
592 <span class=
"operation-name">
593 <span class=
"operation-name">GET
</span>
594 <span class=
"operation-path">/jobs
</span>
597 <div class=
"doc-row">
598 <div class=
"doc-copy">
599 <section class=
"swagger-request-params">
600 <div class=
"prop-row prop-group">
601 <div class=
"prop-name">
602 <div class=
"prop-title">state
</div>
603 <span class=
"json-property-required"></span>
605 <div class=
"prop-value">
606 <p>The id of the account
</p>
609 <div class=
"prop-row prop-inner">
610 <div class=
"prop-name param-label">type
</div>
611 <div class=
"prop-value">
612 <span class=
"json-property-type">string
</span>
613 <span class=
"json-property-range" title=
"Value limits"></span>
616 <div class=
"prop-row prop-inner">
617 <div class=
"prop-name param-label">in
</div>
618 <div class=
"prop-value">path
</div>
620 <div class=
"prop-row prop-group">
621 <div class=
"prop-name">
622 <div class=
"prop-title">start
</div>
624 <div class=
"prop-value">
628 <div class=
"prop-row prop-inner">
629 <div class=
"prop-name param-label">type
</div>
630 <div class=
"prop-value">
631 <span class=
"json-property-type">number
</span>
632 <span class=
"json-property-range" title=
"Value limits"></span>
635 <div class=
"prop-row prop-inner">
636 <div class=
"prop-name param-label">in
</div>
637 <div class=
"prop-value">query
</div>
639 <div class=
"prop-row prop-group">
640 <div class=
"prop-name">
641 <div class=
"prop-title">count
</div>
643 <div class=
"prop-value">
644 <p class=
"no-description">(no description)
</p>
647 <div class=
"prop-row prop-inner">
648 <div class=
"prop-name param-label">type
</div>
649 <div class=
"prop-value">
650 <span class=
"json-property-type">number
</span>
651 <span class=
"json-property-range" title=
"Value limits"></span>
654 <div class=
"prop-row prop-inner">
655 <div class=
"prop-name param-label">in
</div>
656 <div class=
"prop-value">query
</div>
658 <div class=
"prop-row prop-group">
659 <div class=
"prop-name">
660 <div class=
"prop-title">sort
</div>
662 <div class=
"prop-value">
666 <div class=
"prop-row prop-inner">
667 <div class=
"prop-name param-label">type
</div>
668 <div class=
"prop-value">
669 <span class=
"json-property-type">number
</span>
670 <span class=
"json-property-range" title=
"Value limits"></span>
673 <div class=
"prop-row prop-inner">
674 <div class=
"prop-name param-label">in
</div>
675 <div class=
"prop-value">query
</div>
679 <div class=
"doc-examples"></div>
681 <div class=
"doc-row">
682 <div class=
"doc-copy">
683 <section class=
"swagger-responses">
684 <div class=
"prop-row prop-group">
685 <div class=
"prop-name">
686 <div class=
"prop-title">200 OK
</div>
687 <div class=
"prop-ref">
688 <span class=
"json-schema-ref-array">
689 <a class=
"json-schema-ref" href=
"#/definitions/Job">Job
</a>
692 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
694 <div class=
"prop-value">
695 <p>successful operation
</p>
700 <div class=
"doc-examples">
701 <h5>Response Content-Types:
702 <span>application/json
</span>
706 <span>(
200 OK)
</span>
708 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
710 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
711 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
712 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"string
"</span>,
713 <span class=
"hljs-attr">"handlerName
"</span>:
<span class=
"hljs-string">"string
"</span>,
714 <span class=
"hljs-attr">"handlerInputData
"</span>:
<span class=
"hljs-string">"string
"</span>,
715 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
716 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
725 <h1 id=
"tag-ServerFollowing" class=
"swagger-summary-tag" data-traverse-target=
"tag-ServerFollowing">ServerFollowing
</h1>
726 <div id=
"operation--server-following--host--delete" class=
"operation panel" data-traverse-target=
"operation--server-following--host--delete">
727 <!-- <section class="operation-tags row"> -->
728 <!-- <div class="doc-copy"> -->
729 <div class=
"operation-tags">
730 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
735 <h2 class=
"operation-title">
736 <span class=
"operation-name">
737 <span class=
"operation-name">DELETE
</span>
738 <span class=
"operation-path">/server/following/{host}
</span>
741 <div class=
"doc-row">
742 <div class=
"doc-copy">
743 <section class=
"swagger-request-params">
744 <div class=
"prop-row prop-group">
745 <div class=
"prop-name">
746 <div class=
"prop-title">host
</div>
747 <span class=
"json-property-required"></span>
749 <div class=
"prop-value">
750 <p>The host to unfollow
</p>
753 <div class=
"prop-row prop-inner">
754 <div class=
"prop-name param-label">type
</div>
755 <div class=
"prop-value">
756 <span class=
"json-property-type">string
</span>
757 <span class=
"json-property-range" title=
"Value limits"></span>
760 <div class=
"prop-row prop-inner">
761 <div class=
"prop-name param-label">in
</div>
762 <div class=
"prop-value">path
</div>
766 <div class=
"doc-examples"></div>
768 <div class=
"doc-row">
769 <div class=
"doc-copy">
770 <section class=
"swagger-responses">
771 <div class=
"prop-row prop-group">
772 <div class=
"prop-name">
773 <div class=
"prop-title">201 Created
</div>
775 <div class=
"prop-value">
776 <p>successful operation
</p>
781 <div class=
"doc-examples">
782 <h5>Response Content-Types:
783 <span>application/json
</span>
788 <div id=
"operation--server-followers-get" class=
"operation panel" data-traverse-target=
"operation--server-followers-get">
789 <!-- <section class="operation-tags row"> -->
790 <!-- <div class="doc-copy"> -->
791 <div class=
"operation-tags">
792 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
797 <h2 class=
"operation-title">
798 <span class=
"operation-name">
799 <span class=
"operation-name">GET
</span>
800 <span class=
"operation-path">/server/followers
</span>
803 <div class=
"doc-row">
804 <div class=
"doc-copy">
805 <section class=
"swagger-request-params">
806 <div class=
"prop-row prop-group">
807 <div class=
"prop-name">
808 <div class=
"prop-title">start
</div>
810 <div class=
"prop-value">
814 <div class=
"prop-row prop-inner">
815 <div class=
"prop-name param-label">type
</div>
816 <div class=
"prop-value">
817 <span class=
"json-property-type">number
</span>
818 <span class=
"json-property-range" title=
"Value limits"></span>
821 <div class=
"prop-row prop-inner">
822 <div class=
"prop-name param-label">in
</div>
823 <div class=
"prop-value">query
</div>
825 <div class=
"prop-row prop-group">
826 <div class=
"prop-name">
827 <div class=
"prop-title">stop
</div>
829 <div class=
"prop-value">
833 <div class=
"prop-row prop-inner">
834 <div class=
"prop-name param-label">type
</div>
835 <div class=
"prop-value">
836 <span class=
"json-property-type">number
</span>
837 <span class=
"json-property-range" title=
"Value limits"></span>
840 <div class=
"prop-row prop-inner">
841 <div class=
"prop-name param-label">in
</div>
842 <div class=
"prop-value">query
</div>
844 <div class=
"prop-row prop-group">
845 <div class=
"prop-name">
846 <div class=
"prop-title">sort
</div>
848 <div class=
"prop-value">
852 <div class=
"prop-row prop-inner">
853 <div class=
"prop-name param-label">type
</div>
854 <div class=
"prop-value">
855 <span class=
"json-property-type">number
</span>
856 <span class=
"json-property-range" title=
"Value limits"></span>
859 <div class=
"prop-row prop-inner">
860 <div class=
"prop-name param-label">in
</div>
861 <div class=
"prop-value">query
</div>
865 <div class=
"doc-examples"></div>
867 <div class=
"doc-row">
868 <div class=
"doc-copy">
869 <section class=
"swagger-responses">
870 <div class=
"prop-row prop-group">
871 <div class=
"prop-name">
872 <div class=
"prop-title">200 OK
</div>
873 <div class=
"prop-ref">
874 <span class=
"json-schema-ref-array">
875 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
878 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
880 <div class=
"prop-value">
881 <p>successful operation
</p>
886 <div class=
"doc-examples">
887 <h5>Response Content-Types:
888 <span>application/json
</span>
892 <span>(
200 OK)
</span>
894 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
896 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
897 <span class=
"hljs-attr">"follower
"</span>: {
898 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
899 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
900 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
901 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
902 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
903 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
904 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
905 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
906 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
907 <span class=
"hljs-attr">"avatar
"</span>: {
908 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
909 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
910 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
913 <span class=
"hljs-attr">"following
"</span>: {
914 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
915 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
916 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
917 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
918 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
919 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
920 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
921 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
922 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
923 <span class=
"hljs-attr">"avatar
"</span>: {
924 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
925 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
926 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
929 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
930 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
931 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
932 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
941 <div id=
"operation--server-following-get" class=
"operation panel" data-traverse-target=
"operation--server-following-get">
942 <!-- <section class="operation-tags row"> -->
943 <!-- <div class="doc-copy"> -->
944 <div class=
"operation-tags">
945 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
950 <h2 class=
"operation-title">
951 <span class=
"operation-name">
952 <span class=
"operation-name">GET
</span>
953 <span class=
"operation-path">/server/following
</span>
956 <div class=
"doc-row">
957 <div class=
"doc-copy">
958 <section class=
"swagger-request-params">
959 <div class=
"prop-row prop-group">
960 <div class=
"prop-name">
961 <div class=
"prop-title">start
</div>
963 <div class=
"prop-value">
967 <div class=
"prop-row prop-inner">
968 <div class=
"prop-name param-label">type
</div>
969 <div class=
"prop-value">
970 <span class=
"json-property-type">number
</span>
971 <span class=
"json-property-range" title=
"Value limits"></span>
974 <div class=
"prop-row prop-inner">
975 <div class=
"prop-name param-label">in
</div>
976 <div class=
"prop-value">query
</div>
978 <div class=
"prop-row prop-group">
979 <div class=
"prop-name">
980 <div class=
"prop-title">stop
</div>
982 <div class=
"prop-value">
986 <div class=
"prop-row prop-inner">
987 <div class=
"prop-name param-label">type
</div>
988 <div class=
"prop-value">
989 <span class=
"json-property-type">number
</span>
990 <span class=
"json-property-range" title=
"Value limits"></span>
993 <div class=
"prop-row prop-inner">
994 <div class=
"prop-name param-label">in
</div>
995 <div class=
"prop-value">query
</div>
997 <div class=
"prop-row prop-group">
998 <div class=
"prop-name">
999 <div class=
"prop-title">sort
</div>
1001 <div class=
"prop-value">
1005 <div class=
"prop-row prop-inner">
1006 <div class=
"prop-name param-label">type
</div>
1007 <div class=
"prop-value">
1008 <span class=
"json-property-type">number
</span>
1009 <span class=
"json-property-range" title=
"Value limits"></span>
1012 <div class=
"prop-row prop-inner">
1013 <div class=
"prop-name param-label">in
</div>
1014 <div class=
"prop-value">query
</div>
1018 <div class=
"doc-examples"></div>
1020 <div class=
"doc-row">
1021 <div class=
"doc-copy">
1022 <section class=
"swagger-responses">
1023 <div class=
"prop-row prop-group">
1024 <div class=
"prop-name">
1025 <div class=
"prop-title">200 OK
</div>
1026 <div class=
"prop-ref">
1027 <span class=
"json-schema-ref-array">
1028 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1031 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1033 <div class=
"prop-value">
1034 <p>successful operation
</p>
1039 <div class=
"doc-examples">
1040 <h5>Response Content-Types:
1041 <span>application/json
</span>
1044 <h5>Response Example
1045 <span>(
200 OK)
</span>
1047 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1049 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1050 <span class=
"hljs-attr">"follower
"</span>: {
1051 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1052 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1053 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1054 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1055 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1056 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1057 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1058 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1059 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1060 <span class=
"hljs-attr">"avatar
"</span>: {
1061 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1062 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1063 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1066 <span class=
"hljs-attr">"following
"</span>: {
1067 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1068 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1069 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1070 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1071 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1072 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1073 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1074 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1075 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1076 <span class=
"hljs-attr">"avatar
"</span>: {
1077 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1078 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1079 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1082 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1083 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1084 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1085 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1094 <div id=
"operation--server-following-post" class=
"operation panel" data-traverse-target=
"operation--server-following-post">
1095 <!-- <section class="operation-tags row"> -->
1096 <!-- <div class="doc-copy"> -->
1097 <div class=
"operation-tags">
1098 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1103 <h2 class=
"operation-title">
1104 <span class=
"operation-name">
1105 <span class=
"operation-name">POST
</span>
1106 <span class=
"operation-path">/server/following
</span>
1109 <div class=
"doc-row">
1110 <div class=
"doc-copy">
1111 <section class=
"swagger-request-body">
1112 <div class=
"prop-row">
1113 <div class=
"prop-name">
1114 <div class=
"swagger-request-model">
1116 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1120 <div class=
"prop-value columns small-6">
1121 <!-- <div class="swagger-request-description"> -->undefined
1127 <div class=
"doc-examples">
1129 <h5>Request Content-Types:
1130 <span>application/json
</span>
1132 <h5>Request Example
</h5>
1133 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1134 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1135 <span class=
"hljs-attr">"follower
"</span>: {
1136 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1137 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1138 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1139 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1140 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1141 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1142 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1143 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1144 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1145 <span class=
"hljs-attr">"avatar
"</span>: {
1146 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1147 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1148 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1151 <span class=
"hljs-attr">"following
"</span>: {
1152 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1153 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1154 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1155 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1156 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1157 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1158 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1159 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1160 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1161 <span class=
"hljs-attr">"avatar
"</span>: {
1162 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1163 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1164 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1167 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1168 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1169 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1170 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1177 <div class=
"doc-row">
1178 <div class=
"doc-copy">
1179 <section class=
"swagger-responses">
1180 <div class=
"prop-row prop-group">
1181 <div class=
"prop-name">
1182 <div class=
"prop-title">204 No Content
</div>
1184 <div class=
"prop-value">
1185 <p>successful operation
</p>
1190 <div class=
"doc-examples">
1191 <h5>Response Content-Types:
1192 <span>application/json
</span>
1197 <h1 id=
"tag-User" class=
"swagger-summary-tag" data-traverse-target=
"tag-User">User
</h1>
1198 <div id=
"operation--users-post" class=
"operation panel" data-traverse-target=
"operation--users-post">
1199 <!-- <section class="operation-tags row"> -->
1200 <!-- <div class="doc-copy"> -->
1201 <div class=
"operation-tags">
1202 <a class=
"label" href=
"#tag-User">User
</a>
1207 <h2 class=
"operation-title">
1208 <span class=
"operation-name">
1209 <span class=
"operation-name">POST
</span>
1210 <span class=
"operation-path">/users
</span>
1213 <div class=
"doc-row">
1214 <div class=
"doc-copy">
1215 <section class=
"swagger-request-body">
1216 <div class=
"prop-row">
1217 <div class=
"prop-name">
1218 <div class=
"swagger-request-model">
1220 <a class=
"json-schema-ref" href=
"#/definitions/AddUser">AddUser
</a>
1224 <div class=
"prop-value columns small-6">
1225 <!-- <div class="swagger-request-description"> -->undefined
1231 <div class=
"doc-examples">
1233 <h5>Request Content-Types:
1234 <span>application/json
</span>
1236 <h5>Request Example
</h5>
1237 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1238 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1239 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
1240 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1241 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
1242 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
1249 <div class=
"doc-row">
1250 <div class=
"doc-copy">
1251 <section class=
"swagger-responses">
1252 <div class=
"prop-row prop-group">
1253 <div class=
"prop-name">
1254 <div class=
"prop-title">200 OK
</div>
1255 <div class=
"prop-ref">
1257 <a class=
"json-schema-ref" href=
"#/definitions/AddUserResponse">AddUserResponse
</a>
1260 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1262 <div class=
"prop-value">
1263 <p>successful operation
</p>
1268 <div class=
"doc-examples">
1269 <h5>Response Content-Types:
1270 <span>application/json
</span>
1273 <h5>Response Example
1274 <span>(
200 OK)
</span>
1276 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1277 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1278 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1286 <div id=
"operation--users-get" class=
"operation panel" data-traverse-target=
"operation--users-get">
1287 <!-- <section class="operation-tags row"> -->
1288 <!-- <div class="doc-copy"> -->
1289 <div class=
"operation-tags">
1290 <a class=
"label" href=
"#tag-User">User
</a>
1295 <h2 class=
"operation-title">
1296 <span class=
"operation-name">
1297 <span class=
"operation-name">GET
</span>
1298 <span class=
"operation-path">/users
</span>
1301 <div class=
"doc-row">
1302 <div class=
"doc-copy">
1303 <section class=
"swagger-request-params">
1304 <div class=
"prop-row prop-group">
1305 <div class=
"prop-name">
1306 <div class=
"prop-title">start
</div>
1308 <div class=
"prop-value">
1309 <p>starting page
</p>
1312 <div class=
"prop-row prop-inner">
1313 <div class=
"prop-name param-label">type
</div>
1314 <div class=
"prop-value">
1315 <span class=
"json-property-type">number
</span>
1316 <span class=
"json-property-range" title=
"Value limits"></span>
1319 <div class=
"prop-row prop-inner">
1320 <div class=
"prop-name param-label">in
</div>
1321 <div class=
"prop-value">query
</div>
1323 <div class=
"prop-row prop-group">
1324 <div class=
"prop-name">
1325 <div class=
"prop-title">stop
</div>
1327 <div class=
"prop-value">
1331 <div class=
"prop-row prop-inner">
1332 <div class=
"prop-name param-label">type
</div>
1333 <div class=
"prop-value">
1334 <span class=
"json-property-type">number
</span>
1335 <span class=
"json-property-range" title=
"Value limits"></span>
1338 <div class=
"prop-row prop-inner">
1339 <div class=
"prop-name param-label">in
</div>
1340 <div class=
"prop-value">query
</div>
1342 <div class=
"prop-row prop-group">
1343 <div class=
"prop-name">
1344 <div class=
"prop-title">sort
</div>
1346 <div class=
"prop-value">
1350 <div class=
"prop-row prop-inner">
1351 <div class=
"prop-name param-label">type
</div>
1352 <div class=
"prop-value">
1353 <span class=
"json-property-type">number
</span>
1354 <span class=
"json-property-range" title=
"Value limits"></span>
1357 <div class=
"prop-row prop-inner">
1358 <div class=
"prop-name param-label">in
</div>
1359 <div class=
"prop-value">query
</div>
1363 <div class=
"doc-examples"></div>
1365 <div class=
"doc-row">
1366 <div class=
"doc-copy">
1367 <section class=
"swagger-responses">
1368 <div class=
"prop-row prop-group">
1369 <div class=
"prop-name">
1370 <div class=
"prop-title">200 OK
</div>
1371 <div class=
"prop-ref">
1372 <span class=
"json-schema-ref-array">
1373 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1376 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1378 <div class=
"prop-value">
1379 <p>successful operation
</p>
1384 <div class=
"doc-examples">
1385 <h5>Response Content-Types:
1386 <span>application/json
</span>
1389 <h5>Response Example
1390 <span>(
200 OK)
</span>
1392 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1394 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1395 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1396 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1397 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1398 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1399 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1400 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1401 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1402 <span class=
"hljs-attr">"account
"</span>: {
1403 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1404 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1405 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1406 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1407 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1408 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1409 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1410 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1411 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1412 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1413 <span class=
"hljs-attr">"avatar
"</span>: {
1414 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1415 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1416 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1419 <span class=
"hljs-attr">"videoChannels
"</span>: [
1421 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1422 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1423 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1424 <span class=
"hljs-attr">"owner
"</span>: {
1425 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1426 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1428 <span class=
"hljs-attr">"videos
"</span>: [
1430 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1431 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1432 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1433 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1434 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1435 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
1436 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
1437 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
1438 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
1439 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
1440 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
1441 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1442 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
1443 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1444 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1445 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
1446 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1447 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1448 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1449 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
1450 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1451 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1452 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
1465 <div id=
"operation--users--id--delete" class=
"operation panel" data-traverse-target=
"operation--users--id--delete">
1466 <!-- <section class="operation-tags row"> -->
1467 <!-- <div class="doc-copy"> -->
1468 <div class=
"operation-tags">
1469 <a class=
"label" href=
"#tag-User">User
</a>
1474 <h2 class=
"operation-title">
1475 <span class=
"operation-name">
1476 <span class=
"operation-name">DELETE
</span>
1477 <span class=
"operation-path">/users/{id}
</span>
1480 <div class=
"doc-row">
1481 <div class=
"doc-copy">
1482 <section class=
"swagger-request-params">
1483 <div class=
"prop-row prop-group">
1484 <div class=
"prop-name">
1485 <div class=
"prop-title">id
</div>
1486 <span class=
"json-property-required"></span>
1488 <div class=
"prop-value">
1492 <div class=
"prop-row prop-inner">
1493 <div class=
"prop-name param-label">type
</div>
1494 <div class=
"prop-value">
1495 <span class=
"json-property-type">string
</span>
1496 <span class=
"json-property-range" title=
"Value limits"></span>
1499 <div class=
"prop-row prop-inner">
1500 <div class=
"prop-name param-label">in
</div>
1501 <div class=
"prop-value">path
</div>
1505 <div class=
"doc-examples"></div>
1507 <div class=
"doc-row">
1508 <div class=
"doc-copy">
1509 <section class=
"swagger-responses">
1510 <div class=
"prop-row prop-group">
1511 <div class=
"prop-name">
1512 <div class=
"prop-title">204 No Content
</div>
1514 <div class=
"prop-value">
1515 <p>successful operation
</p>
1520 <div class=
"doc-examples">
1521 <h5>Response Content-Types:
1522 <span>application/json
</span>
1527 <div id=
"operation--users--id--get" class=
"operation panel" data-traverse-target=
"operation--users--id--get">
1528 <!-- <section class="operation-tags row"> -->
1529 <!-- <div class="doc-copy"> -->
1530 <div class=
"operation-tags">
1531 <a class=
"label" href=
"#tag-User">User
</a>
1536 <h2 class=
"operation-title">
1537 <span class=
"operation-name">
1538 <span class=
"operation-name">GET
</span>
1539 <span class=
"operation-path">/users/{id}
</span>
1542 <div class=
"doc-row">
1543 <div class=
"doc-copy">
1544 <section class=
"swagger-request-params">
1545 <div class=
"prop-row prop-group">
1546 <div class=
"prop-name">
1547 <div class=
"prop-title">id
</div>
1548 <span class=
"json-property-required"></span>
1550 <div class=
"prop-value">
1554 <div class=
"prop-row prop-inner">
1555 <div class=
"prop-name param-label">type
</div>
1556 <div class=
"prop-value">
1557 <span class=
"json-property-type">string
</span>
1558 <span class=
"json-property-range" title=
"Value limits"></span>
1561 <div class=
"prop-row prop-inner">
1562 <div class=
"prop-name param-label">in
</div>
1563 <div class=
"prop-value">path
</div>
1567 <div class=
"doc-examples"></div>
1569 <div class=
"doc-row">
1570 <div class=
"doc-copy">
1571 <section class=
"swagger-responses">
1572 <div class=
"prop-row prop-group">
1573 <div class=
"prop-name">
1574 <div class=
"prop-title">200 OK
</div>
1575 <div class=
"prop-ref">
1577 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1580 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1582 <div class=
"prop-value">
1583 <p>successful operation
</p>
1588 <div class=
"doc-examples">
1589 <h5>Response Content-Types:
1590 <span>application/json
</span>
1593 <h5>Response Example
1594 <span>(
200 OK)
</span>
1596 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1597 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1598 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1599 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1600 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1601 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1602 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1603 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1604 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1605 <span class=
"hljs-attr">"account
"</span>: {
1606 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1607 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1608 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1609 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1610 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1611 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1612 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1613 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1614 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1615 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1616 <span class=
"hljs-attr">"avatar
"</span>: {
1617 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1618 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1619 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1622 <span class=
"hljs-attr">"videoChannels
"</span>: [
1624 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1625 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1626 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1627 <span class=
"hljs-attr">"owner
"</span>: {
1628 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1629 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1631 <span class=
"hljs-attr">"videos
"</span>: [
1633 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1634 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1635 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1636 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1637 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1638 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
1639 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
1640 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
1641 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
1642 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
1643 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
1644 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1645 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
1646 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1647 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1648 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
1649 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1650 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1651 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1652 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
1653 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1654 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1655 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
1667 <div id=
"operation--users--id--put" class=
"operation panel" data-traverse-target=
"operation--users--id--put">
1668 <!-- <section class="operation-tags row"> -->
1669 <!-- <div class="doc-copy"> -->
1670 <div class=
"operation-tags">
1671 <a class=
"label" href=
"#tag-User">User
</a>
1676 <h2 class=
"operation-title">
1677 <span class=
"operation-name">
1678 <span class=
"operation-name">PUT
</span>
1679 <span class=
"operation-path">/users/{id}
</span>
1682 <div class=
"doc-row">
1683 <div class=
"doc-copy">
1684 <section class=
"swagger-request-body">
1685 <div class=
"prop-row">
1686 <div class=
"prop-name">
1687 <div class=
"swagger-request-model">
1689 <a class=
"json-schema-ref" href=
"#/definitions/UpdateUser">UpdateUser
</a>
1693 <div class=
"prop-value columns small-6">
1694 <!-- <div class="swagger-request-description"> -->undefined
1699 <section class=
"swagger-request-params">
1700 <div class=
"prop-row prop-group">
1701 <div class=
"prop-name">
1702 <div class=
"prop-title">id
</div>
1703 <span class=
"json-property-required"></span>
1705 <div class=
"prop-value">
1709 <div class=
"prop-row prop-inner">
1710 <div class=
"prop-name param-label">type
</div>
1711 <div class=
"prop-value">
1712 <span class=
"json-property-type">string
</span>
1713 <span class=
"json-property-range" title=
"Value limits"></span>
1716 <div class=
"prop-row prop-inner">
1717 <div class=
"prop-name param-label">in
</div>
1718 <div class=
"prop-value">path
</div>
1722 <div class=
"doc-examples">
1724 <h5>Request Content-Types:
1725 <span>application/json
</span>
1727 <h5>Request Example
</h5>
1728 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1729 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
1730 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1731 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
1732 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
1739 <div class=
"doc-row">
1740 <div class=
"doc-copy">
1741 <section class=
"swagger-responses">
1742 <div class=
"prop-row prop-group">
1743 <div class=
"prop-name">
1744 <div class=
"prop-title">204 No Content
</div>
1746 <div class=
"prop-value">
1747 <p>successful operation
</p>
1752 <div class=
"doc-examples">
1753 <h5>Response Content-Types:
1754 <span>application/json
</span>
1759 <div id=
"operation--users-me-get" class=
"operation panel" data-traverse-target=
"operation--users-me-get">
1760 <!-- <section class="operation-tags row"> -->
1761 <!-- <div class="doc-copy"> -->
1762 <div class=
"operation-tags">
1763 <a class=
"label" href=
"#tag-User">User
</a>
1768 <h2 class=
"operation-title">
1769 <span class=
"operation-name">
1770 <span class=
"operation-name">GET
</span>
1771 <span class=
"operation-path">/users/me
</span>
1774 <div class=
"doc-row">
1775 <div class=
"doc-copy"> </div>
1776 <div class=
"doc-examples"></div>
1778 <div class=
"doc-row">
1779 <div class=
"doc-copy">
1780 <section class=
"swagger-responses">
1781 <div class=
"prop-row prop-group">
1782 <div class=
"prop-name">
1783 <div class=
"prop-title">200 OK
</div>
1784 <div class=
"prop-ref">
1785 <span class=
"json-schema-ref-array">
1786 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1789 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1791 <div class=
"prop-value">
1792 <p>successful operation
</p>
1797 <div class=
"doc-examples">
1798 <h5>Response Content-Types:
1799 <span>application/json
</span>
1802 <h5>Response Example
1803 <span>(
200 OK)
</span>
1805 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1807 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1808 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1809 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1810 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1811 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1812 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1813 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1814 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1815 <span class=
"hljs-attr">"account
"</span>: {
1816 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1817 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1818 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1819 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1820 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1821 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1822 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1823 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1824 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1825 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1826 <span class=
"hljs-attr">"avatar
"</span>: {
1827 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1828 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1829 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1832 <span class=
"hljs-attr">"videoChannels
"</span>: [
1834 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1835 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1836 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1837 <span class=
"hljs-attr">"owner
"</span>: {
1838 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1839 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1841 <span class=
"hljs-attr">"videos
"</span>: [
1843 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1844 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1845 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1846 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1847 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1848 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
1849 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
1850 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
1851 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
1852 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
1853 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
1854 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1855 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
1856 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1857 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1858 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
1859 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1860 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1861 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1862 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
1863 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1864 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1865 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
1878 <div id=
"operation--users-me-put" class=
"operation panel" data-traverse-target=
"operation--users-me-put">
1879 <!-- <section class="operation-tags row"> -->
1880 <!-- <div class="doc-copy"> -->
1881 <div class=
"operation-tags">
1882 <a class=
"label" href=
"#tag-User">User
</a>
1887 <h2 class=
"operation-title">
1888 <span class=
"operation-name">
1889 <span class=
"operation-name">PUT
</span>
1890 <span class=
"operation-path">/users/me
</span>
1893 <div class=
"doc-row">
1894 <div class=
"doc-copy">
1895 <section class=
"swagger-request-body">
1896 <div class=
"prop-row">
1897 <div class=
"prop-name">
1898 <div class=
"swagger-request-model">
1900 <a class=
"json-schema-ref" href=
"#/definitions/UpdateMe">UpdateMe
</a>
1904 <div class=
"prop-value columns small-6">
1905 <!-- <div class="swagger-request-description"> -->undefined
1911 <div class=
"doc-examples">
1913 <h5>Request Content-Types:
1914 <span>application/json
</span>
1916 <h5>Request Example
</h5>
1917 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1918 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
1919 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1920 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"string
"</span>,
1921 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"string
"</span>
1928 <div class=
"doc-row">
1929 <div class=
"doc-copy">
1930 <section class=
"swagger-responses">
1931 <div class=
"prop-row prop-group">
1932 <div class=
"prop-name">
1933 <div class=
"prop-title">204 No Content
</div>
1935 <div class=
"prop-value">
1936 <p>successful operation
</p>
1941 <div class=
"doc-examples">
1942 <h5>Response Content-Types:
1943 <span>application/json
</span>
1948 <div id=
"operation--users-me-video-quota-used-get" class=
"operation panel" data-traverse-target=
"operation--users-me-video-quota-used-get">
1949 <!-- <section class="operation-tags row"> -->
1950 <!-- <div class="doc-copy"> -->
1951 <div class=
"operation-tags">
1952 <a class=
"label" href=
"#tag-User">User
</a>
1957 <h2 class=
"operation-title">
1958 <span class=
"operation-name">
1959 <span class=
"operation-name">GET
</span>
1960 <span class=
"operation-path">/users/me/video-quota-used
</span>
1963 <div class=
"doc-row">
1964 <div class=
"doc-copy"> </div>
1965 <div class=
"doc-examples"></div>
1967 <div class=
"doc-row">
1968 <div class=
"doc-copy">
1969 <section class=
"swagger-responses">
1970 <div class=
"prop-row prop-group">
1971 <div class=
"prop-name">
1972 <div class=
"prop-title">200 OK
</div>
1973 <div class=
"prop-ref"></div>
1974 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1976 <div class=
"prop-value">
1977 <p>successful operation
</p>
1982 <div class=
"doc-examples">
1983 <h5>Response Content-Types:
1984 <span>application/json
</span>
1987 <h5>Response Example
1988 <span>(
200 OK)
</span>
1990 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json"><span class=
"hljs-string">"number
"</span>
1997 <div id=
"operation--users-me-videos--videoId--rating-get" class=
"operation panel" data-traverse-target=
"operation--users-me-videos--videoId--rating-get">
1998 <!-- <section class="operation-tags row"> -->
1999 <!-- <div class="doc-copy"> -->
2000 <div class=
"operation-tags">
2001 <a class=
"label" href=
"#tag-User">User
</a>
2006 <h2 class=
"operation-title">
2007 <span class=
"operation-name">
2008 <span class=
"operation-name">GET
</span>
2009 <span class=
"operation-path">/users/me/videos/{videoId}/rating
</span>
2012 <div class=
"doc-row">
2013 <div class=
"doc-copy">
2014 <section class=
"swagger-request-params">
2015 <div class=
"prop-row prop-group">
2016 <div class=
"prop-name">
2017 <div class=
"prop-title">videoId
</div>
2018 <span class=
"json-property-required"></span>
2020 <div class=
"prop-value">
2021 <p>The video id
</p>
2024 <div class=
"prop-row prop-inner">
2025 <div class=
"prop-name param-label">type
</div>
2026 <div class=
"prop-value">
2027 <span class=
"json-property-type">string
</span>
2028 <span class=
"json-property-range" title=
"Value limits"></span>
2031 <div class=
"prop-row prop-inner">
2032 <div class=
"prop-name param-label">in
</div>
2033 <div class=
"prop-value">path
</div>
2037 <div class=
"doc-examples"></div>
2039 <div class=
"doc-row">
2040 <div class=
"doc-copy">
2041 <section class=
"swagger-responses">
2042 <div class=
"prop-row prop-group">
2043 <div class=
"prop-name">
2044 <div class=
"prop-title">200 OK
</div>
2045 <div class=
"prop-ref">
2047 <a class=
"json-schema-ref" href=
"#/definitions/GetMeVideoRating">GetMeVideoRating
</a>
2050 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2052 <div class=
"prop-value">
2053 <p>successful operation
</p>
2058 <div class=
"doc-examples">
2059 <h5>Response Content-Types:
2060 <span>application/json
</span>
2063 <h5>Response Example
2064 <span>(
200 OK)
</span>
2066 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2067 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2068 <span class=
"hljs-attr">"rating
"</span>:
<span class=
"hljs-string">"number
"</span>
2076 <div id=
"operation--users-me-videos-get" class=
"operation panel" data-traverse-target=
"operation--users-me-videos-get">
2077 <!-- <section class="operation-tags row"> -->
2078 <!-- <div class="doc-copy"> -->
2079 <div class=
"operation-tags">
2080 <a class=
"label" href=
"#tag-User">User
</a>
2085 <h2 class=
"operation-title">
2086 <span class=
"operation-name">
2087 <span class=
"operation-name">GET
</span>
2088 <span class=
"operation-path">/users/me/videos
</span>
2091 <div class=
"doc-row">
2092 <div class=
"doc-copy">
2093 <section class=
"swagger-request-params">
2094 <div class=
"prop-row prop-group">
2095 <div class=
"prop-name">
2096 <div class=
"prop-title">start
</div>
2098 <div class=
"prop-value">
2099 <p>starting page
</p>
2102 <div class=
"prop-row prop-inner">
2103 <div class=
"prop-name param-label">type
</div>
2104 <div class=
"prop-value">
2105 <span class=
"json-property-type">number
</span>
2106 <span class=
"json-property-range" title=
"Value limits"></span>
2109 <div class=
"prop-row prop-inner">
2110 <div class=
"prop-name param-label">in
</div>
2111 <div class=
"prop-value">query
</div>
2113 <div class=
"prop-row prop-group">
2114 <div class=
"prop-name">
2115 <div class=
"prop-title">stop
</div>
2117 <div class=
"prop-value">
2121 <div class=
"prop-row prop-inner">
2122 <div class=
"prop-name param-label">type
</div>
2123 <div class=
"prop-value">
2124 <span class=
"json-property-type">number
</span>
2125 <span class=
"json-property-range" title=
"Value limits"></span>
2128 <div class=
"prop-row prop-inner">
2129 <div class=
"prop-name param-label">in
</div>
2130 <div class=
"prop-value">query
</div>
2132 <div class=
"prop-row prop-group">
2133 <div class=
"prop-name">
2134 <div class=
"prop-title">sort
</div>
2136 <div class=
"prop-value">
2140 <div class=
"prop-row prop-inner">
2141 <div class=
"prop-name param-label">type
</div>
2142 <div class=
"prop-value">
2143 <span class=
"json-property-type">number
</span>
2144 <span class=
"json-property-range" title=
"Value limits"></span>
2147 <div class=
"prop-row prop-inner">
2148 <div class=
"prop-name param-label">in
</div>
2149 <div class=
"prop-value">query
</div>
2153 <div class=
"doc-examples"></div>
2155 <div class=
"doc-row">
2156 <div class=
"doc-copy">
2157 <section class=
"swagger-responses">
2158 <div class=
"prop-row prop-group">
2159 <div class=
"prop-name">
2160 <div class=
"prop-title">200 OK
</div>
2161 <div class=
"prop-ref">
2162 <span class=
"json-schema-ref-array">
2163 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2166 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2168 <div class=
"prop-value">
2169 <p>successful operation
</p>
2174 <div class=
"doc-examples">
2175 <h5>Response Content-Types:
2176 <span>application/json
</span>
2179 <h5>Response Example
2180 <span>(
200 OK)
</span>
2182 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2184 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2185 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2186 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2187 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2188 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2189 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
2190 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
2191 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
2192 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
2193 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
2194 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
2195 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2196 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2197 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2198 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2199 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
2200 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2201 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2202 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2203 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2204 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2205 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2206 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
2215 <div id=
"operation--users-register-post" class=
"operation panel" data-traverse-target=
"operation--users-register-post">
2216 <!-- <section class="operation-tags row"> -->
2217 <!-- <div class="doc-copy"> -->
2218 <div class=
"operation-tags">
2219 <a class=
"label" href=
"#tag-User">User
</a>
2224 <h2 class=
"operation-title">
2225 <span class=
"operation-name">
2226 <span class=
"operation-name">POST
</span>
2227 <span class=
"operation-path">/users/register
</span>
2230 <div class=
"doc-row">
2231 <div class=
"doc-copy">
2232 <section class=
"swagger-request-body">
2233 <div class=
"prop-row">
2234 <div class=
"prop-name">
2235 <div class=
"swagger-request-model">
2237 <a class=
"json-schema-ref" href=
"#/definitions/RegisterUser">RegisterUser
</a>
2241 <div class=
"prop-value columns small-6">
2242 <!-- <div class="swagger-request-description"> -->undefined
2248 <div class=
"doc-examples">
2250 <h5>Request Content-Types:
2251 <span>application/json
</span>
2253 <h5>Request Example
</h5>
2254 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2255 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
2256 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
2257 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>
2264 <div class=
"doc-row">
2265 <div class=
"doc-copy">
2266 <section class=
"swagger-responses">
2267 <div class=
"prop-row prop-group">
2268 <div class=
"prop-name">
2269 <div class=
"prop-title">204 No Content
</div>
2271 <div class=
"prop-value">
2272 <p>successful operation
</p>
2277 <div class=
"doc-examples">
2278 <h5>Response Content-Types:
2279 <span>application/json
</span>
2284 <div id=
"operation--users-me-avatar-pick-post" class=
"operation panel" data-traverse-target=
"operation--users-me-avatar-pick-post">
2285 <!-- <section class="operation-tags row"> -->
2286 <!-- <div class="doc-copy"> -->
2287 <div class=
"operation-tags">
2288 <a class=
"label" href=
"#tag-User">User
</a>
2293 <h2 class=
"operation-title">
2294 <span class=
"operation-name">
2295 <span class=
"operation-name">POST
</span>
2296 <span class=
"operation-path">/users/me/avatar/pick
</span>
2299 <div class=
"doc-row">
2300 <div class=
"doc-copy">
2301 <section class=
"swagger-request-params">
2302 <div class=
"prop-row prop-group">
2303 <div class=
"prop-name">
2304 <div class=
"prop-title">avatarfile
</div>
2306 <div class=
"prop-value">
2307 <p>The file to upload.
</p>
2310 <div class=
"prop-row prop-inner">
2311 <div class=
"prop-name param-label">type
</div>
2312 <div class=
"prop-value">
2313 <span class=
"json-property-type">file
</span>
2314 <span class=
"json-property-range" title=
"Value limits"></span>
2317 <div class=
"prop-row prop-inner">
2318 <div class=
"prop-name param-label">in
</div>
2319 <div class=
"prop-value">formData
</div>
2323 <div class=
"doc-examples"></div>
2325 <div class=
"doc-row">
2326 <div class=
"doc-copy">
2327 <section class=
"swagger-responses">
2328 <div class=
"prop-row prop-group">
2329 <div class=
"prop-name">
2330 <div class=
"prop-title">200 OK
</div>
2331 <div class=
"prop-ref">
2333 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
2336 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2338 <div class=
"prop-value">
2339 <p>successful operation
</p>
2344 <div class=
"doc-examples">
2345 <h5>Response Content-Types:
2346 <span>application/json
</span>
2349 <h5>Response Example
2350 <span>(
200 OK)
</span>
2352 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2353 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2354 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2355 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2363 <h1 id=
"tag-Video" class=
"swagger-summary-tag" data-traverse-target=
"tag-Video">Video
</h1>
2364 <div id=
"operation--videos-get" class=
"operation panel" data-traverse-target=
"operation--videos-get">
2365 <!-- <section class="operation-tags row"> -->
2366 <!-- <div class="doc-copy"> -->
2367 <div class=
"operation-tags">
2368 <a class=
"label" href=
"#tag-Video">Video
</a>
2373 <h2 class=
"operation-title">
2374 <span class=
"operation-name">
2375 <span class=
"operation-name">GET
</span>
2376 <span class=
"operation-path">/videos
</span>
2379 <div class=
"doc-row">
2380 <div class=
"doc-copy">
2381 <section class=
"swagger-request-params">
2382 <div class=
"prop-row prop-group">
2383 <div class=
"prop-name">
2384 <div class=
"prop-title">start
</div>
2386 <div class=
"prop-value">
2387 <p>starting page
</p>
2390 <div class=
"prop-row prop-inner">
2391 <div class=
"prop-name param-label">type
</div>
2392 <div class=
"prop-value">
2393 <span class=
"json-property-type">number
</span>
2394 <span class=
"json-property-range" title=
"Value limits"></span>
2397 <div class=
"prop-row prop-inner">
2398 <div class=
"prop-name param-label">in
</div>
2399 <div class=
"prop-value">query
</div>
2401 <div class=
"prop-row prop-group">
2402 <div class=
"prop-name">
2403 <div class=
"prop-title">stop
</div>
2405 <div class=
"prop-value">
2409 <div class=
"prop-row prop-inner">
2410 <div class=
"prop-name param-label">type
</div>
2411 <div class=
"prop-value">
2412 <span class=
"json-property-type">number
</span>
2413 <span class=
"json-property-range" title=
"Value limits"></span>
2416 <div class=
"prop-row prop-inner">
2417 <div class=
"prop-name param-label">in
</div>
2418 <div class=
"prop-value">query
</div>
2420 <div class=
"prop-row prop-group">
2421 <div class=
"prop-name">
2422 <div class=
"prop-title">sort
</div>
2424 <div class=
"prop-value">
2428 <div class=
"prop-row prop-inner">
2429 <div class=
"prop-name param-label">type
</div>
2430 <div class=
"prop-value">
2431 <span class=
"json-property-type">number
</span>
2432 <span class=
"json-property-range" title=
"Value limits"></span>
2435 <div class=
"prop-row prop-inner">
2436 <div class=
"prop-name param-label">in
</div>
2437 <div class=
"prop-value">query
</div>
2441 <div class=
"doc-examples"></div>
2443 <div class=
"doc-row">
2444 <div class=
"doc-copy">
2445 <section class=
"swagger-responses">
2446 <div class=
"prop-row prop-group">
2447 <div class=
"prop-name">
2448 <div class=
"prop-title">200 OK
</div>
2449 <div class=
"prop-ref">
2450 <span class=
"json-schema-ref-array">
2451 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2454 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2456 <div class=
"prop-value">
2457 <p>successful operation
</p>
2462 <div class=
"doc-examples">
2463 <h5>Response Content-Types:
2464 <span>application/json
</span>
2467 <h5>Response Example
2468 <span>(
200 OK)
</span>
2470 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2472 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2473 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2474 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2475 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2476 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2477 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
2478 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
2479 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
2480 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
2481 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
2482 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
2483 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2484 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2485 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2486 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2487 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
2488 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2489 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2490 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2491 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2492 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2493 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2494 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
2503 <div id=
"operation--videos-categories-get" class=
"operation panel" data-traverse-target=
"operation--videos-categories-get">
2504 <!-- <section class="operation-tags row"> -->
2505 <!-- <div class="doc-copy"> -->
2506 <div class=
"operation-tags">
2507 <a class=
"label" href=
"#tag-Video">Video
</a>
2512 <h2 class=
"operation-title">
2513 <span class=
"operation-name">
2514 <span class=
"operation-name">GET
</span>
2515 <span class=
"operation-path">/videos/categories
</span>
2518 <div class=
"doc-row">
2519 <div class=
"doc-copy"> </div>
2520 <div class=
"doc-examples"></div>
2522 <div class=
"doc-row">
2523 <div class=
"doc-copy">
2524 <section class=
"swagger-responses">
2525 <div class=
"prop-row prop-group">
2526 <div class=
"prop-name">
2527 <div class=
"prop-title">200 OK
</div>
2528 <div class=
"prop-ref"></div>
2529 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2531 <div class=
"prop-value">
2532 <p>successful operation
</p>
2537 <div class=
"doc-examples">
2538 <h5>Response Content-Types:
2539 <span>application/json
</span>
2542 <h5>Response Example
2543 <span>(
200 OK)
</span>
2545 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2546 <span class=
"hljs-string">"string
"</span>
2554 <div id=
"operation--videos-licences-get" class=
"operation panel" data-traverse-target=
"operation--videos-licences-get">
2555 <!-- <section class="operation-tags row"> -->
2556 <!-- <div class="doc-copy"> -->
2557 <div class=
"operation-tags">
2558 <a class=
"label" href=
"#tag-Video">Video
</a>
2563 <h2 class=
"operation-title">
2564 <span class=
"operation-name">
2565 <span class=
"operation-name">GET
</span>
2566 <span class=
"operation-path">/videos/licences
</span>
2569 <div class=
"doc-row">
2570 <div class=
"doc-copy"> </div>
2571 <div class=
"doc-examples"></div>
2573 <div class=
"doc-row">
2574 <div class=
"doc-copy">
2575 <section class=
"swagger-responses">
2576 <div class=
"prop-row prop-group">
2577 <div class=
"prop-name">
2578 <div class=
"prop-title">200 OK
</div>
2579 <div class=
"prop-ref"></div>
2580 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2582 <div class=
"prop-value">
2583 <p>successful operation
</p>
2588 <div class=
"doc-examples">
2589 <h5>Response Content-Types:
2590 <span>application/json
</span>
2593 <h5>Response Example
2594 <span>(
200 OK)
</span>
2596 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2597 <span class=
"hljs-string">"string
"</span>
2605 <div id=
"operation--videos-languages-get" class=
"operation panel" data-traverse-target=
"operation--videos-languages-get">
2606 <!-- <section class="operation-tags row"> -->
2607 <!-- <div class="doc-copy"> -->
2608 <div class=
"operation-tags">
2609 <a class=
"label" href=
"#tag-Video">Video
</a>
2614 <h2 class=
"operation-title">
2615 <span class=
"operation-name">
2616 <span class=
"operation-name">GET
</span>
2617 <span class=
"operation-path">/videos/languages
</span>
2620 <div class=
"doc-row">
2621 <div class=
"doc-copy"> </div>
2622 <div class=
"doc-examples"></div>
2624 <div class=
"doc-row">
2625 <div class=
"doc-copy">
2626 <section class=
"swagger-responses">
2627 <div class=
"prop-row prop-group">
2628 <div class=
"prop-name">
2629 <div class=
"prop-title">200 OK
</div>
2630 <div class=
"prop-ref"></div>
2631 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2633 <div class=
"prop-value">
2634 <p>successful operation
</p>
2639 <div class=
"doc-examples">
2640 <h5>Response Content-Types:
2641 <span>application/json
</span>
2644 <h5>Response Example
2645 <span>(
200 OK)
</span>
2647 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2648 <span class=
"hljs-string">"string
"</span>
2656 <div id=
"operation--videos-privacies-get" class=
"operation panel" data-traverse-target=
"operation--videos-privacies-get">
2657 <!-- <section class="operation-tags row"> -->
2658 <!-- <div class="doc-copy"> -->
2659 <div class=
"operation-tags">
2660 <a class=
"label" href=
"#tag-Video">Video
</a>
2665 <h2 class=
"operation-title">
2666 <span class=
"operation-name">
2667 <span class=
"operation-name">GET
</span>
2668 <span class=
"operation-path">/videos/privacies
</span>
2671 <div class=
"doc-row">
2672 <div class=
"doc-copy"> </div>
2673 <div class=
"doc-examples"></div>
2675 <div class=
"doc-row">
2676 <div class=
"doc-copy">
2677 <section class=
"swagger-responses">
2678 <div class=
"prop-row prop-group">
2679 <div class=
"prop-name">
2680 <div class=
"prop-title">200 OK
</div>
2681 <div class=
"prop-ref"></div>
2682 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2684 <div class=
"prop-value">
2685 <p>successful operation
</p>
2690 <div class=
"doc-examples">
2691 <h5>Response Content-Types:
2692 <span>application/json
</span>
2695 <h5>Response Example
2696 <span>(
200 OK)
</span>
2698 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2699 <span class=
"hljs-string">"string
"</span>
2707 <div id=
"operation--videos-search-get" class=
"operation panel" data-traverse-target=
"operation--videos-search-get">
2708 <!-- <section class="operation-tags row"> -->
2709 <!-- <div class="doc-copy"> -->
2710 <div class=
"operation-tags">
2711 <a class=
"label" href=
"#tag-Video">Video
</a>
2716 <h2 class=
"operation-title">
2717 <span class=
"operation-name">
2718 <span class=
"operation-name">GET
</span>
2719 <span class=
"operation-path">/videos/search
</span>
2722 <div class=
"doc-row">
2723 <div class=
"doc-copy">
2724 <section class=
"swagger-request-params">
2725 <div class=
"prop-row prop-group">
2726 <div class=
"prop-name">
2727 <div class=
"prop-title">start
</div>
2729 <div class=
"prop-value">
2730 <p>starting page
</p>
2733 <div class=
"prop-row prop-inner">
2734 <div class=
"prop-name param-label">type
</div>
2735 <div class=
"prop-value">
2736 <span class=
"json-property-type">number
</span>
2737 <span class=
"json-property-range" title=
"Value limits"></span>
2740 <div class=
"prop-row prop-inner">
2741 <div class=
"prop-name param-label">in
</div>
2742 <div class=
"prop-value">query
</div>
2744 <div class=
"prop-row prop-group">
2745 <div class=
"prop-name">
2746 <div class=
"prop-title">stop
</div>
2748 <div class=
"prop-value">
2752 <div class=
"prop-row prop-inner">
2753 <div class=
"prop-name param-label">type
</div>
2754 <div class=
"prop-value">
2755 <span class=
"json-property-type">number
</span>
2756 <span class=
"json-property-range" title=
"Value limits"></span>
2759 <div class=
"prop-row prop-inner">
2760 <div class=
"prop-name param-label">in
</div>
2761 <div class=
"prop-value">query
</div>
2763 <div class=
"prop-row prop-group">
2764 <div class=
"prop-name">
2765 <div class=
"prop-title">sort
</div>
2767 <div class=
"prop-value">
2771 <div class=
"prop-row prop-inner">
2772 <div class=
"prop-name param-label">type
</div>
2773 <div class=
"prop-value">
2774 <span class=
"json-property-type">number
</span>
2775 <span class=
"json-property-range" title=
"Value limits"></span>
2778 <div class=
"prop-row prop-inner">
2779 <div class=
"prop-name param-label">in
</div>
2780 <div class=
"prop-value">query
</div>
2784 <div class=
"doc-examples"></div>
2786 <div class=
"doc-row">
2787 <div class=
"doc-copy">
2788 <section class=
"swagger-responses">
2789 <div class=
"prop-row prop-group">
2790 <div class=
"prop-name">
2791 <div class=
"prop-title">200 OK
</div>
2792 <div class=
"prop-ref">
2793 <span class=
"json-schema-ref-array">
2794 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2797 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2799 <div class=
"prop-value">
2800 <p>successful operation
</p>
2805 <div class=
"doc-examples">
2806 <h5>Response Content-Types:
2807 <span>application/json
</span>
2810 <h5>Response Example
2811 <span>(
200 OK)
</span>
2813 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2815 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2816 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2817 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2818 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2819 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2820 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
2821 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
2822 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
2823 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
2824 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
2825 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
2826 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2827 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2828 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2829 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2830 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
2831 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2832 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2833 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2834 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2835 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2836 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2837 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
2846 <div id=
"operation--videos--id--put" class=
"operation panel" data-traverse-target=
"operation--videos--id--put">
2847 <!-- <section class="operation-tags row"> -->
2848 <!-- <div class="doc-copy"> -->
2849 <div class=
"operation-tags">
2850 <a class=
"label" href=
"#tag-Video">Video
</a>
2855 <h2 class=
"operation-title">
2856 <span class=
"operation-name">
2857 <span class=
"operation-name">PUT
</span>
2858 <span class=
"operation-path">/videos/{id}
</span>
2861 <div class=
"doc-row">
2862 <div class=
"doc-copy">
2863 <section class=
"swagger-request-params">
2864 <div class=
"prop-row prop-group">
2865 <div class=
"prop-name">
2866 <div class=
"prop-title">id
</div>
2867 <span class=
"json-property-required"></span>
2869 <div class=
"prop-value">
2870 <p>The video id
</p>
2873 <div class=
"prop-row prop-inner">
2874 <div class=
"prop-name param-label">type
</div>
2875 <div class=
"prop-value">
2876 <span class=
"json-property-type">string
</span>
2877 <span class=
"json-property-range" title=
"Value limits"></span>
2880 <div class=
"prop-row prop-inner">
2881 <div class=
"prop-name param-label">in
</div>
2882 <div class=
"prop-value">path
</div>
2886 <div class=
"doc-examples"></div>
2888 <div class=
"doc-row">
2889 <div class=
"doc-copy">
2890 <section class=
"swagger-responses">
2891 <div class=
"prop-row prop-group">
2892 <div class=
"prop-name">
2893 <div class=
"prop-title">200 OK
</div>
2894 <div class=
"prop-ref">
2896 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2899 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2901 <div class=
"prop-value">
2902 <p>successful operation
</p>
2907 <div class=
"doc-examples">
2908 <h5>Response Content-Types:
2909 <span>application/json
</span>
2912 <h5>Response Example
2913 <span>(
200 OK)
</span>
2915 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2916 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2917 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2918 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2919 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2920 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2921 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
2922 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
2923 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
2924 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
2925 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
2926 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
2927 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2928 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2929 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2930 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2931 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
2932 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2933 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2934 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2935 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2936 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2937 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2938 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
2946 <div id=
"operation--videos--id--get" class=
"operation panel" data-traverse-target=
"operation--videos--id--get">
2947 <!-- <section class="operation-tags row"> -->
2948 <!-- <div class="doc-copy"> -->
2949 <div class=
"operation-tags">
2950 <a class=
"label" href=
"#tag-Video">Video
</a>
2955 <h2 class=
"operation-title">
2956 <span class=
"operation-name">
2957 <span class=
"operation-name">GET
</span>
2958 <span class=
"operation-path">/videos/{id}
</span>
2961 <div class=
"doc-row">
2962 <div class=
"doc-copy">
2963 <section class=
"swagger-request-params">
2964 <div class=
"prop-row prop-group">
2965 <div class=
"prop-name">
2966 <div class=
"prop-title">id
</div>
2967 <span class=
"json-property-required"></span>
2969 <div class=
"prop-value">
2970 <p>The video id
</p>
2973 <div class=
"prop-row prop-inner">
2974 <div class=
"prop-name param-label">type
</div>
2975 <div class=
"prop-value">
2976 <span class=
"json-property-type">string
</span>
2977 <span class=
"json-property-range" title=
"Value limits"></span>
2980 <div class=
"prop-row prop-inner">
2981 <div class=
"prop-name param-label">in
</div>
2982 <div class=
"prop-value">path
</div>
2986 <div class=
"doc-examples"></div>
2988 <div class=
"doc-row">
2989 <div class=
"doc-copy">
2990 <section class=
"swagger-responses">
2991 <div class=
"prop-row prop-group">
2992 <div class=
"prop-name">
2993 <div class=
"prop-title">200 OK
</div>
2994 <div class=
"prop-ref">
2996 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2999 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3001 <div class=
"prop-value">
3002 <p>successful operation
</p>
3007 <div class=
"doc-examples">
3008 <h5>Response Content-Types:
3009 <span>application/json
</span>
3012 <h5>Response Example
3013 <span>(
200 OK)
</span>
3015 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3016 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3017 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3018 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3019 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3020 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3021 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
3022 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
3023 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
3024 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
3025 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
3026 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
3027 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3028 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3029 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3030 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3031 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
3032 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3033 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3034 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3035 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3036 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3037 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3038 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
3046 <div id=
"operation--videos--id--delete" class=
"operation panel" data-traverse-target=
"operation--videos--id--delete">
3047 <!-- <section class="operation-tags row"> -->
3048 <!-- <div class="doc-copy"> -->
3049 <div class=
"operation-tags">
3050 <a class=
"label" href=
"#tag-Video">Video
</a>
3055 <h2 class=
"operation-title">
3056 <span class=
"operation-name">
3057 <span class=
"operation-name">DELETE
</span>
3058 <span class=
"operation-path">/videos/{id}
</span>
3061 <div class=
"doc-row">
3062 <div class=
"doc-copy">
3063 <section class=
"swagger-request-params">
3064 <div class=
"prop-row prop-group">
3065 <div class=
"prop-name">
3066 <div class=
"prop-title">id
</div>
3067 <span class=
"json-property-required"></span>
3069 <div class=
"prop-value">
3070 <p>The video id
</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">string
</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">path
</div>
3086 <div class=
"doc-examples"></div>
3088 <div class=
"doc-row">
3089 <div class=
"doc-copy">
3090 <section class=
"swagger-responses">
3091 <div class=
"prop-row prop-group">
3092 <div class=
"prop-name">
3093 <div class=
"prop-title">204 No Content
</div>
3095 <div class=
"prop-value">
3096 <p>successful operation
</p>
3101 <div class=
"doc-examples">
3102 <h5>Response Content-Types:
3103 <span>application/json
</span>
3108 <div id=
"operation--videos--id--description-get" class=
"operation panel" data-traverse-target=
"operation--videos--id--description-get">
3109 <!-- <section class="operation-tags row"> -->
3110 <!-- <div class="doc-copy"> -->
3111 <div class=
"operation-tags">
3112 <a class=
"label" href=
"#tag-Video">Video
</a>
3117 <h2 class=
"operation-title">
3118 <span class=
"operation-name">
3119 <span class=
"operation-name">GET
</span>
3120 <span class=
"operation-path">/videos/{id}/description
</span>
3123 <div class=
"doc-row">
3124 <div class=
"doc-copy">
3125 <section class=
"swagger-request-params">
3126 <div class=
"prop-row prop-group">
3127 <div class=
"prop-name">
3128 <div class=
"prop-title">id
</div>
3129 <span class=
"json-property-required"></span>
3131 <div class=
"prop-value">
3132 <p>The video id
</p>
3135 <div class=
"prop-row prop-inner">
3136 <div class=
"prop-name param-label">type
</div>
3137 <div class=
"prop-value">
3138 <span class=
"json-property-type">string
</span>
3139 <span class=
"json-property-range" title=
"Value limits"></span>
3142 <div class=
"prop-row prop-inner">
3143 <div class=
"prop-name param-label">in
</div>
3144 <div class=
"prop-value">path
</div>
3148 <div class=
"doc-examples"></div>
3150 <div class=
"doc-row">
3151 <div class=
"doc-copy">
3152 <section class=
"swagger-responses">
3153 <div class=
"prop-row prop-group">
3154 <div class=
"prop-name">
3155 <div class=
"prop-title">200 OK
</div>
3156 <div class=
"prop-ref"></div>
3157 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3159 <div class=
"prop-value">
3160 <p>successful operation
</p>
3165 <div class=
"doc-examples">
3166 <h5>Response Content-Types:
3167 <span>application/json
</span>
3170 <h5>Response Example
3171 <span>(
200 OK)
</span>
3173 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json"><span class=
"hljs-string">"string
"</span>
3180 <div id=
"operation--videos--id--views-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--views-post">
3181 <!-- <section class="operation-tags row"> -->
3182 <!-- <div class="doc-copy"> -->
3183 <div class=
"operation-tags">
3184 <a class=
"label" href=
"#tag-Video">Video
</a>
3189 <h2 class=
"operation-title">
3190 <span class=
"operation-name">
3191 <span class=
"operation-name">POST
</span>
3192 <span class=
"operation-path">/videos/{id}/views
</span>
3195 <div class=
"doc-row">
3196 <div class=
"doc-copy">
3197 <section class=
"swagger-request-params">
3198 <div class=
"prop-row prop-group">
3199 <div class=
"prop-name">
3200 <div class=
"prop-title">id
</div>
3201 <span class=
"json-property-required"></span>
3203 <div class=
"prop-value">
3204 <p>The video id
</p>
3207 <div class=
"prop-row prop-inner">
3208 <div class=
"prop-name param-label">type
</div>
3209 <div class=
"prop-value">
3210 <span class=
"json-property-type">string
</span>
3211 <span class=
"json-property-range" title=
"Value limits"></span>
3214 <div class=
"prop-row prop-inner">
3215 <div class=
"prop-name param-label">in
</div>
3216 <div class=
"prop-value">path
</div>
3220 <div class=
"doc-examples"></div>
3222 <div class=
"doc-row">
3223 <div class=
"doc-copy">
3224 <section class=
"swagger-responses">
3225 <div class=
"prop-row prop-group">
3226 <div class=
"prop-name">
3227 <div class=
"prop-title">204 No Content
</div>
3229 <div class=
"prop-value">
3230 <p>successful operation
</p>
3235 <div class=
"doc-examples">
3236 <h5>Response Content-Types:
3237 <span>application/json
</span>
3242 <div id=
"operation--videos-upload-post" class=
"operation panel" data-traverse-target=
"operation--videos-upload-post">
3243 <!-- <section class="operation-tags row"> -->
3244 <!-- <div class="doc-copy"> -->
3245 <div class=
"operation-tags">
3246 <a class=
"label" href=
"#tag-Video">Video
</a>
3251 <h2 class=
"operation-title">
3252 <span class=
"operation-name">
3253 <span class=
"operation-name">POST
</span>
3254 <span class=
"operation-path">/videos/upload
</span>
3257 <div class=
"doc-row">
3258 <div class=
"doc-copy">
3259 <section class=
"swagger-request-params">
3260 <div class=
"prop-row prop-group">
3261 <div class=
"prop-name">
3262 <div class=
"prop-title">videofile
</div>
3264 <div class=
"prop-value">
3265 <p>The file to upload.
</p>
3268 <div class=
"prop-row prop-inner">
3269 <div class=
"prop-name param-label">type
</div>
3270 <div class=
"prop-value">
3271 <span class=
"json-property-type">file
</span>
3272 <span class=
"json-property-range" title=
"Value limits"></span>
3275 <div class=
"prop-row prop-inner">
3276 <div class=
"prop-name param-label">in
</div>
3277 <div class=
"prop-value">formData
</div>
3281 <div class=
"doc-examples"></div>
3283 <div class=
"doc-row">
3284 <div class=
"doc-copy">
3285 <section class=
"swagger-responses">
3286 <div class=
"prop-row prop-group">
3287 <div class=
"prop-name">
3288 <div class=
"prop-title">200 OK
</div>
3289 <div class=
"prop-ref">
3291 <a class=
"json-schema-ref" href=
"#/definitions/VideoUploadResponse">VideoUploadResponse
</a>
3294 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3296 <div class=
"prop-value">
3297 <p>successful operation
</p>
3302 <div class=
"doc-examples">
3303 <h5>Response Content-Types:
3304 <span>application/json
</span>
3307 <h5>Response Example
3308 <span>(
200 OK)
</span>
3310 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3311 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3312 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
3320 <h1 id=
"tag-VideoAbuse" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoAbuse">VideoAbuse
</h1>
3321 <div id=
"operation--videos-abuse-get" class=
"operation panel" data-traverse-target=
"operation--videos-abuse-get">
3322 <!-- <section class="operation-tags row"> -->
3323 <!-- <div class="doc-copy"> -->
3324 <div class=
"operation-tags">
3325 <a class=
"label" href=
"#tag-VideoAbuse">VideoAbuse
</a>
3330 <h2 class=
"operation-title">
3331 <span class=
"operation-name">
3332 <span class=
"operation-name">GET
</span>
3333 <span class=
"operation-path">/videos/abuse
</span>
3336 <div class=
"doc-row">
3337 <div class=
"doc-copy">
3338 <section class=
"swagger-request-params">
3339 <div class=
"prop-row prop-group">
3340 <div class=
"prop-name">
3341 <div class=
"prop-title">start
</div>
3343 <div class=
"prop-value">
3344 <p>starting page
</p>
3347 <div class=
"prop-row prop-inner">
3348 <div class=
"prop-name param-label">type
</div>
3349 <div class=
"prop-value">
3350 <span class=
"json-property-type">number
</span>
3351 <span class=
"json-property-range" title=
"Value limits"></span>
3354 <div class=
"prop-row prop-inner">
3355 <div class=
"prop-name param-label">in
</div>
3356 <div class=
"prop-value">query
</div>
3358 <div class=
"prop-row prop-group">
3359 <div class=
"prop-name">
3360 <div class=
"prop-title">stop
</div>
3362 <div class=
"prop-value">
3366 <div class=
"prop-row prop-inner">
3367 <div class=
"prop-name param-label">type
</div>
3368 <div class=
"prop-value">
3369 <span class=
"json-property-type">number
</span>
3370 <span class=
"json-property-range" title=
"Value limits"></span>
3373 <div class=
"prop-row prop-inner">
3374 <div class=
"prop-name param-label">in
</div>
3375 <div class=
"prop-value">query
</div>
3377 <div class=
"prop-row prop-group">
3378 <div class=
"prop-name">
3379 <div class=
"prop-title">sort
</div>
3381 <div class=
"prop-value">
3385 <div class=
"prop-row prop-inner">
3386 <div class=
"prop-name param-label">type
</div>
3387 <div class=
"prop-value">
3388 <span class=
"json-property-type">number
</span>
3389 <span class=
"json-property-range" title=
"Value limits"></span>
3392 <div class=
"prop-row prop-inner">
3393 <div class=
"prop-name param-label">in
</div>
3394 <div class=
"prop-value">query
</div>
3398 <div class=
"doc-examples"></div>
3400 <div class=
"doc-row">
3401 <div class=
"doc-copy">
3402 <section class=
"swagger-responses">
3403 <div class=
"prop-row prop-group">
3404 <div class=
"prop-name">
3405 <div class=
"prop-title">200 OK
</div>
3406 <div class=
"prop-ref">
3407 <span class=
"json-schema-ref-array">
3408 <a class=
"json-schema-ref" href=
"#/definitions/VideoAbuse">VideoAbuse
</a>
3411 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3413 <div class=
"prop-value">
3414 <p>successful operation
</p>
3419 <div class=
"doc-examples">
3420 <h5>Response Content-Types:
3421 <span>application/json
</span>
3424 <h5>Response Example
3425 <span>(
200 OK)
</span>
3427 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3429 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3430 <span class=
"hljs-attr">"reason
"</span>:
<span class=
"hljs-string">"string
"</span>,
3431 <span class=
"hljs-attr">"reporterUsername
"</span>:
<span class=
"hljs-string">"string
"</span>,
3432 <span class=
"hljs-attr">"reporterServerHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
3433 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
3434 <span class=
"hljs-attr">"videoUUID
"</span>:
<span class=
"hljs-string">"string
"</span>,
3435 <span class=
"hljs-attr">"videoName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3436 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3445 <div id=
"operation--videos--id--abuse-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--abuse-post">
3446 <!-- <section class="operation-tags row"> -->
3447 <!-- <div class="doc-copy"> -->
3448 <div class=
"operation-tags">
3449 <a class=
"label" href=
"#tag-VideoAbuse">VideoAbuse
</a>
3454 <h2 class=
"operation-title">
3455 <span class=
"operation-name">
3456 <span class=
"operation-name">POST
</span>
3457 <span class=
"operation-path">/videos/{id}/abuse
</span>
3460 <div class=
"doc-row">
3461 <div class=
"doc-copy">
3462 <section class=
"swagger-request-params">
3463 <div class=
"prop-row prop-group">
3464 <div class=
"prop-name">
3465 <div class=
"prop-title">id
</div>
3466 <span class=
"json-property-required"></span>
3468 <div class=
"prop-value">
3469 <p>The video id
</p>
3472 <div class=
"prop-row prop-inner">
3473 <div class=
"prop-name param-label">type
</div>
3474 <div class=
"prop-value">
3475 <span class=
"json-property-type">string
</span>
3476 <span class=
"json-property-range" title=
"Value limits"></span>
3479 <div class=
"prop-row prop-inner">
3480 <div class=
"prop-name param-label">in
</div>
3481 <div class=
"prop-value">path
</div>
3485 <div class=
"doc-examples"></div>
3487 <div class=
"doc-row">
3488 <div class=
"doc-copy">
3489 <section class=
"swagger-responses">
3490 <div class=
"prop-row prop-group">
3491 <div class=
"prop-name">
3492 <div class=
"prop-title">204 No Content
</div>
3494 <div class=
"prop-value">
3495 <p>successful operation
</p>
3500 <div class=
"doc-examples">
3501 <h5>Response Content-Types:
3502 <span>application/json
</span>
3507 <h1 id=
"tag-VideoBlacklist" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoBlacklist">VideoBlacklist
</h1>
3508 <div id=
"operation--videos--videoId--blacklist-post" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--blacklist-post">
3509 <!-- <section class="operation-tags row"> -->
3510 <!-- <div class="doc-copy"> -->
3511 <div class=
"operation-tags">
3512 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
3517 <h2 class=
"operation-title">
3518 <span class=
"operation-name">
3519 <span class=
"operation-name">POST
</span>
3520 <span class=
"operation-path">/videos/{videoId}/blacklist
</span>
3523 <div class=
"doc-row">
3524 <div class=
"doc-copy">
3525 <section class=
"swagger-request-params">
3526 <div class=
"prop-row prop-group">
3527 <div class=
"prop-name">
3528 <div class=
"prop-title">videoId
</div>
3529 <span class=
"json-property-required"></span>
3531 <div class=
"prop-value">
3532 <p>The video id
</p>
3535 <div class=
"prop-row prop-inner">
3536 <div class=
"prop-name param-label">type
</div>
3537 <div class=
"prop-value">
3538 <span class=
"json-property-type">string
</span>
3539 <span class=
"json-property-range" title=
"Value limits"></span>
3542 <div class=
"prop-row prop-inner">
3543 <div class=
"prop-name param-label">in
</div>
3544 <div class=
"prop-value">path
</div>
3548 <div class=
"doc-examples"></div>
3550 <div class=
"doc-row">
3551 <div class=
"doc-copy">
3552 <section class=
"swagger-responses">
3553 <div class=
"prop-row prop-group">
3554 <div class=
"prop-name">
3555 <div class=
"prop-title">204 No Content
</div>
3557 <div class=
"prop-value">
3558 <p>successful operation
</p>
3563 <div class=
"doc-examples">
3564 <h5>Response Content-Types:
3565 <span>application/json
</span>
3570 <div id=
"operation--videos--videoId--blacklist-delete" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--blacklist-delete">
3571 <!-- <section class="operation-tags row"> -->
3572 <!-- <div class="doc-copy"> -->
3573 <div class=
"operation-tags">
3574 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
3579 <h2 class=
"operation-title">
3580 <span class=
"operation-name">
3581 <span class=
"operation-name">DELETE
</span>
3582 <span class=
"operation-path">/videos/{videoId}/blacklist
</span>
3585 <div class=
"doc-row">
3586 <div class=
"doc-copy">
3587 <section class=
"swagger-request-params">
3588 <div class=
"prop-row prop-group">
3589 <div class=
"prop-name">
3590 <div class=
"prop-title">videoId
</div>
3591 <span class=
"json-property-required"></span>
3593 <div class=
"prop-value">
3594 <p>The video id
</p>
3597 <div class=
"prop-row prop-inner">
3598 <div class=
"prop-name param-label">type
</div>
3599 <div class=
"prop-value">
3600 <span class=
"json-property-type">string
</span>
3601 <span class=
"json-property-range" title=
"Value limits"></span>
3604 <div class=
"prop-row prop-inner">
3605 <div class=
"prop-name param-label">in
</div>
3606 <div class=
"prop-value">path
</div>
3610 <div class=
"doc-examples"></div>
3612 <div class=
"doc-row">
3613 <div class=
"doc-copy">
3614 <section class=
"swagger-responses">
3615 <div class=
"prop-row prop-group">
3616 <div class=
"prop-name">
3617 <div class=
"prop-title">204 No Content
</div>
3619 <div class=
"prop-value">
3620 <p>successful operation
</p>
3625 <div class=
"doc-examples">
3626 <h5>Response Content-Types:
3627 <span>application/json
</span>
3632 <div id=
"operation--videos-blacklist-get" class=
"operation panel" data-traverse-target=
"operation--videos-blacklist-get">
3633 <!-- <section class="operation-tags row"> -->
3634 <!-- <div class="doc-copy"> -->
3635 <div class=
"operation-tags">
3636 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
3641 <h2 class=
"operation-title">
3642 <span class=
"operation-name">
3643 <span class=
"operation-name">GET
</span>
3644 <span class=
"operation-path">/videos/blacklist
</span>
3647 <div class=
"doc-row">
3648 <div class=
"doc-copy">
3649 <section class=
"swagger-request-params">
3650 <div class=
"prop-row prop-group">
3651 <div class=
"prop-name">
3652 <div class=
"prop-title">start
</div>
3654 <div class=
"prop-value">
3655 <p>starting page
</p>
3658 <div class=
"prop-row prop-inner">
3659 <div class=
"prop-name param-label">type
</div>
3660 <div class=
"prop-value">
3661 <span class=
"json-property-type">number
</span>
3662 <span class=
"json-property-range" title=
"Value limits"></span>
3665 <div class=
"prop-row prop-inner">
3666 <div class=
"prop-name param-label">in
</div>
3667 <div class=
"prop-value">query
</div>
3669 <div class=
"prop-row prop-group">
3670 <div class=
"prop-name">
3671 <div class=
"prop-title">stop
</div>
3673 <div class=
"prop-value">
3677 <div class=
"prop-row prop-inner">
3678 <div class=
"prop-name param-label">type
</div>
3679 <div class=
"prop-value">
3680 <span class=
"json-property-type">number
</span>
3681 <span class=
"json-property-range" title=
"Value limits"></span>
3684 <div class=
"prop-row prop-inner">
3685 <div class=
"prop-name param-label">in
</div>
3686 <div class=
"prop-value">query
</div>
3688 <div class=
"prop-row prop-group">
3689 <div class=
"prop-name">
3690 <div class=
"prop-title">sort
</div>
3692 <div class=
"prop-value">
3696 <div class=
"prop-row prop-inner">
3697 <div class=
"prop-name param-label">type
</div>
3698 <div class=
"prop-value">
3699 <span class=
"json-property-type">number
</span>
3700 <span class=
"json-property-range" title=
"Value limits"></span>
3703 <div class=
"prop-row prop-inner">
3704 <div class=
"prop-name param-label">in
</div>
3705 <div class=
"prop-value">query
</div>
3709 <div class=
"doc-examples"></div>
3711 <div class=
"doc-row">
3712 <div class=
"doc-copy">
3713 <section class=
"swagger-responses">
3714 <div class=
"prop-row prop-group">
3715 <div class=
"prop-name">
3716 <div class=
"prop-title">200 OK
</div>
3717 <div class=
"prop-ref">
3718 <span class=
"json-schema-ref-array">
3719 <a class=
"json-schema-ref" href=
"#/definitions/VideoBlacklist">VideoBlacklist
</a>
3722 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3724 <div class=
"prop-value">
3725 <p>successful operation
</p>
3730 <div class=
"doc-examples">
3731 <h5>Response Content-Types:
3732 <span>application/json
</span>
3735 <h5>Response Example
3736 <span>(
200 OK)
</span>
3738 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3740 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3741 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
3742 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3743 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3744 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3745 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3746 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3747 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3748 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3749 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3750 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3751 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
3760 <h1 id=
"tag-VideoChannel" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoChannel">VideoChannel
</h1>
3761 <div id=
"operation--videos-channels-get" class=
"operation panel" data-traverse-target=
"operation--videos-channels-get">
3762 <!-- <section class="operation-tags row"> -->
3763 <!-- <div class="doc-copy"> -->
3764 <div class=
"operation-tags">
3765 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
3770 <h2 class=
"operation-title">
3771 <span class=
"operation-name">
3772 <span class=
"operation-name">GET
</span>
3773 <span class=
"operation-path">/videos/channels
</span>
3776 <div class=
"doc-row">
3777 <div class=
"doc-copy">
3778 <section class=
"swagger-request-params">
3779 <div class=
"prop-row prop-group">
3780 <div class=
"prop-name">
3781 <div class=
"prop-title">start
</div>
3783 <div class=
"prop-value">
3784 <p>starting page
</p>
3787 <div class=
"prop-row prop-inner">
3788 <div class=
"prop-name param-label">type
</div>
3789 <div class=
"prop-value">
3790 <span class=
"json-property-type">number
</span>
3791 <span class=
"json-property-range" title=
"Value limits"></span>
3794 <div class=
"prop-row prop-inner">
3795 <div class=
"prop-name param-label">in
</div>
3796 <div class=
"prop-value">query
</div>
3798 <div class=
"prop-row prop-group">
3799 <div class=
"prop-name">
3800 <div class=
"prop-title">stop
</div>
3802 <div class=
"prop-value">
3806 <div class=
"prop-row prop-inner">
3807 <div class=
"prop-name param-label">type
</div>
3808 <div class=
"prop-value">
3809 <span class=
"json-property-type">number
</span>
3810 <span class=
"json-property-range" title=
"Value limits"></span>
3813 <div class=
"prop-row prop-inner">
3814 <div class=
"prop-name param-label">in
</div>
3815 <div class=
"prop-value">query
</div>
3817 <div class=
"prop-row prop-group">
3818 <div class=
"prop-name">
3819 <div class=
"prop-title">sort
</div>
3821 <div class=
"prop-value">
3825 <div class=
"prop-row prop-inner">
3826 <div class=
"prop-name param-label">type
</div>
3827 <div class=
"prop-value">
3828 <span class=
"json-property-type">number
</span>
3829 <span class=
"json-property-range" title=
"Value limits"></span>
3832 <div class=
"prop-row prop-inner">
3833 <div class=
"prop-name param-label">in
</div>
3834 <div class=
"prop-value">query
</div>
3838 <div class=
"doc-examples"></div>
3840 <div class=
"doc-row">
3841 <div class=
"doc-copy">
3842 <section class=
"swagger-responses">
3843 <div class=
"prop-row prop-group">
3844 <div class=
"prop-name">
3845 <div class=
"prop-title">200 OK
</div>
3846 <div class=
"prop-ref">
3847 <span class=
"json-schema-ref-array">
3848 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
3851 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3853 <div class=
"prop-value">
3854 <p>successful operation
</p>
3859 <div class=
"doc-examples">
3860 <h5>Response Content-Types:
3861 <span>application/json
</span>
3864 <h5>Response Example
3865 <span>(
200 OK)
</span>
3867 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3869 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3870 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3871 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3872 <span class=
"hljs-attr">"owner
"</span>: {
3873 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3874 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
3876 <span class=
"hljs-attr">"videos
"</span>: [
3878 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3879 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3880 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3881 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3882 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3883 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
3884 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
3885 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
3886 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
3887 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
3888 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
3889 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3890 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3891 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3892 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3893 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
3894 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3895 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3896 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3897 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3898 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3899 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3900 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
3911 <div id=
"operation--videos-channels-post" class=
"operation panel" data-traverse-target=
"operation--videos-channels-post">
3912 <!-- <section class="operation-tags row"> -->
3913 <!-- <div class="doc-copy"> -->
3914 <div class=
"operation-tags">
3915 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
3920 <h2 class=
"operation-title">
3921 <span class=
"operation-name">
3922 <span class=
"operation-name">POST
</span>
3923 <span class=
"operation-path">/videos/channels
</span>
3926 <div class=
"doc-row">
3927 <div class=
"doc-copy">
3928 <section class=
"swagger-request-body">
3929 <div class=
"prop-row">
3930 <div class=
"prop-name">
3931 <div class=
"swagger-request-model">
3933 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannelInput">VideoChannelInput
</a>
3937 <div class=
"prop-value columns small-6">
3938 <!-- <div class="swagger-request-description"> -->undefined
3944 <div class=
"doc-examples">
3946 <h5>Request Content-Types:
3947 <span>application/json
</span>
3949 <h5>Request Example
</h5>
3950 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3951 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3952 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
3959 <div class=
"doc-row">
3960 <div class=
"doc-copy">
3961 <section class=
"swagger-responses">
3962 <div class=
"prop-row prop-group">
3963 <div class=
"prop-name">
3964 <div class=
"prop-title">204 No Content
</div>
3966 <div class=
"prop-value">
3967 <p>successful operation
</p>
3972 <div class=
"doc-examples">
3973 <h5>Response Content-Types:
3974 <span>application/json
</span>
3979 <div id=
"operation--videos-channels--id--get" class=
"operation panel" data-traverse-target=
"operation--videos-channels--id--get">
3980 <!-- <section class="operation-tags row"> -->
3981 <!-- <div class="doc-copy"> -->
3982 <div class=
"operation-tags">
3983 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
3988 <h2 class=
"operation-title">
3989 <span class=
"operation-name">
3990 <span class=
"operation-name">GET
</span>
3991 <span class=
"operation-path">/videos/channels/{id}
</span>
3994 <div class=
"doc-row">
3995 <div class=
"doc-copy">
3996 <section class=
"swagger-request-params">
3997 <div class=
"prop-row prop-group">
3998 <div class=
"prop-name">
3999 <div class=
"prop-title">id
</div>
4000 <span class=
"json-property-required"></span>
4002 <div class=
"prop-value">
4003 <p>The video id
</p>
4006 <div class=
"prop-row prop-inner">
4007 <div class=
"prop-name param-label">type
</div>
4008 <div class=
"prop-value">
4009 <span class=
"json-property-type">string
</span>
4010 <span class=
"json-property-range" title=
"Value limits"></span>
4013 <div class=
"prop-row prop-inner">
4014 <div class=
"prop-name param-label">in
</div>
4015 <div class=
"prop-value">path
</div>
4019 <div class=
"doc-examples"></div>
4021 <div class=
"doc-row">
4022 <div class=
"doc-copy">
4023 <section class=
"swagger-responses">
4024 <div class=
"prop-row prop-group">
4025 <div class=
"prop-name">
4026 <div class=
"prop-title">200 OK
</div>
4027 <div class=
"prop-ref">
4029 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4032 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4034 <div class=
"prop-value">
4035 <p>successful operation
</p>
4040 <div class=
"doc-examples">
4041 <h5>Response Content-Types:
4042 <span>application/json
</span>
4045 <h5>Response Example
4046 <span>(
200 OK)
</span>
4048 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4049 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4050 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4051 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4052 <span class=
"hljs-attr">"owner
"</span>: {
4053 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4054 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
4056 <span class=
"hljs-attr">"videos
"</span>: [
4058 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4059 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4060 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4061 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4062 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4063 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
4064 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
4065 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
4066 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
4067 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
4068 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
4069 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4070 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
4071 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4072 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4073 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
4074 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4075 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4076 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4077 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
4078 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4079 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4080 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
4090 <div id=
"operation--videos-channels--id--put" class=
"operation panel" data-traverse-target=
"operation--videos-channels--id--put">
4091 <!-- <section class="operation-tags row"> -->
4092 <!-- <div class="doc-copy"> -->
4093 <div class=
"operation-tags">
4094 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4099 <h2 class=
"operation-title">
4100 <span class=
"operation-name">
4101 <span class=
"operation-name">PUT
</span>
4102 <span class=
"operation-path">/videos/channels/{id}
</span>
4105 <div class=
"doc-row">
4106 <div class=
"doc-copy">
4107 <section class=
"swagger-request-body">
4108 <div class=
"prop-row">
4109 <div class=
"prop-name">
4110 <div class=
"swagger-request-model">
4112 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannelInput">VideoChannelInput
</a>
4116 <div class=
"prop-value columns small-6">
4117 <!-- <div class="swagger-request-description"> -->undefined
4122 <section class=
"swagger-request-params">
4123 <div class=
"prop-row prop-group">
4124 <div class=
"prop-name">
4125 <div class=
"prop-title">id
</div>
4126 <span class=
"json-property-required"></span>
4128 <div class=
"prop-value">
4129 <p>The video id
</p>
4132 <div class=
"prop-row prop-inner">
4133 <div class=
"prop-name param-label">type
</div>
4134 <div class=
"prop-value">
4135 <span class=
"json-property-type">string
</span>
4136 <span class=
"json-property-range" title=
"Value limits"></span>
4139 <div class=
"prop-row prop-inner">
4140 <div class=
"prop-name param-label">in
</div>
4141 <div class=
"prop-value">path
</div>
4145 <div class=
"doc-examples">
4147 <h5>Request Content-Types:
4148 <span>application/json
</span>
4150 <h5>Request Example
</h5>
4151 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4152 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4153 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
4160 <div class=
"doc-row">
4161 <div class=
"doc-copy">
4162 <section class=
"swagger-responses">
4163 <div class=
"prop-row prop-group">
4164 <div class=
"prop-name">
4165 <div class=
"prop-title">204 No Content
</div>
4167 <div class=
"prop-value">
4168 <p>successful operation
</p>
4173 <div class=
"doc-examples">
4174 <h5>Response Content-Types:
4175 <span>application/json
</span>
4180 <div id=
"operation--videos-channels--id--delete" class=
"operation panel" data-traverse-target=
"operation--videos-channels--id--delete">
4181 <!-- <section class="operation-tags row"> -->
4182 <!-- <div class="doc-copy"> -->
4183 <div class=
"operation-tags">
4184 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4189 <h2 class=
"operation-title">
4190 <span class=
"operation-name">
4191 <span class=
"operation-name">DELETE
</span>
4192 <span class=
"operation-path">/videos/channels/{id}
</span>
4195 <div class=
"doc-row">
4196 <div class=
"doc-copy">
4197 <section class=
"swagger-request-params">
4198 <div class=
"prop-row prop-group">
4199 <div class=
"prop-name">
4200 <div class=
"prop-title">id
</div>
4201 <span class=
"json-property-required"></span>
4203 <div class=
"prop-value">
4204 <p>The video id
</p>
4207 <div class=
"prop-row prop-inner">
4208 <div class=
"prop-name param-label">type
</div>
4209 <div class=
"prop-value">
4210 <span class=
"json-property-type">string
</span>
4211 <span class=
"json-property-range" title=
"Value limits"></span>
4214 <div class=
"prop-row prop-inner">
4215 <div class=
"prop-name param-label">in
</div>
4216 <div class=
"prop-value">path
</div>
4220 <div class=
"doc-examples"></div>
4222 <div class=
"doc-row">
4223 <div class=
"doc-copy">
4224 <section class=
"swagger-responses">
4225 <div class=
"prop-row prop-group">
4226 <div class=
"prop-name">
4227 <div class=
"prop-title">204 No Content
</div>
4229 <div class=
"prop-value">
4230 <p>successful operation
</p>
4235 <div class=
"doc-examples">
4236 <h5>Response Content-Types:
4237 <span>application/json
</span>
4242 <div id=
"operation--videos-accounts--accountId--channels-get" class=
"operation panel" data-traverse-target=
"operation--videos-accounts--accountId--channels-get">
4243 <!-- <section class="operation-tags row"> -->
4244 <!-- <div class="doc-copy"> -->
4245 <div class=
"operation-tags">
4246 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4251 <h2 class=
"operation-title">
4252 <span class=
"operation-name">
4253 <span class=
"operation-name">GET
</span>
4254 <span class=
"operation-path">/videos/accounts/{accountId}/channels
</span>
4257 <div class=
"doc-row">
4258 <div class=
"doc-copy">
4259 <section class=
"swagger-request-params">
4260 <div class=
"prop-row prop-group">
4261 <div class=
"prop-name">
4262 <div class=
"prop-title">accountId
</div>
4263 <span class=
"json-property-required"></span>
4265 <div class=
"prop-value">
4266 <p>The account id
</p>
4269 <div class=
"prop-row prop-inner">
4270 <div class=
"prop-name param-label">type
</div>
4271 <div class=
"prop-value">
4272 <span class=
"json-property-type">string
</span>
4273 <span class=
"json-property-range" title=
"Value limits"></span>
4276 <div class=
"prop-row prop-inner">
4277 <div class=
"prop-name param-label">in
</div>
4278 <div class=
"prop-value">path
</div>
4282 <div class=
"doc-examples"></div>
4284 <div class=
"doc-row">
4285 <div class=
"doc-copy">
4286 <section class=
"swagger-responses">
4287 <div class=
"prop-row prop-group">
4288 <div class=
"prop-name">
4289 <div class=
"prop-title">200 OK
</div>
4290 <div class=
"prop-ref">
4291 <span class=
"json-schema-ref-array">
4292 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4295 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4297 <div class=
"prop-value">
4298 <p>successful operation
</p>
4303 <div class=
"doc-examples">
4304 <h5>Response Content-Types:
4305 <span>application/json
</span>
4308 <h5>Response Example
4309 <span>(
200 OK)
</span>
4311 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4313 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4314 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4315 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4316 <span class=
"hljs-attr">"owner
"</span>: {
4317 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4318 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
4320 <span class=
"hljs-attr">"videos
"</span>: [
4322 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4323 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4324 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4325 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4326 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4327 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
4328 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
4329 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
4330 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
4331 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
4332 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
4333 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4334 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
4335 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4336 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4337 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
4338 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4339 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4340 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4341 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
4342 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4343 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4344 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
4355 <h1 id=
"tag-VideoComment" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoComment">VideoComment
</h1>
4356 <div id=
"operation--videos--videoId--comment-threads-get" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comment-threads-get">
4357 <!-- <section class="operation-tags row"> -->
4358 <!-- <div class="doc-copy"> -->
4359 <div class=
"operation-tags">
4360 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
4365 <h2 class=
"operation-title">
4366 <span class=
"operation-name">
4367 <span class=
"operation-name">GET
</span>
4368 <span class=
"operation-path">/videos/{videoId}/comment-threads
</span>
4371 <div class=
"doc-row">
4372 <div class=
"doc-copy">
4373 <section class=
"swagger-request-params">
4374 <div class=
"prop-row prop-group">
4375 <div class=
"prop-name">
4376 <div class=
"prop-title">videoId
</div>
4377 <span class=
"json-property-required"></span>
4379 <div class=
"prop-value">
4380 <p>The video id
</p>
4383 <div class=
"prop-row prop-inner">
4384 <div class=
"prop-name param-label">type
</div>
4385 <div class=
"prop-value">
4386 <span class=
"json-property-type">string
</span>
4387 <span class=
"json-property-range" title=
"Value limits"></span>
4390 <div class=
"prop-row prop-inner">
4391 <div class=
"prop-name param-label">in
</div>
4392 <div class=
"prop-value">path
</div>
4394 <div class=
"prop-row prop-group">
4395 <div class=
"prop-name">
4396 <div class=
"prop-title">start
</div>
4398 <div class=
"prop-value">
4399 <p>starting page
</p>
4402 <div class=
"prop-row prop-inner">
4403 <div class=
"prop-name param-label">type
</div>
4404 <div class=
"prop-value">
4405 <span class=
"json-property-type">number
</span>
4406 <span class=
"json-property-range" title=
"Value limits"></span>
4409 <div class=
"prop-row prop-inner">
4410 <div class=
"prop-name param-label">in
</div>
4411 <div class=
"prop-value">query
</div>
4413 <div class=
"prop-row prop-group">
4414 <div class=
"prop-name">
4415 <div class=
"prop-title">stop
</div>
4417 <div class=
"prop-value">
4421 <div class=
"prop-row prop-inner">
4422 <div class=
"prop-name param-label">type
</div>
4423 <div class=
"prop-value">
4424 <span class=
"json-property-type">number
</span>
4425 <span class=
"json-property-range" title=
"Value limits"></span>
4428 <div class=
"prop-row prop-inner">
4429 <div class=
"prop-name param-label">in
</div>
4430 <div class=
"prop-value">query
</div>
4432 <div class=
"prop-row prop-group">
4433 <div class=
"prop-name">
4434 <div class=
"prop-title">sort
</div>
4436 <div class=
"prop-value">
4440 <div class=
"prop-row prop-inner">
4441 <div class=
"prop-name param-label">type
</div>
4442 <div class=
"prop-value">
4443 <span class=
"json-property-type">number
</span>
4444 <span class=
"json-property-range" title=
"Value limits"></span>
4447 <div class=
"prop-row prop-inner">
4448 <div class=
"prop-name param-label">in
</div>
4449 <div class=
"prop-value">query
</div>
4453 <div class=
"doc-examples"></div>
4455 <div class=
"doc-row">
4456 <div class=
"doc-copy">
4457 <section class=
"swagger-responses">
4458 <div class=
"prop-row prop-group">
4459 <div class=
"prop-name">
4460 <div class=
"prop-title">200 OK
</div>
4461 <div class=
"prop-ref">
4463 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadResponse">CommentThreadResponse
</a>
4466 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4468 <div class=
"prop-value">
4469 <p>successful operation
</p>
4474 <div class=
"doc-examples">
4475 <h5>Response Content-Types:
4476 <span>application/json
</span>
4479 <h5>Response Example
4480 <span>(
200 OK)
</span>
4482 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4483 <span class=
"hljs-attr">"total
"</span>:
<span class=
"hljs-string">"number
"</span>,
4484 <span class=
"hljs-attr">"data
"</span>: [
4486 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4487 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4488 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
4489 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4490 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4491 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4492 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4493 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4494 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
4495 <span class=
"hljs-attr">"account
"</span>: {
4496 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4497 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4498 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4499 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4500 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4501 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4502 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4503 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4504 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4505 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4506 <span class=
"hljs-attr">"avatar
"</span>: {
4507 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4508 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4509 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4521 <div id=
"operation--videos--videoId--comment-threads-post" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comment-threads-post">
4522 <!-- <section class="operation-tags row"> -->
4523 <!-- <div class="doc-copy"> -->
4524 <div class=
"operation-tags">
4525 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
4530 <h2 class=
"operation-title">
4531 <span class=
"operation-name">
4532 <span class=
"operation-name">POST
</span>
4533 <span class=
"operation-path">/videos/{videoId}/comment-threads
</span>
4536 <div class=
"doc-row">
4537 <div class=
"doc-copy">
4538 <section class=
"swagger-request-params">
4539 <div class=
"prop-row prop-group">
4540 <div class=
"prop-name">
4541 <div class=
"prop-title">videoId
</div>
4542 <span class=
"json-property-required"></span>
4544 <div class=
"prop-value">
4545 <p>The video id
</p>
4548 <div class=
"prop-row prop-inner">
4549 <div class=
"prop-name param-label">type
</div>
4550 <div class=
"prop-value">
4551 <span class=
"json-property-type">string
</span>
4552 <span class=
"json-property-range" title=
"Value limits"></span>
4555 <div class=
"prop-row prop-inner">
4556 <div class=
"prop-name param-label">in
</div>
4557 <div class=
"prop-value">path
</div>
4561 <div class=
"doc-examples"></div>
4563 <div class=
"doc-row">
4564 <div class=
"doc-copy">
4565 <section class=
"swagger-responses">
4566 <div class=
"prop-row prop-group">
4567 <div class=
"prop-name">
4568 <div class=
"prop-title">200 OK
</div>
4569 <div class=
"prop-ref">
4571 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadPostResponse">CommentThreadPostResponse
</a>
4574 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4576 <div class=
"prop-value">
4577 <p>successful operation
</p>
4582 <div class=
"doc-examples">
4583 <h5>Response Content-Types:
4584 <span>application/json
</span>
4587 <h5>Response Example
4588 <span>(
200 OK)
</span>
4590 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4591 <span class=
"hljs-attr">"comment
"</span>: {
4592 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4593 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4594 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
4595 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4596 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4597 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4598 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4599 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4600 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
4601 <span class=
"hljs-attr">"account
"</span>: {
4602 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4603 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4604 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4605 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4606 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4607 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4608 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4609 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4610 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4611 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4612 <span class=
"hljs-attr">"avatar
"</span>: {
4613 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4614 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4615 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4626 <div id=
"operation--videos--videoId--comment-threads--threadId--get" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comment-threads--threadId--get">
4627 <!-- <section class="operation-tags row"> -->
4628 <!-- <div class="doc-copy"> -->
4629 <div class=
"operation-tags">
4630 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
4635 <h2 class=
"operation-title">
4636 <span class=
"operation-name">
4637 <span class=
"operation-name">GET
</span>
4638 <span class=
"operation-path">/videos/{videoId}/comment-threads/{threadId}
</span>
4641 <div class=
"doc-row">
4642 <div class=
"doc-copy">
4643 <section class=
"swagger-request-params">
4644 <div class=
"prop-row prop-group">
4645 <div class=
"prop-name">
4646 <div class=
"prop-title">videoId
</div>
4647 <span class=
"json-property-required"></span>
4649 <div class=
"prop-value">
4650 <p>The video id
</p>
4653 <div class=
"prop-row prop-inner">
4654 <div class=
"prop-name param-label">type
</div>
4655 <div class=
"prop-value">
4656 <span class=
"json-property-type">string
</span>
4657 <span class=
"json-property-range" title=
"Value limits"></span>
4660 <div class=
"prop-row prop-inner">
4661 <div class=
"prop-name param-label">in
</div>
4662 <div class=
"prop-value">path
</div>
4664 <div class=
"prop-row prop-group">
4665 <div class=
"prop-name">
4666 <div class=
"prop-title">threadId
</div>
4667 <span class=
"json-property-required"></span>
4669 <div class=
"prop-value">
4670 <p>The thread 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/VideoCommentThreadTree">VideoCommentThreadTree
</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">"comment
"</span>: {
4717 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4718 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4719 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
4720 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4721 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4722 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4723 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4724 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4725 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
4726 <span class=
"hljs-attr">"account
"</span>: {
4727 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4728 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4729 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4730 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4731 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4732 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4733 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4734 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4735 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4736 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4737 <span class=
"hljs-attr">"avatar
"</span>: {
4738 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4739 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4740 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4744 <span class=
"hljs-attr">"children
"</span>: [
4746 <span class=
"hljs-attr">"comment
"</span>: {
4747 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4748 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4749 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
4750 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4751 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4752 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4753 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4754 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4755 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
4756 <span class=
"hljs-attr">"account
"</span>: {
4757 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4758 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4759 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4760 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4761 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4762 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4763 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4764 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4765 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4766 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4767 <span class=
"hljs-attr">"avatar
"</span>: {
4768 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4769 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4770 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4774 <span class=
"hljs-attr">"children
"</span>: [
4776 <span class=
"hljs-attr">"comment
"</span>: {
4777 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4778 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4779 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
4780 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4781 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4782 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4783 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4784 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4785 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
4786 <span class=
"hljs-attr">"account
"</span>: {
4787 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4788 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4789 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4790 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4791 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4792 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4793 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4794 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4795 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4796 <span class=
"hljs-attr">"avatar
"</span>: {
4797 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4798 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4799 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4814 <div id=
"operation--videos--videoId--comments--commentId--post" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comments--commentId--post">
4815 <!-- <section class="operation-tags row"> -->
4816 <!-- <div class="doc-copy"> -->
4817 <div class=
"operation-tags">
4818 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
4823 <h2 class=
"operation-title">
4824 <span class=
"operation-name">
4825 <span class=
"operation-name">POST
</span>
4826 <span class=
"operation-path">/videos/{videoId}/comments/{commentId}
</span>
4829 <div class=
"doc-row">
4830 <div class=
"doc-copy">
4831 <section class=
"swagger-request-params">
4832 <div class=
"prop-row prop-group">
4833 <div class=
"prop-name">
4834 <div class=
"prop-title">videoId
</div>
4835 <span class=
"json-property-required"></span>
4837 <div class=
"prop-value">
4838 <p>The video id
</p>
4841 <div class=
"prop-row prop-inner">
4842 <div class=
"prop-name param-label">type
</div>
4843 <div class=
"prop-value">
4844 <span class=
"json-property-type">string
</span>
4845 <span class=
"json-property-range" title=
"Value limits"></span>
4848 <div class=
"prop-row prop-inner">
4849 <div class=
"prop-name param-label">in
</div>
4850 <div class=
"prop-value">path
</div>
4852 <div class=
"prop-row prop-group">
4853 <div class=
"prop-name">
4854 <div class=
"prop-title">commentId
</div>
4855 <span class=
"json-property-required"></span>
4857 <div class=
"prop-value">
4858 <p>The comment id
</p>
4861 <div class=
"prop-row prop-inner">
4862 <div class=
"prop-name param-label">type
</div>
4863 <div class=
"prop-value">
4864 <span class=
"json-property-type">string
</span>
4865 <span class=
"json-property-range" title=
"Value limits"></span>
4868 <div class=
"prop-row prop-inner">
4869 <div class=
"prop-name param-label">in
</div>
4870 <div class=
"prop-value">path
</div>
4874 <div class=
"doc-examples"></div>
4876 <div class=
"doc-row">
4877 <div class=
"doc-copy">
4878 <section class=
"swagger-responses">
4879 <div class=
"prop-row prop-group">
4880 <div class=
"prop-name">
4881 <div class=
"prop-title">200 OK
</div>
4882 <div class=
"prop-ref">
4884 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadPostResponse">CommentThreadPostResponse
</a>
4887 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4889 <div class=
"prop-value">
4890 <p>successful operation
</p>
4895 <div class=
"doc-examples">
4896 <h5>Response Content-Types:
4897 <span>application/json
</span>
4900 <h5>Response Example
4901 <span>(
200 OK)
</span>
4903 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4904 <span class=
"hljs-attr">"comment
"</span>: {
4905 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4906 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4907 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
4908 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4909 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4910 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4911 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4912 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4913 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
4914 <span class=
"hljs-attr">"account
"</span>: {
4915 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4916 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4917 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4918 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4919 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4920 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4921 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4922 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4923 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4924 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4925 <span class=
"hljs-attr">"avatar
"</span>: {
4926 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4927 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4928 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4939 <div id=
"operation--videos--videoId--comments--commentId--delete" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comments--commentId--delete">
4940 <!-- <section class="operation-tags row"> -->
4941 <!-- <div class="doc-copy"> -->
4942 <div class=
"operation-tags">
4943 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
4948 <h2 class=
"operation-title">
4949 <span class=
"operation-name">
4950 <span class=
"operation-name">DELETE
</span>
4951 <span class=
"operation-path">/videos/{videoId}/comments/{commentId}
</span>
4954 <div class=
"doc-row">
4955 <div class=
"doc-copy">
4956 <section class=
"swagger-request-params">
4957 <div class=
"prop-row prop-group">
4958 <div class=
"prop-name">
4959 <div class=
"prop-title">videoId
</div>
4960 <span class=
"json-property-required"></span>
4962 <div class=
"prop-value">
4963 <p>The video id
</p>
4966 <div class=
"prop-row prop-inner">
4967 <div class=
"prop-name param-label">type
</div>
4968 <div class=
"prop-value">
4969 <span class=
"json-property-type">string
</span>
4970 <span class=
"json-property-range" title=
"Value limits"></span>
4973 <div class=
"prop-row prop-inner">
4974 <div class=
"prop-name param-label">in
</div>
4975 <div class=
"prop-value">path
</div>
4977 <div class=
"prop-row prop-group">
4978 <div class=
"prop-name">
4979 <div class=
"prop-title">commentId
</div>
4980 <span class=
"json-property-required"></span>
4982 <div class=
"prop-value">
4983 <p>The comment id
</p>
4986 <div class=
"prop-row prop-inner">
4987 <div class=
"prop-name param-label">type
</div>
4988 <div class=
"prop-value">
4989 <span class=
"json-property-type">string
</span>
4990 <span class=
"json-property-range" title=
"Value limits"></span>
4993 <div class=
"prop-row prop-inner">
4994 <div class=
"prop-name param-label">in
</div>
4995 <div class=
"prop-value">path
</div>
4999 <div class=
"doc-examples"></div>
5001 <div class=
"doc-row">
5002 <div class=
"doc-copy">
5003 <section class=
"swagger-responses">
5004 <div class=
"prop-row prop-group">
5005 <div class=
"prop-name">
5006 <div class=
"prop-title">204 No Content
</div>
5008 <div class=
"prop-value">
5009 <p>successful operation
</p>
5014 <div class=
"doc-examples">
5015 <h5>Response Content-Types:
5016 <span>application/json
</span>
5021 <h1 id=
"tag-VideoRate" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoRate">VideoRate
</h1>
5022 <div id=
"operation--videos--id--rate-put" class=
"operation panel" data-traverse-target=
"operation--videos--id--rate-put">
5023 <!-- <section class="operation-tags row"> -->
5024 <!-- <div class="doc-copy"> -->
5025 <div class=
"operation-tags">
5026 <a class=
"label" href=
"#tag-VideoRate">VideoRate
</a>
5031 <h2 class=
"operation-title">
5032 <span class=
"operation-name">
5033 <span class=
"operation-name">PUT
</span>
5034 <span class=
"operation-path">/videos/{id}/rate
</span>
5037 <div class=
"doc-row">
5038 <div class=
"doc-copy">
5039 <section class=
"swagger-request-params">
5040 <div class=
"prop-row prop-group">
5041 <div class=
"prop-name">
5042 <div class=
"prop-title">id
</div>
5043 <span class=
"json-property-required"></span>
5045 <div class=
"prop-value">
5046 <p>The video id
</p>
5049 <div class=
"prop-row prop-inner">
5050 <div class=
"prop-name param-label">type
</div>
5051 <div class=
"prop-value">
5052 <span class=
"json-property-type">string
</span>
5053 <span class=
"json-property-range" title=
"Value limits"></span>
5056 <div class=
"prop-row prop-inner">
5057 <div class=
"prop-name param-label">in
</div>
5058 <div class=
"prop-value">path
</div>
5062 <div class=
"doc-examples"></div>
5064 <div class=
"doc-row">
5065 <div class=
"doc-copy">
5066 <section class=
"swagger-responses">
5067 <div class=
"prop-row prop-group">
5068 <div class=
"prop-name">
5069 <div class=
"prop-title">204 No Content
</div>
5071 <div class=
"prop-value">
5072 <p>successful operation
</p>
5077 <div class=
"doc-examples">
5078 <h5>Response Content-Types:
5079 <span>application/json
</span>
5084 <h1>Schema Definitions
</h1>
5085 <div id=
"definition-Video" class=
"definition panel" data-traverse-target=
"definition-Video">
5086 <h2 class=
"panel-title">
5087 <a name=
"/definitions/Video"></a>Video:
5088 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
5089 <span class="json-property-range" title="Value limits"></span>
5094 <div class=
"doc-row">
5095 <div class=
"doc-copy">
5096 <section class=
"json-schema-properties">
5098 <dt data-property-name=
"id">
5099 <span class=
"json-property-name">id:
</span>
5100 <span class=
"json-property-type">number
</span>
5101 <span class=
"json-property-range" title=
"Value limits"></span>
5103 <dt data-property-name=
"uuid">
5104 <span class=
"json-property-name">uuid:
</span>
5105 <span class=
"json-property-type">string
</span>
5106 <span class=
"json-property-range" title=
"Value limits"></span>
5108 <dt data-property-name=
"accountName">
5109 <span class=
"json-property-name">accountName:
</span>
5110 <span class=
"json-property-type">string
</span>
5111 <span class=
"json-property-range" title=
"Value limits"></span>
5113 <dt data-property-name=
"createdAt">
5114 <span class=
"json-property-name">createdAt:
</span>
5115 <span class=
"json-property-type">string
</span>
5116 <span class=
"json-property-range" title=
"Value limits"></span>
5118 <dt data-property-name=
"updatedAt">
5119 <span class=
"json-property-name">updatedAt:
</span>
5120 <span class=
"json-property-type">string
</span>
5121 <span class=
"json-property-range" title=
"Value limits"></span>
5123 <dt data-property-name=
"categoryLabel">
5124 <span class=
"json-property-name">categoryLabel:
</span>
5125 <span class=
"json-property-type">string
</span>
5126 <span class=
"json-property-range" title=
"Value limits"></span>
5128 <dt data-property-name=
"category">
5129 <span class=
"json-property-name">category:
</span>
5130 <span class=
"json-property-type">number
</span>
5131 <span class=
"json-property-range" title=
"Value limits"></span>
5133 <dt data-property-name=
"licenceLabel">
5134 <span class=
"json-property-name">licenceLabel:
</span>
5135 <span class=
"json-property-type">string
</span>
5136 <span class=
"json-property-range" title=
"Value limits"></span>
5138 <dt data-property-name=
"licence">
5139 <span class=
"json-property-name">licence:
</span>
5140 <span class=
"json-property-type">number
</span>
5141 <span class=
"json-property-range" title=
"Value limits"></span>
5143 <dt data-property-name=
"languageLabel">
5144 <span class=
"json-property-name">languageLabel:
</span>
5145 <span class=
"json-property-type">string
</span>
5146 <span class=
"json-property-range" title=
"Value limits"></span>
5148 <dt data-property-name=
"language">
5149 <span class=
"json-property-name">language:
</span>
5150 <span class=
"json-property-type">number
</span>
5151 <span class=
"json-property-range" title=
"Value limits"></span>
5153 <dt data-property-name=
"description">
5154 <span class=
"json-property-name">description:
</span>
5155 <span class=
"json-property-type">string
</span>
5156 <span class=
"json-property-range" title=
"Value limits"></span>
5158 <dt data-property-name=
"duration">
5159 <span class=
"json-property-name">duration:
</span>
5160 <span class=
"json-property-type">number
</span>
5161 <span class=
"json-property-range" title=
"Value limits"></span>
5163 <dt data-property-name=
"isLocal">
5164 <span class=
"json-property-name">isLocal:
</span>
5165 <span class=
"json-property-type">boolean
</span>
5166 <span class=
"json-property-range" title=
"Value limits"></span>
5168 <dt data-property-name=
"name">
5169 <span class=
"json-property-name">name:
</span>
5170 <span class=
"json-property-type">string
</span>
5171 <span class=
"json-property-range" title=
"Value limits"></span>
5173 <dt data-property-name=
"serverHost">
5174 <span class=
"json-property-name">serverHost:
</span>
5175 <span class=
"json-property-type">string
</span>
5176 <span class=
"json-property-range" title=
"Value limits"></span>
5178 <dt data-property-name=
"thumbnailPath">
5179 <span class=
"json-property-name">thumbnailPath:
</span>
5180 <span class=
"json-property-type">string
</span>
5181 <span class=
"json-property-range" title=
"Value limits"></span>
5183 <dt data-property-name=
"previewPath">
5184 <span class=
"json-property-name">previewPath:
</span>
5185 <span class=
"json-property-type">string
</span>
5186 <span class=
"json-property-range" title=
"Value limits"></span>
5188 <dt data-property-name=
"embedPath">
5189 <span class=
"json-property-name">embedPath:
</span>
5190 <span class=
"json-property-type">string
</span>
5191 <span class=
"json-property-range" title=
"Value limits"></span>
5193 <dt data-property-name=
"views">
5194 <span class=
"json-property-name">views:
</span>
5195 <span class=
"json-property-type">number
</span>
5196 <span class=
"json-property-range" title=
"Value limits"></span>
5198 <dt data-property-name=
"likes">
5199 <span class=
"json-property-name">likes:
</span>
5200 <span class=
"json-property-type">number
</span>
5201 <span class=
"json-property-range" title=
"Value limits"></span>
5203 <dt data-property-name=
"dislikes">
5204 <span class=
"json-property-name">dislikes:
</span>
5205 <span class=
"json-property-type">number
</span>
5206 <span class=
"json-property-range" title=
"Value limits"></span>
5208 <dt data-property-name=
"nsfw">
5209 <span class=
"json-property-name">nsfw:
</span>
5210 <span class=
"json-property-type">boolean
</span>
5211 <span class=
"json-property-range" title=
"Value limits"></span>
5216 <div class=
"doc-examples">
5219 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5220 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5221 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5222 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5223 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5224 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5225 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
5226 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
5227 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
5228 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
5229 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
5230 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
5231 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5232 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
5233 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5234 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5235 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
5236 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5237 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5238 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5239 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
5240 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5241 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5242 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
5250 <div id=
"definition-VideoAbuse" class=
"definition panel" data-traverse-target=
"definition-VideoAbuse">
5251 <h2 class=
"panel-title">
5252 <a name=
"/definitions/VideoAbuse"></a>VideoAbuse:
5253 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
5254 <span class="json-property-range" title="Value limits"></span>
5259 <div class=
"doc-row">
5260 <div class=
"doc-copy">
5261 <section class=
"json-schema-properties">
5263 <dt data-property-name=
"id">
5264 <span class=
"json-property-name">id:
</span>
5265 <span class=
"json-property-type">number
</span>
5266 <span class=
"json-property-range" title=
"Value limits"></span>
5268 <dt data-property-name=
"reason">
5269 <span class=
"json-property-name">reason:
</span>
5270 <span class=
"json-property-type">string
</span>
5271 <span class=
"json-property-range" title=
"Value limits"></span>
5273 <dt data-property-name=
"reporterUsername">
5274 <span class=
"json-property-name">reporterUsername:
</span>
5275 <span class=
"json-property-type">string
</span>
5276 <span class=
"json-property-range" title=
"Value limits"></span>
5278 <dt data-property-name=
"reporterServerHost">
5279 <span class=
"json-property-name">reporterServerHost:
</span>
5280 <span class=
"json-property-type">string
</span>
5281 <span class=
"json-property-range" title=
"Value limits"></span>
5283 <dt data-property-name=
"videoId">
5284 <span class=
"json-property-name">videoId:
</span>
5285 <span class=
"json-property-type">number
</span>
5286 <span class=
"json-property-range" title=
"Value limits"></span>
5288 <dt data-property-name=
"videoUUID">
5289 <span class=
"json-property-name">videoUUID:
</span>
5290 <span class=
"json-property-type">string
</span>
5291 <span class=
"json-property-range" title=
"Value limits"></span>
5293 <dt data-property-name=
"videoName">
5294 <span class=
"json-property-name">videoName:
</span>
5295 <span class=
"json-property-type">string
</span>
5296 <span class=
"json-property-range" title=
"Value limits"></span>
5298 <dt data-property-name=
"createdAt">
5299 <span class=
"json-property-name">createdAt:
</span>
5300 <span class=
"json-property-type">string
</span>
5301 <span class=
"json-property-range" title=
"Value limits"></span>
5306 <div class=
"doc-examples">
5309 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5310 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5311 <span class=
"hljs-attr">"reason
"</span>:
<span class=
"hljs-string">"string
"</span>,
5312 <span class=
"hljs-attr">"reporterUsername
"</span>:
<span class=
"hljs-string">"string
"</span>,
5313 <span class=
"hljs-attr">"reporterServerHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
5314 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5315 <span class=
"hljs-attr">"videoUUID
"</span>:
<span class=
"hljs-string">"string
"</span>,
5316 <span class=
"hljs-attr">"videoName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5317 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5325 <div id=
"definition-VideoBlacklist" class=
"definition panel" data-traverse-target=
"definition-VideoBlacklist">
5326 <h2 class=
"panel-title">
5327 <a name=
"/definitions/VideoBlacklist"></a>VideoBlacklist:
5328 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
5329 <span class="json-property-range" title="Value limits"></span>
5334 <div class=
"doc-row">
5335 <div class=
"doc-copy">
5336 <section class=
"json-schema-properties">
5338 <dt data-property-name=
"id">
5339 <span class=
"json-property-name">id:
</span>
5340 <span class=
"json-property-type">number
</span>
5341 <span class=
"json-property-range" title=
"Value limits"></span>
5343 <dt data-property-name=
"videoId">
5344 <span class=
"json-property-name">videoId:
</span>
5345 <span class=
"json-property-type">number
</span>
5346 <span class=
"json-property-range" title=
"Value limits"></span>
5348 <dt data-property-name=
"createdAt">
5349 <span class=
"json-property-name">createdAt:
</span>
5350 <span class=
"json-property-type">string
</span>
5351 <span class=
"json-property-range" title=
"Value limits"></span>
5353 <dt data-property-name=
"updatedAt">
5354 <span class=
"json-property-name">updatedAt:
</span>
5355 <span class=
"json-property-type">string
</span>
5356 <span class=
"json-property-range" title=
"Value limits"></span>
5358 <dt data-property-name=
"name">
5359 <span class=
"json-property-name">name:
</span>
5360 <span class=
"json-property-type">string
</span>
5361 <span class=
"json-property-range" title=
"Value limits"></span>
5363 <dt data-property-name=
"uuid">
5364 <span class=
"json-property-name">uuid:
</span>
5365 <span class=
"json-property-type">string
</span>
5366 <span class=
"json-property-range" title=
"Value limits"></span>
5368 <dt data-property-name=
"description">
5369 <span class=
"json-property-name">description:
</span>
5370 <span class=
"json-property-type">string
</span>
5371 <span class=
"json-property-range" title=
"Value limits"></span>
5373 <dt data-property-name=
"duration">
5374 <span class=
"json-property-name">duration:
</span>
5375 <span class=
"json-property-type">number
</span>
5376 <span class=
"json-property-range" title=
"Value limits"></span>
5378 <dt data-property-name=
"views">
5379 <span class=
"json-property-name">views:
</span>
5380 <span class=
"json-property-type">number
</span>
5381 <span class=
"json-property-range" title=
"Value limits"></span>
5383 <dt data-property-name=
"likes">
5384 <span class=
"json-property-name">likes:
</span>
5385 <span class=
"json-property-type">number
</span>
5386 <span class=
"json-property-range" title=
"Value limits"></span>
5388 <dt data-property-name=
"dislikes">
5389 <span class=
"json-property-name">dislikes:
</span>
5390 <span class=
"json-property-type">number
</span>
5391 <span class=
"json-property-range" title=
"Value limits"></span>
5393 <dt data-property-name=
"nsfw">
5394 <span class=
"json-property-name">nsfw:
</span>
5395 <span class=
"json-property-type">boolean
</span>
5396 <span class=
"json-property-range" title=
"Value limits"></span>
5401 <div class=
"doc-examples">
5404 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5405 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5406 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5407 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5408 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5409 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5410 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5411 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5412 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
5413 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
5414 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5415 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5416 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
5424 <div id=
"definition-VideoChannel" class=
"definition panel" data-traverse-target=
"definition-VideoChannel">
5425 <h2 class=
"panel-title">
5426 <a name=
"/definitions/VideoChannel"></a>VideoChannel:
5427 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
5428 <span class="json-property-range" title="Value limits"></span>
5433 <div class=
"doc-row">
5434 <div class=
"doc-copy">
5435 <section class=
"json-schema-properties">
5437 <dt data-property-name=
"displayName">
5438 <span class=
"json-property-name">displayName:
</span>
5439 <span class=
"json-property-type">string
</span>
5440 <span class=
"json-property-range" title=
"Value limits"></span>
5442 <dt data-property-name=
"description">
5443 <span class=
"json-property-name">description:
</span>
5444 <span class=
"json-property-type">string
</span>
5445 <span class=
"json-property-range" title=
"Value limits"></span>
5447 <dt data-property-name=
"isLocal">
5448 <span class=
"json-property-name">isLocal:
</span>
5449 <span class=
"json-property-type">boolean
</span>
5450 <span class=
"json-property-range" title=
"Value limits"></span>
5452 <dt data-property-name=
"owner">
5453 <span class=
"json-property-name">owner:
</span>
5454 <span class=
"json-property-type">object
</span>
5455 <span class=
"json-property-range" title=
"Value limits"></span>
5457 <dt data-property-name=
"videos">
5458 <span class=
"json-property-name">videos:
</span>
5459 <span class=
"json-property-type">
5460 <span class=
"json-schema-ref-array">
5461 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
5464 <span class=
"json-property-range" title=
"Value limits"></span>
5469 <div class=
"doc-examples">
5472 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5473 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5474 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5475 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5476 <span class=
"hljs-attr">"owner
"</span>: {
5477 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5478 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
5480 <span class=
"hljs-attr">"videos
"</span>: [
5482 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5483 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5484 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5485 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5486 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5487 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
5488 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
5489 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
5490 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
5491 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
5492 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
5493 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5494 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
5495 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5496 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5497 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
5498 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5499 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5500 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5501 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
5502 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5503 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5504 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
5514 <div id=
"definition-VideoComment" class=
"definition panel" data-traverse-target=
"definition-VideoComment">
5515 <h2 class=
"panel-title">
5516 <a name=
"/definitions/VideoComment"></a>VideoComment:
5517 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
5518 <span class="json-property-range" title="Value limits"></span>
5523 <div class=
"doc-row">
5524 <div class=
"doc-copy">
5525 <section class=
"json-schema-properties">
5527 <dt data-property-name=
"id">
5528 <span class=
"json-property-name">id:
</span>
5529 <span class=
"json-property-type">number
</span>
5530 <span class=
"json-property-range" title=
"Value limits"></span>
5532 <dt data-property-name=
"url">
5533 <span class=
"json-property-name">url:
</span>
5534 <span class=
"json-property-type">string
</span>
5535 <span class=
"json-property-range" title=
"Value limits"></span>
5537 <dt data-property-name=
"text">
5538 <span class=
"json-property-name">text:
</span>
5539 <span class=
"json-property-type">string
</span>
5540 <span class=
"json-property-range" title=
"Value limits"></span>
5542 <dt data-property-name=
"threadId">
5543 <span class=
"json-property-name">threadId:
</span>
5544 <span class=
"json-property-type">number
</span>
5545 <span class=
"json-property-range" title=
"Value limits"></span>
5547 <dt data-property-name=
"inReplyToCommentId">
5548 <span class=
"json-property-name">inReplyToCommentId:
</span>
5549 <span class=
"json-property-type">number
</span>
5550 <span class=
"json-property-range" title=
"Value limits"></span>
5552 <dt data-property-name=
"videoId">
5553 <span class=
"json-property-name">videoId:
</span>
5554 <span class=
"json-property-type">number
</span>
5555 <span class=
"json-property-range" title=
"Value limits"></span>
5557 <dt data-property-name=
"createdAt">
5558 <span class=
"json-property-name">createdAt:
</span>
5559 <span class=
"json-property-type">string
</span>
5560 <span class=
"json-property-range" title=
"Value limits"></span>
5562 <dt data-property-name=
"updatedAt">
5563 <span class=
"json-property-name">updatedAt:
</span>
5564 <span class=
"json-property-type">string
</span>
5565 <span class=
"json-property-range" title=
"Value limits"></span>
5567 <dt data-property-name=
"totalReplies">
5568 <span class=
"json-property-name">totalReplies:
</span>
5569 <span class=
"json-property-type">number
</span>
5570 <span class=
"json-property-range" title=
"Value limits"></span>
5572 <dt data-property-name=
"account">
5573 <span class=
"json-property-name">account:
</span>
5574 <span class=
"json-property-type">
5576 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
5579 <span class=
"json-property-range" title=
"Value limits"></span>
5584 <div class=
"doc-examples">
5587 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5588 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5589 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5590 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5591 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5592 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5593 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5594 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5595 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5596 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5597 <span class=
"hljs-attr">"account
"</span>: {
5598 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5599 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5600 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5601 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5602 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5603 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5604 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5605 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5606 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5607 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5608 <span class=
"hljs-attr">"avatar
"</span>: {
5609 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5610 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5611 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5621 <div id=
"definition-VideoCommentThreadTree" class=
"definition panel" data-traverse-target=
"definition-VideoCommentThreadTree">
5622 <h2 class=
"panel-title">
5623 <a name=
"/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree:
5624 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
5625 <span class="json-property-range" title="Value limits"></span>
5630 <div class=
"doc-row">
5631 <div class=
"doc-copy">
5632 <section class=
"json-schema-properties">
5634 <dt data-property-name=
"comment">
5635 <span class=
"json-property-name">comment:
</span>
5636 <span class=
"json-property-type">
5638 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
5641 <span class=
"json-property-range" title=
"Value limits"></span>
5643 <dt data-property-name=
"children">
5644 <span class=
"json-property-name">children:
</span>
5645 <span class=
"json-property-type">
5646 <span class=
"json-schema-ref-array">
5647 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
5650 <span class=
"json-property-range" title=
"Value limits"></span>
5655 <div class=
"doc-examples">
5658 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5659 <span class=
"hljs-attr">"comment
"</span>: {
5660 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5661 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5662 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5663 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5664 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5665 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5666 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5667 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5668 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5669 <span class=
"hljs-attr">"account
"</span>: {
5670 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5671 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5672 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5673 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5674 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5675 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5676 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5677 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5678 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5679 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5680 <span class=
"hljs-attr">"avatar
"</span>: {
5681 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5682 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5683 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5687 <span class=
"hljs-attr">"children
"</span>: [
5689 <span class=
"hljs-attr">"comment
"</span>: {
5690 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5691 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5692 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5693 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5694 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5695 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5696 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5697 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5698 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5699 <span class=
"hljs-attr">"account
"</span>: {
5700 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5701 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5702 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5703 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5704 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5705 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5706 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5707 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5708 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5709 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5710 <span class=
"hljs-attr">"avatar
"</span>: {
5711 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5712 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5713 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5717 <span class=
"hljs-attr">"children
"</span>: [
5719 <span class=
"hljs-attr">"comment
"</span>: {
5720 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5721 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5722 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5723 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5724 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5725 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5726 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5727 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5728 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5729 <span class=
"hljs-attr">"account
"</span>: {
5730 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5731 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5732 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5733 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5734 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5735 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5736 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5737 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5738 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5739 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5740 <span class=
"hljs-attr">"avatar
"</span>: {
5741 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5742 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5743 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5758 <div id=
"definition-Avatar" class=
"definition panel" data-traverse-target=
"definition-Avatar">
5759 <h2 class=
"panel-title">
5760 <a name=
"/definitions/Avatar"></a>Avatar:
5761 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
5762 <span class="json-property-range" title="Value limits"></span>
5767 <div class=
"doc-row">
5768 <div class=
"doc-copy">
5769 <section class=
"json-schema-properties">
5771 <dt data-property-name=
"path">
5772 <span class=
"json-property-name">path:
</span>
5773 <span class=
"json-property-type">string
</span>
5774 <span class=
"json-property-range" title=
"Value limits"></span>
5776 <dt data-property-name=
"createdAt">
5777 <span class=
"json-property-name">createdAt:
</span>
5778 <span class=
"json-property-type">string
</span>
5779 <span class=
"json-property-range" title=
"Value limits"></span>
5781 <dt data-property-name=
"updatedAt">
5782 <span class=
"json-property-name">updatedAt:
</span>
5783 <span class=
"json-property-type">string
</span>
5784 <span class=
"json-property-range" title=
"Value limits"></span>
5789 <div class=
"doc-examples">
5792 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5793 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5794 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5795 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5803 <div id=
"definition-Actor" class=
"definition panel" data-traverse-target=
"definition-Actor">
5804 <h2 class=
"panel-title">
5805 <a name=
"/definitions/Actor"></a>Actor:
5806 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
5807 <span class="json-property-range" title="Value limits"></span>
5812 <div class=
"doc-row">
5813 <div class=
"doc-copy">
5814 <section class=
"json-schema-properties">
5816 <dt data-property-name=
"id">
5817 <span class=
"json-property-name">id:
</span>
5818 <span class=
"json-property-type">number
</span>
5819 <span class=
"json-property-range" title=
"Value limits"></span>
5821 <dt data-property-name=
"uuid">
5822 <span class=
"json-property-name">uuid:
</span>
5823 <span class=
"json-property-type">string
</span>
5824 <span class=
"json-property-range" title=
"Value limits"></span>
5826 <dt data-property-name=
"url">
5827 <span class=
"json-property-name">url:
</span>
5828 <span class=
"json-property-type">string
</span>
5829 <span class=
"json-property-range" title=
"Value limits"></span>
5831 <dt data-property-name=
"name">
5832 <span class=
"json-property-name">name:
</span>
5833 <span class=
"json-property-type">string
</span>
5834 <span class=
"json-property-range" title=
"Value limits"></span>
5836 <dt data-property-name=
"host">
5837 <span class=
"json-property-name">host:
</span>
5838 <span class=
"json-property-type">string
</span>
5839 <span class=
"json-property-range" title=
"Value limits"></span>
5841 <dt data-property-name=
"followingCount">
5842 <span class=
"json-property-name">followingCount:
</span>
5843 <span class=
"json-property-type">number
</span>
5844 <span class=
"json-property-range" title=
"Value limits"></span>
5846 <dt data-property-name=
"followersCount">
5847 <span class=
"json-property-name">followersCount:
</span>
5848 <span class=
"json-property-type">number
</span>
5849 <span class=
"json-property-range" title=
"Value limits"></span>
5851 <dt data-property-name=
"createdAt">
5852 <span class=
"json-property-name">createdAt:
</span>
5853 <span class=
"json-property-type">string
</span>
5854 <span class=
"json-property-range" title=
"Value limits"></span>
5856 <dt data-property-name=
"updatedAt">
5857 <span class=
"json-property-name">updatedAt:
</span>
5858 <span class=
"json-property-type">string
</span>
5859 <span class=
"json-property-range" title=
"Value limits"></span>
5861 <dt data-property-name=
"avatar">
5862 <span class=
"json-property-name">avatar:
</span>
5863 <span class=
"json-property-type">
5865 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
5868 <span class=
"json-property-range" title=
"Value limits"></span>
5873 <div class=
"doc-examples">
5876 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5877 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5878 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5879 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5880 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5881 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5882 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5883 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5884 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5885 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5886 <span class=
"hljs-attr">"avatar
"</span>: {
5887 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5888 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5889 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5898 <div id=
"definition-Account" class=
"definition panel" data-traverse-target=
"definition-Account">
5899 <h2 class=
"panel-title">
5900 <a name=
"/definitions/Account"></a>Account:
5901 <!-- <span class="json-property-type"><span class="json-property-type"></span>
5902 <span class="json-property-range" title="Value limits"></span>
5907 <div class=
"doc-row">
5908 <div class=
"doc-copy">
5909 <section class=
"json-schema-allOf">
5910 <section class=
"json-schema-allOf-inherited">
5913 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
5917 <section class=
"json-schema-allOf-additional">
5918 <section class=
"json-schema-properties">
5920 <dt data-property-name=
"displayName">
5921 <span class=
"json-property-name">displayName:
</span>
5922 <span class=
"json-property-type">string
</span>
5923 <span class=
"json-property-range" title=
"Value limits"></span>
5930 <div class=
"doc-examples">
5933 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5934 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5935 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5936 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5937 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5938 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5939 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5940 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5941 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5942 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5943 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5944 <span class=
"hljs-attr">"avatar
"</span>: {
5945 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5946 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5947 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5956 <div id=
"definition-User" class=
"definition panel" data-traverse-target=
"definition-User">
5957 <h2 class=
"panel-title">
5958 <a name=
"/definitions/User"></a>User:
5959 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
5960 <span class="json-property-range" title="Value limits"></span>
5965 <div class=
"doc-row">
5966 <div class=
"doc-copy">
5967 <section class=
"json-schema-properties">
5969 <dt data-property-name=
"id">
5970 <span class=
"json-property-name">id:
</span>
5971 <span class=
"json-property-type">number
</span>
5972 <span class=
"json-property-range" title=
"Value limits"></span>
5974 <dt data-property-name=
"username">
5975 <span class=
"json-property-name">username:
</span>
5976 <span class=
"json-property-type">string
</span>
5977 <span class=
"json-property-range" title=
"Value limits"></span>
5979 <dt data-property-name=
"email">
5980 <span class=
"json-property-name">email:
</span>
5981 <span class=
"json-property-type">string
</span>
5982 <span class=
"json-property-range" title=
"Value limits"></span>
5984 <dt data-property-name=
"displayNSFW">
5985 <span class=
"json-property-name">displayNSFW:
</span>
5986 <span class=
"json-property-type">boolean
</span>
5987 <span class=
"json-property-range" title=
"Value limits"></span>
5989 <dt data-property-name=
"autoPlayVideo">
5990 <span class=
"json-property-name">autoPlayVideo:
</span>
5991 <span class=
"json-property-type">boolean
</span>
5992 <span class=
"json-property-range" title=
"Value limits"></span>
5994 <dt data-property-name=
"role">
5995 <span class=
"json-property-name">role:
</span>
5996 <span class=
"json-property-type">string
</span>
5997 <span class=
"json-property-enum" title=
"Possible values">
5998 <span class=
"json-property-enum-item">User
</span>,
5999 <span class=
"json-property-enum-item">Moderator
</span>,
6000 <span class=
"json-property-enum-item">Administrator
</span>
6002 <span class=
"json-property-range" title=
"Value limits"></span>
6004 <dt data-property-name=
"videoQuota">
6005 <span class=
"json-property-name">videoQuota:
</span>
6006 <span class=
"json-property-type">number
</span>
6007 <span class=
"json-property-range" title=
"Value limits"></span>
6009 <dt data-property-name=
"createdAt">
6010 <span class=
"json-property-name">createdAt:
</span>
6011 <span class=
"json-property-type">string
</span>
6012 <span class=
"json-property-range" title=
"Value limits"></span>
6014 <dt data-property-name=
"account">
6015 <span class=
"json-property-name">account:
</span>
6016 <span class=
"json-property-type">
6018 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
6021 <span class=
"json-property-range" title=
"Value limits"></span>
6023 <dt data-property-name=
"videoChannels">
6024 <span class=
"json-property-name">videoChannels:
</span>
6025 <span class=
"json-property-type">
6026 <span class=
"json-schema-ref-array">
6027 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
6030 <span class=
"json-property-range" title=
"Value limits"></span>
6035 <div class=
"doc-examples">
6038 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6039 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6040 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
6041 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
6042 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6043 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6044 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
6045 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
6046 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6047 <span class=
"hljs-attr">"account
"</span>: {
6048 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6049 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6050 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6051 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6052 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6053 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6054 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6055 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6056 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6057 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6058 <span class=
"hljs-attr">"avatar
"</span>: {
6059 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6060 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6061 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6064 <span class=
"hljs-attr">"videoChannels
"</span>: [
6066 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6067 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6068 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6069 <span class=
"hljs-attr">"owner
"</span>: {
6070 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6071 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
6073 <span class=
"hljs-attr">"videos
"</span>: [
6075 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6076 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6077 <span class=
"hljs-attr">"accountName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6078 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6079 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6080 <span class=
"hljs-attr">"categoryLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
6081 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"number
"</span>,
6082 <span class=
"hljs-attr">"licenceLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
6083 <span class=
"hljs-attr">"licence
"</span>:
<span class=
"hljs-string">"number
"</span>,
6084 <span class=
"hljs-attr">"languageLabel
"</span>:
<span class=
"hljs-string">"string
"</span>,
6085 <span class=
"hljs-attr">"language
"</span>:
<span class=
"hljs-string">"number
"</span>,
6086 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6087 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6088 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6089 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6090 <span class=
"hljs-attr">"serverHost
"</span>:
<span class=
"hljs-string">"string
"</span>,
6091 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6092 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6093 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6094 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6095 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6096 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6097 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
6109 <div id=
"definition-ServerConfig" class=
"definition panel" data-traverse-target=
"definition-ServerConfig">
6110 <h2 class=
"panel-title">
6111 <a name=
"/definitions/ServerConfig"></a>ServerConfig:
6112 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6113 <span class="json-property-range" title="Value limits"></span>
6118 <div class=
"doc-row">
6119 <div class=
"doc-copy">
6120 <section class=
"json-schema-properties">
6122 <dt data-property-name=
"signup">
6123 <span class=
"json-property-name">signup:
</span>
6124 <span class=
"json-property-type">object
</span>
6125 <span class=
"json-property-range" title=
"Value limits"></span>
6127 <dt data-property-name=
"transcoding">
6128 <span class=
"json-property-name">transcoding:
</span>
6129 <span class=
"json-property-type">object
</span>
6130 <span class=
"json-property-range" title=
"Value limits"></span>
6132 <dt data-property-name=
"avatar">
6133 <span class=
"json-property-name">avatar:
</span>
6134 <span class=
"json-property-type">object
</span>
6135 <span class=
"json-property-range" title=
"Value limits"></span>
6137 <dt data-property-name=
"video">
6138 <span class=
"json-property-name">video:
</span>
6139 <span class=
"json-property-type">object
</span>
6140 <span class=
"json-property-range" title=
"Value limits"></span>
6145 <div class=
"doc-examples">
6148 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6149 <span class=
"hljs-attr">"signup
"</span>: {
6150 <span class=
"hljs-attr">"allowed
"</span>:
<span class=
"hljs-string">"boolean
"</span>
6152 <span class=
"hljs-attr">"transcoding
"</span>: {
6153 <span class=
"hljs-attr">"enabledResolutions
"</span>: [
6154 <span class=
"hljs-string">"number
"</span>
6157 <span class=
"hljs-attr">"avatar
"</span>: {
6158 <span class=
"hljs-attr">"file
"</span>: {
6159 <span class=
"hljs-attr">"size
"</span>: {
6160 <span class=
"hljs-attr">"max
"</span>:
<span class=
"hljs-string">"number
"</span>
6163 <span class=
"hljs-attr">"extensions
"</span>: [
6164 <span class=
"hljs-string">"string
"</span>
6167 <span class=
"hljs-attr">"video
"</span>: {
6168 <span class=
"hljs-attr">"file
"</span>: {
6169 <span class=
"hljs-attr">"extensions
"</span>: [
6170 <span class=
"hljs-string">"string
"</span>
6181 <div id=
"definition-Follow" class=
"definition panel" data-traverse-target=
"definition-Follow">
6182 <h2 class=
"panel-title">
6183 <a name=
"/definitions/Follow"></a>Follow:
6184 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6185 <span class="json-property-range" title="Value limits"></span>
6190 <div class=
"doc-row">
6191 <div class=
"doc-copy">
6192 <section class=
"json-schema-properties">
6194 <dt data-property-name=
"id">
6195 <span class=
"json-property-name">id:
</span>
6196 <span class=
"json-property-type">number
</span>
6197 <span class=
"json-property-range" title=
"Value limits"></span>
6199 <dt data-property-name=
"follower">
6200 <span class=
"json-property-name">follower:
</span>
6201 <span class=
"json-property-type">
6203 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
6206 <span class=
"json-property-range" title=
"Value limits"></span>
6208 <dt data-property-name=
"following">
6209 <span class=
"json-property-name">following:
</span>
6210 <span class=
"json-property-type">
6212 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
6215 <span class=
"json-property-range" title=
"Value limits"></span>
6217 <dt data-property-name=
"score">
6218 <span class=
"json-property-name">score:
</span>
6219 <span class=
"json-property-type">number
</span>
6220 <span class=
"json-property-range" title=
"Value limits"></span>
6222 <dt data-property-name=
"state">
6223 <span class=
"json-property-name">state:
</span>
6224 <span class=
"json-property-type">string
</span>
6225 <span class=
"json-property-enum" title=
"Possible values">
6226 <span class=
"json-property-enum-item">pending
</span>,
6227 <span class=
"json-property-enum-item">accepted
</span>
6229 <span class=
"json-property-range" title=
"Value limits"></span>
6231 <dt data-property-name=
"createdAt">
6232 <span class=
"json-property-name">createdAt:
</span>
6233 <span class=
"json-property-type">string
</span>
6234 <span class=
"json-property-range" title=
"Value limits"></span>
6236 <dt data-property-name=
"updatedAt">
6237 <span class=
"json-property-name">updatedAt:
</span>
6238 <span class=
"json-property-type">string
</span>
6239 <span class=
"json-property-range" title=
"Value limits"></span>
6244 <div class=
"doc-examples">
6247 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6248 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6249 <span class=
"hljs-attr">"follower
"</span>: {
6250 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6251 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6252 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6253 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6254 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6255 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6256 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6257 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6258 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6259 <span class=
"hljs-attr">"avatar
"</span>: {
6260 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6261 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6262 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6265 <span class=
"hljs-attr">"following
"</span>: {
6266 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6267 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6268 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6269 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6270 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6271 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6272 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6273 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6274 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6275 <span class=
"hljs-attr">"avatar
"</span>: {
6276 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6277 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6278 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6281 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
6282 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
6283 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6284 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6292 <div id=
"definition-Job" class=
"definition panel" data-traverse-target=
"definition-Job">
6293 <h2 class=
"panel-title">
6294 <a name=
"/definitions/Job"></a>Job:
6295 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6296 <span class="json-property-range" title="Value limits"></span>
6301 <div class=
"doc-row">
6302 <div class=
"doc-copy">
6303 <section class=
"json-schema-properties">
6305 <dt data-property-name=
"id">
6306 <span class=
"json-property-name">id:
</span>
6307 <span class=
"json-property-type">number
</span>
6308 <span class=
"json-property-range" title=
"Value limits"></span>
6310 <dt data-property-name=
"state">
6311 <span class=
"json-property-name">state:
</span>
6312 <span class=
"json-property-type">string
</span>
6313 <span class=
"json-property-enum" title=
"Possible values">
6314 <span class=
"json-property-enum-item">pending
</span>,
6315 <span class=
"json-property-enum-item">processing
</span>,
6316 <span class=
"json-property-enum-item">error
</span>,
6317 <span class=
"json-property-enum-item">success
</span>
6319 <span class=
"json-property-range" title=
"Value limits"></span>
6321 <dt data-property-name=
"category">
6322 <span class=
"json-property-name">category:
</span>
6323 <span class=
"json-property-type">string
</span>
6324 <span class=
"json-property-enum" title=
"Possible values">
6325 <span class=
"json-property-enum-item">transcoding
</span>,
6326 <span class=
"json-property-enum-item">activitypub-http
</span>
6328 <span class=
"json-property-range" title=
"Value limits"></span>
6330 <dt data-property-name=
"handlerName">
6331 <span class=
"json-property-name">handlerName:
</span>
6332 <span class=
"json-property-type">string
</span>
6333 <span class=
"json-property-range" title=
"Value limits"></span>
6335 <dt data-property-name=
"handlerInputData">
6336 <span class=
"json-property-name">handlerInputData:
</span>
6337 <span class=
"json-property-type">string
</span>
6338 <span class=
"json-property-range" title=
"Value limits"></span>
6340 <dt data-property-name=
"createdAt">
6341 <span class=
"json-property-name">createdAt:
</span>
6342 <span class=
"json-property-type">string
</span>
6343 <span class=
"json-property-range" title=
"Value limits"></span>
6345 <dt data-property-name=
"updatedAt">
6346 <span class=
"json-property-name">updatedAt:
</span>
6347 <span class=
"json-property-type">string
</span>
6348 <span class=
"json-property-range" title=
"Value limits"></span>
6353 <div class=
"doc-examples">
6356 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6357 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6358 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
6359 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"string
"</span>,
6360 <span class=
"hljs-attr">"handlerName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6361 <span class=
"hljs-attr">"handlerInputData
"</span>:
<span class=
"hljs-string">"string
"</span>,
6362 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6363 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6371 <div id=
"definition-AddUserResponse" class=
"definition panel" data-traverse-target=
"definition-AddUserResponse">
6372 <h2 class=
"panel-title">
6373 <a name=
"/definitions/AddUserResponse"></a>AddUserResponse:
6374 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6375 <span class="json-property-range" title="Value limits"></span>
6380 <div class=
"doc-row">
6381 <div class=
"doc-copy">
6382 <section class=
"json-schema-properties">
6384 <dt data-property-name=
"id">
6385 <span class=
"json-property-name">id:
</span>
6386 <span class=
"json-property-type">number
</span>
6387 <span class=
"json-property-range" title=
"Value limits"></span>
6389 <dt data-property-name=
"uuid">
6390 <span class=
"json-property-name">uuid:
</span>
6391 <span class=
"json-property-type">string
</span>
6392 <span class=
"json-property-range" title=
"Value limits"></span>
6397 <div class=
"doc-examples">
6400 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6401 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6402 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
6410 <div id=
"definition-VideoUploadResponse" class=
"definition panel" data-traverse-target=
"definition-VideoUploadResponse">
6411 <h2 class=
"panel-title">
6412 <a name=
"/definitions/VideoUploadResponse"></a>VideoUploadResponse:
6413 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6414 <span class="json-property-range" title="Value limits"></span>
6419 <div class=
"doc-row">
6420 <div class=
"doc-copy">
6421 <section class=
"json-schema-properties">
6423 <dt data-property-name=
"id">
6424 <span class=
"json-property-name">id:
</span>
6425 <span class=
"json-property-type">number
</span>
6426 <span class=
"json-property-range" title=
"Value limits"></span>
6428 <dt data-property-name=
"uuid">
6429 <span class=
"json-property-name">uuid:
</span>
6430 <span class=
"json-property-type">string
</span>
6431 <span class=
"json-property-range" title=
"Value limits"></span>
6436 <div class=
"doc-examples">
6439 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6440 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6441 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
6449 <div id=
"definition-CommentThreadResponse" class=
"definition panel" data-traverse-target=
"definition-CommentThreadResponse">
6450 <h2 class=
"panel-title">
6451 <a name=
"/definitions/CommentThreadResponse"></a>CommentThreadResponse:
6452 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6453 <span class="json-property-range" title="Value limits"></span>
6458 <div class=
"doc-row">
6459 <div class=
"doc-copy">
6460 <section class=
"json-schema-properties">
6462 <dt data-property-name=
"total">
6463 <span class=
"json-property-name">total:
</span>
6464 <span class=
"json-property-type">number
</span>
6465 <span class=
"json-property-range" title=
"Value limits"></span>
6467 <dt data-property-name=
"data">
6468 <span class=
"json-property-name">data:
</span>
6469 <span class=
"json-property-type">
6470 <span class=
"json-schema-ref-array">
6471 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
6474 <span class=
"json-property-range" title=
"Value limits"></span>
6479 <div class=
"doc-examples">
6482 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6483 <span class=
"hljs-attr">"total
"</span>:
<span class=
"hljs-string">"number
"</span>,
6484 <span class=
"hljs-attr">"data
"</span>: [
6486 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6487 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6488 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6489 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6490 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6491 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6492 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6493 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6494 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6495 <span class=
"hljs-attr">"account
"</span>: {
6496 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6497 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6498 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6499 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6500 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6501 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6502 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6503 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6504 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6505 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6506 <span class=
"hljs-attr">"avatar
"</span>: {
6507 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</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>
6521 <div id=
"definition-CommentThreadPostResponse" class=
"definition panel" data-traverse-target=
"definition-CommentThreadPostResponse">
6522 <h2 class=
"panel-title">
6523 <a name=
"/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse:
6524 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6525 <span class="json-property-range" title="Value limits"></span>
6530 <div class=
"doc-row">
6531 <div class=
"doc-copy">
6532 <section class=
"json-schema-properties">
6534 <dt data-property-name=
"comment">
6535 <span class=
"json-property-name">comment:
</span>
6536 <span class=
"json-property-type">
6538 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
6541 <span class=
"json-property-range" title=
"Value limits"></span>
6546 <div class=
"doc-examples">
6549 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6550 <span class=
"hljs-attr">"comment
"</span>: {
6551 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6552 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6553 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6554 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6555 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6556 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6557 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6558 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6559 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6560 <span class=
"hljs-attr">"account
"</span>: {
6561 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6562 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6563 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6564 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6565 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6566 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6567 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6568 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6569 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6570 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6571 <span class=
"hljs-attr">"avatar
"</span>: {
6572 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6573 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6574 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6585 <div id=
"definition-AddUser" class=
"definition panel" data-traverse-target=
"definition-AddUser">
6586 <h2 class=
"panel-title">
6587 <a name=
"/definitions/AddUser"></a>AddUser:
6588 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6589 <span class="json-property-range" title="Value limits"></span>
6594 <div class=
"doc-row">
6595 <div class=
"doc-copy">
6596 <section class=
"json-schema-properties">
6598 <dt data-property-name=
"username" class=
"has-description">
6599 <span class=
"json-property-name">username:
</span>
6600 <span class=
"json-property-type">string
</span>
6601 <span class=
"json-property-range" title=
"Value limits"></span>
6602 <span class=
"json-property-required"></span>
6605 <p>The user username
</p>
6607 <dt data-property-name=
"password" class=
"has-description">
6608 <span class=
"json-property-name">password:
</span>
6609 <span class=
"json-property-type">string
</span>
6610 <span class=
"json-property-range" title=
"Value limits"></span>
6611 <span class=
"json-property-required"></span>
6614 <p>The user password
</p>
6616 <dt data-property-name=
"email" class=
"has-description">
6617 <span class=
"json-property-name">email:
</span>
6618 <span class=
"json-property-type">string
</span>
6619 <span class=
"json-property-range" title=
"Value limits"></span>
6620 <span class=
"json-property-required"></span>
6623 <p>The user email
</p>
6625 <dt data-property-name=
"videoQuota" class=
"has-description">
6626 <span class=
"json-property-name">videoQuota:
</span>
6627 <span class=
"json-property-type">string
</span>
6628 <span class=
"json-property-range" title=
"Value limits"></span>
6629 <span class=
"json-property-required"></span>
6632 <p>The user videoQuota
</p>
6634 <dt data-property-name=
"role" class=
"has-description">
6635 <span class=
"json-property-name">role:
</span>
6636 <span class=
"json-property-type">string
</span>
6637 <span class=
"json-property-range" title=
"Value limits"></span>
6638 <span class=
"json-property-required"></span>
6641 <p>The user role
</p>
6646 <div class=
"doc-examples">
6649 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6650 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
6651 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
6652 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
6653 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
6654 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
6662 <div id=
"definition-UpdateUser" class=
"definition panel" data-traverse-target=
"definition-UpdateUser">
6663 <h2 class=
"panel-title">
6664 <a name=
"/definitions/UpdateUser"></a>UpdateUser:
6665 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6666 <span class="json-property-range" title="Value limits"></span>
6671 <div class=
"doc-row">
6672 <div class=
"doc-copy">
6673 <section class=
"json-schema-properties">
6675 <dt data-property-name=
"id" class=
"has-description">
6676 <span class=
"json-property-name">id:
</span>
6677 <span class=
"json-property-type">string
</span>
6678 <span class=
"json-property-range" title=
"Value limits"></span>
6679 <span class=
"json-property-required"></span>
6684 <dt data-property-name=
"email" class=
"has-description">
6685 <span class=
"json-property-name">email:
</span>
6686 <span class=
"json-property-type">string
</span>
6687 <span class=
"json-property-range" title=
"Value limits"></span>
6688 <span class=
"json-property-required"></span>
6691 <p>The updated email of the user
</p>
6693 <dt data-property-name=
"videoQuota" class=
"has-description">
6694 <span class=
"json-property-name">videoQuota:
</span>
6695 <span class=
"json-property-type">string
</span>
6696 <span class=
"json-property-range" title=
"Value limits"></span>
6697 <span class=
"json-property-required"></span>
6700 <p>The updated videoQuota of the user
</p>
6702 <dt data-property-name=
"role" class=
"has-description">
6703 <span class=
"json-property-name">role:
</span>
6704 <span class=
"json-property-type">string
</span>
6705 <span class=
"json-property-range" title=
"Value limits"></span>
6706 <span class=
"json-property-required"></span>
6709 <p>The updated role of the user
</p>
6714 <div class=
"doc-examples">
6717 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6718 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
6719 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
6720 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
6721 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
6729 <div id=
"definition-UpdateMe" class=
"definition panel" data-traverse-target=
"definition-UpdateMe">
6730 <h2 class=
"panel-title">
6731 <a name=
"/definitions/UpdateMe"></a>UpdateMe:
6732 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6733 <span class="json-property-range" title="Value limits"></span>
6738 <div class=
"doc-row">
6739 <div class=
"doc-copy">
6740 <section class=
"json-schema-properties">
6742 <dt data-property-name=
"password" class=
"has-description">
6743 <span class=
"json-property-name">password:
</span>
6744 <span class=
"json-property-type">string
</span>
6745 <span class=
"json-property-range" title=
"Value limits"></span>
6746 <span class=
"json-property-required"></span>
6749 <p>Your new password
</p>
6751 <dt data-property-name=
"email" class=
"has-description">
6752 <span class=
"json-property-name">email:
</span>
6753 <span class=
"json-property-type">string
</span>
6754 <span class=
"json-property-range" title=
"Value limits"></span>
6755 <span class=
"json-property-required"></span>
6758 <p>Your new email
</p>
6760 <dt data-property-name=
"displayNSFW" class=
"has-description">
6761 <span class=
"json-property-name">displayNSFW:
</span>
6762 <span class=
"json-property-type">string
</span>
6763 <span class=
"json-property-range" title=
"Value limits"></span>
6764 <span class=
"json-property-required"></span>
6767 <p>Your new displayNSFW
</p>
6769 <dt data-property-name=
"autoPlayVideo" class=
"has-description">
6770 <span class=
"json-property-name">autoPlayVideo:
</span>
6771 <span class=
"json-property-type">string
</span>
6772 <span class=
"json-property-range" title=
"Value limits"></span>
6773 <span class=
"json-property-required"></span>
6776 <p>Your new autoPlayVideo
</p>
6781 <div class=
"doc-examples">
6784 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6785 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
6786 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
6787 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"string
"</span>,
6788 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"string
"</span>
6796 <div id=
"definition-GetMeVideoRating" class=
"definition panel" data-traverse-target=
"definition-GetMeVideoRating">
6797 <h2 class=
"panel-title">
6798 <a name=
"/definitions/GetMeVideoRating"></a>GetMeVideoRating:
6799 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6800 <span class="json-property-range" title="Value limits"></span>
6805 <div class=
"doc-row">
6806 <div class=
"doc-copy">
6807 <section class=
"json-schema-properties">
6809 <dt data-property-name=
"id" class=
"has-description">
6810 <span class=
"json-property-name">id:
</span>
6811 <span class=
"json-property-type">string
</span>
6812 <span class=
"json-property-range" title=
"Value limits"></span>
6813 <span class=
"json-property-required"></span>
6816 <p>Id of the video
</p>
6818 <dt data-property-name=
"rating" class=
"has-description">
6819 <span class=
"json-property-name">rating:
</span>
6820 <span class=
"json-property-type">number
</span>
6821 <span class=
"json-property-range" title=
"Value limits"></span>
6822 <span class=
"json-property-required"></span>
6825 <p>Rating of the video
</p>
6830 <div class=
"doc-examples">
6833 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6834 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
6835 <span class=
"hljs-attr">"rating
"</span>:
<span class=
"hljs-string">"number
"</span>
6843 <div id=
"definition-RegisterUser" class=
"definition panel" data-traverse-target=
"definition-RegisterUser">
6844 <h2 class=
"panel-title">
6845 <a name=
"/definitions/RegisterUser"></a>RegisterUser:
6846 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6847 <span class="json-property-range" title="Value limits"></span>
6852 <div class=
"doc-row">
6853 <div class=
"doc-copy">
6854 <section class=
"json-schema-properties">
6856 <dt data-property-name=
"username" class=
"has-description">
6857 <span class=
"json-property-name">username:
</span>
6858 <span class=
"json-property-type">string
</span>
6859 <span class=
"json-property-range" title=
"Value limits"></span>
6860 <span class=
"json-property-required"></span>
6863 <p>The username of the user
</p>
6865 <dt data-property-name=
"password" class=
"has-description">
6866 <span class=
"json-property-name">password:
</span>
6867 <span class=
"json-property-type">string
</span>
6868 <span class=
"json-property-range" title=
"Value limits"></span>
6869 <span class=
"json-property-required"></span>
6872 <p>The password of the user
</p>
6874 <dt data-property-name=
"email" class=
"has-description">
6875 <span class=
"json-property-name">email:
</span>
6876 <span class=
"json-property-type">string
</span>
6877 <span class=
"json-property-range" title=
"Value limits"></span>
6878 <span class=
"json-property-required"></span>
6881 <p>The email of the user
</p>
6886 <div class=
"doc-examples">
6889 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6890 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
6891 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
6892 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>
6900 <div id=
"definition-VideoChannelInput" class=
"definition panel" data-traverse-target=
"definition-VideoChannelInput">
6901 <h2 class=
"panel-title">
6902 <a name=
"/definitions/VideoChannelInput"></a>VideoChannelInput:
6903 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6904 <span class="json-property-range" title="Value limits"></span>
6909 <div class=
"doc-row">
6910 <div class=
"doc-copy">
6911 <section class=
"json-schema-properties">
6913 <dt data-property-name=
"name">
6914 <span class=
"json-property-name">name:
</span>
6915 <span class=
"json-property-type">string
</span>
6916 <span class=
"json-property-range" title=
"Value limits"></span>
6918 <dt data-property-name=
"description">
6919 <span class=
"json-property-name">description:
</span>
6920 <span class=
"json-property-type">string
</span>
6921 <span class=
"json-property-range" title=
"Value limits"></span>
6926 <div class=
"doc-examples">
6929 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6930 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6931 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
6939 <div class=
"doc-row no-margin">
6940 <div class=
"doc-copy doc-separator">
6941 <a class=
"powered-by" href=
"https://sourcey.com/spectacle">Documentation by
6942 <span>Spectacle
</span>