2 <html class=
"no-js" lang=
"en">
4 <meta charset=
"utf-8" />
5 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0" />
6 <title>PeerTube | API Reference
</title>
7 <link rel=
"stylesheet" href=
"stylesheets/foundation.min.css" />
8 <link rel=
"stylesheet" href=
"stylesheets/spectacle.min.css" />
9 <script src=
"https://code.jquery.com/jquery-2.1.4.min.js"></script>
10 <!-- <script src="javascripts/foundation.js"></script> -->
11 <script src=
"javascripts/spectacle.min.js"></script>
14 <div id=
"page" class=
"drawer-layout drawer-slide-right-large">
16 <button class=
"close-button" aria-label=
"Close menu" type=
"button" data-drawer-close
>
17 <span aria-hidden=
"true">×
</span>
19 <nav id=
"nav" role=
"navigation">
21 <a href=
"#introduction">Introduction
</a>
22 <a href=
"#authentication">Authentication
</a>
25 <a href=
"#tag-Accounts">Accounts
</a>
28 <a href=
"#operation--accounts--id--get"> GET /accounts/{id}
</a>
31 <a href=
"#operation--accounts-get"> GET /accounts
</a>
36 <a href=
"#tag-Config">Config
</a>
39 <a href=
"#operation--config-get"> GET /config
</a>
44 <a href=
"#tag-Job">Job
</a>
47 <a href=
"#operation--jobs-get"> GET /jobs
</a>
52 <a href=
"#tag-ServerFollowing">ServerFollowing
</a>
55 <a href=
"#operation--server-following--host--delete"> DELETE /server/following/{host}
</a>
58 <a href=
"#operation--server-followers-get"> GET /server/followers
</a>
61 <a href=
"#operation--server-following-get"> GET /server/following
</a>
64 <a href=
"#operation--server-following-post"> POST /server/following
</a>
69 <a href=
"#tag-User">User
</a>
72 <a href=
"#operation--users-post"> POST /users
</a>
75 <a href=
"#operation--users-get"> GET /users
</a>
78 <a href=
"#operation--users--id--delete"> DELETE /users/{id}
</a>
81 <a href=
"#operation--users--id--get"> GET /users/{id}
</a>
84 <a href=
"#operation--users--id--put"> PUT /users/{id}
</a>
87 <a href=
"#operation--users-me-get"> GET /users/me
</a>
90 <a href=
"#operation--users-me-put"> PUT /users/me
</a>
93 <a href=
"#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used
</a>
96 <a href=
"#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating
</a>
99 <a href=
"#operation--users-me-videos-get"> GET /users/me/videos
</a>
102 <a href=
"#operation--users-register-post"> POST /users/register
</a>
105 <a href=
"#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick
</a>
110 <a href=
"#tag-Video">Video
</a>
113 <a href=
"#operation--videos-get"> GET /videos
</a>
116 <a href=
"#operation--videos-categories-get"> GET /videos/categories
</a>
119 <a href=
"#operation--videos-licences-get"> GET /videos/licences
</a>
122 <a href=
"#operation--videos-languages-get"> GET /videos/languages
</a>
125 <a href=
"#operation--videos-privacies-get"> GET /videos/privacies
</a>
128 <a href=
"#operation--videos-search-get"> GET /videos/search
</a>
131 <a href=
"#operation--videos--id--put"> PUT /videos/{id}
</a>
134 <a href=
"#operation--videos--id--get"> GET /videos/{id}
</a>
137 <a href=
"#operation--videos--id--delete"> DELETE /videos/{id}
</a>
140 <a href=
"#operation--videos--id--description-get"> GET /videos/{id}/description
</a>
143 <a href=
"#operation--videos--id--views-post"> POST /videos/{id}/views
</a>
146 <a href=
"#operation--videos-upload-post"> POST /videos/upload
</a>
151 <a href=
"#tag-VideoAbuse">VideoAbuse
</a>
154 <a href=
"#operation--videos-abuse-get"> GET /videos/abuse
</a>
157 <a href=
"#operation--videos--id--abuse-post"> POST /videos/{id}/abuse
</a>
162 <a href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
165 <a href=
"#operation--videos--videoId--blacklist-post"> POST /videos/{videoId}/blacklist
</a>
168 <a href=
"#operation--videos--videoId--blacklist-delete"> DELETE /videos/{videoId}/blacklist
</a>
171 <a href=
"#operation--videos-blacklist-get"> GET /videos/blacklist
</a>
176 <a href=
"#tag-VideoChannel">VideoChannel
</a>
179 <a href=
"#operation--videos-channels-get"> GET /videos/channels
</a>
182 <a href=
"#operation--videos-channels-post"> POST /videos/channels
</a>
185 <a href=
"#operation--videos-channels--id--get"> GET /videos/channels/{id}
</a>
188 <a href=
"#operation--videos-channels--id--put"> PUT /videos/channels/{id}
</a>
191 <a href=
"#operation--videos-channels--id--delete"> DELETE /videos/channels/{id}
</a>
194 <a href=
"#operation--videos-accounts--accountId--channels-get"> GET /videos/accounts/{accountId}/channels
</a>
199 <a href=
"#tag-VideoComment">VideoComment
</a>
202 <a href=
"#operation--videos--videoId--comment-threads-get"> GET /videos/{videoId}/comment-threads
</a>
205 <a href=
"#operation--videos--videoId--comment-threads-post"> POST /videos/{videoId}/comment-threads
</a>
208 <a href=
"#operation--videos--videoId--comment-threads--threadId--get"> GET /videos/{videoId}/comment-threads/{threadId}
</a>
211 <a href=
"#operation--videos--videoId--comments--commentId--post"> POST /videos/{videoId}/comments/{commentId}
</a>
214 <a href=
"#operation--videos--videoId--comments--commentId--delete"> DELETE /videos/{videoId}/comments/{commentId}
</a>
219 <a href=
"#tag-VideoRate">VideoRate
</a>
222 <a href=
"#operation--videos--id--rate-put"> PUT /videos/{id}/rate
</a>
226 <h5>Schema Definitions
</h5>
227 <a href=
"#definition-VideoConstant"> VideoConstant
</a>
228 <a href=
"#definition-VideoPrivacy"> VideoPrivacy
</a>
229 <a href=
"#definition-Video"> Video
</a>
230 <a href=
"#definition-VideoAbuse"> VideoAbuse
</a>
231 <a href=
"#definition-VideoBlacklist"> VideoBlacklist
</a>
232 <a href=
"#definition-VideoChannel"> VideoChannel
</a>
233 <a href=
"#definition-VideoComment"> VideoComment
</a>
234 <a href=
"#definition-VideoCommentThreadTree"> VideoCommentThreadTree
</a>
235 <a href=
"#definition-Avatar"> Avatar
</a>
236 <a href=
"#definition-Actor"> Actor
</a>
237 <a href=
"#definition-Account"> Account
</a>
238 <a href=
"#definition-User"> User
</a>
239 <a href=
"#definition-ServerConfig"> ServerConfig
</a>
240 <a href=
"#definition-Follow"> Follow
</a>
241 <a href=
"#definition-Job"> Job
</a>
242 <a href=
"#definition-AddUserResponse"> AddUserResponse
</a>
243 <a href=
"#definition-VideoUploadResponse"> VideoUploadResponse
</a>
244 <a href=
"#definition-CommentThreadResponse"> CommentThreadResponse
</a>
245 <a href=
"#definition-CommentThreadPostResponse"> CommentThreadPostResponse
</a>
246 <a href=
"#definition-AddUser"> AddUser
</a>
247 <a href=
"#definition-UpdateUser"> UpdateUser
</a>
248 <a href=
"#definition-UpdateMe"> UpdateMe
</a>
249 <a href=
"#definition-GetMeVideoRating"> GetMeVideoRating
</a>
250 <a href=
"#definition-RegisterUser"> RegisterUser
</a>
251 <a href=
"#definition-VideoChannelInput"> VideoChannelInput
</a>
254 <div id=
"docs" class=
"row collapse expanded drawer" data-drawer
>
255 <button class=
"floating-menu-icon" type=
"button" data-drawer-slide=
"right">
256 <span class=
"hamburger"></span>
258 <div class=
"example-box doc-content"></div>
260 <h1 class=
"doc-title">PeerTube
261 <span>API Reference
</span>
263 <div id=
"introduction" data-traverse-target=
"introduction">
264 <div class=
"doc-row">
265 <div class=
"doc-copy">
266 <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.
</p>
268 <div class=
"doc-examples">
270 <h5>API Endpoint
</h5>
271 <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1
</code></pre>
277 <span>1.0.0-beta
</span>
283 <!-- <h1 id="security" data-traverse-target="security">Security</h1> -->
284 <h1 id=
"authentication" data-traverse-target=
"authentication">Authentication
</h1>
285 <div id=
"security-definition-OAuth2" class=
"panel">
286 <div class=
"doc-row">
287 <div class=
"doc-copy">
288 <h3 class=
"security-definition-title">
289 <span class=
"security-name">OAuth2
</span>
290 <span class=
"swagger-security-definition-oauth2"></span>
292 <section class=
"security-definition-description">
294 <em>Authorization: Bearer mytoken
</em>
297 <section class=
"swagger-security-definition-properties">
298 <div class=
"prop-row security-definition-property">
299 <div class=
"prop-name">
300 <div class=
"prop-title security-definition-property-name">type
</div>
302 <div class=
"prop-value security-definition-property-type"> oauth2
</div>
304 <div class=
"prop-row security-definition-property">
305 <div class=
"prop-name">
306 <div class=
"prop-title security-definition-property-name">flow
</div>
308 <div class=
"prop-value security-definition-property-type"> password
</div>
310 <div class=
"prop-row security-definition-property">
311 <div class=
"prop-name">
312 <div class=
"prop-title security-definition-property-name">tokenUrl
</div>
314 <div class=
"prop-value security-definition-property-type"> https://peertube.example.com/api/v1/users/token
</div>
320 <h1 id=
"tag-Accounts" class=
"swagger-summary-tag" data-traverse-target=
"tag-Accounts">Accounts
</h1>
321 <div id=
"operation--accounts--id--get" class=
"operation panel" data-traverse-target=
"operation--accounts--id--get">
322 <!-- <section class="operation-tags row"> -->
323 <!-- <div class="doc-copy"> -->
324 <div class=
"operation-tags">
325 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
330 <h2 class=
"operation-title">
331 <span class=
"operation-name">
332 <span class=
"operation-name">GET
</span>
333 <span class=
"operation-path">/accounts/{id}
</span>
336 <div class=
"doc-row">
337 <div class=
"doc-copy">
338 <section class=
"swagger-request-params">
339 <div class=
"prop-row prop-group">
340 <div class=
"prop-name">
341 <div class=
"prop-title">id
</div>
342 <span class=
"json-property-required"></span>
343 <div class=
"prop-subtitle"> in path
</div>
344 <div class=
"prop-subtitle">
345 <span class=
"json-property-type">string
</span>
346 <span class=
"json-property-range" title=
"Value limits"></span>
349 <div class=
"prop-value">
350 <p>The id of the account
</p>
353 <div class=
"prop-row prop-group">
354 <div class=
"prop-name">
355 <div class=
"prop-title">start
</div>
356 <div class=
"prop-subtitle"> in query
</div>
357 <div class=
"prop-subtitle">
358 <span class=
"json-property-type">number
</span>
359 <span class=
"json-property-range" title=
"Value limits"></span>
362 <div class=
"prop-value">
366 <div class=
"prop-row prop-group">
367 <div class=
"prop-name">
368 <div class=
"prop-title">stop
</div>
369 <div class=
"prop-subtitle"> in query
</div>
370 <div class=
"prop-subtitle">
371 <span class=
"json-property-type">number
</span>
372 <span class=
"json-property-range" title=
"Value limits"></span>
375 <div class=
"prop-value">
379 <div class=
"prop-row prop-group">
380 <div class=
"prop-name">
381 <div class=
"prop-title">sort
</div>
382 <div class=
"prop-subtitle"> in query
</div>
383 <div class=
"prop-subtitle">
384 <span class=
"json-property-type">number
</span>
385 <span class=
"json-property-range" title=
"Value limits"></span>
388 <div class=
"prop-value">
394 <div class=
"doc-examples"></div>
396 <div class=
"doc-row">
397 <div class=
"doc-copy">
398 <section class=
"swagger-responses">
399 <div class=
"prop-row prop-group">
400 <div class=
"prop-name">
401 <div class=
"prop-title">200 OK
</div>
402 <div class=
"prop-ref">
404 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
407 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
409 <div class=
"prop-value">
410 <p>successful operation
</p>
415 <div class=
"doc-examples">
416 <h5>Response Content-Types:
417 <span>application/json
</span>
421 <span>(
200 OK)
</span>
423 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
424 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
425 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
426 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
427 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
428 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
429 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
430 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
431 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
432 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
433 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
434 <span class=
"hljs-attr">"avatar
"</span>: {
435 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
436 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
437 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
446 <div id=
"operation--accounts-get" class=
"operation panel" data-traverse-target=
"operation--accounts-get">
447 <!-- <section class="operation-tags row"> -->
448 <!-- <div class="doc-copy"> -->
449 <div class=
"operation-tags">
450 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
455 <h2 class=
"operation-title">
456 <span class=
"operation-name">
457 <span class=
"operation-name">GET
</span>
458 <span class=
"operation-path">/accounts
</span>
461 <div class=
"doc-row">
462 <div class=
"doc-copy"> </div>
463 <div class=
"doc-examples"></div>
465 <div class=
"doc-row">
466 <div class=
"doc-copy">
467 <section class=
"swagger-responses">
468 <div class=
"prop-row prop-group">
469 <div class=
"prop-name">
470 <div class=
"prop-title">200 OK
</div>
471 <div class=
"prop-ref">
472 <span class=
"json-schema-ref-array">
473 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
476 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
478 <div class=
"prop-value">
479 <p>successful operation
</p>
482 <div class=
"prop-row prop-inner">
483 <div class=
"prop-name">type
</div>
484 <div class=
"prop-value">
485 <span class=
"json-property-type">
486 <span class=
"json-schema-ref-array">
487 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
490 <span class=
"json-property-range" title=
"Value limits"></span>
495 <div class=
"doc-examples">
496 <h5>Response Content-Types:
497 <span>application/json
</span>
501 <span>(
200 OK)
</span>
503 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
505 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
506 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
507 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
508 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
509 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
510 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
511 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
512 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
513 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
514 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
515 <span class=
"hljs-attr">"avatar
"</span>: {
516 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
517 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
518 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
528 <h1 id=
"tag-Config" class=
"swagger-summary-tag" data-traverse-target=
"tag-Config">Config
</h1>
529 <div id=
"operation--config-get" class=
"operation panel" data-traverse-target=
"operation--config-get">
530 <!-- <section class="operation-tags row"> -->
531 <!-- <div class="doc-copy"> -->
532 <div class=
"operation-tags">
533 <a class=
"label" href=
"#tag-Config">Config
</a>
538 <h2 class=
"operation-title">
539 <span class=
"operation-name">
540 <span class=
"operation-name">GET
</span>
541 <span class=
"operation-path">/config
</span>
544 <div class=
"doc-row">
545 <div class=
"doc-copy"> </div>
546 <div class=
"doc-examples"></div>
548 <div class=
"doc-row">
549 <div class=
"doc-copy">
550 <section class=
"swagger-responses">
551 <div class=
"prop-row prop-group">
552 <div class=
"prop-name">
553 <div class=
"prop-title">200 OK
</div>
554 <div class=
"prop-ref">
556 <a class=
"json-schema-ref" href=
"#/definitions/ServerConfig">ServerConfig
</a>
559 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
561 <div class=
"prop-value">
562 <p>successful operation
</p>
567 <div class=
"doc-examples">
568 <h5>Response Content-Types:
569 <span>application/json
</span>
573 <span>(
200 OK)
</span>
575 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
576 <span class=
"hljs-attr">"signup
"</span>: {
577 <span class=
"hljs-attr">"allowed
"</span>:
<span class=
"hljs-string">"boolean
"</span>
579 <span class=
"hljs-attr">"transcoding
"</span>: {
580 <span class=
"hljs-attr">"enabledResolutions
"</span>: [
581 <span class=
"hljs-string">"number
"</span>
584 <span class=
"hljs-attr">"avatar
"</span>: {
585 <span class=
"hljs-attr">"file
"</span>: {
586 <span class=
"hljs-attr">"size
"</span>: {
587 <span class=
"hljs-attr">"max
"</span>:
<span class=
"hljs-string">"number
"</span>
590 <span class=
"hljs-attr">"extensions
"</span>: [
591 <span class=
"hljs-string">"string
"</span>
594 <span class=
"hljs-attr">"video
"</span>: {
595 <span class=
"hljs-attr">"file
"</span>: {
596 <span class=
"hljs-attr">"extensions
"</span>: [
597 <span class=
"hljs-string">"string
"</span>
608 <h1 id=
"tag-Job" class=
"swagger-summary-tag" data-traverse-target=
"tag-Job">Job
</h1>
609 <div id=
"operation--jobs-get" class=
"operation panel" data-traverse-target=
"operation--jobs-get">
610 <!-- <section class="operation-tags row"> -->
611 <!-- <div class="doc-copy"> -->
612 <div class=
"operation-tags">
613 <a class=
"label" href=
"#tag-Job">Job
</a>
618 <h2 class=
"operation-title">
619 <span class=
"operation-name">
620 <span class=
"operation-name">GET
</span>
621 <span class=
"operation-path">/jobs
</span>
624 <div class=
"doc-row">
625 <div class=
"doc-copy">
626 <section class=
"swagger-request-params">
627 <div class=
"prop-row prop-group">
628 <div class=
"prop-name">
629 <div class=
"prop-title">state
</div>
630 <span class=
"json-property-required"></span>
631 <div class=
"prop-subtitle"> in path
</div>
632 <div class=
"prop-subtitle">
633 <span class=
"json-property-type">string
</span>
634 <span class=
"json-property-range" title=
"Value limits"></span>
637 <div class=
"prop-value">
638 <p>The id of the account
</p>
641 <div class=
"prop-row prop-group">
642 <div class=
"prop-name">
643 <div class=
"prop-title">start
</div>
644 <div class=
"prop-subtitle"> in query
</div>
645 <div class=
"prop-subtitle">
646 <span class=
"json-property-type">number
</span>
647 <span class=
"json-property-range" title=
"Value limits"></span>
650 <div class=
"prop-value">
654 <div class=
"prop-row prop-group">
655 <div class=
"prop-name">
656 <div class=
"prop-title">count
</div>
657 <div class=
"prop-subtitle"> in query
</div>
658 <div class=
"prop-subtitle">
659 <span class=
"json-property-type">number
</span>
660 <span class=
"json-property-range" title=
"Value limits"></span>
663 <div class=
"prop-value">
664 <p class=
"no-description">(no description)
</p>
667 <div class=
"prop-row prop-group">
668 <div class=
"prop-name">
669 <div class=
"prop-title">sort
</div>
670 <div class=
"prop-subtitle"> in query
</div>
671 <div class=
"prop-subtitle">
672 <span class=
"json-property-type">number
</span>
673 <span class=
"json-property-range" title=
"Value limits"></span>
676 <div class=
"prop-value">
682 <div class=
"doc-examples"></div>
684 <div class=
"doc-row">
685 <div class=
"doc-copy">
686 <section class=
"swagger-responses">
687 <div class=
"prop-row prop-group">
688 <div class=
"prop-name">
689 <div class=
"prop-title">200 OK
</div>
690 <div class=
"prop-ref">
691 <span class=
"json-schema-ref-array">
692 <a class=
"json-schema-ref" href=
"#/definitions/Job">Job
</a>
695 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
697 <div class=
"prop-value">
698 <p>successful operation
</p>
701 <div class=
"prop-row prop-inner">
702 <div class=
"prop-name">type
</div>
703 <div class=
"prop-value">
704 <span class=
"json-property-type">
705 <span class=
"json-schema-ref-array">
706 <a class=
"json-schema-ref" href=
"#/definitions/Job">Job
</a>
709 <span class=
"json-property-range" title=
"Value limits"></span>
714 <div class=
"doc-examples">
715 <h5>Response Content-Types:
716 <span>application/json
</span>
720 <span>(
200 OK)
</span>
722 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
724 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
725 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
726 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"string
"</span>,
727 <span class=
"hljs-attr">"handlerName
"</span>:
<span class=
"hljs-string">"string
"</span>,
728 <span class=
"hljs-attr">"handlerInputData
"</span>:
<span class=
"hljs-string">"string
"</span>,
729 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
730 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
738 <div class=
"doc-row">
739 <div class=
"doc-copy">
740 <section class=
"swagger-request-security">
741 <table class=
"table">
744 <th class=
"swagger-request-security-schema"></th>
745 <th class=
"swagger-request-security-scopes"></th>
751 <a href=
"#security-definition-OAuth2">OAuth2
</a>
761 <h1 id=
"tag-ServerFollowing" class=
"swagger-summary-tag" data-traverse-target=
"tag-ServerFollowing">ServerFollowing
</h1>
762 <div id=
"operation--server-following--host--delete" class=
"operation panel" data-traverse-target=
"operation--server-following--host--delete">
763 <!-- <section class="operation-tags row"> -->
764 <!-- <div class="doc-copy"> -->
765 <div class=
"operation-tags">
766 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
771 <h2 class=
"operation-title">
772 <span class=
"operation-name">
773 <span class=
"operation-name">DELETE
</span>
774 <span class=
"operation-path">/server/following/{host}
</span>
777 <div class=
"doc-row">
778 <div class=
"doc-copy">
779 <section class=
"swagger-request-params">
780 <div class=
"prop-row prop-group">
781 <div class=
"prop-name">
782 <div class=
"prop-title">host
</div>
783 <span class=
"json-property-required"></span>
784 <div class=
"prop-subtitle"> in path
</div>
785 <div class=
"prop-subtitle">
786 <span class=
"json-property-type">string
</span>
787 <span class=
"json-property-range" title=
"Value limits"></span>
790 <div class=
"prop-value">
791 <p>The host to unfollow
</p>
796 <div class=
"doc-examples"></div>
798 <div class=
"doc-row">
799 <div class=
"doc-copy">
800 <section class=
"swagger-responses">
801 <div class=
"prop-row prop-group">
802 <div class=
"prop-name">
803 <div class=
"prop-title">201 Created
</div>
805 <div class=
"prop-value">
806 <p>successful operation
</p>
811 <div class=
"doc-examples">
812 <h5>Response Content-Types:
813 <span>application/json
</span>
817 <div class=
"doc-row">
818 <div class=
"doc-copy">
819 <section class=
"swagger-request-security">
820 <table class=
"table">
823 <th class=
"swagger-request-security-schema"></th>
824 <th class=
"swagger-request-security-scopes"></th>
830 <a href=
"#security-definition-OAuth2">OAuth2
</a>
840 <div id=
"operation--server-followers-get" class=
"operation panel" data-traverse-target=
"operation--server-followers-get">
841 <!-- <section class="operation-tags row"> -->
842 <!-- <div class="doc-copy"> -->
843 <div class=
"operation-tags">
844 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
849 <h2 class=
"operation-title">
850 <span class=
"operation-name">
851 <span class=
"operation-name">GET
</span>
852 <span class=
"operation-path">/server/followers
</span>
855 <div class=
"doc-row">
856 <div class=
"doc-copy">
857 <section class=
"swagger-request-params">
858 <div class=
"prop-row prop-group">
859 <div class=
"prop-name">
860 <div class=
"prop-title">start
</div>
861 <div class=
"prop-subtitle"> in query
</div>
862 <div class=
"prop-subtitle">
863 <span class=
"json-property-type">number
</span>
864 <span class=
"json-property-range" title=
"Value limits"></span>
867 <div class=
"prop-value">
871 <div class=
"prop-row prop-group">
872 <div class=
"prop-name">
873 <div class=
"prop-title">stop
</div>
874 <div class=
"prop-subtitle"> in query
</div>
875 <div class=
"prop-subtitle">
876 <span class=
"json-property-type">number
</span>
877 <span class=
"json-property-range" title=
"Value limits"></span>
880 <div class=
"prop-value">
884 <div class=
"prop-row prop-group">
885 <div class=
"prop-name">
886 <div class=
"prop-title">sort
</div>
887 <div class=
"prop-subtitle"> in query
</div>
888 <div class=
"prop-subtitle">
889 <span class=
"json-property-type">number
</span>
890 <span class=
"json-property-range" title=
"Value limits"></span>
893 <div class=
"prop-value">
899 <div class=
"doc-examples"></div>
901 <div class=
"doc-row">
902 <div class=
"doc-copy">
903 <section class=
"swagger-responses">
904 <div class=
"prop-row prop-group">
905 <div class=
"prop-name">
906 <div class=
"prop-title">200 OK
</div>
907 <div class=
"prop-ref">
908 <span class=
"json-schema-ref-array">
909 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
912 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
914 <div class=
"prop-value">
915 <p>successful operation
</p>
918 <div class=
"prop-row prop-inner">
919 <div class=
"prop-name">type
</div>
920 <div class=
"prop-value">
921 <span class=
"json-property-type">
922 <span class=
"json-schema-ref-array">
923 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
926 <span class=
"json-property-range" title=
"Value limits"></span>
931 <div class=
"doc-examples">
932 <h5>Response Content-Types:
933 <span>application/json
</span>
937 <span>(
200 OK)
</span>
939 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
941 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
942 <span class=
"hljs-attr">"follower
"</span>: {
943 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
944 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
945 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
946 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
947 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
948 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
949 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
950 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
951 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
952 <span class=
"hljs-attr">"avatar
"</span>: {
953 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
954 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
955 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
958 <span class=
"hljs-attr">"following
"</span>: {
959 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
960 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
961 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
962 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
963 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
964 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
965 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
966 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
967 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
968 <span class=
"hljs-attr">"avatar
"</span>: {
969 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
970 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
971 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
974 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
975 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
976 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
977 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
986 <div id=
"operation--server-following-get" class=
"operation panel" data-traverse-target=
"operation--server-following-get">
987 <!-- <section class="operation-tags row"> -->
988 <!-- <div class="doc-copy"> -->
989 <div class=
"operation-tags">
990 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
995 <h2 class=
"operation-title">
996 <span class=
"operation-name">
997 <span class=
"operation-name">GET
</span>
998 <span class=
"operation-path">/server/following
</span>
1001 <div class=
"doc-row">
1002 <div class=
"doc-copy">
1003 <section class=
"swagger-request-params">
1004 <div class=
"prop-row prop-group">
1005 <div class=
"prop-name">
1006 <div class=
"prop-title">start
</div>
1007 <div class=
"prop-subtitle"> in query
</div>
1008 <div class=
"prop-subtitle">
1009 <span class=
"json-property-type">number
</span>
1010 <span class=
"json-property-range" title=
"Value limits"></span>
1013 <div class=
"prop-value">
1014 <p>starting page
</p>
1017 <div class=
"prop-row prop-group">
1018 <div class=
"prop-name">
1019 <div class=
"prop-title">stop
</div>
1020 <div class=
"prop-subtitle"> in query
</div>
1021 <div class=
"prop-subtitle">
1022 <span class=
"json-property-type">number
</span>
1023 <span class=
"json-property-range" title=
"Value limits"></span>
1026 <div class=
"prop-value">
1027 <p>stopping page
</p>
1030 <div class=
"prop-row prop-group">
1031 <div class=
"prop-name">
1032 <div class=
"prop-title">sort
</div>
1033 <div class=
"prop-subtitle"> in query
</div>
1034 <div class=
"prop-subtitle">
1035 <span class=
"json-property-type">number
</span>
1036 <span class=
"json-property-range" title=
"Value limits"></span>
1039 <div class=
"prop-value">
1045 <div class=
"doc-examples"></div>
1047 <div class=
"doc-row">
1048 <div class=
"doc-copy">
1049 <section class=
"swagger-responses">
1050 <div class=
"prop-row prop-group">
1051 <div class=
"prop-name">
1052 <div class=
"prop-title">200 OK
</div>
1053 <div class=
"prop-ref">
1054 <span class=
"json-schema-ref-array">
1055 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1058 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1060 <div class=
"prop-value">
1061 <p>successful operation
</p>
1064 <div class=
"prop-row prop-inner">
1065 <div class=
"prop-name">type
</div>
1066 <div class=
"prop-value">
1067 <span class=
"json-property-type">
1068 <span class=
"json-schema-ref-array">
1069 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1072 <span class=
"json-property-range" title=
"Value limits"></span>
1077 <div class=
"doc-examples">
1078 <h5>Response Content-Types:
1079 <span>application/json
</span>
1082 <h5>Response Example
1083 <span>(
200 OK)
</span>
1085 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1087 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1088 <span class=
"hljs-attr">"follower
"</span>: {
1089 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1090 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1091 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1092 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1093 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1094 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1095 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1096 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1097 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1098 <span class=
"hljs-attr">"avatar
"</span>: {
1099 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1100 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1101 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1104 <span class=
"hljs-attr">"following
"</span>: {
1105 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1106 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1107 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1108 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1109 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1110 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1111 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1112 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1113 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1114 <span class=
"hljs-attr">"avatar
"</span>: {
1115 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1116 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1117 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1120 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1121 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1122 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1123 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1132 <div id=
"operation--server-following-post" class=
"operation panel" data-traverse-target=
"operation--server-following-post">
1133 <!-- <section class="operation-tags row"> -->
1134 <!-- <div class="doc-copy"> -->
1135 <div class=
"operation-tags">
1136 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1141 <h2 class=
"operation-title">
1142 <span class=
"operation-name">
1143 <span class=
"operation-name">POST
</span>
1144 <span class=
"operation-path">/server/following
</span>
1147 <div class=
"doc-row">
1148 <div class=
"doc-copy">
1149 <section class=
"swagger-request-body">
1150 <div class=
"prop-row">
1151 <div class=
"prop-name">
1152 <div class=
"swagger-request-model">
1154 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1158 <div class=
"prop-value columns small-6">
1159 <!-- <div class="swagger-request-description"> -->
1166 <div class=
"doc-examples">
1168 <h5>Request Content-Types:
1169 <span>application/json
</span>
1171 <h5>Request Example
</h5>
1172 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1173 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1174 <span class=
"hljs-attr">"follower
"</span>: {
1175 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1176 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1177 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1178 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1179 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1180 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1181 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1182 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1183 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1184 <span class=
"hljs-attr">"avatar
"</span>: {
1185 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1186 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1187 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1190 <span class=
"hljs-attr">"following
"</span>: {
1191 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1192 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1193 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1194 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1195 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1196 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1197 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1198 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1199 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1200 <span class=
"hljs-attr">"avatar
"</span>: {
1201 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1202 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1203 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1206 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1207 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1208 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1209 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1216 <div class=
"doc-row">
1217 <div class=
"doc-copy">
1218 <section class=
"swagger-responses">
1219 <div class=
"prop-row prop-group">
1220 <div class=
"prop-name">
1221 <div class=
"prop-title">204 No Content
</div>
1223 <div class=
"prop-value">
1224 <p>successful operation
</p>
1229 <div class=
"doc-examples">
1230 <h5>Response Content-Types:
1231 <span>application/json
</span>
1235 <div class=
"doc-row">
1236 <div class=
"doc-copy">
1237 <section class=
"swagger-request-security">
1238 <table class=
"table">
1241 <th class=
"swagger-request-security-schema"></th>
1242 <th class=
"swagger-request-security-scopes"></th>
1248 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1258 <h1 id=
"tag-User" class=
"swagger-summary-tag" data-traverse-target=
"tag-User">User
</h1>
1259 <div id=
"operation--users-post" class=
"operation panel" data-traverse-target=
"operation--users-post">
1260 <!-- <section class="operation-tags row"> -->
1261 <!-- <div class="doc-copy"> -->
1262 <div class=
"operation-tags">
1263 <a class=
"label" href=
"#tag-User">User
</a>
1268 <h2 class=
"operation-title">
1269 <span class=
"operation-name">
1270 <span class=
"operation-name">POST
</span>
1271 <span class=
"operation-path">/users
</span>
1274 <div class=
"doc-row">
1275 <div class=
"doc-copy">
1276 <section class=
"swagger-request-body">
1277 <div class=
"prop-row">
1278 <div class=
"prop-name">
1279 <div class=
"swagger-request-model">
1281 <a class=
"json-schema-ref" href=
"#/definitions/AddUser">AddUser
</a>
1285 <div class=
"prop-value columns small-6">
1286 <!-- <div class="swagger-request-description"> -->
1287 <p>User to create
</p>
1293 <div class=
"doc-examples">
1295 <h5>Request Content-Types:
1296 <span>application/json
</span>
1298 <h5>Request Example
</h5>
1299 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1300 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1301 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
1302 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1303 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
1304 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
1311 <div class=
"doc-row">
1312 <div class=
"doc-copy">
1313 <section class=
"swagger-responses">
1314 <div class=
"prop-row prop-group">
1315 <div class=
"prop-name">
1316 <div class=
"prop-title">200 OK
</div>
1317 <div class=
"prop-ref">
1319 <a class=
"json-schema-ref" href=
"#/definitions/AddUserResponse">AddUserResponse
</a>
1322 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1324 <div class=
"prop-value">
1325 <p>successful operation
</p>
1330 <div class=
"doc-examples">
1331 <h5>Response Content-Types:
1332 <span>application/json
</span>
1335 <h5>Response Example
1336 <span>(
200 OK)
</span>
1338 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1339 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1340 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1347 <div class=
"doc-row">
1348 <div class=
"doc-copy">
1349 <section class=
"swagger-request-security">
1350 <table class=
"table">
1353 <th class=
"swagger-request-security-schema"></th>
1354 <th class=
"swagger-request-security-scopes"></th>
1360 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1370 <div id=
"operation--users-get" class=
"operation panel" data-traverse-target=
"operation--users-get">
1371 <!-- <section class="operation-tags row"> -->
1372 <!-- <div class="doc-copy"> -->
1373 <div class=
"operation-tags">
1374 <a class=
"label" href=
"#tag-User">User
</a>
1379 <h2 class=
"operation-title">
1380 <span class=
"operation-name">
1381 <span class=
"operation-name">GET
</span>
1382 <span class=
"operation-path">/users
</span>
1385 <div class=
"doc-row">
1386 <div class=
"doc-copy">
1387 <section class=
"swagger-request-params">
1388 <div class=
"prop-row prop-group">
1389 <div class=
"prop-name">
1390 <div class=
"prop-title">start
</div>
1391 <div class=
"prop-subtitle"> in query
</div>
1392 <div class=
"prop-subtitle">
1393 <span class=
"json-property-type">number
</span>
1394 <span class=
"json-property-range" title=
"Value limits"></span>
1397 <div class=
"prop-value">
1398 <p>starting page
</p>
1401 <div class=
"prop-row prop-group">
1402 <div class=
"prop-name">
1403 <div class=
"prop-title">stop
</div>
1404 <div class=
"prop-subtitle"> in query
</div>
1405 <div class=
"prop-subtitle">
1406 <span class=
"json-property-type">number
</span>
1407 <span class=
"json-property-range" title=
"Value limits"></span>
1410 <div class=
"prop-value">
1411 <p>stopping page
</p>
1414 <div class=
"prop-row prop-group">
1415 <div class=
"prop-name">
1416 <div class=
"prop-title">sort
</div>
1417 <div class=
"prop-subtitle"> in query
</div>
1418 <div class=
"prop-subtitle">
1419 <span class=
"json-property-type">number
</span>
1420 <span class=
"json-property-range" title=
"Value limits"></span>
1423 <div class=
"prop-value">
1429 <div class=
"doc-examples"></div>
1431 <div class=
"doc-row">
1432 <div class=
"doc-copy">
1433 <section class=
"swagger-responses">
1434 <div class=
"prop-row prop-group">
1435 <div class=
"prop-name">
1436 <div class=
"prop-title">200 OK
</div>
1437 <div class=
"prop-ref">
1438 <span class=
"json-schema-ref-array">
1439 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1442 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1444 <div class=
"prop-value">
1445 <p>successful operation
</p>
1448 <div class=
"prop-row prop-inner">
1449 <div class=
"prop-name">type
</div>
1450 <div class=
"prop-value">
1451 <span class=
"json-property-type">
1452 <span class=
"json-schema-ref-array">
1453 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1456 <span class=
"json-property-range" title=
"Value limits"></span>
1461 <div class=
"doc-examples">
1462 <h5>Response Content-Types:
1463 <span>application/json
</span>
1466 <h5>Response Example
1467 <span>(
200 OK)
</span>
1469 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1471 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1472 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1473 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1474 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1475 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1476 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1477 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1478 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1479 <span class=
"hljs-attr">"account
"</span>: {
1480 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1481 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1482 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1483 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1484 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1485 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1486 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1487 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1488 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1489 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1490 <span class=
"hljs-attr">"avatar
"</span>: {
1491 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1492 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1493 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1496 <span class=
"hljs-attr">"videoChannels
"</span>: [
1498 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1499 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1500 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1501 <span class=
"hljs-attr">"owner
"</span>: {
1502 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1503 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1505 <span class=
"hljs-attr">"videos
"</span>: [
1507 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1508 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1509 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1510 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1511 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1512 <span class=
"hljs-attr">"category
"</span>: {
1513 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1514 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1516 <span class=
"hljs-attr">"licence
"</span>: {
1517 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1518 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1520 <span class=
"hljs-attr">"language
"</span>: {
1521 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1522 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1524 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
1525 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1526 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
1527 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1528 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1529 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1530 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1531 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1532 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
1533 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1534 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1535 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1536 <span class=
"hljs-attr">"account
"</span>: {
1537 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1538 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1539 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1540 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1541 <span class=
"hljs-attr">"avatar
"</span>: {
1542 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1543 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1544 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1558 <div class=
"doc-row">
1559 <div class=
"doc-copy">
1560 <section class=
"swagger-request-security">
1561 <table class=
"table">
1564 <th class=
"swagger-request-security-schema"></th>
1565 <th class=
"swagger-request-security-scopes"></th>
1571 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1581 <div id=
"operation--users--id--delete" class=
"operation panel" data-traverse-target=
"operation--users--id--delete">
1582 <!-- <section class="operation-tags row"> -->
1583 <!-- <div class="doc-copy"> -->
1584 <div class=
"operation-tags">
1585 <a class=
"label" href=
"#tag-User">User
</a>
1590 <h2 class=
"operation-title">
1591 <span class=
"operation-name">
1592 <span class=
"operation-name">DELETE
</span>
1593 <span class=
"operation-path">/users/{id}
</span>
1596 <div class=
"doc-row">
1597 <div class=
"doc-copy">
1598 <section class=
"swagger-request-params">
1599 <div class=
"prop-row prop-group">
1600 <div class=
"prop-name">
1601 <div class=
"prop-title">id
</div>
1602 <span class=
"json-property-required"></span>
1603 <div class=
"prop-subtitle"> in path
</div>
1604 <div class=
"prop-subtitle">
1605 <span class=
"json-property-type">string
</span>
1606 <span class=
"json-property-range" title=
"Value limits"></span>
1609 <div class=
"prop-value">
1615 <div class=
"doc-examples"></div>
1617 <div class=
"doc-row">
1618 <div class=
"doc-copy">
1619 <section class=
"swagger-responses">
1620 <div class=
"prop-row prop-group">
1621 <div class=
"prop-name">
1622 <div class=
"prop-title">204 No Content
</div>
1624 <div class=
"prop-value">
1625 <p>successful operation
</p>
1630 <div class=
"doc-examples">
1631 <h5>Response Content-Types:
1632 <span>application/json
</span>
1636 <div class=
"doc-row">
1637 <div class=
"doc-copy">
1638 <section class=
"swagger-request-security">
1639 <table class=
"table">
1642 <th class=
"swagger-request-security-schema"></th>
1643 <th class=
"swagger-request-security-scopes"></th>
1649 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1659 <div id=
"operation--users--id--get" class=
"operation panel" data-traverse-target=
"operation--users--id--get">
1660 <!-- <section class="operation-tags row"> -->
1661 <!-- <div class="doc-copy"> -->
1662 <div class=
"operation-tags">
1663 <a class=
"label" href=
"#tag-User">User
</a>
1668 <h2 class=
"operation-title">
1669 <span class=
"operation-name">
1670 <span class=
"operation-name">GET
</span>
1671 <span class=
"operation-path">/users/{id}
</span>
1674 <div class=
"doc-row">
1675 <div class=
"doc-copy">
1676 <section class=
"swagger-request-params">
1677 <div class=
"prop-row prop-group">
1678 <div class=
"prop-name">
1679 <div class=
"prop-title">id
</div>
1680 <span class=
"json-property-required"></span>
1681 <div class=
"prop-subtitle"> in path
</div>
1682 <div class=
"prop-subtitle">
1683 <span class=
"json-property-type">string
</span>
1684 <span class=
"json-property-range" title=
"Value limits"></span>
1687 <div class=
"prop-value">
1693 <div class=
"doc-examples"></div>
1695 <div class=
"doc-row">
1696 <div class=
"doc-copy">
1697 <section class=
"swagger-responses">
1698 <div class=
"prop-row prop-group">
1699 <div class=
"prop-name">
1700 <div class=
"prop-title">200 OK
</div>
1701 <div class=
"prop-ref">
1703 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1706 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1708 <div class=
"prop-value">
1709 <p>successful operation
</p>
1714 <div class=
"doc-examples">
1715 <h5>Response Content-Types:
1716 <span>application/json
</span>
1719 <h5>Response Example
1720 <span>(
200 OK)
</span>
1722 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1723 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1724 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1725 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1726 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1727 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1728 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1729 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1730 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1731 <span class=
"hljs-attr">"account
"</span>: {
1732 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1733 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1734 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1735 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1736 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1737 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1738 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1739 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1740 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1741 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1742 <span class=
"hljs-attr">"avatar
"</span>: {
1743 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1744 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1745 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1748 <span class=
"hljs-attr">"videoChannels
"</span>: [
1750 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1751 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1752 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1753 <span class=
"hljs-attr">"owner
"</span>: {
1754 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1755 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1757 <span class=
"hljs-attr">"videos
"</span>: [
1759 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1760 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1761 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1762 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1763 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1764 <span class=
"hljs-attr">"category
"</span>: {
1765 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1766 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1768 <span class=
"hljs-attr">"licence
"</span>: {
1769 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1770 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1772 <span class=
"hljs-attr">"language
"</span>: {
1773 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1774 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
1776 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
1777 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1778 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
1779 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1780 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1781 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1782 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1783 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
1784 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
1785 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1786 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
1787 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1788 <span class=
"hljs-attr">"account
"</span>: {
1789 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1790 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1791 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1792 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1793 <span class=
"hljs-attr">"avatar
"</span>: {
1794 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1795 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1796 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1809 <div class=
"doc-row">
1810 <div class=
"doc-copy">
1811 <section class=
"swagger-request-security">
1812 <table class=
"table">
1815 <th class=
"swagger-request-security-schema"></th>
1816 <th class=
"swagger-request-security-scopes"></th>
1822 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1832 <div id=
"operation--users--id--put" class=
"operation panel" data-traverse-target=
"operation--users--id--put">
1833 <!-- <section class="operation-tags row"> -->
1834 <!-- <div class="doc-copy"> -->
1835 <div class=
"operation-tags">
1836 <a class=
"label" href=
"#tag-User">User
</a>
1841 <h2 class=
"operation-title">
1842 <span class=
"operation-name">
1843 <span class=
"operation-name">PUT
</span>
1844 <span class=
"operation-path">/users/{id}
</span>
1847 <div class=
"doc-row">
1848 <div class=
"doc-copy">
1849 <section class=
"swagger-request-body">
1850 <div class=
"prop-row">
1851 <div class=
"prop-name">
1852 <div class=
"swagger-request-model">
1854 <a class=
"json-schema-ref" href=
"#/definitions/UpdateUser">UpdateUser
</a>
1858 <div class=
"prop-value columns small-6">
1859 <!-- <div class="swagger-request-description"> -->
1865 <section class=
"swagger-request-params">
1866 <div class=
"prop-row prop-group">
1867 <div class=
"prop-name">
1868 <div class=
"prop-title">id
</div>
1869 <span class=
"json-property-required"></span>
1870 <div class=
"prop-subtitle"> in path
</div>
1871 <div class=
"prop-subtitle">
1872 <span class=
"json-property-type">string
</span>
1873 <span class=
"json-property-range" title=
"Value limits"></span>
1876 <div class=
"prop-value">
1882 <div class=
"doc-examples">
1884 <h5>Request Content-Types:
1885 <span>application/json
</span>
1887 <h5>Request Example
</h5>
1888 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1889 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
1890 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1891 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
1892 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
1899 <div class=
"doc-row">
1900 <div class=
"doc-copy">
1901 <section class=
"swagger-responses">
1902 <div class=
"prop-row prop-group">
1903 <div class=
"prop-name">
1904 <div class=
"prop-title">204 No Content
</div>
1906 <div class=
"prop-value">
1907 <p>successful operation
</p>
1912 <div class=
"doc-examples">
1913 <h5>Response Content-Types:
1914 <span>application/json
</span>
1918 <div class=
"doc-row">
1919 <div class=
"doc-copy">
1920 <section class=
"swagger-request-security">
1921 <table class=
"table">
1924 <th class=
"swagger-request-security-schema"></th>
1925 <th class=
"swagger-request-security-scopes"></th>
1931 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1941 <div id=
"operation--users-me-get" class=
"operation panel" data-traverse-target=
"operation--users-me-get">
1942 <!-- <section class="operation-tags row"> -->
1943 <!-- <div class="doc-copy"> -->
1944 <div class=
"operation-tags">
1945 <a class=
"label" href=
"#tag-User">User
</a>
1950 <h2 class=
"operation-title">
1951 <span class=
"operation-name">
1952 <span class=
"operation-name">GET
</span>
1953 <span class=
"operation-path">/users/me
</span>
1956 <div class=
"doc-row">
1957 <div class=
"doc-copy"> </div>
1958 <div class=
"doc-examples"></div>
1960 <div class=
"doc-row">
1961 <div class=
"doc-copy">
1962 <section class=
"swagger-responses">
1963 <div class=
"prop-row prop-group">
1964 <div class=
"prop-name">
1965 <div class=
"prop-title">200 OK
</div>
1966 <div class=
"prop-ref">
1967 <span class=
"json-schema-ref-array">
1968 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1971 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1973 <div class=
"prop-value">
1974 <p>successful operation
</p>
1977 <div class=
"prop-row prop-inner">
1978 <div class=
"prop-name">type
</div>
1979 <div class=
"prop-value">
1980 <span class=
"json-property-type">
1981 <span class=
"json-schema-ref-array">
1982 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1985 <span class=
"json-property-range" title=
"Value limits"></span>
1990 <div class=
"doc-examples">
1991 <h5>Response Content-Types:
1992 <span>application/json
</span>
1995 <h5>Response Example
1996 <span>(
200 OK)
</span>
1998 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2000 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2001 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
2002 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
2003 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2004 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2005 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
2006 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
2007 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2008 <span class=
"hljs-attr">"account
"</span>: {
2009 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2010 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2011 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2012 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2013 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2014 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2015 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
2016 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
2017 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2018 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2019 <span class=
"hljs-attr">"avatar
"</span>: {
2020 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2021 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2022 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2025 <span class=
"hljs-attr">"videoChannels
"</span>: [
2027 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2028 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2029 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2030 <span class=
"hljs-attr">"owner
"</span>: {
2031 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2032 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
2034 <span class=
"hljs-attr">"videos
"</span>: [
2036 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2037 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2038 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2039 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2040 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2041 <span class=
"hljs-attr">"category
"</span>: {
2042 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2043 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2045 <span class=
"hljs-attr">"licence
"</span>: {
2046 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2047 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2049 <span class=
"hljs-attr">"language
"</span>: {
2050 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2051 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2053 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
2054 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2055 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2056 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2057 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2058 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2059 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2060 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2061 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2062 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2063 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2064 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2065 <span class=
"hljs-attr">"account
"</span>: {
2066 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2067 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2068 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2069 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2070 <span class=
"hljs-attr">"avatar
"</span>: {
2071 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2072 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2073 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2087 <div class=
"doc-row">
2088 <div class=
"doc-copy">
2089 <section class=
"swagger-request-security">
2090 <table class=
"table">
2093 <th class=
"swagger-request-security-schema"></th>
2094 <th class=
"swagger-request-security-scopes"></th>
2100 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2110 <div id=
"operation--users-me-put" class=
"operation panel" data-traverse-target=
"operation--users-me-put">
2111 <!-- <section class="operation-tags row"> -->
2112 <!-- <div class="doc-copy"> -->
2113 <div class=
"operation-tags">
2114 <a class=
"label" href=
"#tag-User">User
</a>
2119 <h2 class=
"operation-title">
2120 <span class=
"operation-name">
2121 <span class=
"operation-name">PUT
</span>
2122 <span class=
"operation-path">/users/me
</span>
2125 <div class=
"doc-row">
2126 <div class=
"doc-copy">
2127 <section class=
"swagger-request-body">
2128 <div class=
"prop-row">
2129 <div class=
"prop-name">
2130 <div class=
"swagger-request-model">
2132 <a class=
"json-schema-ref" href=
"#/definitions/UpdateMe">UpdateMe
</a>
2136 <div class=
"prop-value columns small-6">
2137 <!-- <div class="swagger-request-description"> -->
2144 <div class=
"doc-examples">
2146 <h5>Request Content-Types:
2147 <span>application/json
</span>
2149 <h5>Request Example
</h5>
2150 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2151 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
2152 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
2153 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"string
"</span>,
2154 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"string
"</span>
2161 <div class=
"doc-row">
2162 <div class=
"doc-copy">
2163 <section class=
"swagger-responses">
2164 <div class=
"prop-row prop-group">
2165 <div class=
"prop-name">
2166 <div class=
"prop-title">204 No Content
</div>
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>
2180 <div class=
"doc-row">
2181 <div class=
"doc-copy">
2182 <section class=
"swagger-request-security">
2183 <table class=
"table">
2186 <th class=
"swagger-request-security-schema"></th>
2187 <th class=
"swagger-request-security-scopes"></th>
2193 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2203 <div id=
"operation--users-me-video-quota-used-get" class=
"operation panel" data-traverse-target=
"operation--users-me-video-quota-used-get">
2204 <!-- <section class="operation-tags row"> -->
2205 <!-- <div class="doc-copy"> -->
2206 <div class=
"operation-tags">
2207 <a class=
"label" href=
"#tag-User">User
</a>
2212 <h2 class=
"operation-title">
2213 <span class=
"operation-name">
2214 <span class=
"operation-name">GET
</span>
2215 <span class=
"operation-path">/users/me/video-quota-used
</span>
2218 <div class=
"doc-row">
2219 <div class=
"doc-copy"> </div>
2220 <div class=
"doc-examples"></div>
2222 <div class=
"doc-row">
2223 <div class=
"doc-copy">
2224 <section class=
"swagger-responses">
2225 <div class=
"prop-row prop-group">
2226 <div class=
"prop-name">
2227 <div class=
"prop-title">200 OK
</div>
2228 <div class=
"prop-ref"></div>
2229 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2231 <div class=
"prop-value">
2232 <p>successful operation
</p>
2235 <div class=
"prop-row prop-inner">
2236 <div class=
"prop-name">type
</div>
2237 <div class=
"prop-value">
2238 <span class=
"json-property-type">number
</span>
2239 <span class=
"json-property-range" title=
"Value limits"></span>
2244 <div class=
"doc-examples">
2245 <h5>Response Content-Types:
2246 <span>application/json
</span>
2249 <h5>Response Example
2250 <span>(
200 OK)
</span>
2252 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json"><span class=
"hljs-string">"number
"</span>
2258 <div class=
"doc-row">
2259 <div class=
"doc-copy">
2260 <section class=
"swagger-request-security">
2261 <table class=
"table">
2264 <th class=
"swagger-request-security-schema"></th>
2265 <th class=
"swagger-request-security-scopes"></th>
2271 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2281 <div id=
"operation--users-me-videos--videoId--rating-get" class=
"operation panel" data-traverse-target=
"operation--users-me-videos--videoId--rating-get">
2282 <!-- <section class="operation-tags row"> -->
2283 <!-- <div class="doc-copy"> -->
2284 <div class=
"operation-tags">
2285 <a class=
"label" href=
"#tag-User">User
</a>
2290 <h2 class=
"operation-title">
2291 <span class=
"operation-name">
2292 <span class=
"operation-name">GET
</span>
2293 <span class=
"operation-path">/users/me/videos/{videoId}/rating
</span>
2296 <div class=
"doc-row">
2297 <div class=
"doc-copy">
2298 <section class=
"swagger-request-params">
2299 <div class=
"prop-row prop-group">
2300 <div class=
"prop-name">
2301 <div class=
"prop-title">videoId
</div>
2302 <span class=
"json-property-required"></span>
2303 <div class=
"prop-subtitle"> in path
</div>
2304 <div class=
"prop-subtitle">
2305 <span class=
"json-property-type">string
</span>
2306 <span class=
"json-property-range" title=
"Value limits"></span>
2309 <div class=
"prop-value">
2310 <p>The video id
</p>
2315 <div class=
"doc-examples"></div>
2317 <div class=
"doc-row">
2318 <div class=
"doc-copy">
2319 <section class=
"swagger-responses">
2320 <div class=
"prop-row prop-group">
2321 <div class=
"prop-name">
2322 <div class=
"prop-title">200 OK
</div>
2323 <div class=
"prop-ref">
2325 <a class=
"json-schema-ref" href=
"#/definitions/GetMeVideoRating">GetMeVideoRating
</a>
2328 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2330 <div class=
"prop-value">
2331 <p>successful operation
</p>
2336 <div class=
"doc-examples">
2337 <h5>Response Content-Types:
2338 <span>application/json
</span>
2341 <h5>Response Example
2342 <span>(
200 OK)
</span>
2344 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2345 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2346 <span class=
"hljs-attr">"rating
"</span>:
<span class=
"hljs-string">"number
"</span>
2353 <div class=
"doc-row">
2354 <div class=
"doc-copy">
2355 <section class=
"swagger-request-security">
2356 <table class=
"table">
2359 <th class=
"swagger-request-security-schema"></th>
2360 <th class=
"swagger-request-security-scopes"></th>
2366 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2376 <div id=
"operation--users-me-videos-get" class=
"operation panel" data-traverse-target=
"operation--users-me-videos-get">
2377 <!-- <section class="operation-tags row"> -->
2378 <!-- <div class="doc-copy"> -->
2379 <div class=
"operation-tags">
2380 <a class=
"label" href=
"#tag-User">User
</a>
2385 <h2 class=
"operation-title">
2386 <span class=
"operation-name">
2387 <span class=
"operation-name">GET
</span>
2388 <span class=
"operation-path">/users/me/videos
</span>
2391 <div class=
"doc-row">
2392 <div class=
"doc-copy">
2393 <section class=
"swagger-request-params">
2394 <div class=
"prop-row prop-group">
2395 <div class=
"prop-name">
2396 <div class=
"prop-title">start
</div>
2397 <div class=
"prop-subtitle"> in query
</div>
2398 <div class=
"prop-subtitle">
2399 <span class=
"json-property-type">number
</span>
2400 <span class=
"json-property-range" title=
"Value limits"></span>
2403 <div class=
"prop-value">
2404 <p>starting page
</p>
2407 <div class=
"prop-row prop-group">
2408 <div class=
"prop-name">
2409 <div class=
"prop-title">stop
</div>
2410 <div class=
"prop-subtitle"> in query
</div>
2411 <div class=
"prop-subtitle">
2412 <span class=
"json-property-type">number
</span>
2413 <span class=
"json-property-range" title=
"Value limits"></span>
2416 <div class=
"prop-value">
2417 <p>stopping page
</p>
2420 <div class=
"prop-row prop-group">
2421 <div class=
"prop-name">
2422 <div class=
"prop-title">sort
</div>
2423 <div class=
"prop-subtitle"> in query
</div>
2424 <div class=
"prop-subtitle">
2425 <span class=
"json-property-type">number
</span>
2426 <span class=
"json-property-range" title=
"Value limits"></span>
2429 <div class=
"prop-value">
2435 <div class=
"doc-examples"></div>
2437 <div class=
"doc-row">
2438 <div class=
"doc-copy">
2439 <section class=
"swagger-responses">
2440 <div class=
"prop-row prop-group">
2441 <div class=
"prop-name">
2442 <div class=
"prop-title">200 OK
</div>
2443 <div class=
"prop-ref">
2444 <span class=
"json-schema-ref-array">
2445 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2448 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2450 <div class=
"prop-value">
2451 <p>successful operation
</p>
2454 <div class=
"prop-row prop-inner">
2455 <div class=
"prop-name">type
</div>
2456 <div class=
"prop-value">
2457 <span class=
"json-property-type">
2458 <span class=
"json-schema-ref-array">
2459 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2462 <span class=
"json-property-range" title=
"Value limits"></span>
2467 <div class=
"doc-examples">
2468 <h5>Response Content-Types:
2469 <span>application/json
</span>
2472 <h5>Response Example
2473 <span>(
200 OK)
</span>
2475 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2477 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2478 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2479 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2480 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2481 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2482 <span class=
"hljs-attr">"category
"</span>: {
2483 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2484 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2486 <span class=
"hljs-attr">"licence
"</span>: {
2487 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2488 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2490 <span class=
"hljs-attr">"language
"</span>: {
2491 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2492 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2494 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
2495 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2496 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2497 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2498 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2499 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2500 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2501 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2502 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2503 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2504 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2505 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2506 <span class=
"hljs-attr">"account
"</span>: {
2507 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2508 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2509 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2510 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2511 <span class=
"hljs-attr">"avatar
"</span>: {
2512 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2513 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2514 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2524 <div class=
"doc-row">
2525 <div class=
"doc-copy">
2526 <section class=
"swagger-request-security">
2527 <table class=
"table">
2530 <th class=
"swagger-request-security-schema"></th>
2531 <th class=
"swagger-request-security-scopes"></th>
2537 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2547 <div id=
"operation--users-register-post" class=
"operation panel" data-traverse-target=
"operation--users-register-post">
2548 <!-- <section class="operation-tags row"> -->
2549 <!-- <div class="doc-copy"> -->
2550 <div class=
"operation-tags">
2551 <a class=
"label" href=
"#tag-User">User
</a>
2556 <h2 class=
"operation-title">
2557 <span class=
"operation-name">
2558 <span class=
"operation-name">POST
</span>
2559 <span class=
"operation-path">/users/register
</span>
2562 <div class=
"doc-row">
2563 <div class=
"doc-copy">
2564 <section class=
"swagger-request-body">
2565 <div class=
"prop-row">
2566 <div class=
"prop-name">
2567 <div class=
"swagger-request-model">
2569 <a class=
"json-schema-ref" href=
"#/definitions/RegisterUser">RegisterUser
</a>
2573 <div class=
"prop-value columns small-6">
2574 <!-- <div class="swagger-request-description"> -->
2581 <div class=
"doc-examples">
2583 <h5>Request Content-Types:
2584 <span>application/json
</span>
2586 <h5>Request Example
</h5>
2587 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2588 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
2589 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
2590 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>
2597 <div class=
"doc-row">
2598 <div class=
"doc-copy">
2599 <section class=
"swagger-responses">
2600 <div class=
"prop-row prop-group">
2601 <div class=
"prop-name">
2602 <div class=
"prop-title">204 No Content
</div>
2604 <div class=
"prop-value">
2605 <p>successful operation
</p>
2610 <div class=
"doc-examples">
2611 <h5>Response Content-Types:
2612 <span>application/json
</span>
2617 <div id=
"operation--users-me-avatar-pick-post" class=
"operation panel" data-traverse-target=
"operation--users-me-avatar-pick-post">
2618 <!-- <section class="operation-tags row"> -->
2619 <!-- <div class="doc-copy"> -->
2620 <div class=
"operation-tags">
2621 <a class=
"label" href=
"#tag-User">User
</a>
2626 <h2 class=
"operation-title">
2627 <span class=
"operation-name">
2628 <span class=
"operation-name">POST
</span>
2629 <span class=
"operation-path">/users/me/avatar/pick
</span>
2632 <div class=
"doc-row">
2633 <div class=
"doc-copy">
2634 <section class=
"swagger-request-params">
2635 <div class=
"prop-row prop-group">
2636 <div class=
"prop-name">
2637 <div class=
"prop-title">avatarfile
</div>
2638 <div class=
"prop-subtitle"> in formData
</div>
2639 <div class=
"prop-subtitle">
2640 <span class=
"json-property-type">file
</span>
2641 <span class=
"json-property-range" title=
"Value limits"></span>
2644 <div class=
"prop-value">
2645 <p>The file to upload.
</p>
2650 <div class=
"doc-examples"></div>
2652 <div class=
"doc-row">
2653 <div class=
"doc-copy">
2654 <section class=
"swagger-responses">
2655 <div class=
"prop-row prop-group">
2656 <div class=
"prop-name">
2657 <div class=
"prop-title">200 OK
</div>
2658 <div class=
"prop-ref">
2660 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
2663 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2665 <div class=
"prop-value">
2666 <p>successful operation
</p>
2671 <div class=
"doc-examples">
2672 <h5>Response Content-Types:
2673 <span>application/json
</span>
2676 <h5>Response Example
2677 <span>(
200 OK)
</span>
2679 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2680 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2681 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2682 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2689 <div class=
"doc-row">
2690 <div class=
"doc-copy">
2691 <section class=
"swagger-request-security">
2692 <table class=
"table">
2695 <th class=
"swagger-request-security-schema"></th>
2696 <th class=
"swagger-request-security-scopes"></th>
2702 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2712 <h1 id=
"tag-Video" class=
"swagger-summary-tag" data-traverse-target=
"tag-Video">Video
</h1>
2713 <div id=
"operation--videos-get" class=
"operation panel" data-traverse-target=
"operation--videos-get">
2714 <!-- <section class="operation-tags row"> -->
2715 <!-- <div class="doc-copy"> -->
2716 <div class=
"operation-tags">
2717 <a class=
"label" href=
"#tag-Video">Video
</a>
2722 <h2 class=
"operation-title">
2723 <span class=
"operation-name">
2724 <span class=
"operation-name">GET
</span>
2725 <span class=
"operation-path">/videos
</span>
2728 <div class=
"doc-row">
2729 <div class=
"doc-copy">
2730 <section class=
"swagger-request-params">
2731 <div class=
"prop-row prop-group">
2732 <div class=
"prop-name">
2733 <div class=
"prop-title">start
</div>
2734 <div class=
"prop-subtitle"> in query
</div>
2735 <div class=
"prop-subtitle">
2736 <span class=
"json-property-type">number
</span>
2737 <span class=
"json-property-range" title=
"Value limits"></span>
2740 <div class=
"prop-value">
2741 <p>starting page
</p>
2744 <div class=
"prop-row prop-group">
2745 <div class=
"prop-name">
2746 <div class=
"prop-title">stop
</div>
2747 <div class=
"prop-subtitle"> in query
</div>
2748 <div class=
"prop-subtitle">
2749 <span class=
"json-property-type">number
</span>
2750 <span class=
"json-property-range" title=
"Value limits"></span>
2753 <div class=
"prop-value">
2754 <p>stopping page
</p>
2757 <div class=
"prop-row prop-group">
2758 <div class=
"prop-name">
2759 <div class=
"prop-title">sort
</div>
2760 <div class=
"prop-subtitle"> in query
</div>
2761 <div class=
"prop-subtitle">
2762 <span class=
"json-property-type">number
</span>
2763 <span class=
"json-property-range" title=
"Value limits"></span>
2766 <div class=
"prop-value">
2772 <div class=
"doc-examples"></div>
2774 <div class=
"doc-row">
2775 <div class=
"doc-copy">
2776 <section class=
"swagger-responses">
2777 <div class=
"prop-row prop-group">
2778 <div class=
"prop-name">
2779 <div class=
"prop-title">200 OK
</div>
2780 <div class=
"prop-ref">
2781 <span class=
"json-schema-ref-array">
2782 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2785 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2787 <div class=
"prop-value">
2788 <p>successful operation
</p>
2791 <div class=
"prop-row prop-inner">
2792 <div class=
"prop-name">type
</div>
2793 <div class=
"prop-value">
2794 <span class=
"json-property-type">
2795 <span class=
"json-schema-ref-array">
2796 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2799 <span class=
"json-property-range" title=
"Value limits"></span>
2804 <div class=
"doc-examples">
2805 <h5>Response Content-Types:
2806 <span>application/json
</span>
2809 <h5>Response Example
2810 <span>(
200 OK)
</span>
2812 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2814 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2815 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2816 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2817 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2818 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2819 <span class=
"hljs-attr">"category
"</span>: {
2820 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2821 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2823 <span class=
"hljs-attr">"licence
"</span>: {
2824 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2825 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2827 <span class=
"hljs-attr">"language
"</span>: {
2828 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2829 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2831 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
2832 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2833 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2834 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2835 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2836 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2837 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2838 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2839 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2840 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2841 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2842 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2843 <span class=
"hljs-attr">"account
"</span>: {
2844 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2845 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2846 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2847 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2848 <span class=
"hljs-attr">"avatar
"</span>: {
2849 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2850 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2851 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2862 <div id=
"operation--videos-categories-get" class=
"operation panel" data-traverse-target=
"operation--videos-categories-get">
2863 <!-- <section class="operation-tags row"> -->
2864 <!-- <div class="doc-copy"> -->
2865 <div class=
"operation-tags">
2866 <a class=
"label" href=
"#tag-Video">Video
</a>
2871 <h2 class=
"operation-title">
2872 <span class=
"operation-name">
2873 <span class=
"operation-name">GET
</span>
2874 <span class=
"operation-path">/videos/categories
</span>
2877 <div class=
"doc-row">
2878 <div class=
"doc-copy"> </div>
2879 <div class=
"doc-examples"></div>
2881 <div class=
"doc-row">
2882 <div class=
"doc-copy">
2883 <section class=
"swagger-responses">
2884 <div class=
"prop-row prop-group">
2885 <div class=
"prop-name">
2886 <div class=
"prop-title">200 OK
</div>
2887 <div class=
"prop-ref"></div>
2888 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2890 <div class=
"prop-value">
2891 <p>successful operation
</p>
2894 <div class=
"prop-row prop-inner">
2895 <div class=
"prop-name">type
</div>
2896 <div class=
"prop-value">
2897 <span class=
"json-property-type">string[]
</span>
2898 <span class=
"json-property-range" title=
"Value limits"></span>
2903 <div class=
"doc-examples">
2904 <h5>Response Content-Types:
2905 <span>application/json
</span>
2908 <h5>Response Example
2909 <span>(
200 OK)
</span>
2911 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2912 <span class=
"hljs-string">"string
"</span>
2920 <div id=
"operation--videos-licences-get" class=
"operation panel" data-traverse-target=
"operation--videos-licences-get">
2921 <!-- <section class="operation-tags row"> -->
2922 <!-- <div class="doc-copy"> -->
2923 <div class=
"operation-tags">
2924 <a class=
"label" href=
"#tag-Video">Video
</a>
2929 <h2 class=
"operation-title">
2930 <span class=
"operation-name">
2931 <span class=
"operation-name">GET
</span>
2932 <span class=
"operation-path">/videos/licences
</span>
2935 <div class=
"doc-row">
2936 <div class=
"doc-copy"> </div>
2937 <div class=
"doc-examples"></div>
2939 <div class=
"doc-row">
2940 <div class=
"doc-copy">
2941 <section class=
"swagger-responses">
2942 <div class=
"prop-row prop-group">
2943 <div class=
"prop-name">
2944 <div class=
"prop-title">200 OK
</div>
2945 <div class=
"prop-ref"></div>
2946 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2948 <div class=
"prop-value">
2949 <p>successful operation
</p>
2952 <div class=
"prop-row prop-inner">
2953 <div class=
"prop-name">type
</div>
2954 <div class=
"prop-value">
2955 <span class=
"json-property-type">string[]
</span>
2956 <span class=
"json-property-range" title=
"Value limits"></span>
2961 <div class=
"doc-examples">
2962 <h5>Response Content-Types:
2963 <span>application/json
</span>
2966 <h5>Response Example
2967 <span>(
200 OK)
</span>
2969 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2970 <span class=
"hljs-string">"string
"</span>
2978 <div id=
"operation--videos-languages-get" class=
"operation panel" data-traverse-target=
"operation--videos-languages-get">
2979 <!-- <section class="operation-tags row"> -->
2980 <!-- <div class="doc-copy"> -->
2981 <div class=
"operation-tags">
2982 <a class=
"label" href=
"#tag-Video">Video
</a>
2987 <h2 class=
"operation-title">
2988 <span class=
"operation-name">
2989 <span class=
"operation-name">GET
</span>
2990 <span class=
"operation-path">/videos/languages
</span>
2993 <div class=
"doc-row">
2994 <div class=
"doc-copy"> </div>
2995 <div class=
"doc-examples"></div>
2997 <div class=
"doc-row">
2998 <div class=
"doc-copy">
2999 <section class=
"swagger-responses">
3000 <div class=
"prop-row prop-group">
3001 <div class=
"prop-name">
3002 <div class=
"prop-title">200 OK
</div>
3003 <div class=
"prop-ref"></div>
3004 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3006 <div class=
"prop-value">
3007 <p>successful operation
</p>
3010 <div class=
"prop-row prop-inner">
3011 <div class=
"prop-name">type
</div>
3012 <div class=
"prop-value">
3013 <span class=
"json-property-type">string[]
</span>
3014 <span class=
"json-property-range" title=
"Value limits"></span>
3019 <div class=
"doc-examples">
3020 <h5>Response Content-Types:
3021 <span>application/json
</span>
3024 <h5>Response Example
3025 <span>(
200 OK)
</span>
3027 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3028 <span class=
"hljs-string">"string
"</span>
3036 <div id=
"operation--videos-privacies-get" class=
"operation panel" data-traverse-target=
"operation--videos-privacies-get">
3037 <!-- <section class="operation-tags row"> -->
3038 <!-- <div class="doc-copy"> -->
3039 <div class=
"operation-tags">
3040 <a class=
"label" href=
"#tag-Video">Video
</a>
3045 <h2 class=
"operation-title">
3046 <span class=
"operation-name">
3047 <span class=
"operation-name">GET
</span>
3048 <span class=
"operation-path">/videos/privacies
</span>
3051 <div class=
"doc-row">
3052 <div class=
"doc-copy"> </div>
3053 <div class=
"doc-examples"></div>
3055 <div class=
"doc-row">
3056 <div class=
"doc-copy">
3057 <section class=
"swagger-responses">
3058 <div class=
"prop-row prop-group">
3059 <div class=
"prop-name">
3060 <div class=
"prop-title">200 OK
</div>
3061 <div class=
"prop-ref"></div>
3062 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3064 <div class=
"prop-value">
3065 <p>successful operation
</p>
3068 <div class=
"prop-row prop-inner">
3069 <div class=
"prop-name">type
</div>
3070 <div class=
"prop-value">
3071 <span class=
"json-property-type">string[]
</span>
3072 <span class=
"json-property-range" title=
"Value limits"></span>
3077 <div class=
"doc-examples">
3078 <h5>Response Content-Types:
3079 <span>application/json
</span>
3082 <h5>Response Example
3083 <span>(
200 OK)
</span>
3085 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3086 <span class=
"hljs-string">"string
"</span>
3094 <div id=
"operation--videos-search-get" class=
"operation panel" data-traverse-target=
"operation--videos-search-get">
3095 <!-- <section class="operation-tags row"> -->
3096 <!-- <div class="doc-copy"> -->
3097 <div class=
"operation-tags">
3098 <a class=
"label" href=
"#tag-Video">Video
</a>
3103 <h2 class=
"operation-title">
3104 <span class=
"operation-name">
3105 <span class=
"operation-name">GET
</span>
3106 <span class=
"operation-path">/videos/search
</span>
3109 <div class=
"doc-row">
3110 <div class=
"doc-copy">
3111 <section class=
"swagger-request-params">
3112 <div class=
"prop-row prop-group">
3113 <div class=
"prop-name">
3114 <div class=
"prop-title">start
</div>
3115 <div class=
"prop-subtitle"> in query
</div>
3116 <div class=
"prop-subtitle">
3117 <span class=
"json-property-type">number
</span>
3118 <span class=
"json-property-range" title=
"Value limits"></span>
3121 <div class=
"prop-value">
3122 <p>starting page
</p>
3125 <div class=
"prop-row prop-group">
3126 <div class=
"prop-name">
3127 <div class=
"prop-title">stop
</div>
3128 <div class=
"prop-subtitle"> in query
</div>
3129 <div class=
"prop-subtitle">
3130 <span class=
"json-property-type">number
</span>
3131 <span class=
"json-property-range" title=
"Value limits"></span>
3134 <div class=
"prop-value">
3135 <p>stopping page
</p>
3138 <div class=
"prop-row prop-group">
3139 <div class=
"prop-name">
3140 <div class=
"prop-title">sort
</div>
3141 <div class=
"prop-subtitle"> in query
</div>
3142 <div class=
"prop-subtitle">
3143 <span class=
"json-property-type">number
</span>
3144 <span class=
"json-property-range" title=
"Value limits"></span>
3147 <div class=
"prop-value">
3153 <div class=
"doc-examples"></div>
3155 <div class=
"doc-row">
3156 <div class=
"doc-copy">
3157 <section class=
"swagger-responses">
3158 <div class=
"prop-row prop-group">
3159 <div class=
"prop-name">
3160 <div class=
"prop-title">200 OK
</div>
3161 <div class=
"prop-ref">
3162 <span class=
"json-schema-ref-array">
3163 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3166 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3168 <div class=
"prop-value">
3169 <p>successful operation
</p>
3172 <div class=
"prop-row prop-inner">
3173 <div class=
"prop-name">type
</div>
3174 <div class=
"prop-value">
3175 <span class=
"json-property-type">
3176 <span class=
"json-schema-ref-array">
3177 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3180 <span class=
"json-property-range" title=
"Value limits"></span>
3185 <div class=
"doc-examples">
3186 <h5>Response Content-Types:
3187 <span>application/json
</span>
3190 <h5>Response Example
3191 <span>(
200 OK)
</span>
3193 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3195 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3196 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3197 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3198 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3199 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3200 <span class=
"hljs-attr">"category
"</span>: {
3201 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3202 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3204 <span class=
"hljs-attr">"licence
"</span>: {
3205 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3206 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3208 <span class=
"hljs-attr">"language
"</span>: {
3209 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3210 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3212 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3213 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3214 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3215 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3216 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3217 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3218 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3219 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3220 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3221 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3222 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3223 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3224 <span class=
"hljs-attr">"account
"</span>: {
3225 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3226 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3227 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3228 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3229 <span class=
"hljs-attr">"avatar
"</span>: {
3230 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3231 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3232 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3243 <div id=
"operation--videos--id--put" class=
"operation panel" data-traverse-target=
"operation--videos--id--put">
3244 <!-- <section class="operation-tags row"> -->
3245 <!-- <div class="doc-copy"> -->
3246 <div class=
"operation-tags">
3247 <a class=
"label" href=
"#tag-Video">Video
</a>
3252 <h2 class=
"operation-title">
3253 <span class=
"operation-name">
3254 <span class=
"operation-name">PUT
</span>
3255 <span class=
"operation-path">/videos/{id}
</span>
3258 <div class=
"doc-row">
3259 <div class=
"doc-copy">
3260 <section class=
"swagger-request-params">
3261 <div class=
"prop-row prop-group">
3262 <div class=
"prop-name">
3263 <div class=
"prop-title">id
</div>
3264 <span class=
"json-property-required"></span>
3265 <div class=
"prop-subtitle"> in path
</div>
3266 <div class=
"prop-subtitle">
3267 <span class=
"json-property-type">string
</span>
3268 <span class=
"json-property-range" title=
"Value limits"></span>
3271 <div class=
"prop-value">
3275 <div class=
"prop-row prop-group">
3276 <div class=
"prop-name">
3277 <div class=
"prop-title">thumbnailfile
</div>
3278 <div class=
"prop-subtitle"> in formData
</div>
3279 <div class=
"prop-subtitle">
3280 <span class=
"json-property-type">file
</span>
3281 <span class=
"json-property-range" title=
"Value limits"></span>
3284 <div class=
"prop-value">
3285 <p>Video thumbnail file
</p>
3288 <div class=
"prop-row prop-group">
3289 <div class=
"prop-name">
3290 <div class=
"prop-title">previewfile
</div>
3291 <div class=
"prop-subtitle"> in formData
</div>
3292 <div class=
"prop-subtitle">
3293 <span class=
"json-property-type">file
</span>
3294 <span class=
"json-property-range" title=
"Value limits"></span>
3297 <div class=
"prop-value">
3298 <p>Video preview file
</p>
3301 <div class=
"prop-row prop-group">
3302 <div class=
"prop-name">
3303 <div class=
"prop-title">category
</div>
3304 <div class=
"prop-subtitle"> in formData
</div>
3305 <div class=
"prop-subtitle">
3306 <span class=
"json-property-type">number
</span>
3307 <span class=
"json-property-range" title=
"Value limits"></span>
3310 <div class=
"prop-value">
3311 <p>Video category
</p>
3314 <div class=
"prop-row prop-group">
3315 <div class=
"prop-name">
3316 <div class=
"prop-title">licence
</div>
3317 <div class=
"prop-subtitle"> in formData
</div>
3318 <div class=
"prop-subtitle">
3319 <span class=
"json-property-type">number
</span>
3320 <span class=
"json-property-range" title=
"Value limits"></span>
3323 <div class=
"prop-value">
3324 <p>Video licence
</p>
3327 <div class=
"prop-row prop-group">
3328 <div class=
"prop-name">
3329 <div class=
"prop-title">language
</div>
3330 <div class=
"prop-subtitle"> in formData
</div>
3331 <div class=
"prop-subtitle">
3332 <span class=
"json-property-type">number
</span>
3333 <span class=
"json-property-range" title=
"Value limits"></span>
3336 <div class=
"prop-value">
3337 <p>Video language
</p>
3340 <div class=
"prop-row prop-group">
3341 <div class=
"prop-name">
3342 <div class=
"prop-title">description
</div>
3343 <div class=
"prop-subtitle"> in formData
</div>
3344 <div class=
"prop-subtitle">
3345 <span class=
"json-property-type">string
</span>
3346 <span class=
"json-property-range" title=
"Value limits"></span>
3349 <div class=
"prop-value">
3350 <p>Video description
</p>
3353 <div class=
"prop-row prop-group">
3354 <div class=
"prop-name">
3355 <div class=
"prop-title">support
</div>
3356 <div class=
"prop-subtitle"> in formData
</div>
3357 <div class=
"prop-subtitle">
3358 <span class=
"json-property-type">string
</span>
3359 <span class=
"json-property-range" title=
"Value limits"></span>
3362 <div class=
"prop-value">
3363 <p>Text describing how to support the video uploader
</p>
3366 <div class=
"prop-row prop-group">
3367 <div class=
"prop-name">
3368 <div class=
"prop-title">nsfw
</div>
3369 <div class=
"prop-subtitle"> in formData
</div>
3370 <div class=
"prop-subtitle">
3371 <span class=
"json-property-type">boolean
</span>
3372 <span class=
"json-property-range" title=
"Value limits"></span>
3375 <div class=
"prop-value">
3376 <p>Whether or not this video contains sensitive content
</p>
3379 <div class=
"prop-row prop-group">
3380 <div class=
"prop-name">
3381 <div class=
"prop-title">name
</div>
3382 <div class=
"prop-subtitle"> in formData
</div>
3383 <div class=
"prop-subtitle">
3384 <span class=
"json-property-type">string
</span>
3385 <span class=
"json-property-range" title=
"Value limits"></span>
3388 <div class=
"prop-value">
3392 <div class=
"prop-row prop-group">
3393 <div class=
"prop-name">
3394 <div class=
"prop-title">tags
</div>
3395 <div class=
"prop-subtitle"> in formData
</div>
3396 <div class=
"prop-subtitle">
3397 <span class=
"json-property-type">string[]
</span>
3398 <span class=
"json-property-range" title=
"Value limits"></span>
3401 <div class=
"prop-value">
3405 <div class=
"prop-row prop-group">
3406 <div class=
"prop-name">
3407 <div class=
"prop-title">commentsEnabled
</div>
3408 <div class=
"prop-subtitle"> in formData
</div>
3409 <div class=
"prop-subtitle">
3410 <span class=
"json-property-type">boolean
</span>
3411 <span class=
"json-property-range" title=
"Value limits"></span>
3414 <div class=
"prop-value">
3415 <p>Enable or disable comments for this video
</p>
3418 <div class=
"prop-row prop-group">
3419 <div class=
"prop-name">
3420 <div class=
"prop-title">privacy
</div>
3421 <div class=
"prop-subtitle"> in formData
</div>
3422 <div class=
"prop-subtitle">
3423 <span class=
"json-property-type">string
</span>
3424 <span class=
"json-property-enum" title=
"Possible values">
3425 <span class=
"json-property-enum-item">Public
</span>,
3426 <span class=
"json-property-enum-item">Unlisted
</span>
3428 <span class=
"json-property-range" title=
"Value limits"></span>
3431 <div class=
"prop-value">
3432 <p>Video privacy
</p>
3437 <div class=
"doc-examples"></div>
3439 <div class=
"doc-row">
3440 <div class=
"doc-copy">
3441 <section class=
"swagger-responses">
3442 <div class=
"prop-row prop-group">
3443 <div class=
"prop-name">
3444 <div class=
"prop-title">200 OK
</div>
3445 <div class=
"prop-ref">
3447 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3450 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3452 <div class=
"prop-value">
3453 <p>successful operation
</p>
3458 <div class=
"doc-examples">
3459 <h5>Response Content-Types:
3460 <span>application/json
</span>
3463 <h5>Response Example
3464 <span>(
200 OK)
</span>
3466 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3467 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3468 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3469 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3470 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3471 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3472 <span class=
"hljs-attr">"category
"</span>: {
3473 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3474 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3476 <span class=
"hljs-attr">"licence
"</span>: {
3477 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3478 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3480 <span class=
"hljs-attr">"language
"</span>: {
3481 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3482 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3484 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3485 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3486 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3487 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3488 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3489 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3490 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3491 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3492 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3493 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3494 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3495 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3496 <span class=
"hljs-attr">"account
"</span>: {
3497 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3498 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3499 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3500 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3501 <span class=
"hljs-attr">"avatar
"</span>: {
3502 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3503 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3504 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3513 <div class=
"doc-row">
3514 <div class=
"doc-copy">
3515 <section class=
"swagger-request-security">
3516 <table class=
"table">
3519 <th class=
"swagger-request-security-schema"></th>
3520 <th class=
"swagger-request-security-scopes"></th>
3526 <a href=
"#security-definition-OAuth2">OAuth2
</a>
3536 <div id=
"operation--videos--id--get" class=
"operation panel" data-traverse-target=
"operation--videos--id--get">
3537 <!-- <section class="operation-tags row"> -->
3538 <!-- <div class="doc-copy"> -->
3539 <div class=
"operation-tags">
3540 <a class=
"label" href=
"#tag-Video">Video
</a>
3545 <h2 class=
"operation-title">
3546 <span class=
"operation-name">
3547 <span class=
"operation-name">GET
</span>
3548 <span class=
"operation-path">/videos/{id}
</span>
3551 <div class=
"doc-row">
3552 <div class=
"doc-copy">
3553 <section class=
"swagger-request-params">
3554 <div class=
"prop-row prop-group">
3555 <div class=
"prop-name">
3556 <div class=
"prop-title">id
</div>
3557 <span class=
"json-property-required"></span>
3558 <div class=
"prop-subtitle"> in path
</div>
3559 <div class=
"prop-subtitle">
3560 <span class=
"json-property-type">string
</span>
3561 <span class=
"json-property-range" title=
"Value limits"></span>
3564 <div class=
"prop-value">
3565 <p>The video id
</p>
3570 <div class=
"doc-examples"></div>
3572 <div class=
"doc-row">
3573 <div class=
"doc-copy">
3574 <section class=
"swagger-responses">
3575 <div class=
"prop-row prop-group">
3576 <div class=
"prop-name">
3577 <div class=
"prop-title">200 OK
</div>
3578 <div class=
"prop-ref">
3580 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3583 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3585 <div class=
"prop-value">
3586 <p>successful operation
</p>
3591 <div class=
"doc-examples">
3592 <h5>Response Content-Types:
3593 <span>application/json
</span>
3596 <h5>Response Example
3597 <span>(
200 OK)
</span>
3599 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3600 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3601 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3602 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3603 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3604 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3605 <span class=
"hljs-attr">"category
"</span>: {
3606 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3607 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3609 <span class=
"hljs-attr">"licence
"</span>: {
3610 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3611 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3613 <span class=
"hljs-attr">"language
"</span>: {
3614 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3615 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3617 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3618 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3619 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3620 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3621 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3622 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3623 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3624 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3625 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3626 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3627 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3628 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3629 <span class=
"hljs-attr">"account
"</span>: {
3630 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3631 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3632 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3633 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3634 <span class=
"hljs-attr">"avatar
"</span>: {
3635 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3636 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3637 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3647 <div id=
"operation--videos--id--delete" class=
"operation panel" data-traverse-target=
"operation--videos--id--delete">
3648 <!-- <section class="operation-tags row"> -->
3649 <!-- <div class="doc-copy"> -->
3650 <div class=
"operation-tags">
3651 <a class=
"label" href=
"#tag-Video">Video
</a>
3656 <h2 class=
"operation-title">
3657 <span class=
"operation-name">
3658 <span class=
"operation-name">DELETE
</span>
3659 <span class=
"operation-path">/videos/{id}
</span>
3662 <div class=
"doc-row">
3663 <div class=
"doc-copy">
3664 <section class=
"swagger-request-params">
3665 <div class=
"prop-row prop-group">
3666 <div class=
"prop-name">
3667 <div class=
"prop-title">id
</div>
3668 <span class=
"json-property-required"></span>
3669 <div class=
"prop-subtitle"> in path
</div>
3670 <div class=
"prop-subtitle">
3671 <span class=
"json-property-type">string
</span>
3672 <span class=
"json-property-range" title=
"Value limits"></span>
3675 <div class=
"prop-value">
3676 <p>The video id
</p>
3681 <div class=
"doc-examples"></div>
3683 <div class=
"doc-row">
3684 <div class=
"doc-copy">
3685 <section class=
"swagger-responses">
3686 <div class=
"prop-row prop-group">
3687 <div class=
"prop-name">
3688 <div class=
"prop-title">204 No Content
</div>
3690 <div class=
"prop-value">
3691 <p>successful operation
</p>
3696 <div class=
"doc-examples">
3697 <h5>Response Content-Types:
3698 <span>application/json
</span>
3702 <div class=
"doc-row">
3703 <div class=
"doc-copy">
3704 <section class=
"swagger-request-security">
3705 <table class=
"table">
3708 <th class=
"swagger-request-security-schema"></th>
3709 <th class=
"swagger-request-security-scopes"></th>
3715 <a href=
"#security-definition-OAuth2">OAuth2
</a>
3725 <div id=
"operation--videos--id--description-get" class=
"operation panel" data-traverse-target=
"operation--videos--id--description-get">
3726 <!-- <section class="operation-tags row"> -->
3727 <!-- <div class="doc-copy"> -->
3728 <div class=
"operation-tags">
3729 <a class=
"label" href=
"#tag-Video">Video
</a>
3734 <h2 class=
"operation-title">
3735 <span class=
"operation-name">
3736 <span class=
"operation-name">GET
</span>
3737 <span class=
"operation-path">/videos/{id}/description
</span>
3740 <div class=
"doc-row">
3741 <div class=
"doc-copy">
3742 <section class=
"swagger-request-params">
3743 <div class=
"prop-row prop-group">
3744 <div class=
"prop-name">
3745 <div class=
"prop-title">id
</div>
3746 <span class=
"json-property-required"></span>
3747 <div class=
"prop-subtitle"> in path
</div>
3748 <div class=
"prop-subtitle">
3749 <span class=
"json-property-type">string
</span>
3750 <span class=
"json-property-range" title=
"Value limits"></span>
3753 <div class=
"prop-value">
3754 <p>The video id
</p>
3759 <div class=
"doc-examples"></div>
3761 <div class=
"doc-row">
3762 <div class=
"doc-copy">
3763 <section class=
"swagger-responses">
3764 <div class=
"prop-row prop-group">
3765 <div class=
"prop-name">
3766 <div class=
"prop-title">200 OK
</div>
3767 <div class=
"prop-ref"></div>
3768 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3770 <div class=
"prop-value">
3771 <p>successful operation
</p>
3774 <div class=
"prop-row prop-inner">
3775 <div class=
"prop-name">type
</div>
3776 <div class=
"prop-value">
3777 <span class=
"json-property-type">string
</span>
3778 <span class=
"json-property-range" title=
"Value limits"></span>
3783 <div class=
"doc-examples">
3784 <h5>Response Content-Types:
3785 <span>application/json
</span>
3788 <h5>Response Example
3789 <span>(
200 OK)
</span>
3791 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json"><span class=
"hljs-string">"string
"</span>
3798 <div id=
"operation--videos--id--views-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--views-post">
3799 <!-- <section class="operation-tags row"> -->
3800 <!-- <div class="doc-copy"> -->
3801 <div class=
"operation-tags">
3802 <a class=
"label" href=
"#tag-Video">Video
</a>
3807 <h2 class=
"operation-title">
3808 <span class=
"operation-name">
3809 <span class=
"operation-name">POST
</span>
3810 <span class=
"operation-path">/videos/{id}/views
</span>
3813 <div class=
"doc-row">
3814 <div class=
"doc-copy">
3815 <section class=
"swagger-request-params">
3816 <div class=
"prop-row prop-group">
3817 <div class=
"prop-name">
3818 <div class=
"prop-title">id
</div>
3819 <span class=
"json-property-required"></span>
3820 <div class=
"prop-subtitle"> in path
</div>
3821 <div class=
"prop-subtitle">
3822 <span class=
"json-property-type">string
</span>
3823 <span class=
"json-property-range" title=
"Value limits"></span>
3826 <div class=
"prop-value">
3827 <p>The video id
</p>
3832 <div class=
"doc-examples"></div>
3834 <div class=
"doc-row">
3835 <div class=
"doc-copy">
3836 <section class=
"swagger-responses">
3837 <div class=
"prop-row prop-group">
3838 <div class=
"prop-name">
3839 <div class=
"prop-title">204 No Content
</div>
3841 <div class=
"prop-value">
3842 <p>successful operation
</p>
3847 <div class=
"doc-examples">
3848 <h5>Response Content-Types:
3849 <span>application/json
</span>
3854 <div id=
"operation--videos-upload-post" class=
"operation panel" data-traverse-target=
"operation--videos-upload-post">
3855 <!-- <section class="operation-tags row"> -->
3856 <!-- <div class="doc-copy"> -->
3857 <div class=
"operation-tags">
3858 <a class=
"label" href=
"#tag-Video">Video
</a>
3863 <h2 class=
"operation-title">
3864 <span class=
"operation-name">
3865 <span class=
"operation-name">POST
</span>
3866 <span class=
"operation-path">/videos/upload
</span>
3869 <div class=
"doc-row">
3870 <div class=
"doc-copy">
3871 <section class=
"swagger-request-params">
3872 <div class=
"prop-row prop-group">
3873 <div class=
"prop-name">
3874 <div class=
"prop-title">videofile
</div>
3875 <span class=
"json-property-required"></span>
3876 <div class=
"prop-subtitle"> in formData
</div>
3877 <div class=
"prop-subtitle">
3878 <span class=
"json-property-type">file
</span>
3879 <span class=
"json-property-range" title=
"Value limits"></span>
3882 <div class=
"prop-value">
3886 <div class=
"prop-row prop-group">
3887 <div class=
"prop-name">
3888 <div class=
"prop-title">thumbnailfile
</div>
3889 <span class=
"json-property-required"></span>
3890 <div class=
"prop-subtitle"> in formData
</div>
3891 <div class=
"prop-subtitle">
3892 <span class=
"json-property-type">file
</span>
3893 <span class=
"json-property-range" title=
"Value limits"></span>
3896 <div class=
"prop-value">
3897 <p>Video thumbnail file
</p>
3900 <div class=
"prop-row prop-group">
3901 <div class=
"prop-name">
3902 <div class=
"prop-title">previewfile
</div>
3903 <span class=
"json-property-required"></span>
3904 <div class=
"prop-subtitle"> in formData
</div>
3905 <div class=
"prop-subtitle">
3906 <span class=
"json-property-type">file
</span>
3907 <span class=
"json-property-range" title=
"Value limits"></span>
3910 <div class=
"prop-value">
3911 <p>Video preview file
</p>
3914 <div class=
"prop-row prop-group">
3915 <div class=
"prop-name">
3916 <div class=
"prop-title">category
</div>
3917 <div class=
"prop-subtitle"> in formData
</div>
3918 <div class=
"prop-subtitle">
3919 <span class=
"json-property-type">number
</span>
3920 <span class=
"json-property-range" title=
"Value limits"></span>
3923 <div class=
"prop-value">
3924 <p>Video category
</p>
3927 <div class=
"prop-row prop-group">
3928 <div class=
"prop-name">
3929 <div class=
"prop-title">licence
</div>
3930 <div class=
"prop-subtitle"> in formData
</div>
3931 <div class=
"prop-subtitle">
3932 <span class=
"json-property-type">number
</span>
3933 <span class=
"json-property-range" title=
"Value limits"></span>
3936 <div class=
"prop-value">
3937 <p>Video licence
</p>
3940 <div class=
"prop-row prop-group">
3941 <div class=
"prop-name">
3942 <div class=
"prop-title">language
</div>
3943 <div class=
"prop-subtitle"> in formData
</div>
3944 <div class=
"prop-subtitle">
3945 <span class=
"json-property-type">number
</span>
3946 <span class=
"json-property-range" title=
"Value limits"></span>
3949 <div class=
"prop-value">
3950 <p>Video language
</p>
3953 <div class=
"prop-row prop-group">
3954 <div class=
"prop-name">
3955 <div class=
"prop-title">description
</div>
3956 <div class=
"prop-subtitle"> in formData
</div>
3957 <div class=
"prop-subtitle">
3958 <span class=
"json-property-type">string
</span>
3959 <span class=
"json-property-range" title=
"Value limits"></span>
3962 <div class=
"prop-value">
3963 <p>Video description
</p>
3966 <div class=
"prop-row prop-group">
3967 <div class=
"prop-name">
3968 <div class=
"prop-title">support
</div>
3969 <div class=
"prop-subtitle"> in formData
</div>
3970 <div class=
"prop-subtitle">
3971 <span class=
"json-property-type">string
</span>
3972 <span class=
"json-property-range" title=
"Value limits"></span>
3975 <div class=
"prop-value">
3976 <p>Text describing how to support the video uploader
</p>
3979 <div class=
"prop-row prop-group">
3980 <div class=
"prop-name">
3981 <div class=
"prop-title">channelId
</div>
3982 <span class=
"json-property-required"></span>
3983 <div class=
"prop-subtitle"> in formData
</div>
3984 <div class=
"prop-subtitle">
3985 <span class=
"json-property-type">number
</span>
3986 <span class=
"json-property-range" title=
"Value limits"></span>
3989 <div class=
"prop-value">
3990 <p>Channel id that will contain this video
</p>
3993 <div class=
"prop-row prop-group">
3994 <div class=
"prop-name">
3995 <div class=
"prop-title">nsfw
</div>
3996 <span class=
"json-property-required"></span>
3997 <div class=
"prop-subtitle"> in formData
</div>
3998 <div class=
"prop-subtitle">
3999 <span class=
"json-property-type">boolean
</span>
4000 <span class=
"json-property-range" title=
"Value limits"></span>
4003 <div class=
"prop-value">
4004 <p>Whether or not this video contains sensitive content
</p>
4007 <div class=
"prop-row prop-group">
4008 <div class=
"prop-name">
4009 <div class=
"prop-title">name
</div>
4010 <span class=
"json-property-required"></span>
4011 <div class=
"prop-subtitle"> in formData
</div>
4012 <div class=
"prop-subtitle">
4013 <span class=
"json-property-type">string
</span>
4014 <span class=
"json-property-range" title=
"Value limits"></span>
4017 <div class=
"prop-value">
4021 <div class=
"prop-row prop-group">
4022 <div class=
"prop-name">
4023 <div class=
"prop-title">tags
</div>
4024 <div class=
"prop-subtitle"> in formData
</div>
4025 <div class=
"prop-subtitle">
4026 <span class=
"json-property-type">string[]
</span>
4027 <span class=
"json-property-range" title=
"Value limits"></span>
4030 <div class=
"prop-value">
4034 <div class=
"prop-row prop-group">
4035 <div class=
"prop-name">
4036 <div class=
"prop-title">commentsEnabled
</div>
4037 <div class=
"prop-subtitle"> in formData
</div>
4038 <div class=
"prop-subtitle">
4039 <span class=
"json-property-type">boolean
</span>
4040 <span class=
"json-property-range" title=
"Value limits"></span>
4043 <div class=
"prop-value">
4044 <p>Enable or disable comments for this video
</p>
4047 <div class=
"prop-row prop-group">
4048 <div class=
"prop-name">
4049 <div class=
"prop-title">privacy
</div>
4050 <span class=
"json-property-required"></span>
4051 <div class=
"prop-subtitle"> in formData
</div>
4052 <div class=
"prop-subtitle">
4053 <span class=
"json-property-type">string
</span>
4054 <span class=
"json-property-enum" title=
"Possible values">
4055 <span class=
"json-property-enum-item">Public
</span>,
4056 <span class=
"json-property-enum-item">Unlisted
</span>,
4057 <span class=
"json-property-enum-item">Private
</span>
4059 <span class=
"json-property-range" title=
"Value limits"></span>
4062 <div class=
"prop-value">
4063 <p>Video privacy
</p>
4068 <div class=
"doc-examples"></div>
4070 <div class=
"doc-row">
4071 <div class=
"doc-copy">
4072 <section class=
"swagger-responses">
4073 <div class=
"prop-row prop-group">
4074 <div class=
"prop-name">
4075 <div class=
"prop-title">200 OK
</div>
4076 <div class=
"prop-ref">
4078 <a class=
"json-schema-ref" href=
"#/definitions/VideoUploadResponse">VideoUploadResponse
</a>
4081 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4083 <div class=
"prop-value">
4084 <p>successful operation
</p>
4089 <div class=
"doc-examples">
4090 <h5>Response Content-Types:
4091 <span>application/json
</span>
4094 <h5>Response Example
4095 <span>(
200 OK)
</span>
4097 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4098 <span class=
"hljs-attr">"video
"</span>: {
4099 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4100 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
4108 <div class=
"doc-row">
4109 <div class=
"doc-copy">
4110 <section class=
"swagger-request-security">
4111 <table class=
"table">
4114 <th class=
"swagger-request-security-schema"></th>
4115 <th class=
"swagger-request-security-scopes"></th>
4121 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4131 <h1 id=
"tag-VideoAbuse" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoAbuse">VideoAbuse
</h1>
4132 <div id=
"operation--videos-abuse-get" class=
"operation panel" data-traverse-target=
"operation--videos-abuse-get">
4133 <!-- <section class="operation-tags row"> -->
4134 <!-- <div class="doc-copy"> -->
4135 <div class=
"operation-tags">
4136 <a class=
"label" href=
"#tag-VideoAbuse">VideoAbuse
</a>
4141 <h2 class=
"operation-title">
4142 <span class=
"operation-name">
4143 <span class=
"operation-name">GET
</span>
4144 <span class=
"operation-path">/videos/abuse
</span>
4147 <div class=
"doc-row">
4148 <div class=
"doc-copy">
4149 <section class=
"swagger-request-params">
4150 <div class=
"prop-row prop-group">
4151 <div class=
"prop-name">
4152 <div class=
"prop-title">start
</div>
4153 <div class=
"prop-subtitle"> in query
</div>
4154 <div class=
"prop-subtitle">
4155 <span class=
"json-property-type">number
</span>
4156 <span class=
"json-property-range" title=
"Value limits"></span>
4159 <div class=
"prop-value">
4160 <p>starting page
</p>
4163 <div class=
"prop-row prop-group">
4164 <div class=
"prop-name">
4165 <div class=
"prop-title">stop
</div>
4166 <div class=
"prop-subtitle"> in query
</div>
4167 <div class=
"prop-subtitle">
4168 <span class=
"json-property-type">number
</span>
4169 <span class=
"json-property-range" title=
"Value limits"></span>
4172 <div class=
"prop-value">
4173 <p>stopping page
</p>
4176 <div class=
"prop-row prop-group">
4177 <div class=
"prop-name">
4178 <div class=
"prop-title">sort
</div>
4179 <div class=
"prop-subtitle"> in query
</div>
4180 <div class=
"prop-subtitle">
4181 <span class=
"json-property-type">number
</span>
4182 <span class=
"json-property-range" title=
"Value limits"></span>
4185 <div class=
"prop-value">
4191 <div class=
"doc-examples"></div>
4193 <div class=
"doc-row">
4194 <div class=
"doc-copy">
4195 <section class=
"swagger-responses">
4196 <div class=
"prop-row prop-group">
4197 <div class=
"prop-name">
4198 <div class=
"prop-title">200 OK
</div>
4199 <div class=
"prop-ref">
4200 <span class=
"json-schema-ref-array">
4201 <a class=
"json-schema-ref" href=
"#/definitions/VideoAbuse">VideoAbuse
</a>
4204 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4206 <div class=
"prop-value">
4207 <p>successful operation
</p>
4210 <div class=
"prop-row prop-inner">
4211 <div class=
"prop-name">type
</div>
4212 <div class=
"prop-value">
4213 <span class=
"json-property-type">
4214 <span class=
"json-schema-ref-array">
4215 <a class=
"json-schema-ref" href=
"#/definitions/VideoAbuse">VideoAbuse
</a>
4218 <span class=
"json-property-range" title=
"Value limits"></span>
4223 <div class=
"doc-examples">
4224 <h5>Response Content-Types:
4225 <span>application/json
</span>
4228 <h5>Response Example
4229 <span>(
200 OK)
</span>
4231 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4233 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4234 <span class=
"hljs-attr">"reason
"</span>:
<span class=
"hljs-string">"string
"</span>,
4235 <span class=
"hljs-attr">"reporterAccount
"</span>: {
4236 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4237 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4238 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4239 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4240 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4241 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4242 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4243 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4244 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4245 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4246 <span class=
"hljs-attr">"avatar
"</span>: {
4247 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4248 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4249 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4252 <span class=
"hljs-attr">"video
"</span>: {
4253 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4254 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4255 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4256 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>
4258 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4266 <div class=
"doc-row">
4267 <div class=
"doc-copy">
4268 <section class=
"swagger-request-security">
4269 <table class=
"table">
4272 <th class=
"swagger-request-security-schema"></th>
4273 <th class=
"swagger-request-security-scopes"></th>
4279 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4289 <div id=
"operation--videos--id--abuse-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--abuse-post">
4290 <!-- <section class="operation-tags row"> -->
4291 <!-- <div class="doc-copy"> -->
4292 <div class=
"operation-tags">
4293 <a class=
"label" href=
"#tag-VideoAbuse">VideoAbuse
</a>
4298 <h2 class=
"operation-title">
4299 <span class=
"operation-name">
4300 <span class=
"operation-name">POST
</span>
4301 <span class=
"operation-path">/videos/{id}/abuse
</span>
4304 <div class=
"doc-row">
4305 <div class=
"doc-copy">
4306 <section class=
"swagger-request-params">
4307 <div class=
"prop-row prop-group">
4308 <div class=
"prop-name">
4309 <div class=
"prop-title">id
</div>
4310 <span class=
"json-property-required"></span>
4311 <div class=
"prop-subtitle"> in path
</div>
4312 <div class=
"prop-subtitle">
4313 <span class=
"json-property-type">string
</span>
4314 <span class=
"json-property-range" title=
"Value limits"></span>
4317 <div class=
"prop-value">
4318 <p>The video id
</p>
4323 <div class=
"doc-examples"></div>
4325 <div class=
"doc-row">
4326 <div class=
"doc-copy">
4327 <section class=
"swagger-responses">
4328 <div class=
"prop-row prop-group">
4329 <div class=
"prop-name">
4330 <div class=
"prop-title">204 No Content
</div>
4332 <div class=
"prop-value">
4333 <p>successful operation
</p>
4338 <div class=
"doc-examples">
4339 <h5>Response Content-Types:
4340 <span>application/json
</span>
4344 <div class=
"doc-row">
4345 <div class=
"doc-copy">
4346 <section class=
"swagger-request-security">
4347 <table class=
"table">
4350 <th class=
"swagger-request-security-schema"></th>
4351 <th class=
"swagger-request-security-scopes"></th>
4357 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4367 <h1 id=
"tag-VideoBlacklist" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoBlacklist">VideoBlacklist
</h1>
4368 <div id=
"operation--videos--videoId--blacklist-post" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--blacklist-post">
4369 <!-- <section class="operation-tags row"> -->
4370 <!-- <div class="doc-copy"> -->
4371 <div class=
"operation-tags">
4372 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4377 <h2 class=
"operation-title">
4378 <span class=
"operation-name">
4379 <span class=
"operation-name">POST
</span>
4380 <span class=
"operation-path">/videos/{videoId}/blacklist
</span>
4383 <div class=
"doc-row">
4384 <div class=
"doc-copy">
4385 <section class=
"swagger-request-params">
4386 <div class=
"prop-row prop-group">
4387 <div class=
"prop-name">
4388 <div class=
"prop-title">videoId
</div>
4389 <span class=
"json-property-required"></span>
4390 <div class=
"prop-subtitle"> in path
</div>
4391 <div class=
"prop-subtitle">
4392 <span class=
"json-property-type">string
</span>
4393 <span class=
"json-property-range" title=
"Value limits"></span>
4396 <div class=
"prop-value">
4397 <p>The video id
</p>
4402 <div class=
"doc-examples"></div>
4404 <div class=
"doc-row">
4405 <div class=
"doc-copy">
4406 <section class=
"swagger-responses">
4407 <div class=
"prop-row prop-group">
4408 <div class=
"prop-name">
4409 <div class=
"prop-title">204 No Content
</div>
4411 <div class=
"prop-value">
4412 <p>successful operation
</p>
4417 <div class=
"doc-examples">
4418 <h5>Response Content-Types:
4419 <span>application/json
</span>
4423 <div class=
"doc-row">
4424 <div class=
"doc-copy">
4425 <section class=
"swagger-request-security">
4426 <table class=
"table">
4429 <th class=
"swagger-request-security-schema"></th>
4430 <th class=
"swagger-request-security-scopes"></th>
4436 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4446 <div id=
"operation--videos--videoId--blacklist-delete" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--blacklist-delete">
4447 <!-- <section class="operation-tags row"> -->
4448 <!-- <div class="doc-copy"> -->
4449 <div class=
"operation-tags">
4450 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4455 <h2 class=
"operation-title">
4456 <span class=
"operation-name">
4457 <span class=
"operation-name">DELETE
</span>
4458 <span class=
"operation-path">/videos/{videoId}/blacklist
</span>
4461 <div class=
"doc-row">
4462 <div class=
"doc-copy">
4463 <section class=
"swagger-request-params">
4464 <div class=
"prop-row prop-group">
4465 <div class=
"prop-name">
4466 <div class=
"prop-title">videoId
</div>
4467 <span class=
"json-property-required"></span>
4468 <div class=
"prop-subtitle"> in path
</div>
4469 <div class=
"prop-subtitle">
4470 <span class=
"json-property-type">string
</span>
4471 <span class=
"json-property-range" title=
"Value limits"></span>
4474 <div class=
"prop-value">
4475 <p>The video id
</p>
4480 <div class=
"doc-examples"></div>
4482 <div class=
"doc-row">
4483 <div class=
"doc-copy">
4484 <section class=
"swagger-responses">
4485 <div class=
"prop-row prop-group">
4486 <div class=
"prop-name">
4487 <div class=
"prop-title">204 No Content
</div>
4489 <div class=
"prop-value">
4490 <p>successful operation
</p>
4495 <div class=
"doc-examples">
4496 <h5>Response Content-Types:
4497 <span>application/json
</span>
4501 <div class=
"doc-row">
4502 <div class=
"doc-copy">
4503 <section class=
"swagger-request-security">
4504 <table class=
"table">
4507 <th class=
"swagger-request-security-schema"></th>
4508 <th class=
"swagger-request-security-scopes"></th>
4514 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4524 <div id=
"operation--videos-blacklist-get" class=
"operation panel" data-traverse-target=
"operation--videos-blacklist-get">
4525 <!-- <section class="operation-tags row"> -->
4526 <!-- <div class="doc-copy"> -->
4527 <div class=
"operation-tags">
4528 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4533 <h2 class=
"operation-title">
4534 <span class=
"operation-name">
4535 <span class=
"operation-name">GET
</span>
4536 <span class=
"operation-path">/videos/blacklist
</span>
4539 <div class=
"doc-row">
4540 <div class=
"doc-copy">
4541 <section class=
"swagger-request-params">
4542 <div class=
"prop-row prop-group">
4543 <div class=
"prop-name">
4544 <div class=
"prop-title">start
</div>
4545 <div class=
"prop-subtitle"> in query
</div>
4546 <div class=
"prop-subtitle">
4547 <span class=
"json-property-type">number
</span>
4548 <span class=
"json-property-range" title=
"Value limits"></span>
4551 <div class=
"prop-value">
4552 <p>starting page
</p>
4555 <div class=
"prop-row prop-group">
4556 <div class=
"prop-name">
4557 <div class=
"prop-title">stop
</div>
4558 <div class=
"prop-subtitle"> in query
</div>
4559 <div class=
"prop-subtitle">
4560 <span class=
"json-property-type">number
</span>
4561 <span class=
"json-property-range" title=
"Value limits"></span>
4564 <div class=
"prop-value">
4565 <p>stopping page
</p>
4568 <div class=
"prop-row prop-group">
4569 <div class=
"prop-name">
4570 <div class=
"prop-title">sort
</div>
4571 <div class=
"prop-subtitle"> in query
</div>
4572 <div class=
"prop-subtitle">
4573 <span class=
"json-property-type">number
</span>
4574 <span class=
"json-property-range" title=
"Value limits"></span>
4577 <div class=
"prop-value">
4583 <div class=
"doc-examples"></div>
4585 <div class=
"doc-row">
4586 <div class=
"doc-copy">
4587 <section class=
"swagger-responses">
4588 <div class=
"prop-row prop-group">
4589 <div class=
"prop-name">
4590 <div class=
"prop-title">200 OK
</div>
4591 <div class=
"prop-ref">
4592 <span class=
"json-schema-ref-array">
4593 <a class=
"json-schema-ref" href=
"#/definitions/VideoBlacklist">VideoBlacklist
</a>
4596 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4598 <div class=
"prop-value">
4599 <p>successful operation
</p>
4602 <div class=
"prop-row prop-inner">
4603 <div class=
"prop-name">type
</div>
4604 <div class=
"prop-value">
4605 <span class=
"json-property-type">
4606 <span class=
"json-schema-ref-array">
4607 <a class=
"json-schema-ref" href=
"#/definitions/VideoBlacklist">VideoBlacklist
</a>
4610 <span class=
"json-property-range" title=
"Value limits"></span>
4615 <div class=
"doc-examples">
4616 <h5>Response Content-Types:
4617 <span>application/json
</span>
4620 <h5>Response Example
4621 <span>(
200 OK)
</span>
4623 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4625 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4626 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4627 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4628 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4629 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4630 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4631 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4632 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
4633 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
4634 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4635 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4636 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
4644 <div class=
"doc-row">
4645 <div class=
"doc-copy">
4646 <section class=
"swagger-request-security">
4647 <table class=
"table">
4650 <th class=
"swagger-request-security-schema"></th>
4651 <th class=
"swagger-request-security-scopes"></th>
4657 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4667 <h1 id=
"tag-VideoChannel" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoChannel">VideoChannel
</h1>
4668 <div id=
"operation--videos-channels-get" class=
"operation panel" data-traverse-target=
"operation--videos-channels-get">
4669 <!-- <section class="operation-tags row"> -->
4670 <!-- <div class="doc-copy"> -->
4671 <div class=
"operation-tags">
4672 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4677 <h2 class=
"operation-title">
4678 <span class=
"operation-name">
4679 <span class=
"operation-name">GET
</span>
4680 <span class=
"operation-path">/videos/channels
</span>
4683 <div class=
"doc-row">
4684 <div class=
"doc-copy">
4685 <section class=
"swagger-request-params">
4686 <div class=
"prop-row prop-group">
4687 <div class=
"prop-name">
4688 <div class=
"prop-title">start
</div>
4689 <div class=
"prop-subtitle"> in query
</div>
4690 <div class=
"prop-subtitle">
4691 <span class=
"json-property-type">number
</span>
4692 <span class=
"json-property-range" title=
"Value limits"></span>
4695 <div class=
"prop-value">
4696 <p>starting page
</p>
4699 <div class=
"prop-row prop-group">
4700 <div class=
"prop-name">
4701 <div class=
"prop-title">stop
</div>
4702 <div class=
"prop-subtitle"> in query
</div>
4703 <div class=
"prop-subtitle">
4704 <span class=
"json-property-type">number
</span>
4705 <span class=
"json-property-range" title=
"Value limits"></span>
4708 <div class=
"prop-value">
4709 <p>stopping page
</p>
4712 <div class=
"prop-row prop-group">
4713 <div class=
"prop-name">
4714 <div class=
"prop-title">sort
</div>
4715 <div class=
"prop-subtitle"> in query
</div>
4716 <div class=
"prop-subtitle">
4717 <span class=
"json-property-type">number
</span>
4718 <span class=
"json-property-range" title=
"Value limits"></span>
4721 <div class=
"prop-value">
4727 <div class=
"doc-examples"></div>
4729 <div class=
"doc-row">
4730 <div class=
"doc-copy">
4731 <section class=
"swagger-responses">
4732 <div class=
"prop-row prop-group">
4733 <div class=
"prop-name">
4734 <div class=
"prop-title">200 OK
</div>
4735 <div class=
"prop-ref">
4736 <span class=
"json-schema-ref-array">
4737 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4740 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4742 <div class=
"prop-value">
4743 <p>successful operation
</p>
4746 <div class=
"prop-row prop-inner">
4747 <div class=
"prop-name">type
</div>
4748 <div class=
"prop-value">
4749 <span class=
"json-property-type">
4750 <span class=
"json-schema-ref-array">
4751 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4754 <span class=
"json-property-range" title=
"Value limits"></span>
4759 <div class=
"doc-examples">
4760 <h5>Response Content-Types:
4761 <span>application/json
</span>
4764 <h5>Response Example
4765 <span>(
200 OK)
</span>
4767 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4769 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4770 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4771 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4772 <span class=
"hljs-attr">"owner
"</span>: {
4773 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4774 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
4776 <span class=
"hljs-attr">"videos
"</span>: [
4778 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4779 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4780 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4781 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4782 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4783 <span class=
"hljs-attr">"category
"</span>: {
4784 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4785 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
4787 <span class=
"hljs-attr">"licence
"</span>: {
4788 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4789 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
4791 <span class=
"hljs-attr">"language
"</span>: {
4792 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4793 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
4795 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
4796 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4797 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
4798 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4799 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4800 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4801 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4802 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
4803 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
4804 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4805 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4806 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4807 <span class=
"hljs-attr">"account
"</span>: {
4808 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4809 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4810 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4811 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4812 <span class=
"hljs-attr">"avatar
"</span>: {
4813 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4814 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4815 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4828 <div id=
"operation--videos-channels-post" class=
"operation panel" data-traverse-target=
"operation--videos-channels-post">
4829 <!-- <section class="operation-tags row"> -->
4830 <!-- <div class="doc-copy"> -->
4831 <div class=
"operation-tags">
4832 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4837 <h2 class=
"operation-title">
4838 <span class=
"operation-name">
4839 <span class=
"operation-name">POST
</span>
4840 <span class=
"operation-path">/videos/channels
</span>
4843 <div class=
"doc-row">
4844 <div class=
"doc-copy">
4845 <section class=
"swagger-request-body">
4846 <div class=
"prop-row">
4847 <div class=
"prop-name">
4848 <div class=
"swagger-request-model">
4850 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannelInput">VideoChannelInput
</a>
4854 <div class=
"prop-value columns small-6">
4855 <!-- <div class="swagger-request-description"> -->
4862 <div class=
"doc-examples">
4864 <h5>Request Content-Types:
4865 <span>application/json
</span>
4867 <h5>Request Example
</h5>
4868 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4869 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4870 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
4877 <div class=
"doc-row">
4878 <div class=
"doc-copy">
4879 <section class=
"swagger-responses">
4880 <div class=
"prop-row prop-group">
4881 <div class=
"prop-name">
4882 <div class=
"prop-title">204 No Content
</div>
4884 <div class=
"prop-value">
4885 <p>successful operation
</p>
4890 <div class=
"doc-examples">
4891 <h5>Response Content-Types:
4892 <span>application/json
</span>
4896 <div class=
"doc-row">
4897 <div class=
"doc-copy">
4898 <section class=
"swagger-request-security">
4899 <table class=
"table">
4902 <th class=
"swagger-request-security-schema"></th>
4903 <th class=
"swagger-request-security-scopes"></th>
4909 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4919 <div id=
"operation--videos-channels--id--get" class=
"operation panel" data-traverse-target=
"operation--videos-channels--id--get">
4920 <!-- <section class="operation-tags row"> -->
4921 <!-- <div class="doc-copy"> -->
4922 <div class=
"operation-tags">
4923 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4928 <h2 class=
"operation-title">
4929 <span class=
"operation-name">
4930 <span class=
"operation-name">GET
</span>
4931 <span class=
"operation-path">/videos/channels/{id}
</span>
4934 <div class=
"doc-row">
4935 <div class=
"doc-copy">
4936 <section class=
"swagger-request-params">
4937 <div class=
"prop-row prop-group">
4938 <div class=
"prop-name">
4939 <div class=
"prop-title">id
</div>
4940 <span class=
"json-property-required"></span>
4941 <div class=
"prop-subtitle"> in path
</div>
4942 <div class=
"prop-subtitle">
4943 <span class=
"json-property-type">string
</span>
4944 <span class=
"json-property-range" title=
"Value limits"></span>
4947 <div class=
"prop-value">
4948 <p>The video id
</p>
4953 <div class=
"doc-examples"></div>
4955 <div class=
"doc-row">
4956 <div class=
"doc-copy">
4957 <section class=
"swagger-responses">
4958 <div class=
"prop-row prop-group">
4959 <div class=
"prop-name">
4960 <div class=
"prop-title">200 OK
</div>
4961 <div class=
"prop-ref">
4963 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4966 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4968 <div class=
"prop-value">
4969 <p>successful operation
</p>
4974 <div class=
"doc-examples">
4975 <h5>Response Content-Types:
4976 <span>application/json
</span>
4979 <h5>Response Example
4980 <span>(
200 OK)
</span>
4982 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4983 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4984 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4985 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4986 <span class=
"hljs-attr">"owner
"</span>: {
4987 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4988 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
4990 <span class=
"hljs-attr">"videos
"</span>: [
4992 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4993 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4994 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4995 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4996 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4997 <span class=
"hljs-attr">"category
"</span>: {
4998 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4999 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5001 <span class=
"hljs-attr">"licence
"</span>: {
5002 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5003 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5005 <span class=
"hljs-attr">"language
"</span>: {
5006 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5007 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5009 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
5010 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5011 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
5012 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5013 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5014 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5015 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5016 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5017 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
5018 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5019 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5020 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5021 <span class=
"hljs-attr">"account
"</span>: {
5022 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5023 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5024 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5025 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5026 <span class=
"hljs-attr">"avatar
"</span>: {
5027 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5028 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5029 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5041 <div id=
"operation--videos-channels--id--put" class=
"operation panel" data-traverse-target=
"operation--videos-channels--id--put">
5042 <!-- <section class="operation-tags row"> -->
5043 <!-- <div class="doc-copy"> -->
5044 <div class=
"operation-tags">
5045 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5050 <h2 class=
"operation-title">
5051 <span class=
"operation-name">
5052 <span class=
"operation-name">PUT
</span>
5053 <span class=
"operation-path">/videos/channels/{id}
</span>
5056 <div class=
"doc-row">
5057 <div class=
"doc-copy">
5058 <section class=
"swagger-request-body">
5059 <div class=
"prop-row">
5060 <div class=
"prop-name">
5061 <div class=
"swagger-request-model">
5063 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannelInput">VideoChannelInput
</a>
5067 <div class=
"prop-value columns small-6">
5068 <!-- <div class="swagger-request-description"> -->
5074 <section class=
"swagger-request-params">
5075 <div class=
"prop-row prop-group">
5076 <div class=
"prop-name">
5077 <div class=
"prop-title">id
</div>
5078 <span class=
"json-property-required"></span>
5079 <div class=
"prop-subtitle"> in path
</div>
5080 <div class=
"prop-subtitle">
5081 <span class=
"json-property-type">string
</span>
5082 <span class=
"json-property-range" title=
"Value limits"></span>
5085 <div class=
"prop-value">
5086 <p>The video id
</p>
5091 <div class=
"doc-examples">
5093 <h5>Request Content-Types:
5094 <span>application/json
</span>
5096 <h5>Request Example
</h5>
5097 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5098 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5099 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
5106 <div class=
"doc-row">
5107 <div class=
"doc-copy">
5108 <section class=
"swagger-responses">
5109 <div class=
"prop-row prop-group">
5110 <div class=
"prop-name">
5111 <div class=
"prop-title">204 No Content
</div>
5113 <div class=
"prop-value">
5114 <p>successful operation
</p>
5119 <div class=
"doc-examples">
5120 <h5>Response Content-Types:
5121 <span>application/json
</span>
5125 <div class=
"doc-row">
5126 <div class=
"doc-copy">
5127 <section class=
"swagger-request-security">
5128 <table class=
"table">
5131 <th class=
"swagger-request-security-schema"></th>
5132 <th class=
"swagger-request-security-scopes"></th>
5138 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5148 <div id=
"operation--videos-channels--id--delete" class=
"operation panel" data-traverse-target=
"operation--videos-channels--id--delete">
5149 <!-- <section class="operation-tags row"> -->
5150 <!-- <div class="doc-copy"> -->
5151 <div class=
"operation-tags">
5152 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5157 <h2 class=
"operation-title">
5158 <span class=
"operation-name">
5159 <span class=
"operation-name">DELETE
</span>
5160 <span class=
"operation-path">/videos/channels/{id}
</span>
5163 <div class=
"doc-row">
5164 <div class=
"doc-copy">
5165 <section class=
"swagger-request-params">
5166 <div class=
"prop-row prop-group">
5167 <div class=
"prop-name">
5168 <div class=
"prop-title">id
</div>
5169 <span class=
"json-property-required"></span>
5170 <div class=
"prop-subtitle"> in path
</div>
5171 <div class=
"prop-subtitle">
5172 <span class=
"json-property-type">string
</span>
5173 <span class=
"json-property-range" title=
"Value limits"></span>
5176 <div class=
"prop-value">
5177 <p>The video id
</p>
5182 <div class=
"doc-examples"></div>
5184 <div class=
"doc-row">
5185 <div class=
"doc-copy">
5186 <section class=
"swagger-responses">
5187 <div class=
"prop-row prop-group">
5188 <div class=
"prop-name">
5189 <div class=
"prop-title">204 No Content
</div>
5191 <div class=
"prop-value">
5192 <p>successful operation
</p>
5197 <div class=
"doc-examples">
5198 <h5>Response Content-Types:
5199 <span>application/json
</span>
5203 <div class=
"doc-row">
5204 <div class=
"doc-copy">
5205 <section class=
"swagger-request-security">
5206 <table class=
"table">
5209 <th class=
"swagger-request-security-schema"></th>
5210 <th class=
"swagger-request-security-scopes"></th>
5216 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5226 <div id=
"operation--videos-accounts--accountId--channels-get" class=
"operation panel" data-traverse-target=
"operation--videos-accounts--accountId--channels-get">
5227 <!-- <section class="operation-tags row"> -->
5228 <!-- <div class="doc-copy"> -->
5229 <div class=
"operation-tags">
5230 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5235 <h2 class=
"operation-title">
5236 <span class=
"operation-name">
5237 <span class=
"operation-name">GET
</span>
5238 <span class=
"operation-path">/videos/accounts/{accountId}/channels
</span>
5241 <div class=
"doc-row">
5242 <div class=
"doc-copy">
5243 <section class=
"swagger-request-params">
5244 <div class=
"prop-row prop-group">
5245 <div class=
"prop-name">
5246 <div class=
"prop-title">accountId
</div>
5247 <span class=
"json-property-required"></span>
5248 <div class=
"prop-subtitle"> in path
</div>
5249 <div class=
"prop-subtitle">
5250 <span class=
"json-property-type">string
</span>
5251 <span class=
"json-property-range" title=
"Value limits"></span>
5254 <div class=
"prop-value">
5255 <p>The account id
</p>
5260 <div class=
"doc-examples"></div>
5262 <div class=
"doc-row">
5263 <div class=
"doc-copy">
5264 <section class=
"swagger-responses">
5265 <div class=
"prop-row prop-group">
5266 <div class=
"prop-name">
5267 <div class=
"prop-title">200 OK
</div>
5268 <div class=
"prop-ref">
5269 <span class=
"json-schema-ref-array">
5270 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
5273 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5275 <div class=
"prop-value">
5276 <p>successful operation
</p>
5279 <div class=
"prop-row prop-inner">
5280 <div class=
"prop-name">type
</div>
5281 <div class=
"prop-value">
5282 <span class=
"json-property-type">
5283 <span class=
"json-schema-ref-array">
5284 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
5287 <span class=
"json-property-range" title=
"Value limits"></span>
5292 <div class=
"doc-examples">
5293 <h5>Response Content-Types:
5294 <span>application/json
</span>
5297 <h5>Response Example
5298 <span>(
200 OK)
</span>
5300 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
5302 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5303 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5304 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5305 <span class=
"hljs-attr">"owner
"</span>: {
5306 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5307 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
5309 <span class=
"hljs-attr">"videos
"</span>: [
5311 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5312 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5313 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5314 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5315 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5316 <span class=
"hljs-attr">"category
"</span>: {
5317 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5318 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5320 <span class=
"hljs-attr">"licence
"</span>: {
5321 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5322 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5324 <span class=
"hljs-attr">"language
"</span>: {
5325 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5326 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5328 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
5329 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5330 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
5331 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5332 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5333 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5334 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5335 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5336 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
5337 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5338 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5339 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5340 <span class=
"hljs-attr">"account
"</span>: {
5341 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5342 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5343 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5344 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5345 <span class=
"hljs-attr">"avatar
"</span>: {
5346 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5347 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5348 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5361 <h1 id=
"tag-VideoComment" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoComment">VideoComment
</h1>
5362 <div id=
"operation--videos--videoId--comment-threads-get" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comment-threads-get">
5363 <!-- <section class="operation-tags row"> -->
5364 <!-- <div class="doc-copy"> -->
5365 <div class=
"operation-tags">
5366 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5371 <h2 class=
"operation-title">
5372 <span class=
"operation-name">
5373 <span class=
"operation-name">GET
</span>
5374 <span class=
"operation-path">/videos/{videoId}/comment-threads
</span>
5377 <div class=
"doc-row">
5378 <div class=
"doc-copy">
5379 <section class=
"swagger-request-params">
5380 <div class=
"prop-row prop-group">
5381 <div class=
"prop-name">
5382 <div class=
"prop-title">videoId
</div>
5383 <span class=
"json-property-required"></span>
5384 <div class=
"prop-subtitle"> in path
</div>
5385 <div class=
"prop-subtitle">
5386 <span class=
"json-property-type">string
</span>
5387 <span class=
"json-property-range" title=
"Value limits"></span>
5390 <div class=
"prop-value">
5391 <p>The video id
</p>
5394 <div class=
"prop-row prop-group">
5395 <div class=
"prop-name">
5396 <div class=
"prop-title">start
</div>
5397 <div class=
"prop-subtitle"> in query
</div>
5398 <div class=
"prop-subtitle">
5399 <span class=
"json-property-type">number
</span>
5400 <span class=
"json-property-range" title=
"Value limits"></span>
5403 <div class=
"prop-value">
5404 <p>starting page
</p>
5407 <div class=
"prop-row prop-group">
5408 <div class=
"prop-name">
5409 <div class=
"prop-title">stop
</div>
5410 <div class=
"prop-subtitle"> in query
</div>
5411 <div class=
"prop-subtitle">
5412 <span class=
"json-property-type">number
</span>
5413 <span class=
"json-property-range" title=
"Value limits"></span>
5416 <div class=
"prop-value">
5417 <p>stopping page
</p>
5420 <div class=
"prop-row prop-group">
5421 <div class=
"prop-name">
5422 <div class=
"prop-title">sort
</div>
5423 <div class=
"prop-subtitle"> in query
</div>
5424 <div class=
"prop-subtitle">
5425 <span class=
"json-property-type">number
</span>
5426 <span class=
"json-property-range" title=
"Value limits"></span>
5429 <div class=
"prop-value">
5435 <div class=
"doc-examples"></div>
5437 <div class=
"doc-row">
5438 <div class=
"doc-copy">
5439 <section class=
"swagger-responses">
5440 <div class=
"prop-row prop-group">
5441 <div class=
"prop-name">
5442 <div class=
"prop-title">200 OK
</div>
5443 <div class=
"prop-ref">
5445 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadResponse">CommentThreadResponse
</a>
5448 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5450 <div class=
"prop-value">
5451 <p>successful operation
</p>
5456 <div class=
"doc-examples">
5457 <h5>Response Content-Types:
5458 <span>application/json
</span>
5461 <h5>Response Example
5462 <span>(
200 OK)
</span>
5464 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5465 <span class=
"hljs-attr">"total
"</span>:
<span class=
"hljs-string">"number
"</span>,
5466 <span class=
"hljs-attr">"data
"</span>: [
5468 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5469 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5470 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5471 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5472 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5473 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5474 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5475 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5476 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5477 <span class=
"hljs-attr">"account
"</span>: {
5478 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5479 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5480 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5481 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5482 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5483 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5484 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5485 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5486 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5487 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5488 <span class=
"hljs-attr">"avatar
"</span>: {
5489 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5490 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5491 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5503 <div id=
"operation--videos--videoId--comment-threads-post" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comment-threads-post">
5504 <!-- <section class="operation-tags row"> -->
5505 <!-- <div class="doc-copy"> -->
5506 <div class=
"operation-tags">
5507 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5512 <h2 class=
"operation-title">
5513 <span class=
"operation-name">
5514 <span class=
"operation-name">POST
</span>
5515 <span class=
"operation-path">/videos/{videoId}/comment-threads
</span>
5518 <div class=
"doc-row">
5519 <div class=
"doc-copy">
5520 <section class=
"swagger-request-params">
5521 <div class=
"prop-row prop-group">
5522 <div class=
"prop-name">
5523 <div class=
"prop-title">videoId
</div>
5524 <span class=
"json-property-required"></span>
5525 <div class=
"prop-subtitle"> in path
</div>
5526 <div class=
"prop-subtitle">
5527 <span class=
"json-property-type">string
</span>
5528 <span class=
"json-property-range" title=
"Value limits"></span>
5531 <div class=
"prop-value">
5532 <p>The video id
</p>
5537 <div class=
"doc-examples"></div>
5539 <div class=
"doc-row">
5540 <div class=
"doc-copy">
5541 <section class=
"swagger-responses">
5542 <div class=
"prop-row prop-group">
5543 <div class=
"prop-name">
5544 <div class=
"prop-title">200 OK
</div>
5545 <div class=
"prop-ref">
5547 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadPostResponse">CommentThreadPostResponse
</a>
5550 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5552 <div class=
"prop-value">
5553 <p>successful operation
</p>
5558 <div class=
"doc-examples">
5559 <h5>Response Content-Types:
5560 <span>application/json
</span>
5563 <h5>Response Example
5564 <span>(
200 OK)
</span>
5566 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5567 <span class=
"hljs-attr">"comment
"</span>: {
5568 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5569 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5570 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5571 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5572 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5573 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5574 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5575 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5576 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5577 <span class=
"hljs-attr">"account
"</span>: {
5578 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5579 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5580 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5581 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5582 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5583 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5584 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5585 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5586 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5587 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5588 <span class=
"hljs-attr">"avatar
"</span>: {
5589 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5590 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5591 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5601 <div class=
"doc-row">
5602 <div class=
"doc-copy">
5603 <section class=
"swagger-request-security">
5604 <table class=
"table">
5607 <th class=
"swagger-request-security-schema"></th>
5608 <th class=
"swagger-request-security-scopes"></th>
5614 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5624 <div id=
"operation--videos--videoId--comment-threads--threadId--get" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comment-threads--threadId--get">
5625 <!-- <section class="operation-tags row"> -->
5626 <!-- <div class="doc-copy"> -->
5627 <div class=
"operation-tags">
5628 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5633 <h2 class=
"operation-title">
5634 <span class=
"operation-name">
5635 <span class=
"operation-name">GET
</span>
5636 <span class=
"operation-path">/videos/{videoId}/comment-threads/{threadId}
</span>
5639 <div class=
"doc-row">
5640 <div class=
"doc-copy">
5641 <section class=
"swagger-request-params">
5642 <div class=
"prop-row prop-group">
5643 <div class=
"prop-name">
5644 <div class=
"prop-title">videoId
</div>
5645 <span class=
"json-property-required"></span>
5646 <div class=
"prop-subtitle"> in path
</div>
5647 <div class=
"prop-subtitle">
5648 <span class=
"json-property-type">string
</span>
5649 <span class=
"json-property-range" title=
"Value limits"></span>
5652 <div class=
"prop-value">
5653 <p>The video id
</p>
5656 <div class=
"prop-row prop-group">
5657 <div class=
"prop-name">
5658 <div class=
"prop-title">threadId
</div>
5659 <span class=
"json-property-required"></span>
5660 <div class=
"prop-subtitle"> in path
</div>
5661 <div class=
"prop-subtitle">
5662 <span class=
"json-property-type">string
</span>
5663 <span class=
"json-property-range" title=
"Value limits"></span>
5666 <div class=
"prop-value">
5667 <p>The thread id
</p>
5672 <div class=
"doc-examples"></div>
5674 <div class=
"doc-row">
5675 <div class=
"doc-copy">
5676 <section class=
"swagger-responses">
5677 <div class=
"prop-row prop-group">
5678 <div class=
"prop-name">
5679 <div class=
"prop-title">200 OK
</div>
5680 <div class=
"prop-ref">
5682 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
5685 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5687 <div class=
"prop-value">
5688 <p>successful operation
</p>
5693 <div class=
"doc-examples">
5694 <h5>Response Content-Types:
5695 <span>application/json
</span>
5698 <h5>Response Example
5699 <span>(
200 OK)
</span>
5701 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5702 <span class=
"hljs-attr">"comment
"</span>: {
5703 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5704 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5705 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5706 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5707 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5708 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5709 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5710 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5711 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5712 <span class=
"hljs-attr">"account
"</span>: {
5713 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5714 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5715 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5716 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5717 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5718 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5719 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5720 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5721 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5722 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5723 <span class=
"hljs-attr">"avatar
"</span>: {
5724 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5725 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5726 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5730 <span class=
"hljs-attr">"children
"</span>: [
5732 <span class=
"hljs-attr">"comment
"</span>: {
5733 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5734 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5735 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5736 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5737 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5738 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5739 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5740 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5741 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5742 <span class=
"hljs-attr">"account
"</span>: {
5743 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5744 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5745 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5746 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5747 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5748 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5749 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5750 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5751 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5752 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5753 <span class=
"hljs-attr">"avatar
"</span>: {
5754 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5755 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5756 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5760 <span class=
"hljs-attr">"children
"</span>: [
5762 <span class=
"hljs-attr">"comment
"</span>: {
5763 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5764 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5765 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5766 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5767 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5768 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5769 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5770 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5771 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5772 <span class=
"hljs-attr">"account
"</span>: {
5773 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5774 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5775 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5776 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5777 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5778 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5779 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5780 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5781 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5782 <span class=
"hljs-attr">"avatar
"</span>: {
5783 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5784 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5785 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5800 <div id=
"operation--videos--videoId--comments--commentId--post" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comments--commentId--post">
5801 <!-- <section class="operation-tags row"> -->
5802 <!-- <div class="doc-copy"> -->
5803 <div class=
"operation-tags">
5804 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5809 <h2 class=
"operation-title">
5810 <span class=
"operation-name">
5811 <span class=
"operation-name">POST
</span>
5812 <span class=
"operation-path">/videos/{videoId}/comments/{commentId}
</span>
5815 <div class=
"doc-row">
5816 <div class=
"doc-copy">
5817 <section class=
"swagger-request-params">
5818 <div class=
"prop-row prop-group">
5819 <div class=
"prop-name">
5820 <div class=
"prop-title">videoId
</div>
5821 <span class=
"json-property-required"></span>
5822 <div class=
"prop-subtitle"> in path
</div>
5823 <div class=
"prop-subtitle">
5824 <span class=
"json-property-type">string
</span>
5825 <span class=
"json-property-range" title=
"Value limits"></span>
5828 <div class=
"prop-value">
5829 <p>The video id
</p>
5832 <div class=
"prop-row prop-group">
5833 <div class=
"prop-name">
5834 <div class=
"prop-title">commentId
</div>
5835 <span class=
"json-property-required"></span>
5836 <div class=
"prop-subtitle"> in path
</div>
5837 <div class=
"prop-subtitle">
5838 <span class=
"json-property-type">string
</span>
5839 <span class=
"json-property-range" title=
"Value limits"></span>
5842 <div class=
"prop-value">
5843 <p>The comment id
</p>
5848 <div class=
"doc-examples"></div>
5850 <div class=
"doc-row">
5851 <div class=
"doc-copy">
5852 <section class=
"swagger-responses">
5853 <div class=
"prop-row prop-group">
5854 <div class=
"prop-name">
5855 <div class=
"prop-title">200 OK
</div>
5856 <div class=
"prop-ref">
5858 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadPostResponse">CommentThreadPostResponse
</a>
5861 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5863 <div class=
"prop-value">
5864 <p>successful operation
</p>
5869 <div class=
"doc-examples">
5870 <h5>Response Content-Types:
5871 <span>application/json
</span>
5874 <h5>Response Example
5875 <span>(
200 OK)
</span>
5877 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5878 <span class=
"hljs-attr">"comment
"</span>: {
5879 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5880 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5881 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5882 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5883 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5884 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5885 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5886 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5887 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5888 <span class=
"hljs-attr">"account
"</span>: {
5889 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5890 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5891 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5892 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5893 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5894 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5895 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5896 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5897 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5898 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5899 <span class=
"hljs-attr">"avatar
"</span>: {
5900 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5901 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5902 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5912 <div class=
"doc-row">
5913 <div class=
"doc-copy">
5914 <section class=
"swagger-request-security">
5915 <table class=
"table">
5918 <th class=
"swagger-request-security-schema"></th>
5919 <th class=
"swagger-request-security-scopes"></th>
5925 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5935 <div id=
"operation--videos--videoId--comments--commentId--delete" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comments--commentId--delete">
5936 <!-- <section class="operation-tags row"> -->
5937 <!-- <div class="doc-copy"> -->
5938 <div class=
"operation-tags">
5939 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5944 <h2 class=
"operation-title">
5945 <span class=
"operation-name">
5946 <span class=
"operation-name">DELETE
</span>
5947 <span class=
"operation-path">/videos/{videoId}/comments/{commentId}
</span>
5950 <div class=
"doc-row">
5951 <div class=
"doc-copy">
5952 <section class=
"swagger-request-params">
5953 <div class=
"prop-row prop-group">
5954 <div class=
"prop-name">
5955 <div class=
"prop-title">videoId
</div>
5956 <span class=
"json-property-required"></span>
5957 <div class=
"prop-subtitle"> in path
</div>
5958 <div class=
"prop-subtitle">
5959 <span class=
"json-property-type">string
</span>
5960 <span class=
"json-property-range" title=
"Value limits"></span>
5963 <div class=
"prop-value">
5964 <p>The video id
</p>
5967 <div class=
"prop-row prop-group">
5968 <div class=
"prop-name">
5969 <div class=
"prop-title">commentId
</div>
5970 <span class=
"json-property-required"></span>
5971 <div class=
"prop-subtitle"> in path
</div>
5972 <div class=
"prop-subtitle">
5973 <span class=
"json-property-type">string
</span>
5974 <span class=
"json-property-range" title=
"Value limits"></span>
5977 <div class=
"prop-value">
5978 <p>The comment id
</p>
5983 <div class=
"doc-examples"></div>
5985 <div class=
"doc-row">
5986 <div class=
"doc-copy">
5987 <section class=
"swagger-responses">
5988 <div class=
"prop-row prop-group">
5989 <div class=
"prop-name">
5990 <div class=
"prop-title">204 No Content
</div>
5992 <div class=
"prop-value">
5993 <p>successful operation
</p>
5998 <div class=
"doc-examples">
5999 <h5>Response Content-Types:
6000 <span>application/json
</span>
6004 <div class=
"doc-row">
6005 <div class=
"doc-copy">
6006 <section class=
"swagger-request-security">
6007 <table class=
"table">
6010 <th class=
"swagger-request-security-schema"></th>
6011 <th class=
"swagger-request-security-scopes"></th>
6017 <a href=
"#security-definition-OAuth2">OAuth2
</a>
6027 <h1 id=
"tag-VideoRate" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoRate">VideoRate
</h1>
6028 <div id=
"operation--videos--id--rate-put" class=
"operation panel" data-traverse-target=
"operation--videos--id--rate-put">
6029 <!-- <section class="operation-tags row"> -->
6030 <!-- <div class="doc-copy"> -->
6031 <div class=
"operation-tags">
6032 <a class=
"label" href=
"#tag-VideoRate">VideoRate
</a>
6037 <h2 class=
"operation-title">
6038 <span class=
"operation-name">
6039 <span class=
"operation-name">PUT
</span>
6040 <span class=
"operation-path">/videos/{id}/rate
</span>
6043 <div class=
"doc-row">
6044 <div class=
"doc-copy">
6045 <section class=
"swagger-request-params">
6046 <div class=
"prop-row prop-group">
6047 <div class=
"prop-name">
6048 <div class=
"prop-title">id
</div>
6049 <span class=
"json-property-required"></span>
6050 <div class=
"prop-subtitle"> in path
</div>
6051 <div class=
"prop-subtitle">
6052 <span class=
"json-property-type">string
</span>
6053 <span class=
"json-property-range" title=
"Value limits"></span>
6056 <div class=
"prop-value">
6057 <p>The video id
</p>
6062 <div class=
"doc-examples"></div>
6064 <div class=
"doc-row">
6065 <div class=
"doc-copy">
6066 <section class=
"swagger-responses">
6067 <div class=
"prop-row prop-group">
6068 <div class=
"prop-name">
6069 <div class=
"prop-title">204 No Content
</div>
6071 <div class=
"prop-value">
6072 <p>successful operation
</p>
6077 <div class=
"doc-examples">
6078 <h5>Response Content-Types:
6079 <span>application/json
</span>
6083 <div class=
"doc-row">
6084 <div class=
"doc-copy">
6085 <section class=
"swagger-request-security">
6086 <table class=
"table">
6089 <th class=
"swagger-request-security-schema"></th>
6090 <th class=
"swagger-request-security-scopes"></th>
6096 <a href=
"#security-definition-OAuth2">OAuth2
</a>
6106 <h1>Schema Definitions
</h1>
6107 <div id=
"definition-VideoConstant" class=
"definition panel" data-traverse-target=
"definition-VideoConstant">
6108 <h2 class=
"panel-title">
6109 <a name=
"/definitions/VideoConstant"></a>VideoConstant:
6110 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6111 <span class="json-property-range" title="Value limits"></span>
6116 <div class=
"doc-row">
6117 <div class=
"doc-copy">
6118 <section class=
"json-schema-properties">
6120 <dt data-property-name=
"id">
6121 <span class=
"json-property-name">id:
</span>
6122 <span class=
"json-property-type">number
</span>
6123 <span class=
"json-property-range" title=
"Value limits"></span>
6125 <dt data-property-name=
"label">
6126 <span class=
"json-property-name">label:
</span>
6127 <span class=
"json-property-type">string
</span>
6128 <span class=
"json-property-range" title=
"Value limits"></span>
6133 <div class=
"doc-examples">
6136 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6137 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6138 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6146 <div id=
"definition-VideoPrivacy" class=
"definition panel" data-traverse-target=
"definition-VideoPrivacy">
6147 <h2 class=
"panel-title">
6148 <a name=
"/definitions/VideoPrivacy"></a>VideoPrivacy: string
6149 <!-- <span class="json-property-type"><span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values">
6150 <span class="json-property-enum-item">Public</span>,
6151 <span class="json-property-enum-item">Unlisted</span>,
6152 <span class="json-property-enum-item">Private</span>
6154 <span class="json-property-range" title="Value limits"></span>
6159 <div class=
"doc-row">
6160 <div class=
"doc-copy">
6161 <span class=
"json-property-type">string
</span>
6162 <span class=
"json-property-enum" title=
"Possible values">
6163 <span class=
"json-property-enum-item">Public
</span>,
6164 <span class=
"json-property-enum-item">Unlisted
</span>,
6165 <span class=
"json-property-enum-item">Private
</span>
6167 <span class=
"json-property-range" title=
"Value limits"></span>
6171 <div id=
"definition-Video" class=
"definition panel" data-traverse-target=
"definition-Video">
6172 <h2 class=
"panel-title">
6173 <a name=
"/definitions/Video"></a>Video:
6174 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6175 <span class="json-property-range" title="Value limits"></span>
6180 <div class=
"doc-row">
6181 <div class=
"doc-copy">
6182 <section class=
"json-schema-properties">
6184 <dt data-property-name=
"id">
6185 <span class=
"json-property-name">id:
</span>
6186 <span class=
"json-property-type">number
</span>
6187 <span class=
"json-property-range" title=
"Value limits"></span>
6189 <dt data-property-name=
"uuid">
6190 <span class=
"json-property-name">uuid:
</span>
6191 <span class=
"json-property-type">string
</span>
6192 <span class=
"json-property-range" title=
"Value limits"></span>
6194 <dt data-property-name=
"createdAt">
6195 <span class=
"json-property-name">createdAt:
</span>
6196 <span class=
"json-property-type">string
</span>
6197 <span class=
"json-property-range" title=
"Value limits"></span>
6199 <dt data-property-name=
"publishedAt">
6200 <span class=
"json-property-name">publishedAt:
</span>
6201 <span class=
"json-property-type">string
</span>
6202 <span class=
"json-property-range" title=
"Value limits"></span>
6204 <dt data-property-name=
"updatedAt">
6205 <span class=
"json-property-name">updatedAt:
</span>
6206 <span class=
"json-property-type">string
</span>
6207 <span class=
"json-property-range" title=
"Value limits"></span>
6209 <dt data-property-name=
"category">
6210 <span class=
"json-property-name">category:
</span>
6211 <span class=
"json-property-type">
6213 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstant">VideoConstant
</a>
6216 <span class=
"json-property-range" title=
"Value limits"></span>
6218 <dt data-property-name=
"licence">
6219 <span class=
"json-property-name">licence:
</span>
6220 <span class=
"json-property-type">
6222 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstant">VideoConstant
</a>
6225 <span class=
"json-property-range" title=
"Value limits"></span>
6227 <dt data-property-name=
"language">
6228 <span class=
"json-property-name">language:
</span>
6229 <span class=
"json-property-type">
6231 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstant">VideoConstant
</a>
6234 <span class=
"json-property-range" title=
"Value limits"></span>
6236 <dt data-property-name=
"privacy">
6237 <span class=
"json-property-name">privacy:
</span>
6238 <span class=
"json-property-type">
6240 <a class=
"json-schema-ref" href=
"#/definitions/VideoPrivacy">VideoPrivacy
</a>
6243 <span class=
"json-property-range" title=
"Value limits"></span>
6245 <dt data-property-name=
"description">
6246 <span class=
"json-property-name">description:
</span>
6247 <span class=
"json-property-type">string
</span>
6248 <span class=
"json-property-range" title=
"Value limits"></span>
6250 <dt data-property-name=
"duration">
6251 <span class=
"json-property-name">duration:
</span>
6252 <span class=
"json-property-type">number
</span>
6253 <span class=
"json-property-range" title=
"Value limits"></span>
6255 <dt data-property-name=
"isLocal">
6256 <span class=
"json-property-name">isLocal:
</span>
6257 <span class=
"json-property-type">boolean
</span>
6258 <span class=
"json-property-range" title=
"Value limits"></span>
6260 <dt data-property-name=
"name">
6261 <span class=
"json-property-name">name:
</span>
6262 <span class=
"json-property-type">string
</span>
6263 <span class=
"json-property-range" title=
"Value limits"></span>
6265 <dt data-property-name=
"thumbnailPath">
6266 <span class=
"json-property-name">thumbnailPath:
</span>
6267 <span class=
"json-property-type">string
</span>
6268 <span class=
"json-property-range" title=
"Value limits"></span>
6270 <dt data-property-name=
"previewPath">
6271 <span class=
"json-property-name">previewPath:
</span>
6272 <span class=
"json-property-type">string
</span>
6273 <span class=
"json-property-range" title=
"Value limits"></span>
6275 <dt data-property-name=
"embedPath">
6276 <span class=
"json-property-name">embedPath:
</span>
6277 <span class=
"json-property-type">string
</span>
6278 <span class=
"json-property-range" title=
"Value limits"></span>
6280 <dt data-property-name=
"views">
6281 <span class=
"json-property-name">views:
</span>
6282 <span class=
"json-property-type">number
</span>
6283 <span class=
"json-property-range" title=
"Value limits"></span>
6285 <dt data-property-name=
"likes">
6286 <span class=
"json-property-name">likes:
</span>
6287 <span class=
"json-property-type">number
</span>
6288 <span class=
"json-property-range" title=
"Value limits"></span>
6290 <dt data-property-name=
"dislikes">
6291 <span class=
"json-property-name">dislikes:
</span>
6292 <span class=
"json-property-type">number
</span>
6293 <span class=
"json-property-range" title=
"Value limits"></span>
6295 <dt data-property-name=
"nsfw">
6296 <span class=
"json-property-name">nsfw:
</span>
6297 <span class=
"json-property-type">boolean
</span>
6298 <span class=
"json-property-range" title=
"Value limits"></span>
6300 <dt data-property-name=
"account">
6301 <span class=
"json-property-name">account:
</span>
6302 <span class=
"json-property-type">object
</span>
6303 <span class=
"json-property-range" title=
"Value limits"></span>
6308 <div class=
"doc-examples">
6311 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6312 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6313 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6314 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6315 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6316 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6317 <span class=
"hljs-attr">"category
"</span>: {
6318 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6319 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6321 <span class=
"hljs-attr">"licence
"</span>: {
6322 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6323 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6325 <span class=
"hljs-attr">"language
"</span>: {
6326 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6327 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6329 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
6330 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6331 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6332 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6333 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6334 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6335 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6336 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6337 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6338 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6339 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6340 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6341 <span class=
"hljs-attr">"account
"</span>: {
6342 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6343 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6344 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6345 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6346 <span class=
"hljs-attr">"avatar
"</span>: {
6347 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6348 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6349 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6359 <div id=
"definition-VideoAbuse" class=
"definition panel" data-traverse-target=
"definition-VideoAbuse">
6360 <h2 class=
"panel-title">
6361 <a name=
"/definitions/VideoAbuse"></a>VideoAbuse:
6362 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6363 <span class="json-property-range" title="Value limits"></span>
6368 <div class=
"doc-row">
6369 <div class=
"doc-copy">
6370 <section class=
"json-schema-properties">
6372 <dt data-property-name=
"id">
6373 <span class=
"json-property-name">id:
</span>
6374 <span class=
"json-property-type">number
</span>
6375 <span class=
"json-property-range" title=
"Value limits"></span>
6377 <dt data-property-name=
"reason">
6378 <span class=
"json-property-name">reason:
</span>
6379 <span class=
"json-property-type">string
</span>
6380 <span class=
"json-property-range" title=
"Value limits"></span>
6382 <dt data-property-name=
"reporterAccount">
6383 <span class=
"json-property-name">reporterAccount:
</span>
6384 <span class=
"json-property-type">
6386 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
6389 <span class=
"json-property-range" title=
"Value limits"></span>
6391 <dt data-property-name=
"video">
6392 <span class=
"json-property-name">video:
</span>
6393 <span class=
"json-property-type">object
</span>
6394 <span class=
"json-property-range" title=
"Value limits"></span>
6396 <dt data-property-name=
"createdAt">
6397 <span class=
"json-property-name">createdAt:
</span>
6398 <span class=
"json-property-type">string
</span>
6399 <span class=
"json-property-range" title=
"Value limits"></span>
6404 <div class=
"doc-examples">
6407 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6408 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6409 <span class=
"hljs-attr">"reason
"</span>:
<span class=
"hljs-string">"string
"</span>,
6410 <span class=
"hljs-attr">"reporterAccount
"</span>: {
6411 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6412 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6413 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6414 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6415 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6416 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6417 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6418 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6419 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6420 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6421 <span class=
"hljs-attr">"avatar
"</span>: {
6422 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6423 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6424 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6427 <span class=
"hljs-attr">"video
"</span>: {
6428 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6429 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6430 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6431 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>
6433 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6441 <div id=
"definition-VideoBlacklist" class=
"definition panel" data-traverse-target=
"definition-VideoBlacklist">
6442 <h2 class=
"panel-title">
6443 <a name=
"/definitions/VideoBlacklist"></a>VideoBlacklist:
6444 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6445 <span class="json-property-range" title="Value limits"></span>
6450 <div class=
"doc-row">
6451 <div class=
"doc-copy">
6452 <section class=
"json-schema-properties">
6454 <dt data-property-name=
"id">
6455 <span class=
"json-property-name">id:
</span>
6456 <span class=
"json-property-type">number
</span>
6457 <span class=
"json-property-range" title=
"Value limits"></span>
6459 <dt data-property-name=
"videoId">
6460 <span class=
"json-property-name">videoId:
</span>
6461 <span class=
"json-property-type">number
</span>
6462 <span class=
"json-property-range" title=
"Value limits"></span>
6464 <dt data-property-name=
"createdAt">
6465 <span class=
"json-property-name">createdAt:
</span>
6466 <span class=
"json-property-type">string
</span>
6467 <span class=
"json-property-range" title=
"Value limits"></span>
6469 <dt data-property-name=
"updatedAt">
6470 <span class=
"json-property-name">updatedAt:
</span>
6471 <span class=
"json-property-type">string
</span>
6472 <span class=
"json-property-range" title=
"Value limits"></span>
6474 <dt data-property-name=
"name">
6475 <span class=
"json-property-name">name:
</span>
6476 <span class=
"json-property-type">string
</span>
6477 <span class=
"json-property-range" title=
"Value limits"></span>
6479 <dt data-property-name=
"uuid">
6480 <span class=
"json-property-name">uuid:
</span>
6481 <span class=
"json-property-type">string
</span>
6482 <span class=
"json-property-range" title=
"Value limits"></span>
6484 <dt data-property-name=
"description">
6485 <span class=
"json-property-name">description:
</span>
6486 <span class=
"json-property-type">string
</span>
6487 <span class=
"json-property-range" title=
"Value limits"></span>
6489 <dt data-property-name=
"duration">
6490 <span class=
"json-property-name">duration:
</span>
6491 <span class=
"json-property-type">number
</span>
6492 <span class=
"json-property-range" title=
"Value limits"></span>
6494 <dt data-property-name=
"views">
6495 <span class=
"json-property-name">views:
</span>
6496 <span class=
"json-property-type">number
</span>
6497 <span class=
"json-property-range" title=
"Value limits"></span>
6499 <dt data-property-name=
"likes">
6500 <span class=
"json-property-name">likes:
</span>
6501 <span class=
"json-property-type">number
</span>
6502 <span class=
"json-property-range" title=
"Value limits"></span>
6504 <dt data-property-name=
"dislikes">
6505 <span class=
"json-property-name">dislikes:
</span>
6506 <span class=
"json-property-type">number
</span>
6507 <span class=
"json-property-range" title=
"Value limits"></span>
6509 <dt data-property-name=
"nsfw">
6510 <span class=
"json-property-name">nsfw:
</span>
6511 <span class=
"json-property-type">boolean
</span>
6512 <span class=
"json-property-range" title=
"Value limits"></span>
6517 <div class=
"doc-examples">
6520 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6521 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6522 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6523 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6524 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6525 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6526 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6527 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6528 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6529 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6530 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6531 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6532 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
6540 <div id=
"definition-VideoChannel" class=
"definition panel" data-traverse-target=
"definition-VideoChannel">
6541 <h2 class=
"panel-title">
6542 <a name=
"/definitions/VideoChannel"></a>VideoChannel:
6543 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6544 <span class="json-property-range" title="Value limits"></span>
6549 <div class=
"doc-row">
6550 <div class=
"doc-copy">
6551 <section class=
"json-schema-properties">
6553 <dt data-property-name=
"displayName">
6554 <span class=
"json-property-name">displayName:
</span>
6555 <span class=
"json-property-type">string
</span>
6556 <span class=
"json-property-range" title=
"Value limits"></span>
6558 <dt data-property-name=
"description">
6559 <span class=
"json-property-name">description:
</span>
6560 <span class=
"json-property-type">string
</span>
6561 <span class=
"json-property-range" title=
"Value limits"></span>
6563 <dt data-property-name=
"isLocal">
6564 <span class=
"json-property-name">isLocal:
</span>
6565 <span class=
"json-property-type">boolean
</span>
6566 <span class=
"json-property-range" title=
"Value limits"></span>
6568 <dt data-property-name=
"owner">
6569 <span class=
"json-property-name">owner:
</span>
6570 <span class=
"json-property-type">object
</span>
6571 <span class=
"json-property-range" title=
"Value limits"></span>
6573 <dt data-property-name=
"videos">
6574 <span class=
"json-property-name">videos:
</span>
6575 <span class=
"json-property-type">
6576 <span class=
"json-schema-ref-array">
6577 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
6580 <span class=
"json-property-range" title=
"Value limits"></span>
6585 <div class=
"doc-examples">
6588 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6589 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6590 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6591 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6592 <span class=
"hljs-attr">"owner
"</span>: {
6593 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6594 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
6596 <span class=
"hljs-attr">"videos
"</span>: [
6598 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6599 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6600 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6601 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6602 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6603 <span class=
"hljs-attr">"category
"</span>: {
6604 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6605 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6607 <span class=
"hljs-attr">"licence
"</span>: {
6608 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6609 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6611 <span class=
"hljs-attr">"language
"</span>: {
6612 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6613 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6615 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
6616 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6617 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6618 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6619 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6620 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6621 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6622 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6623 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6624 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6625 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6626 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6627 <span class=
"hljs-attr">"account
"</span>: {
6628 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6629 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6630 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6631 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6632 <span class=
"hljs-attr">"avatar
"</span>: {
6633 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6634 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6635 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6647 <div id=
"definition-VideoComment" class=
"definition panel" data-traverse-target=
"definition-VideoComment">
6648 <h2 class=
"panel-title">
6649 <a name=
"/definitions/VideoComment"></a>VideoComment:
6650 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6651 <span class="json-property-range" title="Value limits"></span>
6656 <div class=
"doc-row">
6657 <div class=
"doc-copy">
6658 <section class=
"json-schema-properties">
6660 <dt data-property-name=
"id">
6661 <span class=
"json-property-name">id:
</span>
6662 <span class=
"json-property-type">number
</span>
6663 <span class=
"json-property-range" title=
"Value limits"></span>
6665 <dt data-property-name=
"url">
6666 <span class=
"json-property-name">url:
</span>
6667 <span class=
"json-property-type">string
</span>
6668 <span class=
"json-property-range" title=
"Value limits"></span>
6670 <dt data-property-name=
"text">
6671 <span class=
"json-property-name">text:
</span>
6672 <span class=
"json-property-type">string
</span>
6673 <span class=
"json-property-range" title=
"Value limits"></span>
6675 <dt data-property-name=
"threadId">
6676 <span class=
"json-property-name">threadId:
</span>
6677 <span class=
"json-property-type">number
</span>
6678 <span class=
"json-property-range" title=
"Value limits"></span>
6680 <dt data-property-name=
"inReplyToCommentId">
6681 <span class=
"json-property-name">inReplyToCommentId:
</span>
6682 <span class=
"json-property-type">number
</span>
6683 <span class=
"json-property-range" title=
"Value limits"></span>
6685 <dt data-property-name=
"videoId">
6686 <span class=
"json-property-name">videoId:
</span>
6687 <span class=
"json-property-type">number
</span>
6688 <span class=
"json-property-range" title=
"Value limits"></span>
6690 <dt data-property-name=
"createdAt">
6691 <span class=
"json-property-name">createdAt:
</span>
6692 <span class=
"json-property-type">string
</span>
6693 <span class=
"json-property-range" title=
"Value limits"></span>
6695 <dt data-property-name=
"updatedAt">
6696 <span class=
"json-property-name">updatedAt:
</span>
6697 <span class=
"json-property-type">string
</span>
6698 <span class=
"json-property-range" title=
"Value limits"></span>
6700 <dt data-property-name=
"totalReplies">
6701 <span class=
"json-property-name">totalReplies:
</span>
6702 <span class=
"json-property-type">number
</span>
6703 <span class=
"json-property-range" title=
"Value limits"></span>
6705 <dt data-property-name=
"account">
6706 <span class=
"json-property-name">account:
</span>
6707 <span class=
"json-property-type">
6709 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
6712 <span class=
"json-property-range" title=
"Value limits"></span>
6717 <div class=
"doc-examples">
6720 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6721 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6722 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6723 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6724 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6725 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6726 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6727 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6728 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6729 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6730 <span class=
"hljs-attr">"account
"</span>: {
6731 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6732 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6733 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6734 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6735 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6736 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6737 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6738 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6739 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6740 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6741 <span class=
"hljs-attr">"avatar
"</span>: {
6742 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6743 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6744 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6754 <div id=
"definition-VideoCommentThreadTree" class=
"definition panel" data-traverse-target=
"definition-VideoCommentThreadTree">
6755 <h2 class=
"panel-title">
6756 <a name=
"/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree:
6757 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6758 <span class="json-property-range" title="Value limits"></span>
6763 <div class=
"doc-row">
6764 <div class=
"doc-copy">
6765 <section class=
"json-schema-properties">
6767 <dt data-property-name=
"comment">
6768 <span class=
"json-property-name">comment:
</span>
6769 <span class=
"json-property-type">
6771 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
6774 <span class=
"json-property-range" title=
"Value limits"></span>
6776 <dt data-property-name=
"children">
6777 <span class=
"json-property-name">children:
</span>
6778 <span class=
"json-property-type">
6779 <span class=
"json-schema-ref-array">
6780 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
6783 <span class=
"json-property-range" title=
"Value limits"></span>
6788 <div class=
"doc-examples">
6791 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6792 <span class=
"hljs-attr">"comment
"</span>: {
6793 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6794 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6795 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6796 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6797 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6798 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6799 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6800 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6801 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6802 <span class=
"hljs-attr">"account
"</span>: {
6803 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6804 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6805 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6806 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6807 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6808 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6809 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6810 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6811 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6812 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6813 <span class=
"hljs-attr">"avatar
"</span>: {
6814 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6815 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6816 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6820 <span class=
"hljs-attr">"children
"</span>: [
6822 <span class=
"hljs-attr">"comment
"</span>: {
6823 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6824 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6825 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6826 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6827 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6828 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6829 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6830 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6831 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6832 <span class=
"hljs-attr">"account
"</span>: {
6833 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6834 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6835 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6836 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6837 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6838 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6839 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6840 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6841 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6842 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6843 <span class=
"hljs-attr">"avatar
"</span>: {
6844 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6845 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6846 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6850 <span class=
"hljs-attr">"children
"</span>: [
6852 <span class=
"hljs-attr">"comment
"</span>: {
6853 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6854 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6855 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6856 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6857 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6858 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6859 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6860 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6861 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6862 <span class=
"hljs-attr">"account
"</span>: {
6863 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6864 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6865 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6866 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6867 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6868 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6869 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6870 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6871 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6872 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6873 <span class=
"hljs-attr">"avatar
"</span>: {
6874 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6875 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6876 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6891 <div id=
"definition-Avatar" class=
"definition panel" data-traverse-target=
"definition-Avatar">
6892 <h2 class=
"panel-title">
6893 <a name=
"/definitions/Avatar"></a>Avatar:
6894 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6895 <span class="json-property-range" title="Value limits"></span>
6900 <div class=
"doc-row">
6901 <div class=
"doc-copy">
6902 <section class=
"json-schema-properties">
6904 <dt data-property-name=
"path">
6905 <span class=
"json-property-name">path:
</span>
6906 <span class=
"json-property-type">string
</span>
6907 <span class=
"json-property-range" title=
"Value limits"></span>
6909 <dt data-property-name=
"createdAt">
6910 <span class=
"json-property-name">createdAt:
</span>
6911 <span class=
"json-property-type">string
</span>
6912 <span class=
"json-property-range" title=
"Value limits"></span>
6914 <dt data-property-name=
"updatedAt">
6915 <span class=
"json-property-name">updatedAt:
</span>
6916 <span class=
"json-property-type">string
</span>
6917 <span class=
"json-property-range" title=
"Value limits"></span>
6922 <div class=
"doc-examples">
6925 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6926 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6927 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6928 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6936 <div id=
"definition-Actor" class=
"definition panel" data-traverse-target=
"definition-Actor">
6937 <h2 class=
"panel-title">
6938 <a name=
"/definitions/Actor"></a>Actor:
6939 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6940 <span class="json-property-range" title="Value limits"></span>
6945 <div class=
"doc-row">
6946 <div class=
"doc-copy">
6947 <section class=
"json-schema-properties">
6949 <dt data-property-name=
"id">
6950 <span class=
"json-property-name">id:
</span>
6951 <span class=
"json-property-type">number
</span>
6952 <span class=
"json-property-range" title=
"Value limits"></span>
6954 <dt data-property-name=
"uuid">
6955 <span class=
"json-property-name">uuid:
</span>
6956 <span class=
"json-property-type">string
</span>
6957 <span class=
"json-property-range" title=
"Value limits"></span>
6959 <dt data-property-name=
"url">
6960 <span class=
"json-property-name">url:
</span>
6961 <span class=
"json-property-type">string
</span>
6962 <span class=
"json-property-range" title=
"Value limits"></span>
6964 <dt data-property-name=
"name">
6965 <span class=
"json-property-name">name:
</span>
6966 <span class=
"json-property-type">string
</span>
6967 <span class=
"json-property-range" title=
"Value limits"></span>
6969 <dt data-property-name=
"host">
6970 <span class=
"json-property-name">host:
</span>
6971 <span class=
"json-property-type">string
</span>
6972 <span class=
"json-property-range" title=
"Value limits"></span>
6974 <dt data-property-name=
"followingCount">
6975 <span class=
"json-property-name">followingCount:
</span>
6976 <span class=
"json-property-type">number
</span>
6977 <span class=
"json-property-range" title=
"Value limits"></span>
6979 <dt data-property-name=
"followersCount">
6980 <span class=
"json-property-name">followersCount:
</span>
6981 <span class=
"json-property-type">number
</span>
6982 <span class=
"json-property-range" title=
"Value limits"></span>
6984 <dt data-property-name=
"createdAt">
6985 <span class=
"json-property-name">createdAt:
</span>
6986 <span class=
"json-property-type">string
</span>
6987 <span class=
"json-property-range" title=
"Value limits"></span>
6989 <dt data-property-name=
"updatedAt">
6990 <span class=
"json-property-name">updatedAt:
</span>
6991 <span class=
"json-property-type">string
</span>
6992 <span class=
"json-property-range" title=
"Value limits"></span>
6994 <dt data-property-name=
"avatar">
6995 <span class=
"json-property-name">avatar:
</span>
6996 <span class=
"json-property-type">
6998 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
7001 <span class=
"json-property-range" title=
"Value limits"></span>
7006 <div class=
"doc-examples">
7009 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7010 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7011 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7012 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7013 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7014 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7015 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7016 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7017 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7018 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7019 <span class=
"hljs-attr">"avatar
"</span>: {
7020 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7021 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7022 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7031 <div id=
"definition-Account" class=
"definition panel" data-traverse-target=
"definition-Account">
7032 <h2 class=
"panel-title">
7033 <a name=
"/definitions/Account"></a>Account:
7034 <!-- <span class="json-property-type"><span class="json-property-type"></span>
7035 <span class="json-property-range" title="Value limits"></span>
7040 <div class=
"doc-row">
7041 <div class=
"doc-copy">
7042 <section class=
"json-schema-allOf">
7043 <section class=
"json-schema-allOf-inherited">
7046 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7050 <section class=
"json-schema-allOf-additional">
7051 <section class=
"json-schema-properties">
7053 <dt data-property-name=
"displayName">
7054 <span class=
"json-property-name">displayName:
</span>
7055 <span class=
"json-property-type">string
</span>
7056 <span class=
"json-property-range" title=
"Value limits"></span>
7063 <div class=
"doc-examples">
7066 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7067 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7068 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7069 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7070 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7071 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7072 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7073 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7074 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7075 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7076 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7077 <span class=
"hljs-attr">"avatar
"</span>: {
7078 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7079 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7080 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7089 <div id=
"definition-User" class=
"definition panel" data-traverse-target=
"definition-User">
7090 <h2 class=
"panel-title">
7091 <a name=
"/definitions/User"></a>User:
7092 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7093 <span class="json-property-range" title="Value limits"></span>
7098 <div class=
"doc-row">
7099 <div class=
"doc-copy">
7100 <section class=
"json-schema-properties">
7102 <dt data-property-name=
"id">
7103 <span class=
"json-property-name">id:
</span>
7104 <span class=
"json-property-type">number
</span>
7105 <span class=
"json-property-range" title=
"Value limits"></span>
7107 <dt data-property-name=
"username">
7108 <span class=
"json-property-name">username:
</span>
7109 <span class=
"json-property-type">string
</span>
7110 <span class=
"json-property-range" title=
"Value limits"></span>
7112 <dt data-property-name=
"email">
7113 <span class=
"json-property-name">email:
</span>
7114 <span class=
"json-property-type">string
</span>
7115 <span class=
"json-property-range" title=
"Value limits"></span>
7117 <dt data-property-name=
"displayNSFW">
7118 <span class=
"json-property-name">displayNSFW:
</span>
7119 <span class=
"json-property-type">boolean
</span>
7120 <span class=
"json-property-range" title=
"Value limits"></span>
7122 <dt data-property-name=
"autoPlayVideo">
7123 <span class=
"json-property-name">autoPlayVideo:
</span>
7124 <span class=
"json-property-type">boolean
</span>
7125 <span class=
"json-property-range" title=
"Value limits"></span>
7127 <dt data-property-name=
"role">
7128 <span class=
"json-property-name">role:
</span>
7129 <span class=
"json-property-type">string
</span>
7130 <span class=
"json-property-enum" title=
"Possible values">
7131 <span class=
"json-property-enum-item">User
</span>,
7132 <span class=
"json-property-enum-item">Moderator
</span>,
7133 <span class=
"json-property-enum-item">Administrator
</span>
7135 <span class=
"json-property-range" title=
"Value limits"></span>
7137 <dt data-property-name=
"videoQuota">
7138 <span class=
"json-property-name">videoQuota:
</span>
7139 <span class=
"json-property-type">number
</span>
7140 <span class=
"json-property-range" title=
"Value limits"></span>
7142 <dt data-property-name=
"createdAt">
7143 <span class=
"json-property-name">createdAt:
</span>
7144 <span class=
"json-property-type">string
</span>
7145 <span class=
"json-property-range" title=
"Value limits"></span>
7147 <dt data-property-name=
"account">
7148 <span class=
"json-property-name">account:
</span>
7149 <span class=
"json-property-type">
7151 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
7154 <span class=
"json-property-range" title=
"Value limits"></span>
7156 <dt data-property-name=
"videoChannels">
7157 <span class=
"json-property-name">videoChannels:
</span>
7158 <span class=
"json-property-type">
7159 <span class=
"json-schema-ref-array">
7160 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
7163 <span class=
"json-property-range" title=
"Value limits"></span>
7168 <div class=
"doc-examples">
7171 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7172 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7173 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
7174 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
7175 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7176 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7177 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
7178 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
7179 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7180 <span class=
"hljs-attr">"account
"</span>: {
7181 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7182 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7183 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7184 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7185 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7186 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7187 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7188 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7189 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7190 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7191 <span class=
"hljs-attr">"avatar
"</span>: {
7192 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7193 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7194 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7197 <span class=
"hljs-attr">"videoChannels
"</span>: [
7199 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7200 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
7201 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7202 <span class=
"hljs-attr">"owner
"</span>: {
7203 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7204 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
7206 <span class=
"hljs-attr">"videos
"</span>: [
7208 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7209 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7210 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7211 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7212 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7213 <span class=
"hljs-attr">"category
"</span>: {
7214 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7215 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
7217 <span class=
"hljs-attr">"licence
"</span>: {
7218 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7219 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
7221 <span class=
"hljs-attr">"language
"</span>: {
7222 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7223 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
7225 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
7226 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
7227 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
7228 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7229 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7230 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
7231 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
7232 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
7233 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
7234 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
7235 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
7236 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7237 <span class=
"hljs-attr">"account
"</span>: {
7238 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7239 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7240 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7241 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7242 <span class=
"hljs-attr">"avatar
"</span>: {
7243 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7244 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7245 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7259 <div id=
"definition-ServerConfig" class=
"definition panel" data-traverse-target=
"definition-ServerConfig">
7260 <h2 class=
"panel-title">
7261 <a name=
"/definitions/ServerConfig"></a>ServerConfig:
7262 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7263 <span class="json-property-range" title="Value limits"></span>
7268 <div class=
"doc-row">
7269 <div class=
"doc-copy">
7270 <section class=
"json-schema-properties">
7272 <dt data-property-name=
"signup">
7273 <span class=
"json-property-name">signup:
</span>
7274 <span class=
"json-property-type">object
</span>
7275 <span class=
"json-property-range" title=
"Value limits"></span>
7277 <dt data-property-name=
"transcoding">
7278 <span class=
"json-property-name">transcoding:
</span>
7279 <span class=
"json-property-type">object
</span>
7280 <span class=
"json-property-range" title=
"Value limits"></span>
7282 <dt data-property-name=
"avatar">
7283 <span class=
"json-property-name">avatar:
</span>
7284 <span class=
"json-property-type">object
</span>
7285 <span class=
"json-property-range" title=
"Value limits"></span>
7287 <dt data-property-name=
"video">
7288 <span class=
"json-property-name">video:
</span>
7289 <span class=
"json-property-type">object
</span>
7290 <span class=
"json-property-range" title=
"Value limits"></span>
7295 <div class=
"doc-examples">
7298 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7299 <span class=
"hljs-attr">"signup
"</span>: {
7300 <span class=
"hljs-attr">"allowed
"</span>:
<span class=
"hljs-string">"boolean
"</span>
7302 <span class=
"hljs-attr">"transcoding
"</span>: {
7303 <span class=
"hljs-attr">"enabledResolutions
"</span>: [
7304 <span class=
"hljs-string">"number
"</span>
7307 <span class=
"hljs-attr">"avatar
"</span>: {
7308 <span class=
"hljs-attr">"file
"</span>: {
7309 <span class=
"hljs-attr">"size
"</span>: {
7310 <span class=
"hljs-attr">"max
"</span>:
<span class=
"hljs-string">"number
"</span>
7313 <span class=
"hljs-attr">"extensions
"</span>: [
7314 <span class=
"hljs-string">"string
"</span>
7317 <span class=
"hljs-attr">"video
"</span>: {
7318 <span class=
"hljs-attr">"file
"</span>: {
7319 <span class=
"hljs-attr">"extensions
"</span>: [
7320 <span class=
"hljs-string">"string
"</span>
7331 <div id=
"definition-Follow" class=
"definition panel" data-traverse-target=
"definition-Follow">
7332 <h2 class=
"panel-title">
7333 <a name=
"/definitions/Follow"></a>Follow:
7334 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7335 <span class="json-property-range" title="Value limits"></span>
7340 <div class=
"doc-row">
7341 <div class=
"doc-copy">
7342 <section class=
"json-schema-properties">
7344 <dt data-property-name=
"id">
7345 <span class=
"json-property-name">id:
</span>
7346 <span class=
"json-property-type">number
</span>
7347 <span class=
"json-property-range" title=
"Value limits"></span>
7349 <dt data-property-name=
"follower">
7350 <span class=
"json-property-name">follower:
</span>
7351 <span class=
"json-property-type">
7353 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7356 <span class=
"json-property-range" title=
"Value limits"></span>
7358 <dt data-property-name=
"following">
7359 <span class=
"json-property-name">following:
</span>
7360 <span class=
"json-property-type">
7362 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7365 <span class=
"json-property-range" title=
"Value limits"></span>
7367 <dt data-property-name=
"score">
7368 <span class=
"json-property-name">score:
</span>
7369 <span class=
"json-property-type">number
</span>
7370 <span class=
"json-property-range" title=
"Value limits"></span>
7372 <dt data-property-name=
"state">
7373 <span class=
"json-property-name">state:
</span>
7374 <span class=
"json-property-type">string
</span>
7375 <span class=
"json-property-enum" title=
"Possible values">
7376 <span class=
"json-property-enum-item">pending
</span>,
7377 <span class=
"json-property-enum-item">accepted
</span>
7379 <span class=
"json-property-range" title=
"Value limits"></span>
7381 <dt data-property-name=
"createdAt">
7382 <span class=
"json-property-name">createdAt:
</span>
7383 <span class=
"json-property-type">string
</span>
7384 <span class=
"json-property-range" title=
"Value limits"></span>
7386 <dt data-property-name=
"updatedAt">
7387 <span class=
"json-property-name">updatedAt:
</span>
7388 <span class=
"json-property-type">string
</span>
7389 <span class=
"json-property-range" title=
"Value limits"></span>
7394 <div class=
"doc-examples">
7397 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7398 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7399 <span class=
"hljs-attr">"follower
"</span>: {
7400 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7401 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7402 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7403 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7404 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7405 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7406 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7407 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7408 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7409 <span class=
"hljs-attr">"avatar
"</span>: {
7410 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7411 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7412 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7415 <span class=
"hljs-attr">"following
"</span>: {
7416 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7417 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7418 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7419 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7420 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7421 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7422 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7423 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7424 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7425 <span class=
"hljs-attr">"avatar
"</span>: {
7426 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7427 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7428 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7431 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
7432 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
7433 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7434 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7442 <div id=
"definition-Job" class=
"definition panel" data-traverse-target=
"definition-Job">
7443 <h2 class=
"panel-title">
7444 <a name=
"/definitions/Job"></a>Job:
7445 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7446 <span class="json-property-range" title="Value limits"></span>
7451 <div class=
"doc-row">
7452 <div class=
"doc-copy">
7453 <section class=
"json-schema-properties">
7455 <dt data-property-name=
"id">
7456 <span class=
"json-property-name">id:
</span>
7457 <span class=
"json-property-type">number
</span>
7458 <span class=
"json-property-range" title=
"Value limits"></span>
7460 <dt data-property-name=
"state">
7461 <span class=
"json-property-name">state:
</span>
7462 <span class=
"json-property-type">string
</span>
7463 <span class=
"json-property-enum" title=
"Possible values">
7464 <span class=
"json-property-enum-item">pending
</span>,
7465 <span class=
"json-property-enum-item">processing
</span>,
7466 <span class=
"json-property-enum-item">error
</span>,
7467 <span class=
"json-property-enum-item">success
</span>
7469 <span class=
"json-property-range" title=
"Value limits"></span>
7471 <dt data-property-name=
"category">
7472 <span class=
"json-property-name">category:
</span>
7473 <span class=
"json-property-type">string
</span>
7474 <span class=
"json-property-enum" title=
"Possible values">
7475 <span class=
"json-property-enum-item">transcoding
</span>,
7476 <span class=
"json-property-enum-item">activitypub-http
</span>
7478 <span class=
"json-property-range" title=
"Value limits"></span>
7480 <dt data-property-name=
"handlerName">
7481 <span class=
"json-property-name">handlerName:
</span>
7482 <span class=
"json-property-type">string
</span>
7483 <span class=
"json-property-range" title=
"Value limits"></span>
7485 <dt data-property-name=
"handlerInputData">
7486 <span class=
"json-property-name">handlerInputData:
</span>
7487 <span class=
"json-property-type">string
</span>
7488 <span class=
"json-property-range" title=
"Value limits"></span>
7490 <dt data-property-name=
"createdAt">
7491 <span class=
"json-property-name">createdAt:
</span>
7492 <span class=
"json-property-type">string
</span>
7493 <span class=
"json-property-range" title=
"Value limits"></span>
7495 <dt data-property-name=
"updatedAt">
7496 <span class=
"json-property-name">updatedAt:
</span>
7497 <span class=
"json-property-type">string
</span>
7498 <span class=
"json-property-range" title=
"Value limits"></span>
7503 <div class=
"doc-examples">
7506 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7507 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7508 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
7509 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"string
"</span>,
7510 <span class=
"hljs-attr">"handlerName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7511 <span class=
"hljs-attr">"handlerInputData
"</span>:
<span class=
"hljs-string">"string
"</span>,
7512 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7513 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7521 <div id=
"definition-AddUserResponse" class=
"definition panel" data-traverse-target=
"definition-AddUserResponse">
7522 <h2 class=
"panel-title">
7523 <a name=
"/definitions/AddUserResponse"></a>AddUserResponse:
7524 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7525 <span class="json-property-range" title="Value limits"></span>
7530 <div class=
"doc-row">
7531 <div class=
"doc-copy">
7532 <section class=
"json-schema-properties">
7534 <dt data-property-name=
"id">
7535 <span class=
"json-property-name">id:
</span>
7536 <span class=
"json-property-type">number
</span>
7537 <span class=
"json-property-range" title=
"Value limits"></span>
7539 <dt data-property-name=
"uuid">
7540 <span class=
"json-property-name">uuid:
</span>
7541 <span class=
"json-property-type">string
</span>
7542 <span class=
"json-property-range" title=
"Value limits"></span>
7547 <div class=
"doc-examples">
7550 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7551 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7552 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
7560 <div id=
"definition-VideoUploadResponse" class=
"definition panel" data-traverse-target=
"definition-VideoUploadResponse">
7561 <h2 class=
"panel-title">
7562 <a name=
"/definitions/VideoUploadResponse"></a>VideoUploadResponse:
7563 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7564 <span class="json-property-range" title="Value limits"></span>
7569 <div class=
"doc-row">
7570 <div class=
"doc-copy">
7571 <section class=
"json-schema-properties">
7573 <dt data-property-name=
"video">
7574 <span class=
"json-property-name">video:
</span>
7575 <span class=
"json-property-type">object
</span>
7576 <span class=
"json-property-range" title=
"Value limits"></span>
7581 <div class=
"doc-examples">
7584 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7585 <span class=
"hljs-attr">"video
"</span>: {
7586 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7587 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
7596 <div id=
"definition-CommentThreadResponse" class=
"definition panel" data-traverse-target=
"definition-CommentThreadResponse">
7597 <h2 class=
"panel-title">
7598 <a name=
"/definitions/CommentThreadResponse"></a>CommentThreadResponse:
7599 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7600 <span class="json-property-range" title="Value limits"></span>
7605 <div class=
"doc-row">
7606 <div class=
"doc-copy">
7607 <section class=
"json-schema-properties">
7609 <dt data-property-name=
"total">
7610 <span class=
"json-property-name">total:
</span>
7611 <span class=
"json-property-type">number
</span>
7612 <span class=
"json-property-range" title=
"Value limits"></span>
7614 <dt data-property-name=
"data">
7615 <span class=
"json-property-name">data:
</span>
7616 <span class=
"json-property-type">
7617 <span class=
"json-schema-ref-array">
7618 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
7621 <span class=
"json-property-range" title=
"Value limits"></span>
7626 <div class=
"doc-examples">
7629 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7630 <span class=
"hljs-attr">"total
"</span>:
<span class=
"hljs-string">"number
"</span>,
7631 <span class=
"hljs-attr">"data
"</span>: [
7633 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7634 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7635 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7636 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7637 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7638 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7639 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7640 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7641 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7642 <span class=
"hljs-attr">"account
"</span>: {
7643 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7644 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7645 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7646 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7647 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7648 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7649 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7650 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7651 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7652 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7653 <span class=
"hljs-attr">"avatar
"</span>: {
7654 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7655 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7656 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7668 <div id=
"definition-CommentThreadPostResponse" class=
"definition panel" data-traverse-target=
"definition-CommentThreadPostResponse">
7669 <h2 class=
"panel-title">
7670 <a name=
"/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse:
7671 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7672 <span class="json-property-range" title="Value limits"></span>
7677 <div class=
"doc-row">
7678 <div class=
"doc-copy">
7679 <section class=
"json-schema-properties">
7681 <dt data-property-name=
"comment">
7682 <span class=
"json-property-name">comment:
</span>
7683 <span class=
"json-property-type">
7685 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
7688 <span class=
"json-property-range" title=
"Value limits"></span>
7693 <div class=
"doc-examples">
7696 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7697 <span class=
"hljs-attr">"comment
"</span>: {
7698 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7699 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7700 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7701 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7702 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7703 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7704 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7705 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7706 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7707 <span class=
"hljs-attr">"account
"</span>: {
7708 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7709 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7710 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7711 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7712 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7713 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7714 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7715 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7716 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7717 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7718 <span class=
"hljs-attr">"avatar
"</span>: {
7719 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7720 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7721 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7732 <div id=
"definition-AddUser" class=
"definition panel" data-traverse-target=
"definition-AddUser">
7733 <h2 class=
"panel-title">
7734 <a name=
"/definitions/AddUser"></a>AddUser:
7735 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7736 <span class="json-property-range" title="Value limits"></span>
7741 <div class=
"doc-row">
7742 <div class=
"doc-copy">
7743 <section class=
"json-schema-properties">
7745 <dt data-property-name=
"username" class=
"has-description">
7746 <span class=
"json-property-name">username:
</span>
7747 <span class=
"json-property-type">string
</span>
7748 <span class=
"json-property-range" title=
"Value limits"></span>
7749 <span class=
"json-property-required"></span>
7752 <p>The user username
</p>
7754 <dt data-property-name=
"password" class=
"has-description">
7755 <span class=
"json-property-name">password:
</span>
7756 <span class=
"json-property-type">string
</span>
7757 <span class=
"json-property-range" title=
"Value limits"></span>
7758 <span class=
"json-property-required"></span>
7761 <p>The user password
</p>
7763 <dt data-property-name=
"email" class=
"has-description">
7764 <span class=
"json-property-name">email:
</span>
7765 <span class=
"json-property-type">string
</span>
7766 <span class=
"json-property-range" title=
"Value limits"></span>
7767 <span class=
"json-property-required"></span>
7770 <p>The user email
</p>
7772 <dt data-property-name=
"videoQuota" class=
"has-description">
7773 <span class=
"json-property-name">videoQuota:
</span>
7774 <span class=
"json-property-type">string
</span>
7775 <span class=
"json-property-range" title=
"Value limits"></span>
7776 <span class=
"json-property-required"></span>
7779 <p>The user videoQuota
</p>
7781 <dt data-property-name=
"role" class=
"has-description">
7782 <span class=
"json-property-name">role:
</span>
7783 <span class=
"json-property-type">string
</span>
7784 <span class=
"json-property-range" title=
"Value limits"></span>
7785 <span class=
"json-property-required"></span>
7788 <p>The user role
</p>
7793 <div class=
"doc-examples">
7796 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7797 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
7798 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
7799 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
7800 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
7801 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
7809 <div id=
"definition-UpdateUser" class=
"definition panel" data-traverse-target=
"definition-UpdateUser">
7810 <h2 class=
"panel-title">
7811 <a name=
"/definitions/UpdateUser"></a>UpdateUser:
7812 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7813 <span class="json-property-range" title="Value limits"></span>
7818 <div class=
"doc-row">
7819 <div class=
"doc-copy">
7820 <section class=
"json-schema-properties">
7822 <dt data-property-name=
"id" class=
"has-description">
7823 <span class=
"json-property-name">id:
</span>
7824 <span class=
"json-property-type">string
</span>
7825 <span class=
"json-property-range" title=
"Value limits"></span>
7826 <span class=
"json-property-required"></span>
7831 <dt data-property-name=
"email" class=
"has-description">
7832 <span class=
"json-property-name">email:
</span>
7833 <span class=
"json-property-type">string
</span>
7834 <span class=
"json-property-range" title=
"Value limits"></span>
7835 <span class=
"json-property-required"></span>
7838 <p>The updated email of the user
</p>
7840 <dt data-property-name=
"videoQuota" class=
"has-description">
7841 <span class=
"json-property-name">videoQuota:
</span>
7842 <span class=
"json-property-type">string
</span>
7843 <span class=
"json-property-range" title=
"Value limits"></span>
7844 <span class=
"json-property-required"></span>
7847 <p>The updated videoQuota of the user
</p>
7849 <dt data-property-name=
"role" class=
"has-description">
7850 <span class=
"json-property-name">role:
</span>
7851 <span class=
"json-property-type">string
</span>
7852 <span class=
"json-property-range" title=
"Value limits"></span>
7853 <span class=
"json-property-required"></span>
7856 <p>The updated role of the user
</p>
7861 <div class=
"doc-examples">
7864 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7865 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
7866 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
7867 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
7868 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
7876 <div id=
"definition-UpdateMe" class=
"definition panel" data-traverse-target=
"definition-UpdateMe">
7877 <h2 class=
"panel-title">
7878 <a name=
"/definitions/UpdateMe"></a>UpdateMe:
7879 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7880 <span class="json-property-range" title="Value limits"></span>
7885 <div class=
"doc-row">
7886 <div class=
"doc-copy">
7887 <section class=
"json-schema-properties">
7889 <dt data-property-name=
"password" class=
"has-description">
7890 <span class=
"json-property-name">password:
</span>
7891 <span class=
"json-property-type">string
</span>
7892 <span class=
"json-property-range" title=
"Value limits"></span>
7893 <span class=
"json-property-required"></span>
7896 <p>Your new password
</p>
7898 <dt data-property-name=
"email" class=
"has-description">
7899 <span class=
"json-property-name">email:
</span>
7900 <span class=
"json-property-type">string
</span>
7901 <span class=
"json-property-range" title=
"Value limits"></span>
7902 <span class=
"json-property-required"></span>
7905 <p>Your new email
</p>
7907 <dt data-property-name=
"displayNSFW" class=
"has-description">
7908 <span class=
"json-property-name">displayNSFW:
</span>
7909 <span class=
"json-property-type">string
</span>
7910 <span class=
"json-property-range" title=
"Value limits"></span>
7911 <span class=
"json-property-required"></span>
7914 <p>Your new displayNSFW
</p>
7916 <dt data-property-name=
"autoPlayVideo" class=
"has-description">
7917 <span class=
"json-property-name">autoPlayVideo:
</span>
7918 <span class=
"json-property-type">string
</span>
7919 <span class=
"json-property-range" title=
"Value limits"></span>
7920 <span class=
"json-property-required"></span>
7923 <p>Your new autoPlayVideo
</p>
7928 <div class=
"doc-examples">
7931 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7932 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
7933 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
7934 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"string
"</span>,
7935 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"string
"</span>
7943 <div id=
"definition-GetMeVideoRating" class=
"definition panel" data-traverse-target=
"definition-GetMeVideoRating">
7944 <h2 class=
"panel-title">
7945 <a name=
"/definitions/GetMeVideoRating"></a>GetMeVideoRating:
7946 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7947 <span class="json-property-range" title="Value limits"></span>
7952 <div class=
"doc-row">
7953 <div class=
"doc-copy">
7954 <section class=
"json-schema-properties">
7956 <dt data-property-name=
"id" class=
"has-description">
7957 <span class=
"json-property-name">id:
</span>
7958 <span class=
"json-property-type">string
</span>
7959 <span class=
"json-property-range" title=
"Value limits"></span>
7960 <span class=
"json-property-required"></span>
7963 <p>Id of the video
</p>
7965 <dt data-property-name=
"rating" class=
"has-description">
7966 <span class=
"json-property-name">rating:
</span>
7967 <span class=
"json-property-type">number
</span>
7968 <span class=
"json-property-range" title=
"Value limits"></span>
7969 <span class=
"json-property-required"></span>
7972 <p>Rating of the video
</p>
7977 <div class=
"doc-examples">
7980 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7981 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
7982 <span class=
"hljs-attr">"rating
"</span>:
<span class=
"hljs-string">"number
"</span>
7990 <div id=
"definition-RegisterUser" class=
"definition panel" data-traverse-target=
"definition-RegisterUser">
7991 <h2 class=
"panel-title">
7992 <a name=
"/definitions/RegisterUser"></a>RegisterUser:
7993 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7994 <span class="json-property-range" title="Value limits"></span>
7999 <div class=
"doc-row">
8000 <div class=
"doc-copy">
8001 <section class=
"json-schema-properties">
8003 <dt data-property-name=
"username" class=
"has-description">
8004 <span class=
"json-property-name">username:
</span>
8005 <span class=
"json-property-type">string
</span>
8006 <span class=
"json-property-range" title=
"Value limits"></span>
8007 <span class=
"json-property-required"></span>
8010 <p>The username of the user
</p>
8012 <dt data-property-name=
"password" class=
"has-description">
8013 <span class=
"json-property-name">password:
</span>
8014 <span class=
"json-property-type">string
</span>
8015 <span class=
"json-property-range" title=
"Value limits"></span>
8016 <span class=
"json-property-required"></span>
8019 <p>The password of the user
</p>
8021 <dt data-property-name=
"email" class=
"has-description">
8022 <span class=
"json-property-name">email:
</span>
8023 <span class=
"json-property-type">string
</span>
8024 <span class=
"json-property-range" title=
"Value limits"></span>
8025 <span class=
"json-property-required"></span>
8028 <p>The email of the user
</p>
8033 <div class=
"doc-examples">
8036 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8037 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
8038 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
8039 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>
8047 <div id=
"definition-VideoChannelInput" class=
"definition panel" data-traverse-target=
"definition-VideoChannelInput">
8048 <h2 class=
"panel-title">
8049 <a name=
"/definitions/VideoChannelInput"></a>VideoChannelInput:
8050 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8051 <span class="json-property-range" title="Value limits"></span>
8056 <div class=
"doc-row">
8057 <div class=
"doc-copy">
8058 <section class=
"json-schema-properties">
8060 <dt data-property-name=
"name">
8061 <span class=
"json-property-name">name:
</span>
8062 <span class=
"json-property-type">string
</span>
8063 <span class=
"json-property-range" title=
"Value limits"></span>
8065 <dt data-property-name=
"description">
8066 <span class=
"json-property-name">description:
</span>
8067 <span class=
"json-property-type">string
</span>
8068 <span class=
"json-property-range" title=
"Value limits"></span>
8073 <div class=
"doc-examples">
8076 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8077 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
8078 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
8086 <div class=
"doc-row no-margin">
8087 <div class=
"doc-copy doc-separator">
8088 <a class=
"powered-by" href=
"https://sourcey.com/spectacle">Documentation by
8089 <span>Spectacle
</span>