2 <html class=
"no-js" lang=
"en">
4 <meta charset=
"utf-8" />
5 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0" />
6 <title>PeerTube | API Reference
</title>
7 <link rel=
"stylesheet" href=
"stylesheets/foundation.min.css" />
8 <link rel=
"stylesheet" href=
"stylesheets/spectacle.min.css" />
9 <script src=
"https://code.jquery.com/jquery-2.1.4.min.js"></script>
10 <!-- <script src="javascripts/foundation.js"></script> -->
11 <script src=
"javascripts/spectacle.min.js"></script>
14 <div id=
"page" class=
"drawer-layout drawer-slide-right-large">
16 <button class=
"close-button" aria-label=
"Close menu" type=
"button" data-drawer-close
>
17 <span aria-hidden=
"true">×
</span>
19 <nav id=
"nav" role=
"navigation">
21 <a href=
"#introduction">Introduction
</a>
22 <a href=
"#authentication">Authentication
</a>
25 <a href=
"#tag-Accounts">Accounts
</a>
28 <a href=
"#operation--accounts--name--get"> GET /accounts/{name}
</a>
31 <a href=
"#operation--accounts--name--videos-get"> GET /accounts/{name}/videos
</a>
34 <a href=
"#operation--accounts-get"> GET /accounts
</a>
39 <a href=
"#tag-Config">Config
</a>
42 <a href=
"#operation--config-get"> GET /config
</a>
47 <a href=
"#tag-Feeds">Feeds
</a>
50 <a href=
"#operation--feeds-videos.-format--get"> GET /feeds/videos.{format}
</a>
55 <a href=
"#tag-Job">Job
</a>
58 <a href=
"#operation--jobs-get"> GET /jobs
</a>
63 <a href=
"#tag-ServerFollowing">ServerFollowing
</a>
66 <a href=
"#operation--server-following--host--delete"> DELETE /server/following/{host}
</a>
69 <a href=
"#operation--server-followers-get"> GET /server/followers
</a>
72 <a href=
"#operation--server-following-get"> GET /server/following
</a>
75 <a href=
"#operation--server-following-post"> POST /server/following
</a>
80 <a href=
"#tag-User">User
</a>
83 <a href=
"#operation--users-post"> POST /users
</a>
86 <a href=
"#operation--users-get"> GET /users
</a>
89 <a href=
"#operation--users--id--delete"> DELETE /users/{id}
</a>
92 <a href=
"#operation--users--id--get"> GET /users/{id}
</a>
95 <a href=
"#operation--users--id--put"> PUT /users/{id}
</a>
98 <a href=
"#operation--users-me-get"> GET /users/me
</a>
101 <a href=
"#operation--users-me-put"> PUT /users/me
</a>
104 <a href=
"#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used
</a>
107 <a href=
"#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating
</a>
110 <a href=
"#operation--users-me-videos-get"> GET /users/me/videos
</a>
113 <a href=
"#operation--users-register-post"> POST /users/register
</a>
116 <a href=
"#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick
</a>
121 <a href=
"#tag-Video">Video
</a>
124 <a href=
"#operation--videos-get"> GET /videos
</a>
127 <a href=
"#operation--videos-categories-get"> GET /videos/categories
</a>
130 <a href=
"#operation--videos-licences-get"> GET /videos/licences
</a>
133 <a href=
"#operation--videos-languages-get"> GET /videos/languages
</a>
136 <a href=
"#operation--videos-privacies-get"> GET /videos/privacies
</a>
139 <a href=
"#operation--videos-search-get"> GET /videos/search
</a>
142 <a href=
"#operation--videos--id--put"> PUT /videos/{id}
</a>
145 <a href=
"#operation--videos--id--get"> GET /videos/{id}
</a>
148 <a href=
"#operation--videos--id--delete"> DELETE /videos/{id}
</a>
151 <a href=
"#operation--videos--id--description-get"> GET /videos/{id}/description
</a>
154 <a href=
"#operation--videos--id--views-post"> POST /videos/{id}/views
</a>
157 <a href=
"#operation--videos-upload-post"> POST /videos/upload
</a>
162 <a href=
"#tag-VideoAbuse">VideoAbuse
</a>
165 <a href=
"#operation--videos-abuse-get"> GET /videos/abuse
</a>
168 <a href=
"#operation--videos--id--abuse-post"> POST /videos/{id}/abuse
</a>
173 <a href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
176 <a href=
"#operation--videos--id--blacklist-post"> POST /videos/{id}/blacklist
</a>
179 <a href=
"#operation--videos--id--blacklist-delete"> DELETE /videos/{id}/blacklist
</a>
182 <a href=
"#operation--videos-blacklist-get"> GET /videos/blacklist
</a>
187 <a href=
"#tag-VideoChannel">VideoChannel
</a>
190 <a href=
"#operation--video-channels-get"> GET /video-channels
</a>
193 <a href=
"#operation--video-channels-post"> POST /video-channels
</a>
196 <a href=
"#operation--video-channels--id--get"> GET /video-channels/{id}
</a>
199 <a href=
"#operation--video-channels--id--put"> PUT /video-channels/{id}
</a>
202 <a href=
"#operation--video-channels--id--delete"> DELETE /video-channels/{id}
</a>
205 <a href=
"#operation--video-channels--id--videos-get"> GET /video-channels/{id}/videos
</a>
208 <a href=
"#operation--accounts--name--video-channels-get"> GET /accounts/{name}/video-channels
</a>
213 <a href=
"#tag-VideoComment">VideoComment
</a>
216 <a href=
"#operation--videos--id--comment-threads-get"> GET /videos/{id}/comment-threads
</a>
219 <a href=
"#operation--videos--id--comment-threads-post"> POST /videos/{id}/comment-threads
</a>
222 <a href=
"#operation--videos--id--comment-threads--threadId--get"> GET /videos/{id}/comment-threads/{threadId}
</a>
225 <a href=
"#operation--videos--id--comments--commentId--post"> POST /videos/{id}/comments/{commentId}
</a>
228 <a href=
"#operation--videos--id--comments--commentId--delete"> DELETE /videos/{id}/comments/{commentId}
</a>
233 <a href=
"#tag-VideoRate">VideoRate
</a>
236 <a href=
"#operation--videos--id--rate-put"> PUT /videos/{id}/rate
</a>
240 <h5>Schema Definitions
</h5>
241 <a href=
"#definition-VideoConstantNumber"> VideoConstantNumber
</a>
242 <a href=
"#definition-VideoConstantString"> VideoConstantString
</a>
243 <a href=
"#definition-VideoPrivacy"> VideoPrivacy
</a>
244 <a href=
"#definition-Video"> Video
</a>
245 <a href=
"#definition-VideoAbuse"> VideoAbuse
</a>
246 <a href=
"#definition-VideoBlacklist"> VideoBlacklist
</a>
247 <a href=
"#definition-VideoChannel"> VideoChannel
</a>
248 <a href=
"#definition-VideoComment"> VideoComment
</a>
249 <a href=
"#definition-VideoCommentThreadTree"> VideoCommentThreadTree
</a>
250 <a href=
"#definition-Avatar"> Avatar
</a>
251 <a href=
"#definition-Actor"> Actor
</a>
252 <a href=
"#definition-Account"> Account
</a>
253 <a href=
"#definition-User"> User
</a>
254 <a href=
"#definition-ServerConfig"> ServerConfig
</a>
255 <a href=
"#definition-Follow"> Follow
</a>
256 <a href=
"#definition-Job"> Job
</a>
257 <a href=
"#definition-AddUserResponse"> AddUserResponse
</a>
258 <a href=
"#definition-VideoUploadResponse"> VideoUploadResponse
</a>
259 <a href=
"#definition-CommentThreadResponse"> CommentThreadResponse
</a>
260 <a href=
"#definition-CommentThreadPostResponse"> CommentThreadPostResponse
</a>
261 <a href=
"#definition-AddUser"> AddUser
</a>
262 <a href=
"#definition-UpdateUser"> UpdateUser
</a>
263 <a href=
"#definition-UpdateMe"> UpdateMe
</a>
264 <a href=
"#definition-GetMeVideoRating"> GetMeVideoRating
</a>
265 <a href=
"#definition-RegisterUser"> RegisterUser
</a>
266 <a href=
"#definition-VideoChannelInput"> VideoChannelInput
</a>
269 <div id=
"docs" class=
"row collapse expanded drawer" data-drawer
>
270 <button class=
"floating-menu-icon" type=
"button" data-drawer-slide=
"right">
271 <span class=
"hamburger"></span>
273 <div class=
"example-box doc-content"></div>
275 <h1 class=
"doc-title">PeerTube
276 <span>API Reference
</span>
278 <div id=
"introduction" data-traverse-target=
"introduction">
279 <div class=
"doc-row">
280 <div class=
"doc-copy">
281 <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.
</p>
283 <div class=
"doc-examples">
285 <h5>API Endpoint
</h5>
286 <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1
</code></pre>
292 <span>1.0.0-beta
</span>
298 <!-- <h1 id="security" data-traverse-target="security">Security</h1> -->
299 <h1 id=
"authentication" data-traverse-target=
"authentication">Authentication
</h1>
300 <div id=
"security-definition-OAuth2" class=
"panel">
301 <div class=
"doc-row">
302 <div class=
"doc-copy">
303 <h3 class=
"security-definition-title">
304 <span class=
"security-name">OAuth2
</span>
305 <span class=
"swagger-security-definition-oauth2"></span>
307 <section class=
"security-definition-description">
309 <em>Authorization: Bearer mytoken
</em>
312 <section class=
"swagger-security-definition-properties">
313 <div class=
"prop-row security-definition-property">
314 <div class=
"prop-name">
315 <div class=
"prop-title security-definition-property-name">type
</div>
317 <div class=
"prop-value security-definition-property-type"> oauth2
</div>
319 <div class=
"prop-row security-definition-property">
320 <div class=
"prop-name">
321 <div class=
"prop-title security-definition-property-name">flow
</div>
323 <div class=
"prop-value security-definition-property-type"> password
</div>
325 <div class=
"prop-row security-definition-property">
326 <div class=
"prop-name">
327 <div class=
"prop-title security-definition-property-name">tokenUrl
</div>
329 <div class=
"prop-value security-definition-property-type"> https://peertube.example.com/api/v1/users/token
</div>
335 <h1 id=
"tag-Accounts" class=
"swagger-summary-tag" data-traverse-target=
"tag-Accounts">Accounts
</h1>
336 <div id=
"operation--accounts--name--get" class=
"operation panel" data-traverse-target=
"operation--accounts--name--get">
337 <!-- <section class="operation-tags row"> -->
338 <!-- <div class="doc-copy"> -->
339 <div class=
"operation-tags">
340 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
345 <h2 class=
"operation-title">
346 <span class=
"operation-name">
347 <span class=
"operation-name">GET
</span>
348 <span class=
"operation-path">/accounts/{name}
</span>
351 <div class=
"doc-row">
352 <div class=
"doc-copy">
353 <section class=
"swagger-request-params">
354 <div class=
"prop-row prop-group">
355 <div class=
"prop-name">
356 <div class=
"prop-title">name:
357 <span class=
"prop-type">
358 <span class=
"json-property-type">string
</span>
359 <span class=
"json-property-range" title=
"Value limits"></span>
362 <span class=
"json-property-required"></span>
363 <div class=
"prop-subtitle"> in path
</div>
365 <div class=
"prop-value">
366 <p>The name of the account (chocobozzz or
367 <a href=
"mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re
</a> for example)
</p>
370 <div class=
"prop-row prop-group">
371 <div class=
"prop-name">
372 <div class=
"prop-title">start:
373 <span class=
"prop-type">
374 <span class=
"json-property-type">number
</span>
375 <span class=
"json-property-range" title=
"Value limits"></span>
378 <div class=
"prop-subtitle"> in query
</div>
380 <div class=
"prop-value">
384 <div class=
"prop-row prop-group">
385 <div class=
"prop-name">
386 <div class=
"prop-title">count:
387 <span class=
"prop-type">
388 <span class=
"json-property-type">number
</span>
389 <span class=
"json-property-range" title=
"Value limits"></span>
392 <div class=
"prop-subtitle"> in query
</div>
394 <div class=
"prop-value">
395 <p>Number of items
</p>
398 <div class=
"prop-row prop-group">
399 <div class=
"prop-name">
400 <div class=
"prop-title">sort:
401 <span class=
"prop-type">
402 <span class=
"json-property-type">string
</span>
403 <span class=
"json-property-range" title=
"Value limits"></span>
406 <div class=
"prop-subtitle"> in query
</div>
408 <div class=
"prop-value">
409 <p>Sort column (-createdAt for example)
</p>
414 <div class=
"doc-examples"></div>
416 <div class=
"doc-row">
417 <div class=
"doc-copy">
418 <section class=
"swagger-responses">
419 <div class=
"prop-row prop-group">
420 <div class=
"prop-name">
421 <div class=
"prop-title">200 OK
</div>
422 <div class=
"prop-ref">
424 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
427 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
429 <div class=
"prop-value">
430 <p>successful operation
</p>
435 <div class=
"doc-examples">
436 <h5>Response Content-Types:
437 <span>application/json
</span>
441 <span>(
200 OK)
</span>
443 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
444 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
445 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
446 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
447 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
448 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
449 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
450 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
451 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
452 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
453 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
454 <span class=
"hljs-attr">"avatar
"</span>: {
455 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
456 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
457 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
466 <div id=
"operation--accounts--name--videos-get" class=
"operation panel" data-traverse-target=
"operation--accounts--name--videos-get">
467 <!-- <section class="operation-tags row"> -->
468 <!-- <div class="doc-copy"> -->
469 <div class=
"operation-tags">
470 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
475 <h2 class=
"operation-title">
476 <span class=
"operation-name">
477 <span class=
"operation-name">GET
</span>
478 <span class=
"operation-path">/accounts/{name}/videos
</span>
481 <div class=
"doc-row">
482 <div class=
"doc-copy">
483 <section class=
"swagger-request-params">
484 <div class=
"prop-row prop-group">
485 <div class=
"prop-name">
486 <div class=
"prop-title">name:
487 <span class=
"prop-type">
488 <span class=
"json-property-type">string
</span>
489 <span class=
"json-property-range" title=
"Value limits"></span>
492 <span class=
"json-property-required"></span>
493 <div class=
"prop-subtitle"> in path
</div>
495 <div class=
"prop-value">
496 <p>The name of the account (chocobozzz or
497 <a href=
"mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re
</a> for example)
</p>
502 <div class=
"doc-examples"></div>
504 <div class=
"doc-row">
505 <div class=
"doc-copy">
506 <section class=
"swagger-responses">
507 <div class=
"prop-row prop-group">
508 <div class=
"prop-name">
509 <div class=
"prop-title">200 OK
</div>
510 <div class=
"prop-ref">
512 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
515 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
517 <div class=
"prop-value">
518 <p>successful operation
</p>
523 <div class=
"doc-examples">
524 <h5>Response Content-Types:
525 <span>application/json
</span>
529 <span>(
200 OK)
</span>
531 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
532 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
533 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
534 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
535 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
536 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
537 <span class=
"hljs-attr">"category
"</span>: {
538 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
539 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
541 <span class=
"hljs-attr">"licence
"</span>: {
542 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
543 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
545 <span class=
"hljs-attr">"language
"</span>: {
546 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
547 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
549 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
550 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
551 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
552 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
553 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
554 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
555 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
556 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
557 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
558 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
559 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
560 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
561 <span class=
"hljs-attr">"account
"</span>: {
562 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
563 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
564 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
565 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
566 <span class=
"hljs-attr">"avatar
"</span>: {
567 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
568 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
569 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
579 <div id=
"operation--accounts-get" class=
"operation panel" data-traverse-target=
"operation--accounts-get">
580 <!-- <section class="operation-tags row"> -->
581 <!-- <div class="doc-copy"> -->
582 <div class=
"operation-tags">
583 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
588 <h2 class=
"operation-title">
589 <span class=
"operation-name">
590 <span class=
"operation-name">GET
</span>
591 <span class=
"operation-path">/accounts
</span>
594 <div class=
"doc-row">
595 <div class=
"doc-copy"> </div>
596 <div class=
"doc-examples"></div>
598 <div class=
"doc-row">
599 <div class=
"doc-copy">
600 <section class=
"swagger-responses">
601 <div class=
"prop-row prop-group">
602 <div class=
"prop-name">
603 <div class=
"prop-title">200 OK
</div>
604 <div class=
"prop-ref">
605 <span class=
"json-schema-ref-array">
606 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
609 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
611 <div class=
"prop-value">
612 <p>successful operation
</p>
615 <div class=
"prop-row prop-inner">
616 <div class=
"prop-name">type
</div>
617 <div class=
"prop-value">
618 <span class=
"json-property-type">
619 <span class=
"json-schema-ref-array">
620 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
623 <span class=
"json-property-range" title=
"Value limits"></span>
628 <div class=
"doc-examples">
629 <h5>Response Content-Types:
630 <span>application/json
</span>
634 <span>(
200 OK)
</span>
636 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
638 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
639 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
640 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
641 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
642 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
643 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
644 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
645 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
646 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
647 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
648 <span class=
"hljs-attr">"avatar
"</span>: {
649 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
650 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
651 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
661 <h1 id=
"tag-Config" class=
"swagger-summary-tag" data-traverse-target=
"tag-Config">Config
</h1>
662 <div id=
"operation--config-get" class=
"operation panel" data-traverse-target=
"operation--config-get">
663 <!-- <section class="operation-tags row"> -->
664 <!-- <div class="doc-copy"> -->
665 <div class=
"operation-tags">
666 <a class=
"label" href=
"#tag-Config">Config
</a>
671 <h2 class=
"operation-title">
672 <span class=
"operation-name">
673 <span class=
"operation-name">GET
</span>
674 <span class=
"operation-path">/config
</span>
677 <div class=
"doc-row">
678 <div class=
"doc-copy"> </div>
679 <div class=
"doc-examples"></div>
681 <div class=
"doc-row">
682 <div class=
"doc-copy">
683 <section class=
"swagger-responses">
684 <div class=
"prop-row prop-group">
685 <div class=
"prop-name">
686 <div class=
"prop-title">200 OK
</div>
687 <div class=
"prop-ref">
689 <a class=
"json-schema-ref" href=
"#/definitions/ServerConfig">ServerConfig
</a>
692 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
694 <div class=
"prop-value">
695 <p>successful operation
</p>
700 <div class=
"doc-examples">
701 <h5>Response Content-Types:
702 <span>application/json
</span>
706 <span>(
200 OK)
</span>
708 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
709 <span class=
"hljs-attr">"signup
"</span>: {
710 <span class=
"hljs-attr">"allowed
"</span>:
<span class=
"hljs-string">"boolean
"</span>
712 <span class=
"hljs-attr">"transcoding
"</span>: {
713 <span class=
"hljs-attr">"enabledResolutions
"</span>: [
714 <span class=
"hljs-string">"number
"</span>
717 <span class=
"hljs-attr">"avatar
"</span>: {
718 <span class=
"hljs-attr">"file
"</span>: {
719 <span class=
"hljs-attr">"size
"</span>: {
720 <span class=
"hljs-attr">"max
"</span>:
<span class=
"hljs-string">"number
"</span>
723 <span class=
"hljs-attr">"extensions
"</span>: [
724 <span class=
"hljs-string">"string
"</span>
727 <span class=
"hljs-attr">"video
"</span>: {
728 <span class=
"hljs-attr">"file
"</span>: {
729 <span class=
"hljs-attr">"extensions
"</span>: [
730 <span class=
"hljs-string">"string
"</span>
741 <h1 id=
"tag-Feeds" class=
"swagger-summary-tag" data-traverse-target=
"tag-Feeds">Feeds
</h1>
742 <div id=
"operation--feeds-videos.-format--get" class=
"operation panel" data-traverse-target=
"operation--feeds-videos.-format--get">
743 <!-- <section class="operation-tags row"> -->
744 <!-- <div class="doc-copy"> -->
745 <div class=
"operation-tags">
746 <a class=
"label" href=
"#tag-Feeds">Feeds
</a>
751 <h2 class=
"operation-title">
752 <span class=
"operation-name">
753 <span class=
"operation-name">GET
</span>
754 <span class=
"operation-path">/feeds/videos.{format}
</span>
757 <div class=
"doc-row">
758 <div class=
"doc-copy">
759 <section class=
"swagger-request-params">
760 <div class=
"prop-row prop-group">
761 <div class=
"prop-name">
762 <div class=
"prop-title">format:
763 <span class=
"prop-type">
764 <span class=
"json-property-type">string
</span>
765 <span class=
"json-property-enum" title=
"Possible values">
766 <span class=
"json-property-enum-item json-property-enum-default-value">xml
</span>,
767 <span class=
"json-property-enum-item">atom
</span>,
768 <span class=
"json-property-enum-item">json
</span>
770 <span class=
"json-property-range" title=
"Value limits"></span>
771 <span class=
"json-property-default-value" title=
"Default value">xml
</span>
774 <span class=
"json-property-required"></span>
775 <div class=
"prop-subtitle"> in path
</div>
777 <div class=
"prop-value">
778 <p>The format expected (xml defaults to RSS
2.0, atom to ATOM
1.0 and json to JSON FEED
1.0</p>
781 <div class=
"prop-row prop-group">
782 <div class=
"prop-name">
783 <div class=
"prop-title">accountId:
784 <span class=
"prop-type">
785 <span class=
"json-property-type">number
</span>
786 <span class=
"json-property-range" title=
"Value limits"></span>
789 <div class=
"prop-subtitle"> in query
</div>
791 <div class=
"prop-value">
792 <p>The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds
</p>
795 <div class=
"prop-row prop-group">
796 <div class=
"prop-name">
797 <div class=
"prop-title">accountName:
798 <span class=
"prop-type">
799 <span class=
"json-property-type">string
</span>
800 <span class=
"json-property-range" title=
"Value limits"></span>
803 <div class=
"prop-subtitle"> in query
</div>
805 <div class=
"prop-value">
806 <p>The name of the local account to filter to
</p>
811 <div class=
"doc-examples"></div>
813 <div class=
"doc-row">
814 <div class=
"doc-copy">
815 <section class=
"swagger-responses">
816 <div class=
"prop-row prop-group">
817 <div class=
"prop-name">
818 <div class=
"prop-title">200 OK
</div>
820 <div class=
"prop-value">
821 <p>successful operation
</p>
826 <div class=
"doc-examples">
827 <h5>Response Content-Types:
828 <span>application/atom+xml, application/rss+xml, application/json
</span>
833 <h1 id=
"tag-Job" class=
"swagger-summary-tag" data-traverse-target=
"tag-Job">Job
</h1>
834 <div id=
"operation--jobs-get" class=
"operation panel" data-traverse-target=
"operation--jobs-get">
835 <!-- <section class="operation-tags row"> -->
836 <!-- <div class="doc-copy"> -->
837 <div class=
"operation-tags">
838 <a class=
"label" href=
"#tag-Job">Job
</a>
843 <h2 class=
"operation-title">
844 <span class=
"operation-name">
845 <span class=
"operation-name">GET
</span>
846 <span class=
"operation-path">/jobs
</span>
849 <div class=
"doc-row">
850 <div class=
"doc-copy">
851 <section class=
"swagger-request-params">
852 <div class=
"prop-row prop-group">
853 <div class=
"prop-name">
854 <div class=
"prop-title">state:
855 <span class=
"prop-type">
856 <span class=
"json-property-type">string
</span>
857 <span class=
"json-property-range" title=
"Value limits"></span>
860 <span class=
"json-property-required"></span>
861 <div class=
"prop-subtitle"> in path
</div>
863 <div class=
"prop-value">
864 <p>The state of the job
</p>
867 <div class=
"prop-row prop-group">
868 <div class=
"prop-name">
869 <div class=
"prop-title">start:
870 <span class=
"prop-type">
871 <span class=
"json-property-type">number
</span>
872 <span class=
"json-property-range" title=
"Value limits"></span>
875 <div class=
"prop-subtitle"> in query
</div>
877 <div class=
"prop-value">
881 <div class=
"prop-row prop-group">
882 <div class=
"prop-name">
883 <div class=
"prop-title">count:
884 <span class=
"prop-type">
885 <span class=
"json-property-type">number
</span>
886 <span class=
"json-property-range" title=
"Value limits"></span>
889 <div class=
"prop-subtitle"> in query
</div>
891 <div class=
"prop-value">
892 <p>Number of items
</p>
895 <div class=
"prop-row prop-group">
896 <div class=
"prop-name">
897 <div class=
"prop-title">sort:
898 <span class=
"prop-type">
899 <span class=
"json-property-type">string
</span>
900 <span class=
"json-property-range" title=
"Value limits"></span>
903 <div class=
"prop-subtitle"> in query
</div>
905 <div class=
"prop-value">
906 <p>Sort column (-createdAt for example)
</p>
911 <div class=
"doc-examples"></div>
913 <div class=
"doc-row">
914 <div class=
"doc-copy">
915 <section class=
"swagger-responses">
916 <div class=
"prop-row prop-group">
917 <div class=
"prop-name">
918 <div class=
"prop-title">200 OK
</div>
919 <div class=
"prop-ref">
920 <span class=
"json-schema-ref-array">
921 <a class=
"json-schema-ref" href=
"#/definitions/Job">Job
</a>
924 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
926 <div class=
"prop-value">
927 <p>successful operation
</p>
930 <div class=
"prop-row prop-inner">
931 <div class=
"prop-name">type
</div>
932 <div class=
"prop-value">
933 <span class=
"json-property-type">
934 <span class=
"json-schema-ref-array">
935 <a class=
"json-schema-ref" href=
"#/definitions/Job">Job
</a>
938 <span class=
"json-property-range" title=
"Value limits"></span>
943 <div class=
"doc-examples">
944 <h5>Response Content-Types:
945 <span>application/json
</span>
949 <span>(
200 OK)
</span>
951 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
953 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
954 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
955 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"string
"</span>,
956 <span class=
"hljs-attr">"handlerName
"</span>:
<span class=
"hljs-string">"string
"</span>,
957 <span class=
"hljs-attr">"handlerInputData
"</span>:
<span class=
"hljs-string">"string
"</span>,
958 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
959 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
967 <div class=
"doc-row">
968 <div class=
"doc-copy">
969 <section class=
"swagger-request-security">
970 <table class=
"table">
973 <th class=
"swagger-request-security-schema"></th>
974 <th class=
"swagger-request-security-scopes"></th>
980 <a href=
"#security-definition-OAuth2">OAuth2
</a>
990 <h1 id=
"tag-ServerFollowing" class=
"swagger-summary-tag" data-traverse-target=
"tag-ServerFollowing">ServerFollowing
</h1>
991 <div id=
"operation--server-following--host--delete" class=
"operation panel" data-traverse-target=
"operation--server-following--host--delete">
992 <!-- <section class="operation-tags row"> -->
993 <!-- <div class="doc-copy"> -->
994 <div class=
"operation-tags">
995 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1000 <h2 class=
"operation-title">
1001 <span class=
"operation-name">
1002 <span class=
"operation-name">DELETE
</span>
1003 <span class=
"operation-path">/server/following/{host}
</span>
1006 <div class=
"doc-row">
1007 <div class=
"doc-copy">
1008 <section class=
"swagger-request-params">
1009 <div class=
"prop-row prop-group">
1010 <div class=
"prop-name">
1011 <div class=
"prop-title">host:
1012 <span class=
"prop-type">
1013 <span class=
"json-property-type">string
</span>
1014 <span class=
"json-property-range" title=
"Value limits"></span>
1017 <span class=
"json-property-required"></span>
1018 <div class=
"prop-subtitle"> in path
</div>
1020 <div class=
"prop-value">
1021 <p>The host to unfollow
</p>
1026 <div class=
"doc-examples"></div>
1028 <div class=
"doc-row">
1029 <div class=
"doc-copy">
1030 <section class=
"swagger-responses">
1031 <div class=
"prop-row prop-group">
1032 <div class=
"prop-name">
1033 <div class=
"prop-title">201 Created
</div>
1035 <div class=
"prop-value">
1036 <p>successful operation
</p>
1041 <div class=
"doc-examples">
1042 <h5>Response Content-Types:
1043 <span>application/json
</span>
1047 <div class=
"doc-row">
1048 <div class=
"doc-copy">
1049 <section class=
"swagger-request-security">
1050 <table class=
"table">
1053 <th class=
"swagger-request-security-schema"></th>
1054 <th class=
"swagger-request-security-scopes"></th>
1060 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1070 <div id=
"operation--server-followers-get" class=
"operation panel" data-traverse-target=
"operation--server-followers-get">
1071 <!-- <section class="operation-tags row"> -->
1072 <!-- <div class="doc-copy"> -->
1073 <div class=
"operation-tags">
1074 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1079 <h2 class=
"operation-title">
1080 <span class=
"operation-name">
1081 <span class=
"operation-name">GET
</span>
1082 <span class=
"operation-path">/server/followers
</span>
1085 <div class=
"doc-row">
1086 <div class=
"doc-copy">
1087 <section class=
"swagger-request-params">
1088 <div class=
"prop-row prop-group">
1089 <div class=
"prop-name">
1090 <div class=
"prop-title">start:
1091 <span class=
"prop-type">
1092 <span class=
"json-property-type">number
</span>
1093 <span class=
"json-property-range" title=
"Value limits"></span>
1096 <div class=
"prop-subtitle"> in query
</div>
1098 <div class=
"prop-value">
1102 <div class=
"prop-row prop-group">
1103 <div class=
"prop-name">
1104 <div class=
"prop-title">count:
1105 <span class=
"prop-type">
1106 <span class=
"json-property-type">number
</span>
1107 <span class=
"json-property-range" title=
"Value limits"></span>
1110 <div class=
"prop-subtitle"> in query
</div>
1112 <div class=
"prop-value">
1113 <p>Number of items
</p>
1116 <div class=
"prop-row prop-group">
1117 <div class=
"prop-name">
1118 <div class=
"prop-title">sort:
1119 <span class=
"prop-type">
1120 <span class=
"json-property-type">string
</span>
1121 <span class=
"json-property-range" title=
"Value limits"></span>
1124 <div class=
"prop-subtitle"> in query
</div>
1126 <div class=
"prop-value">
1127 <p>Sort column (-createdAt for example)
</p>
1132 <div class=
"doc-examples"></div>
1134 <div class=
"doc-row">
1135 <div class=
"doc-copy">
1136 <section class=
"swagger-responses">
1137 <div class=
"prop-row prop-group">
1138 <div class=
"prop-name">
1139 <div class=
"prop-title">200 OK
</div>
1140 <div class=
"prop-ref">
1141 <span class=
"json-schema-ref-array">
1142 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1145 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1147 <div class=
"prop-value">
1148 <p>successful operation
</p>
1151 <div class=
"prop-row prop-inner">
1152 <div class=
"prop-name">type
</div>
1153 <div class=
"prop-value">
1154 <span class=
"json-property-type">
1155 <span class=
"json-schema-ref-array">
1156 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1159 <span class=
"json-property-range" title=
"Value limits"></span>
1164 <div class=
"doc-examples">
1165 <h5>Response Content-Types:
1166 <span>application/json
</span>
1169 <h5>Response Example
1170 <span>(
200 OK)
</span>
1172 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1174 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1175 <span class=
"hljs-attr">"follower
"</span>: {
1176 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1177 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1178 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1179 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1180 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1181 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1182 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1183 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1184 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1185 <span class=
"hljs-attr">"avatar
"</span>: {
1186 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1187 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1188 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1191 <span class=
"hljs-attr">"following
"</span>: {
1192 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1193 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1194 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1195 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1196 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1197 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1198 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1199 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1200 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1201 <span class=
"hljs-attr">"avatar
"</span>: {
1202 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1203 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1204 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1207 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1208 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1209 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1210 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1219 <div id=
"operation--server-following-get" class=
"operation panel" data-traverse-target=
"operation--server-following-get">
1220 <!-- <section class="operation-tags row"> -->
1221 <!-- <div class="doc-copy"> -->
1222 <div class=
"operation-tags">
1223 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1228 <h2 class=
"operation-title">
1229 <span class=
"operation-name">
1230 <span class=
"operation-name">GET
</span>
1231 <span class=
"operation-path">/server/following
</span>
1234 <div class=
"doc-row">
1235 <div class=
"doc-copy">
1236 <section class=
"swagger-request-params">
1237 <div class=
"prop-row prop-group">
1238 <div class=
"prop-name">
1239 <div class=
"prop-title">start:
1240 <span class=
"prop-type">
1241 <span class=
"json-property-type">number
</span>
1242 <span class=
"json-property-range" title=
"Value limits"></span>
1245 <div class=
"prop-subtitle"> in query
</div>
1247 <div class=
"prop-value">
1251 <div class=
"prop-row prop-group">
1252 <div class=
"prop-name">
1253 <div class=
"prop-title">count:
1254 <span class=
"prop-type">
1255 <span class=
"json-property-type">number
</span>
1256 <span class=
"json-property-range" title=
"Value limits"></span>
1259 <div class=
"prop-subtitle"> in query
</div>
1261 <div class=
"prop-value">
1262 <p>Number of items
</p>
1265 <div class=
"prop-row prop-group">
1266 <div class=
"prop-name">
1267 <div class=
"prop-title">sort:
1268 <span class=
"prop-type">
1269 <span class=
"json-property-type">string
</span>
1270 <span class=
"json-property-range" title=
"Value limits"></span>
1273 <div class=
"prop-subtitle"> in query
</div>
1275 <div class=
"prop-value">
1276 <p>Sort column (-createdAt for example)
</p>
1281 <div class=
"doc-examples"></div>
1283 <div class=
"doc-row">
1284 <div class=
"doc-copy">
1285 <section class=
"swagger-responses">
1286 <div class=
"prop-row prop-group">
1287 <div class=
"prop-name">
1288 <div class=
"prop-title">200 OK
</div>
1289 <div class=
"prop-ref">
1290 <span class=
"json-schema-ref-array">
1291 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1294 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1296 <div class=
"prop-value">
1297 <p>successful operation
</p>
1300 <div class=
"prop-row prop-inner">
1301 <div class=
"prop-name">type
</div>
1302 <div class=
"prop-value">
1303 <span class=
"json-property-type">
1304 <span class=
"json-schema-ref-array">
1305 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1308 <span class=
"json-property-range" title=
"Value limits"></span>
1313 <div class=
"doc-examples">
1314 <h5>Response Content-Types:
1315 <span>application/json
</span>
1318 <h5>Response Example
1319 <span>(
200 OK)
</span>
1321 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1323 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1324 <span class=
"hljs-attr">"follower
"</span>: {
1325 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1326 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1327 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1328 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1329 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1330 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1331 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1332 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1333 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1334 <span class=
"hljs-attr">"avatar
"</span>: {
1335 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1336 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1337 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1340 <span class=
"hljs-attr">"following
"</span>: {
1341 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1342 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1343 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1344 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1345 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1346 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1347 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1348 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1349 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1350 <span class=
"hljs-attr">"avatar
"</span>: {
1351 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1352 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1353 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1356 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1357 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1358 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1359 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1368 <div id=
"operation--server-following-post" class=
"operation panel" data-traverse-target=
"operation--server-following-post">
1369 <!-- <section class="operation-tags row"> -->
1370 <!-- <div class="doc-copy"> -->
1371 <div class=
"operation-tags">
1372 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1377 <h2 class=
"operation-title">
1378 <span class=
"operation-name">
1379 <span class=
"operation-name">POST
</span>
1380 <span class=
"operation-path">/server/following
</span>
1383 <div class=
"doc-row">
1384 <div class=
"doc-copy">
1385 <section class=
"swagger-request-body">
1386 <div class=
"prop-row">
1387 <div class=
"prop-name">
1388 <div class=
"swagger-request-model">
1390 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1394 <div class=
"prop-value columns small-6">
1395 <!-- <div class="swagger-request-description"> -->
1402 <div class=
"doc-examples">
1404 <h5>Request Content-Types:
1405 <span>application/json
</span>
1407 <h5>Request Example
</h5>
1408 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1409 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1410 <span class=
"hljs-attr">"follower
"</span>: {
1411 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1412 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1413 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1414 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1415 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1416 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1417 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1418 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1419 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1420 <span class=
"hljs-attr">"avatar
"</span>: {
1421 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1422 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1423 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1426 <span class=
"hljs-attr">"following
"</span>: {
1427 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1428 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1429 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1430 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1431 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1432 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1433 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1434 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1435 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1436 <span class=
"hljs-attr">"avatar
"</span>: {
1437 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1438 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1439 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1442 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1443 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1444 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1445 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1452 <div class=
"doc-row">
1453 <div class=
"doc-copy">
1454 <section class=
"swagger-responses">
1455 <div class=
"prop-row prop-group">
1456 <div class=
"prop-name">
1457 <div class=
"prop-title">204 No Content
</div>
1459 <div class=
"prop-value">
1460 <p>Successful operation
</p>
1465 <div class=
"doc-examples">
1466 <h5>Response Content-Types:
1467 <span>application/json
</span>
1471 <div class=
"doc-row">
1472 <div class=
"doc-copy">
1473 <section class=
"swagger-request-security">
1474 <table class=
"table">
1477 <th class=
"swagger-request-security-schema"></th>
1478 <th class=
"swagger-request-security-scopes"></th>
1484 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1494 <h1 id=
"tag-User" class=
"swagger-summary-tag" data-traverse-target=
"tag-User">User
</h1>
1495 <div id=
"operation--users-post" class=
"operation panel" data-traverse-target=
"operation--users-post">
1496 <!-- <section class="operation-tags row"> -->
1497 <!-- <div class="doc-copy"> -->
1498 <div class=
"operation-tags">
1499 <a class=
"label" href=
"#tag-User">User
</a>
1504 <h2 class=
"operation-title">
1505 <span class=
"operation-name">
1506 <span class=
"operation-name">POST
</span>
1507 <span class=
"operation-path">/users
</span>
1510 <div class=
"doc-row">
1511 <div class=
"doc-copy">
1512 <section class=
"swagger-request-body">
1513 <div class=
"prop-row">
1514 <div class=
"prop-name">
1515 <div class=
"swagger-request-model">
1517 <a class=
"json-schema-ref" href=
"#/definitions/AddUser">AddUser
</a>
1521 <div class=
"prop-value columns small-6">
1522 <!-- <div class="swagger-request-description"> -->
1523 <p>User to create
</p>
1529 <div class=
"doc-examples">
1531 <h5>Request Content-Types:
1532 <span>application/json
</span>
1534 <h5>Request Example
</h5>
1535 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1536 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1537 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
1538 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1539 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
1540 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
1547 <div class=
"doc-row">
1548 <div class=
"doc-copy">
1549 <section class=
"swagger-responses">
1550 <div class=
"prop-row prop-group">
1551 <div class=
"prop-name">
1552 <div class=
"prop-title">200 OK
</div>
1553 <div class=
"prop-ref">
1555 <a class=
"json-schema-ref" href=
"#/definitions/AddUserResponse">AddUserResponse
</a>
1558 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1560 <div class=
"prop-value">
1561 <p>successful operation
</p>
1566 <div class=
"doc-examples">
1567 <h5>Response Content-Types:
1568 <span>application/json
</span>
1571 <h5>Response Example
1572 <span>(
200 OK)
</span>
1574 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1575 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1576 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1583 <div class=
"doc-row">
1584 <div class=
"doc-copy">
1585 <section class=
"swagger-request-security">
1586 <table class=
"table">
1589 <th class=
"swagger-request-security-schema"></th>
1590 <th class=
"swagger-request-security-scopes"></th>
1596 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1606 <div id=
"operation--users-get" class=
"operation panel" data-traverse-target=
"operation--users-get">
1607 <!-- <section class="operation-tags row"> -->
1608 <!-- <div class="doc-copy"> -->
1609 <div class=
"operation-tags">
1610 <a class=
"label" href=
"#tag-User">User
</a>
1615 <h2 class=
"operation-title">
1616 <span class=
"operation-name">
1617 <span class=
"operation-name">GET
</span>
1618 <span class=
"operation-path">/users
</span>
1621 <div class=
"doc-row">
1622 <div class=
"doc-copy">
1623 <section class=
"swagger-request-params">
1624 <div class=
"prop-row prop-group">
1625 <div class=
"prop-name">
1626 <div class=
"prop-title">start:
1627 <span class=
"prop-type">
1628 <span class=
"json-property-type">number
</span>
1629 <span class=
"json-property-range" title=
"Value limits"></span>
1632 <div class=
"prop-subtitle"> in query
</div>
1634 <div class=
"prop-value">
1638 <div class=
"prop-row prop-group">
1639 <div class=
"prop-name">
1640 <div class=
"prop-title">count:
1641 <span class=
"prop-type">
1642 <span class=
"json-property-type">number
</span>
1643 <span class=
"json-property-range" title=
"Value limits"></span>
1646 <div class=
"prop-subtitle"> in query
</div>
1648 <div class=
"prop-value">
1649 <p>Number of items
</p>
1652 <div class=
"prop-row prop-group">
1653 <div class=
"prop-name">
1654 <div class=
"prop-title">sort:
1655 <span class=
"prop-type">
1656 <span class=
"json-property-type">string
</span>
1657 <span class=
"json-property-range" title=
"Value limits"></span>
1660 <div class=
"prop-subtitle"> in query
</div>
1662 <div class=
"prop-value">
1663 <p>Sort column (-createdAt for example)
</p>
1668 <div class=
"doc-examples"></div>
1670 <div class=
"doc-row">
1671 <div class=
"doc-copy">
1672 <section class=
"swagger-responses">
1673 <div class=
"prop-row prop-group">
1674 <div class=
"prop-name">
1675 <div class=
"prop-title">200 OK
</div>
1676 <div class=
"prop-ref">
1677 <span class=
"json-schema-ref-array">
1678 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1681 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1683 <div class=
"prop-value">
1684 <p>successful operation
</p>
1687 <div class=
"prop-row prop-inner">
1688 <div class=
"prop-name">type
</div>
1689 <div class=
"prop-value">
1690 <span class=
"json-property-type">
1691 <span class=
"json-schema-ref-array">
1692 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1695 <span class=
"json-property-range" title=
"Value limits"></span>
1700 <div class=
"doc-examples">
1701 <h5>Response Content-Types:
1702 <span>application/json
</span>
1705 <h5>Response Example
1706 <span>(
200 OK)
</span>
1708 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1710 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1711 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1712 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1713 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1714 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1715 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1716 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1717 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1718 <span class=
"hljs-attr">"account
"</span>: {
1719 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1720 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1721 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1722 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1723 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1724 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1725 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1726 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1727 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1728 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1729 <span class=
"hljs-attr">"avatar
"</span>: {
1730 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1731 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1732 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1735 <span class=
"hljs-attr">"videoChannels
"</span>: [
1737 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1738 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1739 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1740 <span class=
"hljs-attr">"ownerAccount
"</span>: {
1741 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1742 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1753 <div class=
"doc-row">
1754 <div class=
"doc-copy">
1755 <section class=
"swagger-request-security">
1756 <table class=
"table">
1759 <th class=
"swagger-request-security-schema"></th>
1760 <th class=
"swagger-request-security-scopes"></th>
1766 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1776 <div id=
"operation--users--id--delete" class=
"operation panel" data-traverse-target=
"operation--users--id--delete">
1777 <!-- <section class="operation-tags row"> -->
1778 <!-- <div class="doc-copy"> -->
1779 <div class=
"operation-tags">
1780 <a class=
"label" href=
"#tag-User">User
</a>
1785 <h2 class=
"operation-title">
1786 <span class=
"operation-name">
1787 <span class=
"operation-name">DELETE
</span>
1788 <span class=
"operation-path">/users/{id}
</span>
1791 <div class=
"doc-row">
1792 <div class=
"doc-copy">
1793 <section class=
"swagger-request-params">
1794 <div class=
"prop-row prop-group">
1795 <div class=
"prop-name">
1796 <div class=
"prop-title">id:
1797 <span class=
"prop-type">
1798 <span class=
"json-property-type">number
</span>
1799 <span class=
"json-property-range" title=
"Value limits"></span>
1802 <span class=
"json-property-required"></span>
1803 <div class=
"prop-subtitle"> in path
</div>
1805 <div class=
"prop-value">
1811 <div class=
"doc-examples"></div>
1813 <div class=
"doc-row">
1814 <div class=
"doc-copy">
1815 <section class=
"swagger-responses">
1816 <div class=
"prop-row prop-group">
1817 <div class=
"prop-name">
1818 <div class=
"prop-title">204 No Content
</div>
1820 <div class=
"prop-value">
1821 <p>Successful operation
</p>
1826 <div class=
"doc-examples">
1827 <h5>Response Content-Types:
1828 <span>application/json
</span>
1832 <div class=
"doc-row">
1833 <div class=
"doc-copy">
1834 <section class=
"swagger-request-security">
1835 <table class=
"table">
1838 <th class=
"swagger-request-security-schema"></th>
1839 <th class=
"swagger-request-security-scopes"></th>
1845 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1855 <div id=
"operation--users--id--get" class=
"operation panel" data-traverse-target=
"operation--users--id--get">
1856 <!-- <section class="operation-tags row"> -->
1857 <!-- <div class="doc-copy"> -->
1858 <div class=
"operation-tags">
1859 <a class=
"label" href=
"#tag-User">User
</a>
1864 <h2 class=
"operation-title">
1865 <span class=
"operation-name">
1866 <span class=
"operation-name">GET
</span>
1867 <span class=
"operation-path">/users/{id}
</span>
1870 <div class=
"doc-row">
1871 <div class=
"doc-copy">
1872 <section class=
"swagger-request-params">
1873 <div class=
"prop-row prop-group">
1874 <div class=
"prop-name">
1875 <div class=
"prop-title">id:
1876 <span class=
"prop-type">
1877 <span class=
"json-property-type">number
</span>
1878 <span class=
"json-property-range" title=
"Value limits"></span>
1881 <span class=
"json-property-required"></span>
1882 <div class=
"prop-subtitle"> in path
</div>
1884 <div class=
"prop-value">
1890 <div class=
"doc-examples"></div>
1892 <div class=
"doc-row">
1893 <div class=
"doc-copy">
1894 <section class=
"swagger-responses">
1895 <div class=
"prop-row prop-group">
1896 <div class=
"prop-name">
1897 <div class=
"prop-title">200 OK
</div>
1898 <div class=
"prop-ref">
1900 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1903 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1905 <div class=
"prop-value">
1906 <p>successful operation
</p>
1911 <div class=
"doc-examples">
1912 <h5>Response Content-Types:
1913 <span>application/json
</span>
1916 <h5>Response Example
1917 <span>(
200 OK)
</span>
1919 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1920 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1921 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1922 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1923 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1924 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1925 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1926 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1927 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1928 <span class=
"hljs-attr">"account
"</span>: {
1929 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1930 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1931 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1932 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1933 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1934 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1935 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1936 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1937 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1938 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1939 <span class=
"hljs-attr">"avatar
"</span>: {
1940 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1941 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1942 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1945 <span class=
"hljs-attr">"videoChannels
"</span>: [
1947 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1948 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1949 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1950 <span class=
"hljs-attr">"ownerAccount
"</span>: {
1951 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1952 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1962 <div class=
"doc-row">
1963 <div class=
"doc-copy">
1964 <section class=
"swagger-request-security">
1965 <table class=
"table">
1968 <th class=
"swagger-request-security-schema"></th>
1969 <th class=
"swagger-request-security-scopes"></th>
1975 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1985 <div id=
"operation--users--id--put" class=
"operation panel" data-traverse-target=
"operation--users--id--put">
1986 <!-- <section class="operation-tags row"> -->
1987 <!-- <div class="doc-copy"> -->
1988 <div class=
"operation-tags">
1989 <a class=
"label" href=
"#tag-User">User
</a>
1994 <h2 class=
"operation-title">
1995 <span class=
"operation-name">
1996 <span class=
"operation-name">PUT
</span>
1997 <span class=
"operation-path">/users/{id}
</span>
2000 <div class=
"doc-row">
2001 <div class=
"doc-copy">
2002 <section class=
"swagger-request-body">
2003 <div class=
"prop-row">
2004 <div class=
"prop-name">
2005 <div class=
"swagger-request-model">
2007 <a class=
"json-schema-ref" href=
"#/definitions/UpdateUser">UpdateUser
</a>
2011 <div class=
"prop-value columns small-6">
2012 <!-- <div class="swagger-request-description"> -->
2018 <section class=
"swagger-request-params">
2019 <div class=
"prop-row prop-group">
2020 <div class=
"prop-name">
2021 <div class=
"prop-title">id:
2022 <span class=
"prop-type">
2023 <span class=
"json-property-type">number
</span>
2024 <span class=
"json-property-range" title=
"Value limits"></span>
2027 <span class=
"json-property-required"></span>
2028 <div class=
"prop-subtitle"> in path
</div>
2030 <div class=
"prop-value">
2036 <div class=
"doc-examples">
2038 <h5>Request Content-Types:
2039 <span>application/json
</span>
2041 <h5>Request Example
</h5>
2042 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2043 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2044 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
2045 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
2046 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
2053 <div class=
"doc-row">
2054 <div class=
"doc-copy">
2055 <section class=
"swagger-responses">
2056 <div class=
"prop-row prop-group">
2057 <div class=
"prop-name">
2058 <div class=
"prop-title">204 No Content
</div>
2060 <div class=
"prop-value">
2061 <p>Successful operation
</p>
2066 <div class=
"doc-examples">
2067 <h5>Response Content-Types:
2068 <span>application/json
</span>
2072 <div class=
"doc-row">
2073 <div class=
"doc-copy">
2074 <section class=
"swagger-request-security">
2075 <table class=
"table">
2078 <th class=
"swagger-request-security-schema"></th>
2079 <th class=
"swagger-request-security-scopes"></th>
2085 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2095 <div id=
"operation--users-me-get" class=
"operation panel" data-traverse-target=
"operation--users-me-get">
2096 <!-- <section class="operation-tags row"> -->
2097 <!-- <div class="doc-copy"> -->
2098 <div class=
"operation-tags">
2099 <a class=
"label" href=
"#tag-User">User
</a>
2104 <h2 class=
"operation-title">
2105 <span class=
"operation-name">
2106 <span class=
"operation-name">GET
</span>
2107 <span class=
"operation-path">/users/me
</span>
2110 <div class=
"doc-row">
2111 <div class=
"doc-copy"> </div>
2112 <div class=
"doc-examples"></div>
2114 <div class=
"doc-row">
2115 <div class=
"doc-copy">
2116 <section class=
"swagger-responses">
2117 <div class=
"prop-row prop-group">
2118 <div class=
"prop-name">
2119 <div class=
"prop-title">200 OK
</div>
2120 <div class=
"prop-ref">
2121 <span class=
"json-schema-ref-array">
2122 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
2125 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2127 <div class=
"prop-value">
2128 <p>successful operation
</p>
2131 <div class=
"prop-row prop-inner">
2132 <div class=
"prop-name">type
</div>
2133 <div class=
"prop-value">
2134 <span class=
"json-property-type">
2135 <span class=
"json-schema-ref-array">
2136 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
2139 <span class=
"json-property-range" title=
"Value limits"></span>
2144 <div class=
"doc-examples">
2145 <h5>Response Content-Types:
2146 <span>application/json
</span>
2149 <h5>Response Example
2150 <span>(
200 OK)
</span>
2152 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2154 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2155 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
2156 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
2157 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2158 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2159 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
2160 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
2161 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2162 <span class=
"hljs-attr">"account
"</span>: {
2163 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2164 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2165 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2166 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2167 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2168 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2169 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
2170 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
2171 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2172 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2173 <span class=
"hljs-attr">"avatar
"</span>: {
2174 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2175 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2176 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2179 <span class=
"hljs-attr">"videoChannels
"</span>: [
2181 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2182 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2183 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2184 <span class=
"hljs-attr">"ownerAccount
"</span>: {
2185 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2186 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
2197 <div class=
"doc-row">
2198 <div class=
"doc-copy">
2199 <section class=
"swagger-request-security">
2200 <table class=
"table">
2203 <th class=
"swagger-request-security-schema"></th>
2204 <th class=
"swagger-request-security-scopes"></th>
2210 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2220 <div id=
"operation--users-me-put" class=
"operation panel" data-traverse-target=
"operation--users-me-put">
2221 <!-- <section class="operation-tags row"> -->
2222 <!-- <div class="doc-copy"> -->
2223 <div class=
"operation-tags">
2224 <a class=
"label" href=
"#tag-User">User
</a>
2229 <h2 class=
"operation-title">
2230 <span class=
"operation-name">
2231 <span class=
"operation-name">PUT
</span>
2232 <span class=
"operation-path">/users/me
</span>
2235 <div class=
"doc-row">
2236 <div class=
"doc-copy">
2237 <section class=
"swagger-request-body">
2238 <div class=
"prop-row">
2239 <div class=
"prop-name">
2240 <div class=
"swagger-request-model">
2242 <a class=
"json-schema-ref" href=
"#/definitions/UpdateMe">UpdateMe
</a>
2246 <div class=
"prop-value columns small-6">
2247 <!-- <div class="swagger-request-description"> -->
2254 <div class=
"doc-examples">
2256 <h5>Request Content-Types:
2257 <span>application/json
</span>
2259 <h5>Request Example
</h5>
2260 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2261 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
2262 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
2263 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"string
"</span>,
2264 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"string
"</span>
2271 <div class=
"doc-row">
2272 <div class=
"doc-copy">
2273 <section class=
"swagger-responses">
2274 <div class=
"prop-row prop-group">
2275 <div class=
"prop-name">
2276 <div class=
"prop-title">204 No Content
</div>
2278 <div class=
"prop-value">
2279 <p>Successful operation
</p>
2284 <div class=
"doc-examples">
2285 <h5>Response Content-Types:
2286 <span>application/json
</span>
2290 <div class=
"doc-row">
2291 <div class=
"doc-copy">
2292 <section class=
"swagger-request-security">
2293 <table class=
"table">
2296 <th class=
"swagger-request-security-schema"></th>
2297 <th class=
"swagger-request-security-scopes"></th>
2303 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2313 <div id=
"operation--users-me-video-quota-used-get" class=
"operation panel" data-traverse-target=
"operation--users-me-video-quota-used-get">
2314 <!-- <section class="operation-tags row"> -->
2315 <!-- <div class="doc-copy"> -->
2316 <div class=
"operation-tags">
2317 <a class=
"label" href=
"#tag-User">User
</a>
2322 <h2 class=
"operation-title">
2323 <span class=
"operation-name">
2324 <span class=
"operation-name">GET
</span>
2325 <span class=
"operation-path">/users/me/video-quota-used
</span>
2328 <div class=
"doc-row">
2329 <div class=
"doc-copy"> </div>
2330 <div class=
"doc-examples"></div>
2332 <div class=
"doc-row">
2333 <div class=
"doc-copy">
2334 <section class=
"swagger-responses">
2335 <div class=
"prop-row prop-group">
2336 <div class=
"prop-name">
2337 <div class=
"prop-title">200 OK
</div>
2338 <div class=
"prop-ref"> </div>
2339 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2341 <div class=
"prop-value">
2342 <p>successful operation
</p>
2345 <div class=
"prop-row prop-inner">
2346 <div class=
"prop-name">type
</div>
2347 <div class=
"prop-value">
2348 <span class=
"json-property-type">number
</span>
2349 <span class=
"json-property-range" title=
"Value limits"></span>
2354 <div class=
"doc-examples">
2355 <h5>Response Content-Types:
2356 <span>application/json
</span>
2359 <h5>Response Example
2360 <span>(
200 OK)
</span>
2362 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json"><span class=
"hljs-string">"number
"</span>
2368 <div class=
"doc-row">
2369 <div class=
"doc-copy">
2370 <section class=
"swagger-request-security">
2371 <table class=
"table">
2374 <th class=
"swagger-request-security-schema"></th>
2375 <th class=
"swagger-request-security-scopes"></th>
2381 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2391 <div id=
"operation--users-me-videos--videoId--rating-get" class=
"operation panel" data-traverse-target=
"operation--users-me-videos--videoId--rating-get">
2392 <!-- <section class="operation-tags row"> -->
2393 <!-- <div class="doc-copy"> -->
2394 <div class=
"operation-tags">
2395 <a class=
"label" href=
"#tag-User">User
</a>
2400 <h2 class=
"operation-title">
2401 <span class=
"operation-name">
2402 <span class=
"operation-name">GET
</span>
2403 <span class=
"operation-path">/users/me/videos/{videoId}/rating
</span>
2406 <div class=
"doc-row">
2407 <div class=
"doc-copy">
2408 <section class=
"swagger-request-params">
2409 <div class=
"prop-row prop-group">
2410 <div class=
"prop-name">
2411 <div class=
"prop-title">videoId:
2412 <span class=
"prop-type">
2413 <span class=
"json-property-type">string
</span>
2414 <span class=
"json-property-range" title=
"Value limits"></span>
2417 <span class=
"json-property-required"></span>
2418 <div class=
"prop-subtitle"> in path
</div>
2420 <div class=
"prop-value">
2421 <p>The video id
</p>
2426 <div class=
"doc-examples"></div>
2428 <div class=
"doc-row">
2429 <div class=
"doc-copy">
2430 <section class=
"swagger-responses">
2431 <div class=
"prop-row prop-group">
2432 <div class=
"prop-name">
2433 <div class=
"prop-title">200 OK
</div>
2434 <div class=
"prop-ref">
2436 <a class=
"json-schema-ref" href=
"#/definitions/GetMeVideoRating">GetMeVideoRating
</a>
2439 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2441 <div class=
"prop-value">
2442 <p>successful operation
</p>
2447 <div class=
"doc-examples">
2448 <h5>Response Content-Types:
2449 <span>application/json
</span>
2452 <h5>Response Example
2453 <span>(
200 OK)
</span>
2455 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2456 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2457 <span class=
"hljs-attr">"rating
"</span>:
<span class=
"hljs-string">"number
"</span>
2464 <div class=
"doc-row">
2465 <div class=
"doc-copy">
2466 <section class=
"swagger-request-security">
2467 <table class=
"table">
2470 <th class=
"swagger-request-security-schema"></th>
2471 <th class=
"swagger-request-security-scopes"></th>
2477 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2487 <div id=
"operation--users-me-videos-get" class=
"operation panel" data-traverse-target=
"operation--users-me-videos-get">
2488 <!-- <section class="operation-tags row"> -->
2489 <!-- <div class="doc-copy"> -->
2490 <div class=
"operation-tags">
2491 <a class=
"label" href=
"#tag-User">User
</a>
2496 <h2 class=
"operation-title">
2497 <span class=
"operation-name">
2498 <span class=
"operation-name">GET
</span>
2499 <span class=
"operation-path">/users/me/videos
</span>
2502 <div class=
"doc-row">
2503 <div class=
"doc-copy">
2504 <section class=
"swagger-request-params">
2505 <div class=
"prop-row prop-group">
2506 <div class=
"prop-name">
2507 <div class=
"prop-title">start:
2508 <span class=
"prop-type">
2509 <span class=
"json-property-type">number
</span>
2510 <span class=
"json-property-range" title=
"Value limits"></span>
2513 <div class=
"prop-subtitle"> in query
</div>
2515 <div class=
"prop-value">
2519 <div class=
"prop-row prop-group">
2520 <div class=
"prop-name">
2521 <div class=
"prop-title">count:
2522 <span class=
"prop-type">
2523 <span class=
"json-property-type">number
</span>
2524 <span class=
"json-property-range" title=
"Value limits"></span>
2527 <div class=
"prop-subtitle"> in query
</div>
2529 <div class=
"prop-value">
2530 <p>Number of items
</p>
2533 <div class=
"prop-row prop-group">
2534 <div class=
"prop-name">
2535 <div class=
"prop-title">sort:
2536 <span class=
"prop-type">
2537 <span class=
"json-property-type">string
</span>
2538 <span class=
"json-property-range" title=
"Value limits"></span>
2541 <div class=
"prop-subtitle"> in query
</div>
2543 <div class=
"prop-value">
2544 <p>Sort column (-createdAt for example)
</p>
2549 <div class=
"doc-examples"></div>
2551 <div class=
"doc-row">
2552 <div class=
"doc-copy">
2553 <section class=
"swagger-responses">
2554 <div class=
"prop-row prop-group">
2555 <div class=
"prop-name">
2556 <div class=
"prop-title">200 OK
</div>
2557 <div class=
"prop-ref">
2558 <span class=
"json-schema-ref-array">
2559 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2562 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2564 <div class=
"prop-value">
2565 <p>successful operation
</p>
2568 <div class=
"prop-row prop-inner">
2569 <div class=
"prop-name">type
</div>
2570 <div class=
"prop-value">
2571 <span class=
"json-property-type">
2572 <span class=
"json-schema-ref-array">
2573 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2576 <span class=
"json-property-range" title=
"Value limits"></span>
2581 <div class=
"doc-examples">
2582 <h5>Response Content-Types:
2583 <span>application/json
</span>
2586 <h5>Response Example
2587 <span>(
200 OK)
</span>
2589 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2591 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2592 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2593 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2594 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2595 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2596 <span class=
"hljs-attr">"category
"</span>: {
2597 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2598 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2600 <span class=
"hljs-attr">"licence
"</span>: {
2601 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2602 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2604 <span class=
"hljs-attr">"language
"</span>: {
2605 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2606 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2608 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
2609 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2610 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2611 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2612 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2613 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2614 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2615 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2616 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2617 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2618 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2619 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2620 <span class=
"hljs-attr">"account
"</span>: {
2621 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2622 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2623 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2624 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2625 <span class=
"hljs-attr">"avatar
"</span>: {
2626 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2627 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2628 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2638 <div class=
"doc-row">
2639 <div class=
"doc-copy">
2640 <section class=
"swagger-request-security">
2641 <table class=
"table">
2644 <th class=
"swagger-request-security-schema"></th>
2645 <th class=
"swagger-request-security-scopes"></th>
2651 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2661 <div id=
"operation--users-register-post" class=
"operation panel" data-traverse-target=
"operation--users-register-post">
2662 <!-- <section class="operation-tags row"> -->
2663 <!-- <div class="doc-copy"> -->
2664 <div class=
"operation-tags">
2665 <a class=
"label" href=
"#tag-User">User
</a>
2670 <h2 class=
"operation-title">
2671 <span class=
"operation-name">
2672 <span class=
"operation-name">POST
</span>
2673 <span class=
"operation-path">/users/register
</span>
2676 <div class=
"doc-row">
2677 <div class=
"doc-copy">
2678 <section class=
"swagger-request-body">
2679 <div class=
"prop-row">
2680 <div class=
"prop-name">
2681 <div class=
"swagger-request-model">
2683 <a class=
"json-schema-ref" href=
"#/definitions/RegisterUser">RegisterUser
</a>
2687 <div class=
"prop-value columns small-6">
2688 <!-- <div class="swagger-request-description"> -->
2695 <div class=
"doc-examples">
2697 <h5>Request Content-Types:
2698 <span>application/json
</span>
2700 <h5>Request Example
</h5>
2701 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2702 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
2703 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
2704 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>
2711 <div class=
"doc-row">
2712 <div class=
"doc-copy">
2713 <section class=
"swagger-responses">
2714 <div class=
"prop-row prop-group">
2715 <div class=
"prop-name">
2716 <div class=
"prop-title">204 No Content
</div>
2718 <div class=
"prop-value">
2719 <p>Successful operation
</p>
2724 <div class=
"doc-examples">
2725 <h5>Response Content-Types:
2726 <span>application/json
</span>
2731 <div id=
"operation--users-me-avatar-pick-post" class=
"operation panel" data-traverse-target=
"operation--users-me-avatar-pick-post">
2732 <!-- <section class="operation-tags row"> -->
2733 <!-- <div class="doc-copy"> -->
2734 <div class=
"operation-tags">
2735 <a class=
"label" href=
"#tag-User">User
</a>
2740 <h2 class=
"operation-title">
2741 <span class=
"operation-name">
2742 <span class=
"operation-name">POST
</span>
2743 <span class=
"operation-path">/users/me/avatar/pick
</span>
2746 <div class=
"doc-row">
2747 <div class=
"doc-copy">
2748 <section class=
"swagger-request-params">
2749 <div class=
"prop-row prop-group">
2750 <div class=
"prop-name">
2751 <div class=
"prop-title">avatarfile:
2752 <span class=
"prop-type">
2753 <span class=
"json-property-type">file
</span>
2754 <span class=
"json-property-range" title=
"Value limits"></span>
2757 <div class=
"prop-subtitle"> in formData
</div>
2759 <div class=
"prop-value">
2760 <p>The file to upload.
</p>
2765 <div class=
"doc-examples"></div>
2767 <div class=
"doc-row">
2768 <div class=
"doc-copy">
2769 <section class=
"swagger-responses">
2770 <div class=
"prop-row prop-group">
2771 <div class=
"prop-name">
2772 <div class=
"prop-title">200 OK
</div>
2773 <div class=
"prop-ref">
2775 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
2778 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2780 <div class=
"prop-value">
2781 <p>successful operation
</p>
2786 <div class=
"doc-examples">
2787 <h5>Response Content-Types:
2788 <span>application/json
</span>
2791 <h5>Response Example
2792 <span>(
200 OK)
</span>
2794 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2795 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2796 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2797 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2804 <div class=
"doc-row">
2805 <div class=
"doc-copy">
2806 <section class=
"swagger-request-security">
2807 <table class=
"table">
2810 <th class=
"swagger-request-security-schema"></th>
2811 <th class=
"swagger-request-security-scopes"></th>
2817 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2827 <h1 id=
"tag-Video" class=
"swagger-summary-tag" data-traverse-target=
"tag-Video">Video
</h1>
2828 <div id=
"operation--videos-get" class=
"operation panel" data-traverse-target=
"operation--videos-get">
2829 <!-- <section class="operation-tags row"> -->
2830 <!-- <div class="doc-copy"> -->
2831 <div class=
"operation-tags">
2832 <a class=
"label" href=
"#tag-Video">Video
</a>
2837 <h2 class=
"operation-title">
2838 <span class=
"operation-name">
2839 <span class=
"operation-name">GET
</span>
2840 <span class=
"operation-path">/videos
</span>
2843 <div class=
"doc-row">
2844 <div class=
"doc-copy">
2845 <section class=
"swagger-request-params">
2846 <div class=
"prop-row prop-group">
2847 <div class=
"prop-name">
2848 <div class=
"prop-title">category:
2849 <span class=
"prop-type">
2850 <span class=
"json-property-type">number
</span>
2851 <span class=
"json-property-range" title=
"Value limits"></span>
2854 <div class=
"prop-subtitle"> in query
</div>
2856 <div class=
"prop-value">
2857 <p>category id of the video
</p>
2860 <div class=
"prop-row prop-group">
2861 <div class=
"prop-name">
2862 <div class=
"prop-title">start:
2863 <span class=
"prop-type">
2864 <span class=
"json-property-type">number
</span>
2865 <span class=
"json-property-range" title=
"Value limits"></span>
2868 <div class=
"prop-subtitle"> in query
</div>
2870 <div class=
"prop-value">
2874 <div class=
"prop-row prop-group">
2875 <div class=
"prop-name">
2876 <div class=
"prop-title">count:
2877 <span class=
"prop-type">
2878 <span class=
"json-property-type">number
</span>
2879 <span class=
"json-property-range" title=
"Value limits"></span>
2882 <div class=
"prop-subtitle"> in query
</div>
2884 <div class=
"prop-value">
2885 <p>Number of items
</p>
2888 <div class=
"prop-row prop-group">
2889 <div class=
"prop-name">
2890 <div class=
"prop-title">sort:
2891 <span class=
"prop-type">
2892 <span class=
"json-property-type">string
</span>
2893 <span class=
"json-property-range" title=
"Value limits"></span>
2896 <div class=
"prop-subtitle"> in query
</div>
2898 <div class=
"prop-value">
2899 <p>Sort column (-createdAt for example)
</p>
2904 <div class=
"doc-examples"></div>
2906 <div class=
"doc-row">
2907 <div class=
"doc-copy">
2908 <section class=
"swagger-responses">
2909 <div class=
"prop-row prop-group">
2910 <div class=
"prop-name">
2911 <div class=
"prop-title">200 OK
</div>
2912 <div class=
"prop-ref">
2913 <span class=
"json-schema-ref-array">
2914 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2917 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2919 <div class=
"prop-value">
2920 <p>successful operation
</p>
2923 <div class=
"prop-row prop-inner">
2924 <div class=
"prop-name">type
</div>
2925 <div class=
"prop-value">
2926 <span class=
"json-property-type">
2927 <span class=
"json-schema-ref-array">
2928 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2931 <span class=
"json-property-range" title=
"Value limits"></span>
2936 <div class=
"doc-examples">
2937 <h5>Response Content-Types:
2938 <span>application/json
</span>
2941 <h5>Response Example
2942 <span>(
200 OK)
</span>
2944 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2946 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2947 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2948 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2949 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2950 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2951 <span class=
"hljs-attr">"category
"</span>: {
2952 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2953 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2955 <span class=
"hljs-attr">"licence
"</span>: {
2956 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2957 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2959 <span class=
"hljs-attr">"language
"</span>: {
2960 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2961 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2963 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
2964 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2965 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2966 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2967 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2968 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2969 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2970 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2971 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2972 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2973 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2974 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2975 <span class=
"hljs-attr">"account
"</span>: {
2976 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2977 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2978 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2979 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2980 <span class=
"hljs-attr">"avatar
"</span>: {
2981 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2982 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2983 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2994 <div id=
"operation--videos-categories-get" class=
"operation panel" data-traverse-target=
"operation--videos-categories-get">
2995 <!-- <section class="operation-tags row"> -->
2996 <!-- <div class="doc-copy"> -->
2997 <div class=
"operation-tags">
2998 <a class=
"label" href=
"#tag-Video">Video
</a>
3003 <h2 class=
"operation-title">
3004 <span class=
"operation-name">
3005 <span class=
"operation-name">GET
</span>
3006 <span class=
"operation-path">/videos/categories
</span>
3009 <div class=
"doc-row">
3010 <div class=
"doc-copy"> </div>
3011 <div class=
"doc-examples"></div>
3013 <div class=
"doc-row">
3014 <div class=
"doc-copy">
3015 <section class=
"swagger-responses">
3016 <div class=
"prop-row prop-group">
3017 <div class=
"prop-name">
3018 <div class=
"prop-title">200 OK
</div>
3019 <div class=
"prop-ref"> </div>
3020 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3022 <div class=
"prop-value">
3023 <p>successful operation
</p>
3026 <div class=
"prop-row prop-inner">
3027 <div class=
"prop-name">type
</div>
3028 <div class=
"prop-value">
3029 <span class=
"json-property-type">string[]
</span>
3030 <span class=
"json-property-range" title=
"Value limits"></span>
3035 <div class=
"doc-examples">
3036 <h5>Response Content-Types:
3037 <span>application/json
</span>
3040 <h5>Response Example
3041 <span>(
200 OK)
</span>
3043 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3044 <span class=
"hljs-string">"string
"</span>
3052 <div id=
"operation--videos-licences-get" class=
"operation panel" data-traverse-target=
"operation--videos-licences-get">
3053 <!-- <section class="operation-tags row"> -->
3054 <!-- <div class="doc-copy"> -->
3055 <div class=
"operation-tags">
3056 <a class=
"label" href=
"#tag-Video">Video
</a>
3061 <h2 class=
"operation-title">
3062 <span class=
"operation-name">
3063 <span class=
"operation-name">GET
</span>
3064 <span class=
"operation-path">/videos/licences
</span>
3067 <div class=
"doc-row">
3068 <div class=
"doc-copy"> </div>
3069 <div class=
"doc-examples"></div>
3071 <div class=
"doc-row">
3072 <div class=
"doc-copy">
3073 <section class=
"swagger-responses">
3074 <div class=
"prop-row prop-group">
3075 <div class=
"prop-name">
3076 <div class=
"prop-title">200 OK
</div>
3077 <div class=
"prop-ref"> </div>
3078 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3080 <div class=
"prop-value">
3081 <p>successful operation
</p>
3084 <div class=
"prop-row prop-inner">
3085 <div class=
"prop-name">type
</div>
3086 <div class=
"prop-value">
3087 <span class=
"json-property-type">string[]
</span>
3088 <span class=
"json-property-range" title=
"Value limits"></span>
3093 <div class=
"doc-examples">
3094 <h5>Response Content-Types:
3095 <span>application/json
</span>
3098 <h5>Response Example
3099 <span>(
200 OK)
</span>
3101 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3102 <span class=
"hljs-string">"string
"</span>
3110 <div id=
"operation--videos-languages-get" class=
"operation panel" data-traverse-target=
"operation--videos-languages-get">
3111 <!-- <section class="operation-tags row"> -->
3112 <!-- <div class="doc-copy"> -->
3113 <div class=
"operation-tags">
3114 <a class=
"label" href=
"#tag-Video">Video
</a>
3119 <h2 class=
"operation-title">
3120 <span class=
"operation-name">
3121 <span class=
"operation-name">GET
</span>
3122 <span class=
"operation-path">/videos/languages
</span>
3125 <div class=
"doc-row">
3126 <div class=
"doc-copy"> </div>
3127 <div class=
"doc-examples"></div>
3129 <div class=
"doc-row">
3130 <div class=
"doc-copy">
3131 <section class=
"swagger-responses">
3132 <div class=
"prop-row prop-group">
3133 <div class=
"prop-name">
3134 <div class=
"prop-title">200 OK
</div>
3135 <div class=
"prop-ref"> </div>
3136 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3138 <div class=
"prop-value">
3139 <p>successful operation
</p>
3142 <div class=
"prop-row prop-inner">
3143 <div class=
"prop-name">type
</div>
3144 <div class=
"prop-value">
3145 <span class=
"json-property-type">string[]
</span>
3146 <span class=
"json-property-range" title=
"Value limits"></span>
3151 <div class=
"doc-examples">
3152 <h5>Response Content-Types:
3153 <span>application/json
</span>
3156 <h5>Response Example
3157 <span>(
200 OK)
</span>
3159 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3160 <span class=
"hljs-string">"string
"</span>
3168 <div id=
"operation--videos-privacies-get" class=
"operation panel" data-traverse-target=
"operation--videos-privacies-get">
3169 <!-- <section class="operation-tags row"> -->
3170 <!-- <div class="doc-copy"> -->
3171 <div class=
"operation-tags">
3172 <a class=
"label" href=
"#tag-Video">Video
</a>
3177 <h2 class=
"operation-title">
3178 <span class=
"operation-name">
3179 <span class=
"operation-name">GET
</span>
3180 <span class=
"operation-path">/videos/privacies
</span>
3183 <div class=
"doc-row">
3184 <div class=
"doc-copy"> </div>
3185 <div class=
"doc-examples"></div>
3187 <div class=
"doc-row">
3188 <div class=
"doc-copy">
3189 <section class=
"swagger-responses">
3190 <div class=
"prop-row prop-group">
3191 <div class=
"prop-name">
3192 <div class=
"prop-title">200 OK
</div>
3193 <div class=
"prop-ref"> </div>
3194 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3196 <div class=
"prop-value">
3197 <p>successful operation
</p>
3200 <div class=
"prop-row prop-inner">
3201 <div class=
"prop-name">type
</div>
3202 <div class=
"prop-value">
3203 <span class=
"json-property-type">string[]
</span>
3204 <span class=
"json-property-range" title=
"Value limits"></span>
3209 <div class=
"doc-examples">
3210 <h5>Response Content-Types:
3211 <span>application/json
</span>
3214 <h5>Response Example
3215 <span>(
200 OK)
</span>
3217 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3218 <span class=
"hljs-string">"string
"</span>
3226 <div id=
"operation--videos-search-get" class=
"operation panel" data-traverse-target=
"operation--videos-search-get">
3227 <!-- <section class="operation-tags row"> -->
3228 <!-- <div class="doc-copy"> -->
3229 <div class=
"operation-tags">
3230 <a class=
"label" href=
"#tag-Video">Video
</a>
3235 <h2 class=
"operation-title">
3236 <span class=
"operation-name">
3237 <span class=
"operation-name">GET
</span>
3238 <span class=
"operation-path">/videos/search
</span>
3241 <div class=
"doc-row">
3242 <div class=
"doc-copy">
3243 <section class=
"swagger-request-params">
3244 <div class=
"prop-row prop-group">
3245 <div class=
"prop-name">
3246 <div class=
"prop-title">start:
3247 <span class=
"prop-type">
3248 <span class=
"json-property-type">number
</span>
3249 <span class=
"json-property-range" title=
"Value limits"></span>
3252 <div class=
"prop-subtitle"> in query
</div>
3254 <div class=
"prop-value">
3258 <div class=
"prop-row prop-group">
3259 <div class=
"prop-name">
3260 <div class=
"prop-title">count:
3261 <span class=
"prop-type">
3262 <span class=
"json-property-type">number
</span>
3263 <span class=
"json-property-range" title=
"Value limits"></span>
3266 <div class=
"prop-subtitle"> in query
</div>
3268 <div class=
"prop-value">
3269 <p>Number of items
</p>
3272 <div class=
"prop-row prop-group">
3273 <div class=
"prop-name">
3274 <div class=
"prop-title">sort:
3275 <span class=
"prop-type">
3276 <span class=
"json-property-type">string
</span>
3277 <span class=
"json-property-range" title=
"Value limits"></span>
3280 <div class=
"prop-subtitle"> in query
</div>
3282 <div class=
"prop-value">
3283 <p>Sort column (-createdAt for example)
</p>
3288 <div class=
"doc-examples"></div>
3290 <div class=
"doc-row">
3291 <div class=
"doc-copy">
3292 <section class=
"swagger-responses">
3293 <div class=
"prop-row prop-group">
3294 <div class=
"prop-name">
3295 <div class=
"prop-title">200 OK
</div>
3296 <div class=
"prop-ref">
3297 <span class=
"json-schema-ref-array">
3298 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3301 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3303 <div class=
"prop-value">
3304 <p>successful operation
</p>
3307 <div class=
"prop-row prop-inner">
3308 <div class=
"prop-name">type
</div>
3309 <div class=
"prop-value">
3310 <span class=
"json-property-type">
3311 <span class=
"json-schema-ref-array">
3312 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3315 <span class=
"json-property-range" title=
"Value limits"></span>
3320 <div class=
"doc-examples">
3321 <h5>Response Content-Types:
3322 <span>application/json
</span>
3325 <h5>Response Example
3326 <span>(
200 OK)
</span>
3328 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3330 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3331 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3332 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3333 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3334 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3335 <span class=
"hljs-attr">"category
"</span>: {
3336 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3337 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3339 <span class=
"hljs-attr">"licence
"</span>: {
3340 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3341 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3343 <span class=
"hljs-attr">"language
"</span>: {
3344 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
3345 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3347 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3348 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3349 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3350 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3351 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3352 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3353 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3354 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3355 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3356 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3357 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3358 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3359 <span class=
"hljs-attr">"account
"</span>: {
3360 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3361 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3362 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3363 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3364 <span class=
"hljs-attr">"avatar
"</span>: {
3365 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3366 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3367 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3378 <div id=
"operation--videos--id--put" class=
"operation panel" data-traverse-target=
"operation--videos--id--put">
3379 <!-- <section class="operation-tags row"> -->
3380 <!-- <div class="doc-copy"> -->
3381 <div class=
"operation-tags">
3382 <a class=
"label" href=
"#tag-Video">Video
</a>
3387 <h2 class=
"operation-title">
3388 <span class=
"operation-name">
3389 <span class=
"operation-name">PUT
</span>
3390 <span class=
"operation-path">/videos/{id}
</span>
3393 <div class=
"doc-row">
3394 <div class=
"doc-copy">
3395 <section class=
"swagger-request-params">
3396 <div class=
"prop-row prop-group">
3397 <div class=
"prop-name">
3398 <div class=
"prop-title">id:
3399 <span class=
"prop-type">
3400 <span class=
"json-property-type">string
</span>
3401 <span class=
"json-property-range" title=
"Value limits"></span>
3404 <span class=
"json-property-required"></span>
3405 <div class=
"prop-subtitle"> in path
</div>
3407 <div class=
"prop-value">
3408 <p>The video id or uuid
</p>
3411 <div class=
"prop-row prop-group">
3412 <div class=
"prop-name">
3413 <div class=
"prop-title">thumbnailfile:
3414 <span class=
"prop-type">
3415 <span class=
"json-property-type">file
</span>
3416 <span class=
"json-property-range" title=
"Value limits"></span>
3419 <div class=
"prop-subtitle"> in formData
</div>
3421 <div class=
"prop-value">
3422 <p>Video thumbnail file
</p>
3425 <div class=
"prop-row prop-group">
3426 <div class=
"prop-name">
3427 <div class=
"prop-title">previewfile:
3428 <span class=
"prop-type">
3429 <span class=
"json-property-type">file
</span>
3430 <span class=
"json-property-range" title=
"Value limits"></span>
3433 <div class=
"prop-subtitle"> in formData
</div>
3435 <div class=
"prop-value">
3436 <p>Video preview file
</p>
3439 <div class=
"prop-row prop-group">
3440 <div class=
"prop-name">
3441 <div class=
"prop-title">category:
3442 <span class=
"prop-type">
3443 <span class=
"json-property-type">number
</span>
3444 <span class=
"json-property-range" title=
"Value limits"></span>
3447 <div class=
"prop-subtitle"> in formData
</div>
3449 <div class=
"prop-value">
3450 <p>Video category
</p>
3453 <div class=
"prop-row prop-group">
3454 <div class=
"prop-name">
3455 <div class=
"prop-title">licence:
3456 <span class=
"prop-type">
3457 <span class=
"json-property-type">number
</span>
3458 <span class=
"json-property-range" title=
"Value limits"></span>
3461 <div class=
"prop-subtitle"> in formData
</div>
3463 <div class=
"prop-value">
3464 <p>Video licence
</p>
3467 <div class=
"prop-row prop-group">
3468 <div class=
"prop-name">
3469 <div class=
"prop-title">language:
3470 <span class=
"prop-type">
3471 <span class=
"json-property-type">string
</span>
3472 <span class=
"json-property-range" title=
"Value limits"></span>
3475 <div class=
"prop-subtitle"> in formData
</div>
3477 <div class=
"prop-value">
3478 <p>Video language
</p>
3481 <div class=
"prop-row prop-group">
3482 <div class=
"prop-name">
3483 <div class=
"prop-title">description:
3484 <span class=
"prop-type">
3485 <span class=
"json-property-type">string
</span>
3486 <span class=
"json-property-range" title=
"Value limits"></span>
3489 <div class=
"prop-subtitle"> in formData
</div>
3491 <div class=
"prop-value">
3492 <p>Video description
</p>
3495 <div class=
"prop-row prop-group">
3496 <div class=
"prop-name">
3497 <div class=
"prop-title">waitTranscoding:
3498 <span class=
"prop-type">
3499 <span class=
"json-property-type">boolean
</span>
3500 <span class=
"json-property-range" title=
"Value limits"></span>
3503 <div class=
"prop-subtitle"> in formData
</div>
3505 <div class=
"prop-value">
3506 <p>Whether or not we wait transcoding before publish the video
</p>
3509 <div class=
"prop-row prop-group">
3510 <div class=
"prop-name">
3511 <div class=
"prop-title">support:
3512 <span class=
"prop-type">
3513 <span class=
"json-property-type">string
</span>
3514 <span class=
"json-property-range" title=
"Value limits"></span>
3517 <div class=
"prop-subtitle"> in formData
</div>
3519 <div class=
"prop-value">
3520 <p>Text describing how to support the video uploader
</p>
3523 <div class=
"prop-row prop-group">
3524 <div class=
"prop-name">
3525 <div class=
"prop-title">nsfw:
3526 <span class=
"prop-type">
3527 <span class=
"json-property-type">boolean
</span>
3528 <span class=
"json-property-range" title=
"Value limits"></span>
3531 <div class=
"prop-subtitle"> in formData
</div>
3533 <div class=
"prop-value">
3534 <p>Whether or not this video contains sensitive content
</p>
3537 <div class=
"prop-row prop-group">
3538 <div class=
"prop-name">
3539 <div class=
"prop-title">name:
3540 <span class=
"prop-type">
3541 <span class=
"json-property-type">string
</span>
3542 <span class=
"json-property-range" title=
"Value limits"></span>
3545 <div class=
"prop-subtitle"> in formData
</div>
3547 <div class=
"prop-value">
3551 <div class=
"prop-row prop-group">
3552 <div class=
"prop-name">
3553 <div class=
"prop-title">tags:
3554 <span class=
"prop-type">
3555 <span class=
"json-property-type">string[]
</span>
3556 <span class=
"json-property-range" title=
"Value limits"></span>
3559 <div class=
"prop-subtitle"> in formData
</div>
3561 <div class=
"prop-value">
3565 <div class=
"prop-row prop-group">
3566 <div class=
"prop-name">
3567 <div class=
"prop-title">commentsEnabled:
3568 <span class=
"prop-type">
3569 <span class=
"json-property-type">boolean
</span>
3570 <span class=
"json-property-range" title=
"Value limits"></span>
3573 <div class=
"prop-subtitle"> in formData
</div>
3575 <div class=
"prop-value">
3576 <p>Enable or disable comments for this video
</p>
3579 <div class=
"prop-row prop-group">
3580 <div class=
"prop-name">
3581 <div class=
"prop-title">privacy:
3582 <span class=
"prop-type">
3583 <span class=
"json-property-type">string
</span>
3584 <span class=
"json-property-enum" title=
"Possible values">
3585 <span class=
"json-property-enum-item">Public
</span>,
3586 <span class=
"json-property-enum-item">Unlisted
</span>
3588 <span class=
"json-property-range" title=
"Value limits"></span>
3591 <div class=
"prop-subtitle"> in formData
</div>
3593 <div class=
"prop-value">
3594 <p>Video privacy
</p>
3597 <div class=
"prop-row prop-group">
3598 <div class=
"prop-name">
3599 <div class=
"prop-title">scheduleUpdate:
3600 <span class=
"prop-type">
3601 <span class=
"json-property-type">object
</span>
3602 <span class=
"json-property-range" title=
"Value limits"></span>
3605 <div class=
"prop-subtitle"> in formData
</div>
3607 <div class=
"prop-value">
3608 <p>Schedule an update at a specific datetime
</p>
3613 <div class=
"doc-examples"></div>
3615 <div class=
"doc-row">
3616 <div class=
"doc-copy">
3617 <section class=
"swagger-responses">
3618 <div class=
"prop-row prop-group">
3619 <div class=
"prop-name">
3620 <div class=
"prop-title">200 OK
</div>
3621 <div class=
"prop-ref">
3623 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3626 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3628 <div class=
"prop-value">
3629 <p>successful operation
</p>
3634 <div class=
"doc-examples">
3635 <h5>Response Content-Types:
3636 <span>application/json
</span>
3639 <h5>Response Example
3640 <span>(
200 OK)
</span>
3642 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3643 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3644 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3645 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3646 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3647 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3648 <span class=
"hljs-attr">"category
"</span>: {
3649 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3650 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3652 <span class=
"hljs-attr">"licence
"</span>: {
3653 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3654 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3656 <span class=
"hljs-attr">"language
"</span>: {
3657 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
3658 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3660 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3661 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3662 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3663 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3664 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3665 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3666 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3667 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3668 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3669 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3670 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3671 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3672 <span class=
"hljs-attr">"account
"</span>: {
3673 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3674 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3675 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3676 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3677 <span class=
"hljs-attr">"avatar
"</span>: {
3678 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3679 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3680 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3689 <div class=
"doc-row">
3690 <div class=
"doc-copy">
3691 <section class=
"swagger-request-security">
3692 <table class=
"table">
3695 <th class=
"swagger-request-security-schema"></th>
3696 <th class=
"swagger-request-security-scopes"></th>
3702 <a href=
"#security-definition-OAuth2">OAuth2
</a>
3712 <div id=
"operation--videos--id--get" class=
"operation panel" data-traverse-target=
"operation--videos--id--get">
3713 <!-- <section class="operation-tags row"> -->
3714 <!-- <div class="doc-copy"> -->
3715 <div class=
"operation-tags">
3716 <a class=
"label" href=
"#tag-Video">Video
</a>
3721 <h2 class=
"operation-title">
3722 <span class=
"operation-name">
3723 <span class=
"operation-name">GET
</span>
3724 <span class=
"operation-path">/videos/{id}
</span>
3727 <div class=
"doc-row">
3728 <div class=
"doc-copy">
3729 <section class=
"swagger-request-params">
3730 <div class=
"prop-row prop-group">
3731 <div class=
"prop-name">
3732 <div class=
"prop-title">id:
3733 <span class=
"prop-type">
3734 <span class=
"json-property-type">string
</span>
3735 <span class=
"json-property-range" title=
"Value limits"></span>
3738 <span class=
"json-property-required"></span>
3739 <div class=
"prop-subtitle"> in path
</div>
3741 <div class=
"prop-value">
3742 <p>The video id or uuid
</p>
3747 <div class=
"doc-examples"></div>
3749 <div class=
"doc-row">
3750 <div class=
"doc-copy">
3751 <section class=
"swagger-responses">
3752 <div class=
"prop-row prop-group">
3753 <div class=
"prop-name">
3754 <div class=
"prop-title">200 OK
</div>
3755 <div class=
"prop-ref">
3757 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3760 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3762 <div class=
"prop-value">
3763 <p>successful operation
</p>
3768 <div class=
"doc-examples">
3769 <h5>Response Content-Types:
3770 <span>application/json
</span>
3773 <h5>Response Example
3774 <span>(
200 OK)
</span>
3776 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3777 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3778 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3779 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3780 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3781 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3782 <span class=
"hljs-attr">"category
"</span>: {
3783 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3784 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3786 <span class=
"hljs-attr">"licence
"</span>: {
3787 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3788 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3790 <span class=
"hljs-attr">"language
"</span>: {
3791 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
3792 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3794 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3795 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3796 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3797 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3798 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3799 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3800 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3801 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3802 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3803 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3804 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3805 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3806 <span class=
"hljs-attr">"account
"</span>: {
3807 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3808 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3809 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3810 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3811 <span class=
"hljs-attr">"avatar
"</span>: {
3812 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3813 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3814 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3824 <div id=
"operation--videos--id--delete" class=
"operation panel" data-traverse-target=
"operation--videos--id--delete">
3825 <!-- <section class="operation-tags row"> -->
3826 <!-- <div class="doc-copy"> -->
3827 <div class=
"operation-tags">
3828 <a class=
"label" href=
"#tag-Video">Video
</a>
3833 <h2 class=
"operation-title">
3834 <span class=
"operation-name">
3835 <span class=
"operation-name">DELETE
</span>
3836 <span class=
"operation-path">/videos/{id}
</span>
3839 <div class=
"doc-row">
3840 <div class=
"doc-copy">
3841 <section class=
"swagger-request-params">
3842 <div class=
"prop-row prop-group">
3843 <div class=
"prop-name">
3844 <div class=
"prop-title">id:
3845 <span class=
"prop-type">
3846 <span class=
"json-property-type">string
</span>
3847 <span class=
"json-property-range" title=
"Value limits"></span>
3850 <span class=
"json-property-required"></span>
3851 <div class=
"prop-subtitle"> in path
</div>
3853 <div class=
"prop-value">
3854 <p>The video id or uuid
</p>
3859 <div class=
"doc-examples"></div>
3861 <div class=
"doc-row">
3862 <div class=
"doc-copy">
3863 <section class=
"swagger-responses">
3864 <div class=
"prop-row prop-group">
3865 <div class=
"prop-name">
3866 <div class=
"prop-title">204 No Content
</div>
3868 <div class=
"prop-value">
3869 <p>Successful operation
</p>
3874 <div class=
"doc-examples">
3875 <h5>Response Content-Types:
3876 <span>application/json
</span>
3880 <div class=
"doc-row">
3881 <div class=
"doc-copy">
3882 <section class=
"swagger-request-security">
3883 <table class=
"table">
3886 <th class=
"swagger-request-security-schema"></th>
3887 <th class=
"swagger-request-security-scopes"></th>
3893 <a href=
"#security-definition-OAuth2">OAuth2
</a>
3903 <div id=
"operation--videos--id--description-get" class=
"operation panel" data-traverse-target=
"operation--videos--id--description-get">
3904 <!-- <section class="operation-tags row"> -->
3905 <!-- <div class="doc-copy"> -->
3906 <div class=
"operation-tags">
3907 <a class=
"label" href=
"#tag-Video">Video
</a>
3912 <h2 class=
"operation-title">
3913 <span class=
"operation-name">
3914 <span class=
"operation-name">GET
</span>
3915 <span class=
"operation-path">/videos/{id}/description
</span>
3918 <div class=
"doc-row">
3919 <div class=
"doc-copy">
3920 <section class=
"swagger-request-params">
3921 <div class=
"prop-row prop-group">
3922 <div class=
"prop-name">
3923 <div class=
"prop-title">id:
3924 <span class=
"prop-type">
3925 <span class=
"json-property-type">string
</span>
3926 <span class=
"json-property-range" title=
"Value limits"></span>
3929 <span class=
"json-property-required"></span>
3930 <div class=
"prop-subtitle"> in path
</div>
3932 <div class=
"prop-value">
3933 <p>The video id or uuid
</p>
3938 <div class=
"doc-examples"></div>
3940 <div class=
"doc-row">
3941 <div class=
"doc-copy">
3942 <section class=
"swagger-responses">
3943 <div class=
"prop-row prop-group">
3944 <div class=
"prop-name">
3945 <div class=
"prop-title">200 OK
</div>
3946 <div class=
"prop-ref"> </div>
3947 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3949 <div class=
"prop-value">
3950 <p>successful operation
</p>
3953 <div class=
"prop-row prop-inner">
3954 <div class=
"prop-name">type
</div>
3955 <div class=
"prop-value">
3956 <span class=
"json-property-type">string
</span>
3957 <span class=
"json-property-range" title=
"Value limits"></span>
3962 <div class=
"doc-examples">
3963 <h5>Response Content-Types:
3964 <span>application/json
</span>
3967 <h5>Response Example
3968 <span>(
200 OK)
</span>
3970 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json"><span class=
"hljs-string">"string
"</span>
3977 <div id=
"operation--videos--id--views-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--views-post">
3978 <!-- <section class="operation-tags row"> -->
3979 <!-- <div class="doc-copy"> -->
3980 <div class=
"operation-tags">
3981 <a class=
"label" href=
"#tag-Video">Video
</a>
3986 <h2 class=
"operation-title">
3987 <span class=
"operation-name">
3988 <span class=
"operation-name">POST
</span>
3989 <span class=
"operation-path">/videos/{id}/views
</span>
3992 <div class=
"doc-row">
3993 <div class=
"doc-copy">
3994 <section class=
"swagger-request-params">
3995 <div class=
"prop-row prop-group">
3996 <div class=
"prop-name">
3997 <div class=
"prop-title">id:
3998 <span class=
"prop-type">
3999 <span class=
"json-property-type">string
</span>
4000 <span class=
"json-property-range" title=
"Value limits"></span>
4003 <span class=
"json-property-required"></span>
4004 <div class=
"prop-subtitle"> in path
</div>
4006 <div class=
"prop-value">
4007 <p>The video id or uuid
</p>
4012 <div class=
"doc-examples"></div>
4014 <div class=
"doc-row">
4015 <div class=
"doc-copy">
4016 <section class=
"swagger-responses">
4017 <div class=
"prop-row prop-group">
4018 <div class=
"prop-name">
4019 <div class=
"prop-title">204 No Content
</div>
4021 <div class=
"prop-value">
4022 <p>Successful operation
</p>
4027 <div class=
"doc-examples">
4028 <h5>Response Content-Types:
4029 <span>application/json
</span>
4034 <div id=
"operation--videos-upload-post" class=
"operation panel" data-traverse-target=
"operation--videos-upload-post">
4035 <!-- <section class="operation-tags row"> -->
4036 <!-- <div class="doc-copy"> -->
4037 <div class=
"operation-tags">
4038 <a class=
"label" href=
"#tag-Video">Video
</a>
4043 <h2 class=
"operation-title">
4044 <span class=
"operation-name">
4045 <span class=
"operation-name">POST
</span>
4046 <span class=
"operation-path">/videos/upload
</span>
4049 <div class=
"doc-row">
4050 <div class=
"doc-copy">
4051 <section class=
"swagger-request-params">
4052 <div class=
"prop-row prop-group">
4053 <div class=
"prop-name">
4054 <div class=
"prop-title">videofile:
4055 <span class=
"prop-type">
4056 <span class=
"json-property-type">file
</span>
4057 <span class=
"json-property-range" title=
"Value limits"></span>
4060 <span class=
"json-property-required"></span>
4061 <div class=
"prop-subtitle"> in formData
</div>
4063 <div class=
"prop-value">
4067 <div class=
"prop-row prop-group">
4068 <div class=
"prop-name">
4069 <div class=
"prop-title">channelId:
4070 <span class=
"prop-type">
4071 <span class=
"json-property-type">number
</span>
4072 <span class=
"json-property-range" title=
"Value limits"></span>
4075 <span class=
"json-property-required"></span>
4076 <div class=
"prop-subtitle"> in formData
</div>
4078 <div class=
"prop-value">
4079 <p>Channel id that will contain this video
</p>
4082 <div class=
"prop-row prop-group">
4083 <div class=
"prop-name">
4084 <div class=
"prop-title">thumbnailfile:
4085 <span class=
"prop-type">
4086 <span class=
"json-property-type">file
</span>
4087 <span class=
"json-property-range" title=
"Value limits"></span>
4090 <div class=
"prop-subtitle"> in formData
</div>
4092 <div class=
"prop-value">
4093 <p>Video thumbnail file
</p>
4096 <div class=
"prop-row prop-group">
4097 <div class=
"prop-name">
4098 <div class=
"prop-title">previewfile:
4099 <span class=
"prop-type">
4100 <span class=
"json-property-type">file
</span>
4101 <span class=
"json-property-range" title=
"Value limits"></span>
4104 <div class=
"prop-subtitle"> in formData
</div>
4106 <div class=
"prop-value">
4107 <p>Video preview file
</p>
4110 <div class=
"prop-row prop-group">
4111 <div class=
"prop-name">
4112 <div class=
"prop-title">category:
4113 <span class=
"prop-type">
4114 <span class=
"json-property-type">number
</span>
4115 <span class=
"json-property-range" title=
"Value limits"></span>
4118 <div class=
"prop-subtitle"> in formData
</div>
4120 <div class=
"prop-value">
4121 <p>Video category
</p>
4124 <div class=
"prop-row prop-group">
4125 <div class=
"prop-name">
4126 <div class=
"prop-title">licence:
4127 <span class=
"prop-type">
4128 <span class=
"json-property-type">number
</span>
4129 <span class=
"json-property-range" title=
"Value limits"></span>
4132 <div class=
"prop-subtitle"> in formData
</div>
4134 <div class=
"prop-value">
4135 <p>Video licence
</p>
4138 <div class=
"prop-row prop-group">
4139 <div class=
"prop-name">
4140 <div class=
"prop-title">language:
4141 <span class=
"prop-type">
4142 <span class=
"json-property-type">string
</span>
4143 <span class=
"json-property-range" title=
"Value limits"></span>
4146 <div class=
"prop-subtitle"> in formData
</div>
4148 <div class=
"prop-value">
4149 <p>Video language
</p>
4152 <div class=
"prop-row prop-group">
4153 <div class=
"prop-name">
4154 <div class=
"prop-title">description:
4155 <span class=
"prop-type">
4156 <span class=
"json-property-type">string
</span>
4157 <span class=
"json-property-range" title=
"Value limits"></span>
4160 <div class=
"prop-subtitle"> in formData
</div>
4162 <div class=
"prop-value">
4163 <p>Video description
</p>
4166 <div class=
"prop-row prop-group">
4167 <div class=
"prop-name">
4168 <div class=
"prop-title">waitTranscoding:
4169 <span class=
"prop-type">
4170 <span class=
"json-property-type">boolean
</span>
4171 <span class=
"json-property-range" title=
"Value limits"></span>
4174 <div class=
"prop-subtitle"> in formData
</div>
4176 <div class=
"prop-value">
4177 <p>Whether or not we wait transcoding before publish the video
</p>
4180 <div class=
"prop-row prop-group">
4181 <div class=
"prop-name">
4182 <div class=
"prop-title">support:
4183 <span class=
"prop-type">
4184 <span class=
"json-property-type">string
</span>
4185 <span class=
"json-property-range" title=
"Value limits"></span>
4188 <div class=
"prop-subtitle"> in formData
</div>
4190 <div class=
"prop-value">
4191 <p>Text describing how to support the video uploader
</p>
4194 <div class=
"prop-row prop-group">
4195 <div class=
"prop-name">
4196 <div class=
"prop-title">nsfw:
4197 <span class=
"prop-type">
4198 <span class=
"json-property-type">boolean
</span>
4199 <span class=
"json-property-range" title=
"Value limits"></span>
4202 <div class=
"prop-subtitle"> in formData
</div>
4204 <div class=
"prop-value">
4205 <p>Whether or not this video contains sensitive content
</p>
4208 <div class=
"prop-row prop-group">
4209 <div class=
"prop-name">
4210 <div class=
"prop-title">name:
4211 <span class=
"prop-type">
4212 <span class=
"json-property-type">string
</span>
4213 <span class=
"json-property-range" title=
"Value limits"></span>
4216 <div class=
"prop-subtitle"> in formData
</div>
4218 <div class=
"prop-value">
4222 <div class=
"prop-row prop-group">
4223 <div class=
"prop-name">
4224 <div class=
"prop-title">tags:
4225 <span class=
"prop-type">
4226 <span class=
"json-property-type">string[]
</span>
4227 <span class=
"json-property-range" title=
"Value limits"></span>
4230 <div class=
"prop-subtitle"> in formData
</div>
4232 <div class=
"prop-value">
4236 <div class=
"prop-row prop-group">
4237 <div class=
"prop-name">
4238 <div class=
"prop-title">commentsEnabled:
4239 <span class=
"prop-type">
4240 <span class=
"json-property-type">boolean
</span>
4241 <span class=
"json-property-range" title=
"Value limits"></span>
4244 <div class=
"prop-subtitle"> in formData
</div>
4246 <div class=
"prop-value">
4247 <p>Enable or disable comments for this video
</p>
4250 <div class=
"prop-row prop-group">
4251 <div class=
"prop-name">
4252 <div class=
"prop-title">privacy:
4253 <span class=
"prop-type">
4254 <span class=
"json-property-type">string
</span>
4255 <span class=
"json-property-enum" title=
"Possible values">
4256 <span class=
"json-property-enum-item">Public
</span>,
4257 <span class=
"json-property-enum-item">Unlisted
</span>
4259 <span class=
"json-property-range" title=
"Value limits"></span>
4262 <div class=
"prop-subtitle"> in formData
</div>
4264 <div class=
"prop-value">
4265 <p>Video privacy
</p>
4268 <div class=
"prop-row prop-group">
4269 <div class=
"prop-name">
4270 <div class=
"prop-title">scheduleUpdate:
4271 <span class=
"prop-type">
4272 <span class=
"json-property-type">object
</span>
4273 <span class=
"json-property-range" title=
"Value limits"></span>
4276 <div class=
"prop-subtitle"> in formData
</div>
4278 <div class=
"prop-value">
4279 <p>Schedule an update at a specific datetime
</p>
4284 <div class=
"doc-examples"></div>
4286 <div class=
"doc-row">
4287 <div class=
"doc-copy">
4288 <section class=
"swagger-responses">
4289 <div class=
"prop-row prop-group">
4290 <div class=
"prop-name">
4291 <div class=
"prop-title">200 OK
</div>
4292 <div class=
"prop-ref">
4294 <a class=
"json-schema-ref" href=
"#/definitions/VideoUploadResponse">VideoUploadResponse
</a>
4297 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4299 <div class=
"prop-value">
4300 <p>successful operation
</p>
4305 <div class=
"doc-examples">
4306 <h5>Response Content-Types:
4307 <span>application/json
</span>
4310 <h5>Response Example
4311 <span>(
200 OK)
</span>
4313 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4314 <span class=
"hljs-attr">"video
"</span>: {
4315 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4316 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
4324 <div class=
"doc-row">
4325 <div class=
"doc-copy">
4326 <section class=
"swagger-request-security">
4327 <table class=
"table">
4330 <th class=
"swagger-request-security-schema"></th>
4331 <th class=
"swagger-request-security-scopes"></th>
4337 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4347 <h1 id=
"tag-VideoAbuse" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoAbuse">VideoAbuse
</h1>
4348 <div id=
"operation--videos-abuse-get" class=
"operation panel" data-traverse-target=
"operation--videos-abuse-get">
4349 <!-- <section class="operation-tags row"> -->
4350 <!-- <div class="doc-copy"> -->
4351 <div class=
"operation-tags">
4352 <a class=
"label" href=
"#tag-VideoAbuse">VideoAbuse
</a>
4357 <h2 class=
"operation-title">
4358 <span class=
"operation-name">
4359 <span class=
"operation-name">GET
</span>
4360 <span class=
"operation-path">/videos/abuse
</span>
4363 <div class=
"doc-row">
4364 <div class=
"doc-copy">
4365 <section class=
"swagger-request-params">
4366 <div class=
"prop-row prop-group">
4367 <div class=
"prop-name">
4368 <div class=
"prop-title">start:
4369 <span class=
"prop-type">
4370 <span class=
"json-property-type">number
</span>
4371 <span class=
"json-property-range" title=
"Value limits"></span>
4374 <div class=
"prop-subtitle"> in query
</div>
4376 <div class=
"prop-value">
4380 <div class=
"prop-row prop-group">
4381 <div class=
"prop-name">
4382 <div class=
"prop-title">count:
4383 <span class=
"prop-type">
4384 <span class=
"json-property-type">number
</span>
4385 <span class=
"json-property-range" title=
"Value limits"></span>
4388 <div class=
"prop-subtitle"> in query
</div>
4390 <div class=
"prop-value">
4391 <p>Number of items
</p>
4394 <div class=
"prop-row prop-group">
4395 <div class=
"prop-name">
4396 <div class=
"prop-title">sort:
4397 <span class=
"prop-type">
4398 <span class=
"json-property-type">string
</span>
4399 <span class=
"json-property-range" title=
"Value limits"></span>
4402 <div class=
"prop-subtitle"> in query
</div>
4404 <div class=
"prop-value">
4405 <p>Sort column (-createdAt for example)
</p>
4410 <div class=
"doc-examples"></div>
4412 <div class=
"doc-row">
4413 <div class=
"doc-copy">
4414 <section class=
"swagger-responses">
4415 <div class=
"prop-row prop-group">
4416 <div class=
"prop-name">
4417 <div class=
"prop-title">200 OK
</div>
4418 <div class=
"prop-ref">
4419 <span class=
"json-schema-ref-array">
4420 <a class=
"json-schema-ref" href=
"#/definitions/VideoAbuse">VideoAbuse
</a>
4423 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4425 <div class=
"prop-value">
4426 <p>successful operation
</p>
4429 <div class=
"prop-row prop-inner">
4430 <div class=
"prop-name">type
</div>
4431 <div class=
"prop-value">
4432 <span class=
"json-property-type">
4433 <span class=
"json-schema-ref-array">
4434 <a class=
"json-schema-ref" href=
"#/definitions/VideoAbuse">VideoAbuse
</a>
4437 <span class=
"json-property-range" title=
"Value limits"></span>
4442 <div class=
"doc-examples">
4443 <h5>Response Content-Types:
4444 <span>application/json
</span>
4447 <h5>Response Example
4448 <span>(
200 OK)
</span>
4450 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4452 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4453 <span class=
"hljs-attr">"reason
"</span>:
<span class=
"hljs-string">"string
"</span>,
4454 <span class=
"hljs-attr">"reporterAccount
"</span>: {
4455 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4456 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4457 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4458 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4459 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4460 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4461 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4462 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4463 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4464 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4465 <span class=
"hljs-attr">"avatar
"</span>: {
4466 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4467 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4468 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4471 <span class=
"hljs-attr">"video
"</span>: {
4472 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4473 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4474 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4475 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>
4477 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4485 <div class=
"doc-row">
4486 <div class=
"doc-copy">
4487 <section class=
"swagger-request-security">
4488 <table class=
"table">
4491 <th class=
"swagger-request-security-schema"></th>
4492 <th class=
"swagger-request-security-scopes"></th>
4498 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4508 <div id=
"operation--videos--id--abuse-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--abuse-post">
4509 <!-- <section class="operation-tags row"> -->
4510 <!-- <div class="doc-copy"> -->
4511 <div class=
"operation-tags">
4512 <a class=
"label" href=
"#tag-VideoAbuse">VideoAbuse
</a>
4517 <h2 class=
"operation-title">
4518 <span class=
"operation-name">
4519 <span class=
"operation-name">POST
</span>
4520 <span class=
"operation-path">/videos/{id}/abuse
</span>
4523 <div class=
"doc-row">
4524 <div class=
"doc-copy">
4525 <section class=
"swagger-request-params">
4526 <div class=
"prop-row prop-group">
4527 <div class=
"prop-name">
4528 <div class=
"prop-title">id:
4529 <span class=
"prop-type">
4530 <span class=
"json-property-type">string
</span>
4531 <span class=
"json-property-range" title=
"Value limits"></span>
4534 <span class=
"json-property-required"></span>
4535 <div class=
"prop-subtitle"> in path
</div>
4537 <div class=
"prop-value">
4538 <p>The video id or uuid
</p>
4543 <div class=
"doc-examples"></div>
4545 <div class=
"doc-row">
4546 <div class=
"doc-copy">
4547 <section class=
"swagger-responses">
4548 <div class=
"prop-row prop-group">
4549 <div class=
"prop-name">
4550 <div class=
"prop-title">204 No Content
</div>
4552 <div class=
"prop-value">
4553 <p>Successful operation
</p>
4558 <div class=
"doc-examples">
4559 <h5>Response Content-Types:
4560 <span>application/json
</span>
4564 <div class=
"doc-row">
4565 <div class=
"doc-copy">
4566 <section class=
"swagger-request-security">
4567 <table class=
"table">
4570 <th class=
"swagger-request-security-schema"></th>
4571 <th class=
"swagger-request-security-scopes"></th>
4577 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4587 <h1 id=
"tag-VideoBlacklist" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoBlacklist">VideoBlacklist
</h1>
4588 <div id=
"operation--videos--id--blacklist-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--blacklist-post">
4589 <!-- <section class="operation-tags row"> -->
4590 <!-- <div class="doc-copy"> -->
4591 <div class=
"operation-tags">
4592 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4597 <h2 class=
"operation-title">
4598 <span class=
"operation-name">
4599 <span class=
"operation-name">POST
</span>
4600 <span class=
"operation-path">/videos/{id}/blacklist
</span>
4603 <div class=
"doc-row">
4604 <div class=
"doc-copy">
4605 <section class=
"swagger-request-params">
4606 <div class=
"prop-row prop-group">
4607 <div class=
"prop-name">
4608 <div class=
"prop-title">id:
4609 <span class=
"prop-type">
4610 <span class=
"json-property-type">string
</span>
4611 <span class=
"json-property-range" title=
"Value limits"></span>
4614 <span class=
"json-property-required"></span>
4615 <div class=
"prop-subtitle"> in path
</div>
4617 <div class=
"prop-value">
4618 <p>The video id or uuid
</p>
4623 <div class=
"doc-examples"></div>
4625 <div class=
"doc-row">
4626 <div class=
"doc-copy">
4627 <section class=
"swagger-responses">
4628 <div class=
"prop-row prop-group">
4629 <div class=
"prop-name">
4630 <div class=
"prop-title">204 No Content
</div>
4632 <div class=
"prop-value">
4633 <p>Successful operation
</p>
4638 <div class=
"doc-examples">
4639 <h5>Response Content-Types:
4640 <span>application/json
</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 <div id=
"operation--videos--id--blacklist-delete" class=
"operation panel" data-traverse-target=
"operation--videos--id--blacklist-delete">
4668 <!-- <section class="operation-tags row"> -->
4669 <!-- <div class="doc-copy"> -->
4670 <div class=
"operation-tags">
4671 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4676 <h2 class=
"operation-title">
4677 <span class=
"operation-name">
4678 <span class=
"operation-name">DELETE
</span>
4679 <span class=
"operation-path">/videos/{id}/blacklist
</span>
4682 <div class=
"doc-row">
4683 <div class=
"doc-copy">
4684 <section class=
"swagger-request-params">
4685 <div class=
"prop-row prop-group">
4686 <div class=
"prop-name">
4687 <div class=
"prop-title">id:
4688 <span class=
"prop-type">
4689 <span class=
"json-property-type">string
</span>
4690 <span class=
"json-property-range" title=
"Value limits"></span>
4693 <span class=
"json-property-required"></span>
4694 <div class=
"prop-subtitle"> in path
</div>
4696 <div class=
"prop-value">
4697 <p>The video id or uuid
</p>
4702 <div class=
"doc-examples"></div>
4704 <div class=
"doc-row">
4705 <div class=
"doc-copy">
4706 <section class=
"swagger-responses">
4707 <div class=
"prop-row prop-group">
4708 <div class=
"prop-name">
4709 <div class=
"prop-title">204 No Content
</div>
4711 <div class=
"prop-value">
4712 <p>Successful operation
</p>
4717 <div class=
"doc-examples">
4718 <h5>Response Content-Types:
4719 <span>application/json
</span>
4723 <div class=
"doc-row">
4724 <div class=
"doc-copy">
4725 <section class=
"swagger-request-security">
4726 <table class=
"table">
4729 <th class=
"swagger-request-security-schema"></th>
4730 <th class=
"swagger-request-security-scopes"></th>
4736 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4746 <div id=
"operation--videos-blacklist-get" class=
"operation panel" data-traverse-target=
"operation--videos-blacklist-get">
4747 <!-- <section class="operation-tags row"> -->
4748 <!-- <div class="doc-copy"> -->
4749 <div class=
"operation-tags">
4750 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4755 <h2 class=
"operation-title">
4756 <span class=
"operation-name">
4757 <span class=
"operation-name">GET
</span>
4758 <span class=
"operation-path">/videos/blacklist
</span>
4761 <div class=
"doc-row">
4762 <div class=
"doc-copy">
4763 <section class=
"swagger-request-params">
4764 <div class=
"prop-row prop-group">
4765 <div class=
"prop-name">
4766 <div class=
"prop-title">start:
4767 <span class=
"prop-type">
4768 <span class=
"json-property-type">number
</span>
4769 <span class=
"json-property-range" title=
"Value limits"></span>
4772 <div class=
"prop-subtitle"> in query
</div>
4774 <div class=
"prop-value">
4778 <div class=
"prop-row prop-group">
4779 <div class=
"prop-name">
4780 <div class=
"prop-title">count:
4781 <span class=
"prop-type">
4782 <span class=
"json-property-type">number
</span>
4783 <span class=
"json-property-range" title=
"Value limits"></span>
4786 <div class=
"prop-subtitle"> in query
</div>
4788 <div class=
"prop-value">
4789 <p>Number of items
</p>
4792 <div class=
"prop-row prop-group">
4793 <div class=
"prop-name">
4794 <div class=
"prop-title">sort:
4795 <span class=
"prop-type">
4796 <span class=
"json-property-type">string
</span>
4797 <span class=
"json-property-range" title=
"Value limits"></span>
4800 <div class=
"prop-subtitle"> in query
</div>
4802 <div class=
"prop-value">
4803 <p>Sort column (-createdAt for example)
</p>
4808 <div class=
"doc-examples"></div>
4810 <div class=
"doc-row">
4811 <div class=
"doc-copy">
4812 <section class=
"swagger-responses">
4813 <div class=
"prop-row prop-group">
4814 <div class=
"prop-name">
4815 <div class=
"prop-title">200 OK
</div>
4816 <div class=
"prop-ref">
4817 <span class=
"json-schema-ref-array">
4818 <a class=
"json-schema-ref" href=
"#/definitions/VideoBlacklist">VideoBlacklist
</a>
4821 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4823 <div class=
"prop-value">
4824 <p>successful operation
</p>
4827 <div class=
"prop-row prop-inner">
4828 <div class=
"prop-name">type
</div>
4829 <div class=
"prop-value">
4830 <span class=
"json-property-type">
4831 <span class=
"json-schema-ref-array">
4832 <a class=
"json-schema-ref" href=
"#/definitions/VideoBlacklist">VideoBlacklist
</a>
4835 <span class=
"json-property-range" title=
"Value limits"></span>
4840 <div class=
"doc-examples">
4841 <h5>Response Content-Types:
4842 <span>application/json
</span>
4845 <h5>Response Example
4846 <span>(
200 OK)
</span>
4848 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4850 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4851 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4852 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4853 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4854 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4855 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4856 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4857 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
4858 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
4859 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4860 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4861 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
4869 <div class=
"doc-row">
4870 <div class=
"doc-copy">
4871 <section class=
"swagger-request-security">
4872 <table class=
"table">
4875 <th class=
"swagger-request-security-schema"></th>
4876 <th class=
"swagger-request-security-scopes"></th>
4882 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4892 <h1 id=
"tag-VideoChannel" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoChannel">VideoChannel
</h1>
4893 <div id=
"operation--video-channels-get" class=
"operation panel" data-traverse-target=
"operation--video-channels-get">
4894 <!-- <section class="operation-tags row"> -->
4895 <!-- <div class="doc-copy"> -->
4896 <div class=
"operation-tags">
4897 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4902 <h2 class=
"operation-title">
4903 <span class=
"operation-name">
4904 <span class=
"operation-name">GET
</span>
4905 <span class=
"operation-path">/video-channels
</span>
4908 <div class=
"doc-row">
4909 <div class=
"doc-copy">
4910 <section class=
"swagger-request-params">
4911 <div class=
"prop-row prop-group">
4912 <div class=
"prop-name">
4913 <div class=
"prop-title">start:
4914 <span class=
"prop-type">
4915 <span class=
"json-property-type">number
</span>
4916 <span class=
"json-property-range" title=
"Value limits"></span>
4919 <div class=
"prop-subtitle"> in query
</div>
4921 <div class=
"prop-value">
4925 <div class=
"prop-row prop-group">
4926 <div class=
"prop-name">
4927 <div class=
"prop-title">count:
4928 <span class=
"prop-type">
4929 <span class=
"json-property-type">number
</span>
4930 <span class=
"json-property-range" title=
"Value limits"></span>
4933 <div class=
"prop-subtitle"> in query
</div>
4935 <div class=
"prop-value">
4936 <p>Number of items
</p>
4939 <div class=
"prop-row prop-group">
4940 <div class=
"prop-name">
4941 <div class=
"prop-title">sort:
4942 <span class=
"prop-type">
4943 <span class=
"json-property-type">string
</span>
4944 <span class=
"json-property-range" title=
"Value limits"></span>
4947 <div class=
"prop-subtitle"> in query
</div>
4949 <div class=
"prop-value">
4950 <p>Sort column (-createdAt for example)
</p>
4955 <div class=
"doc-examples"></div>
4957 <div class=
"doc-row">
4958 <div class=
"doc-copy">
4959 <section class=
"swagger-responses">
4960 <div class=
"prop-row prop-group">
4961 <div class=
"prop-name">
4962 <div class=
"prop-title">200 OK
</div>
4963 <div class=
"prop-ref">
4964 <span class=
"json-schema-ref-array">
4965 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4968 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4970 <div class=
"prop-value">
4971 <p>successful operation
</p>
4974 <div class=
"prop-row prop-inner">
4975 <div class=
"prop-name">type
</div>
4976 <div class=
"prop-value">
4977 <span class=
"json-property-type">
4978 <span class=
"json-schema-ref-array">
4979 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4982 <span class=
"json-property-range" title=
"Value limits"></span>
4987 <div class=
"doc-examples">
4988 <h5>Response Content-Types:
4989 <span>application/json
</span>
4992 <h5>Response Example
4993 <span>(
200 OK)
</span>
4995 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4997 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4998 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4999 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5000 <span class=
"hljs-attr">"ownerAccount
"</span>: {
5001 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5002 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
5012 <div id=
"operation--video-channels-post" class=
"operation panel" data-traverse-target=
"operation--video-channels-post">
5013 <!-- <section class="operation-tags row"> -->
5014 <!-- <div class="doc-copy"> -->
5015 <div class=
"operation-tags">
5016 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5021 <h2 class=
"operation-title">
5022 <span class=
"operation-name">
5023 <span class=
"operation-name">POST
</span>
5024 <span class=
"operation-path">/video-channels
</span>
5027 <div class=
"doc-row">
5028 <div class=
"doc-copy">
5029 <section class=
"swagger-request-body">
5030 <div class=
"prop-row">
5031 <div class=
"prop-name">
5032 <div class=
"swagger-request-model">
5034 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannelInput">VideoChannelInput
</a>
5038 <div class=
"prop-value columns small-6">
5039 <!-- <div class="swagger-request-description"> -->
5046 <div class=
"doc-examples">
5048 <h5>Request Content-Types:
5049 <span>application/json
</span>
5051 <h5>Request Example
</h5>
5052 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5053 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5054 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
5061 <div class=
"doc-row">
5062 <div class=
"doc-copy">
5063 <section class=
"swagger-responses">
5064 <div class=
"prop-row prop-group">
5065 <div class=
"prop-name">
5066 <div class=
"prop-title">204 No Content
</div>
5068 <div class=
"prop-value">
5069 <p>Successful operation
</p>
5074 <div class=
"doc-examples">
5075 <h5>Response Content-Types:
5076 <span>application/json
</span>
5080 <div class=
"doc-row">
5081 <div class=
"doc-copy">
5082 <section class=
"swagger-request-security">
5083 <table class=
"table">
5086 <th class=
"swagger-request-security-schema"></th>
5087 <th class=
"swagger-request-security-scopes"></th>
5093 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5103 <div id=
"operation--video-channels--id--get" class=
"operation panel" data-traverse-target=
"operation--video-channels--id--get">
5104 <!-- <section class="operation-tags row"> -->
5105 <!-- <div class="doc-copy"> -->
5106 <div class=
"operation-tags">
5107 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5112 <h2 class=
"operation-title">
5113 <span class=
"operation-name">
5114 <span class=
"operation-name">GET
</span>
5115 <span class=
"operation-path">/video-channels/{id}
</span>
5118 <div class=
"doc-row">
5119 <div class=
"doc-copy">
5120 <section class=
"swagger-request-params">
5121 <div class=
"prop-row prop-group">
5122 <div class=
"prop-name">
5123 <div class=
"prop-title">id:
5124 <span class=
"prop-type">
5125 <span class=
"json-property-type">string
</span>
5126 <span class=
"json-property-range" title=
"Value limits"></span>
5129 <span class=
"json-property-required"></span>
5130 <div class=
"prop-subtitle"> in path
</div>
5132 <div class=
"prop-value">
5133 <p>The video channel id or uuid
</p>
5138 <div class=
"doc-examples"></div>
5140 <div class=
"doc-row">
5141 <div class=
"doc-copy">
5142 <section class=
"swagger-responses">
5143 <div class=
"prop-row prop-group">
5144 <div class=
"prop-name">
5145 <div class=
"prop-title">200 OK
</div>
5146 <div class=
"prop-ref">
5148 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
5151 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5153 <div class=
"prop-value">
5154 <p>successful operation
</p>
5159 <div class=
"doc-examples">
5160 <h5>Response Content-Types:
5161 <span>application/json
</span>
5164 <h5>Response Example
5165 <span>(
200 OK)
</span>
5167 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5168 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5169 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5170 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5171 <span class=
"hljs-attr">"ownerAccount
"</span>: {
5172 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5173 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
5182 <div id=
"operation--video-channels--id--put" class=
"operation panel" data-traverse-target=
"operation--video-channels--id--put">
5183 <!-- <section class="operation-tags row"> -->
5184 <!-- <div class="doc-copy"> -->
5185 <div class=
"operation-tags">
5186 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5191 <h2 class=
"operation-title">
5192 <span class=
"operation-name">
5193 <span class=
"operation-name">PUT
</span>
5194 <span class=
"operation-path">/video-channels/{id}
</span>
5197 <div class=
"doc-row">
5198 <div class=
"doc-copy">
5199 <section class=
"swagger-request-body">
5200 <div class=
"prop-row">
5201 <div class=
"prop-name">
5202 <div class=
"swagger-request-model">
5204 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannelInput">VideoChannelInput
</a>
5208 <div class=
"prop-value columns small-6">
5209 <!-- <div class="swagger-request-description"> -->
5215 <section class=
"swagger-request-params">
5216 <div class=
"prop-row prop-group">
5217 <div class=
"prop-name">
5218 <div class=
"prop-title">id:
5219 <span class=
"prop-type">
5220 <span class=
"json-property-type">string
</span>
5221 <span class=
"json-property-range" title=
"Value limits"></span>
5224 <span class=
"json-property-required"></span>
5225 <div class=
"prop-subtitle"> in path
</div>
5227 <div class=
"prop-value">
5228 <p>The video channel id or uuid
</p>
5233 <div class=
"doc-examples">
5235 <h5>Request Content-Types:
5236 <span>application/json
</span>
5238 <h5>Request Example
</h5>
5239 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5240 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5241 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
5248 <div class=
"doc-row">
5249 <div class=
"doc-copy">
5250 <section class=
"swagger-responses">
5251 <div class=
"prop-row prop-group">
5252 <div class=
"prop-name">
5253 <div class=
"prop-title">204 No Content
</div>
5255 <div class=
"prop-value">
5256 <p>Successful operation
</p>
5261 <div class=
"doc-examples">
5262 <h5>Response Content-Types:
5263 <span>application/json
</span>
5267 <div class=
"doc-row">
5268 <div class=
"doc-copy">
5269 <section class=
"swagger-request-security">
5270 <table class=
"table">
5273 <th class=
"swagger-request-security-schema"></th>
5274 <th class=
"swagger-request-security-scopes"></th>
5280 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5290 <div id=
"operation--video-channels--id--delete" class=
"operation panel" data-traverse-target=
"operation--video-channels--id--delete">
5291 <!-- <section class="operation-tags row"> -->
5292 <!-- <div class="doc-copy"> -->
5293 <div class=
"operation-tags">
5294 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5299 <h2 class=
"operation-title">
5300 <span class=
"operation-name">
5301 <span class=
"operation-name">DELETE
</span>
5302 <span class=
"operation-path">/video-channels/{id}
</span>
5305 <div class=
"doc-row">
5306 <div class=
"doc-copy">
5307 <section class=
"swagger-request-params">
5308 <div class=
"prop-row prop-group">
5309 <div class=
"prop-name">
5310 <div class=
"prop-title">id:
5311 <span class=
"prop-type">
5312 <span class=
"json-property-type">string
</span>
5313 <span class=
"json-property-range" title=
"Value limits"></span>
5316 <span class=
"json-property-required"></span>
5317 <div class=
"prop-subtitle"> in path
</div>
5319 <div class=
"prop-value">
5320 <p>The video channel id or uuid
</p>
5325 <div class=
"doc-examples"></div>
5327 <div class=
"doc-row">
5328 <div class=
"doc-copy">
5329 <section class=
"swagger-responses">
5330 <div class=
"prop-row prop-group">
5331 <div class=
"prop-name">
5332 <div class=
"prop-title">204 No Content
</div>
5334 <div class=
"prop-value">
5335 <p>Successful operation
</p>
5340 <div class=
"doc-examples">
5341 <h5>Response Content-Types:
5342 <span>application/json
</span>
5346 <div class=
"doc-row">
5347 <div class=
"doc-copy">
5348 <section class=
"swagger-request-security">
5349 <table class=
"table">
5352 <th class=
"swagger-request-security-schema"></th>
5353 <th class=
"swagger-request-security-scopes"></th>
5359 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5369 <div id=
"operation--video-channels--id--videos-get" class=
"operation panel" data-traverse-target=
"operation--video-channels--id--videos-get">
5370 <!-- <section class="operation-tags row"> -->
5371 <!-- <div class="doc-copy"> -->
5372 <div class=
"operation-tags">
5373 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5378 <h2 class=
"operation-title">
5379 <span class=
"operation-name">
5380 <span class=
"operation-name">GET
</span>
5381 <span class=
"operation-path">/video-channels/{id}/videos
</span>
5384 <div class=
"doc-row">
5385 <div class=
"doc-copy">
5386 <section class=
"swagger-request-params">
5387 <div class=
"prop-row prop-group">
5388 <div class=
"prop-name">
5389 <div class=
"prop-title">id:
5390 <span class=
"prop-type">
5391 <span class=
"json-property-type">string
</span>
5392 <span class=
"json-property-range" title=
"Value limits"></span>
5395 <span class=
"json-property-required"></span>
5396 <div class=
"prop-subtitle"> in path
</div>
5398 <div class=
"prop-value">
5399 <p>The video channel id or uuid
</p>
5404 <div class=
"doc-examples"></div>
5406 <div class=
"doc-row">
5407 <div class=
"doc-copy">
5408 <section class=
"swagger-responses">
5409 <div class=
"prop-row prop-group">
5410 <div class=
"prop-name">
5411 <div class=
"prop-title">200 OK
</div>
5412 <div class=
"prop-ref">
5414 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
5417 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5419 <div class=
"prop-value">
5420 <p>successful operation
</p>
5425 <div class=
"doc-examples">
5426 <h5>Response Content-Types:
5427 <span>application/json
</span>
5430 <h5>Response Example
5431 <span>(
200 OK)
</span>
5433 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5434 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5435 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5436 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5437 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5438 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5439 <span class=
"hljs-attr">"category
"</span>: {
5440 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5441 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5443 <span class=
"hljs-attr">"licence
"</span>: {
5444 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5445 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5447 <span class=
"hljs-attr">"language
"</span>: {
5448 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
5449 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5451 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
5452 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5453 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
5454 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5455 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5456 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5457 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5458 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5459 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
5460 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5461 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5462 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5463 <span class=
"hljs-attr">"account
"</span>: {
5464 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5465 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5466 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5467 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5468 <span class=
"hljs-attr">"avatar
"</span>: {
5469 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5470 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5471 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5481 <div id=
"operation--accounts--name--video-channels-get" class=
"operation panel" data-traverse-target=
"operation--accounts--name--video-channels-get">
5482 <!-- <section class="operation-tags row"> -->
5483 <!-- <div class="doc-copy"> -->
5484 <div class=
"operation-tags">
5485 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5490 <h2 class=
"operation-title">
5491 <span class=
"operation-name">
5492 <span class=
"operation-name">GET
</span>
5493 <span class=
"operation-path">/accounts/{name}/video-channels
</span>
5496 <div class=
"doc-row">
5497 <div class=
"doc-copy">
5498 <section class=
"swagger-request-params">
5499 <div class=
"prop-row prop-group">
5500 <div class=
"prop-name">
5501 <div class=
"prop-title">name:
5502 <span class=
"prop-type">
5503 <span class=
"json-property-type">string
</span>
5504 <span class=
"json-property-range" title=
"Value limits"></span>
5507 <span class=
"json-property-required"></span>
5508 <div class=
"prop-subtitle"> in path
</div>
5510 <div class=
"prop-value">
5511 <p>The name of the account (chocobozzz or
5512 <a href=
"mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re
</a> for example)
</p>
5517 <div class=
"doc-examples"></div>
5519 <div class=
"doc-row">
5520 <div class=
"doc-copy">
5521 <section class=
"swagger-responses">
5522 <div class=
"prop-row prop-group">
5523 <div class=
"prop-name">
5524 <div class=
"prop-title">200 OK
</div>
5525 <div class=
"prop-ref">
5526 <span class=
"json-schema-ref-array">
5527 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
5530 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5532 <div class=
"prop-value">
5533 <p>successful operation
</p>
5536 <div class=
"prop-row prop-inner">
5537 <div class=
"prop-name">type
</div>
5538 <div class=
"prop-value">
5539 <span class=
"json-property-type">
5540 <span class=
"json-schema-ref-array">
5541 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
5544 <span class=
"json-property-range" title=
"Value limits"></span>
5549 <div class=
"doc-examples">
5550 <h5>Response Content-Types:
5551 <span>application/json
</span>
5554 <h5>Response Example
5555 <span>(
200 OK)
</span>
5557 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
5559 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5560 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5561 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5562 <span class=
"hljs-attr">"ownerAccount
"</span>: {
5563 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5564 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
5574 <h1 id=
"tag-VideoComment" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoComment">VideoComment
</h1>
5575 <div id=
"operation--videos--id--comment-threads-get" class=
"operation panel" data-traverse-target=
"operation--videos--id--comment-threads-get">
5576 <!-- <section class="operation-tags row"> -->
5577 <!-- <div class="doc-copy"> -->
5578 <div class=
"operation-tags">
5579 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5584 <h2 class=
"operation-title">
5585 <span class=
"operation-name">
5586 <span class=
"operation-name">GET
</span>
5587 <span class=
"operation-path">/videos/{id}/comment-threads
</span>
5590 <div class=
"doc-row">
5591 <div class=
"doc-copy">
5592 <section class=
"swagger-request-params">
5593 <div class=
"prop-row prop-group">
5594 <div class=
"prop-name">
5595 <div class=
"prop-title">id:
5596 <span class=
"prop-type">
5597 <span class=
"json-property-type">string
</span>
5598 <span class=
"json-property-range" title=
"Value limits"></span>
5601 <span class=
"json-property-required"></span>
5602 <div class=
"prop-subtitle"> in path
</div>
5604 <div class=
"prop-value">
5605 <p>The video id or uuid
</p>
5608 <div class=
"prop-row prop-group">
5609 <div class=
"prop-name">
5610 <div class=
"prop-title">start:
5611 <span class=
"prop-type">
5612 <span class=
"json-property-type">number
</span>
5613 <span class=
"json-property-range" title=
"Value limits"></span>
5616 <div class=
"prop-subtitle"> in query
</div>
5618 <div class=
"prop-value">
5622 <div class=
"prop-row prop-group">
5623 <div class=
"prop-name">
5624 <div class=
"prop-title">count:
5625 <span class=
"prop-type">
5626 <span class=
"json-property-type">number
</span>
5627 <span class=
"json-property-range" title=
"Value limits"></span>
5630 <div class=
"prop-subtitle"> in query
</div>
5632 <div class=
"prop-value">
5633 <p>Number of items
</p>
5636 <div class=
"prop-row prop-group">
5637 <div class=
"prop-name">
5638 <div class=
"prop-title">sort:
5639 <span class=
"prop-type">
5640 <span class=
"json-property-type">string
</span>
5641 <span class=
"json-property-range" title=
"Value limits"></span>
5644 <div class=
"prop-subtitle"> in query
</div>
5646 <div class=
"prop-value">
5647 <p>Sort column (-createdAt for example)
</p>
5652 <div class=
"doc-examples"></div>
5654 <div class=
"doc-row">
5655 <div class=
"doc-copy">
5656 <section class=
"swagger-responses">
5657 <div class=
"prop-row prop-group">
5658 <div class=
"prop-name">
5659 <div class=
"prop-title">200 OK
</div>
5660 <div class=
"prop-ref">
5662 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadResponse">CommentThreadResponse
</a>
5665 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5667 <div class=
"prop-value">
5668 <p>successful operation
</p>
5673 <div class=
"doc-examples">
5674 <h5>Response Content-Types:
5675 <span>application/json
</span>
5678 <h5>Response Example
5679 <span>(
200 OK)
</span>
5681 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5682 <span class=
"hljs-attr">"total
"</span>:
<span class=
"hljs-string">"number
"</span>,
5683 <span class=
"hljs-attr">"data
"</span>: [
5685 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5686 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5687 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5688 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5689 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5690 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5691 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5692 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5693 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5694 <span class=
"hljs-attr">"account
"</span>: {
5695 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5696 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5697 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5698 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5699 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5700 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5701 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5702 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5703 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5704 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5705 <span class=
"hljs-attr">"avatar
"</span>: {
5706 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5707 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5708 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5720 <div id=
"operation--videos--id--comment-threads-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--comment-threads-post">
5721 <!-- <section class="operation-tags row"> -->
5722 <!-- <div class="doc-copy"> -->
5723 <div class=
"operation-tags">
5724 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5729 <h2 class=
"operation-title">
5730 <span class=
"operation-name">
5731 <span class=
"operation-name">POST
</span>
5732 <span class=
"operation-path">/videos/{id}/comment-threads
</span>
5735 <div class=
"doc-row">
5736 <div class=
"doc-copy">
5737 <section class=
"swagger-request-params">
5738 <div class=
"prop-row prop-group">
5739 <div class=
"prop-name">
5740 <div class=
"prop-title">id:
5741 <span class=
"prop-type">
5742 <span class=
"json-property-type">string
</span>
5743 <span class=
"json-property-range" title=
"Value limits"></span>
5746 <span class=
"json-property-required"></span>
5747 <div class=
"prop-subtitle"> in path
</div>
5749 <div class=
"prop-value">
5750 <p>The video id or uuid
</p>
5755 <div class=
"doc-examples"></div>
5757 <div class=
"doc-row">
5758 <div class=
"doc-copy">
5759 <section class=
"swagger-responses">
5760 <div class=
"prop-row prop-group">
5761 <div class=
"prop-name">
5762 <div class=
"prop-title">200 OK
</div>
5763 <div class=
"prop-ref">
5765 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadPostResponse">CommentThreadPostResponse
</a>
5768 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5770 <div class=
"prop-value">
5771 <p>successful operation
</p>
5776 <div class=
"doc-examples">
5777 <h5>Response Content-Types:
5778 <span>application/json
</span>
5781 <h5>Response Example
5782 <span>(
200 OK)
</span>
5784 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5785 <span class=
"hljs-attr">"comment
"</span>: {
5786 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5787 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5788 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5789 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5790 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5791 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5792 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5793 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5794 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5795 <span class=
"hljs-attr">"account
"</span>: {
5796 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5797 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5798 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5799 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5800 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5801 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5802 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5803 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5804 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5805 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5806 <span class=
"hljs-attr">"avatar
"</span>: {
5807 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5808 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5809 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5819 <div class=
"doc-row">
5820 <div class=
"doc-copy">
5821 <section class=
"swagger-request-security">
5822 <table class=
"table">
5825 <th class=
"swagger-request-security-schema"></th>
5826 <th class=
"swagger-request-security-scopes"></th>
5832 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5842 <div id=
"operation--videos--id--comment-threads--threadId--get" class=
"operation panel" data-traverse-target=
"operation--videos--id--comment-threads--threadId--get">
5843 <!-- <section class="operation-tags row"> -->
5844 <!-- <div class="doc-copy"> -->
5845 <div class=
"operation-tags">
5846 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5851 <h2 class=
"operation-title">
5852 <span class=
"operation-name">
5853 <span class=
"operation-name">GET
</span>
5854 <span class=
"operation-path">/videos/{id}/comment-threads/{threadId}
</span>
5857 <div class=
"doc-row">
5858 <div class=
"doc-copy">
5859 <section class=
"swagger-request-params">
5860 <div class=
"prop-row prop-group">
5861 <div class=
"prop-name">
5862 <div class=
"prop-title">id:
5863 <span class=
"prop-type">
5864 <span class=
"json-property-type">string
</span>
5865 <span class=
"json-property-range" title=
"Value limits"></span>
5868 <span class=
"json-property-required"></span>
5869 <div class=
"prop-subtitle"> in path
</div>
5871 <div class=
"prop-value">
5872 <p>The video id or uuid
</p>
5875 <div class=
"prop-row prop-group">
5876 <div class=
"prop-name">
5877 <div class=
"prop-title">threadId:
5878 <span class=
"prop-type">
5879 <span class=
"json-property-type">number
</span>
5880 <span class=
"json-property-range" title=
"Value limits"></span>
5883 <span class=
"json-property-required"></span>
5884 <div class=
"prop-subtitle"> in path
</div>
5886 <div class=
"prop-value">
5887 <p>The thread id (root comment id)
</p>
5892 <div class=
"doc-examples"></div>
5894 <div class=
"doc-row">
5895 <div class=
"doc-copy">
5896 <section class=
"swagger-responses">
5897 <div class=
"prop-row prop-group">
5898 <div class=
"prop-name">
5899 <div class=
"prop-title">200 OK
</div>
5900 <div class=
"prop-ref">
5902 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
5905 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5907 <div class=
"prop-value">
5908 <p>successful operation
</p>
5913 <div class=
"doc-examples">
5914 <h5>Response Content-Types:
5915 <span>application/json
</span>
5918 <h5>Response Example
5919 <span>(
200 OK)
</span>
5921 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5922 <span class=
"hljs-attr">"comment
"</span>: {
5923 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5924 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5925 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5926 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5927 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5928 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5929 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5930 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5931 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5932 <span class=
"hljs-attr">"account
"</span>: {
5933 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5934 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5935 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5936 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5937 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5938 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5939 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5940 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5941 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5942 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5943 <span class=
"hljs-attr">"avatar
"</span>: {
5944 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5945 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5946 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5950 <span class=
"hljs-attr">"children
"</span>: [
5952 <span class=
"hljs-attr">"comment
"</span>: {
5953 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5954 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5955 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5956 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5957 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5958 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5959 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5960 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5961 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5962 <span class=
"hljs-attr">"account
"</span>: {
5963 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5964 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5965 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5966 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5967 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5968 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5969 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5970 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5971 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5972 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5973 <span class=
"hljs-attr">"avatar
"</span>: {
5974 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5975 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5976 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5980 <span class=
"hljs-attr">"children
"</span>: [
5982 <span class=
"hljs-attr">"comment
"</span>: {
5983 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5984 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5985 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5986 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5987 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5988 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5989 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5990 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5991 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5992 <span class=
"hljs-attr">"account
"</span>: {
5993 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5994 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5995 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5996 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5997 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5998 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5999 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6000 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6001 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6002 <span class=
"hljs-attr">"avatar
"</span>: {
6003 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6004 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6005 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6020 <div id=
"operation--videos--id--comments--commentId--post" class=
"operation panel" data-traverse-target=
"operation--videos--id--comments--commentId--post">
6021 <!-- <section class="operation-tags row"> -->
6022 <!-- <div class="doc-copy"> -->
6023 <div class=
"operation-tags">
6024 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
6029 <h2 class=
"operation-title">
6030 <span class=
"operation-name">
6031 <span class=
"operation-name">POST
</span>
6032 <span class=
"operation-path">/videos/{id}/comments/{commentId}
</span>
6035 <div class=
"doc-row">
6036 <div class=
"doc-copy">
6037 <section class=
"swagger-request-params">
6038 <div class=
"prop-row prop-group">
6039 <div class=
"prop-name">
6040 <div class=
"prop-title">id:
6041 <span class=
"prop-type">
6042 <span class=
"json-property-type">string
</span>
6043 <span class=
"json-property-range" title=
"Value limits"></span>
6046 <span class=
"json-property-required"></span>
6047 <div class=
"prop-subtitle"> in path
</div>
6049 <div class=
"prop-value">
6050 <p>The video id or uuid
</p>
6053 <div class=
"prop-row prop-group">
6054 <div class=
"prop-name">
6055 <div class=
"prop-title">threadId:
6056 <span class=
"prop-type">
6057 <span class=
"json-property-type">number
</span>
6058 <span class=
"json-property-range" title=
"Value limits"></span>
6061 <span class=
"json-property-required"></span>
6062 <div class=
"prop-subtitle"> in path
</div>
6064 <div class=
"prop-value">
6065 <p>The comment id
</p>
6070 <div class=
"doc-examples"></div>
6072 <div class=
"doc-row">
6073 <div class=
"doc-copy">
6074 <section class=
"swagger-responses">
6075 <div class=
"prop-row prop-group">
6076 <div class=
"prop-name">
6077 <div class=
"prop-title">200 OK
</div>
6078 <div class=
"prop-ref">
6080 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadPostResponse">CommentThreadPostResponse
</a>
6083 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
6085 <div class=
"prop-value">
6086 <p>successful operation
</p>
6091 <div class=
"doc-examples">
6092 <h5>Response Content-Types:
6093 <span>application/json
</span>
6096 <h5>Response Example
6097 <span>(
200 OK)
</span>
6099 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6100 <span class=
"hljs-attr">"comment
"</span>: {
6101 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6102 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6103 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6104 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6105 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6106 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6107 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6108 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6109 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6110 <span class=
"hljs-attr">"account
"</span>: {
6111 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6112 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6113 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6114 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6115 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6116 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6117 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6118 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6119 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6120 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6121 <span class=
"hljs-attr">"avatar
"</span>: {
6122 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6123 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6124 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6134 <div class=
"doc-row">
6135 <div class=
"doc-copy">
6136 <section class=
"swagger-request-security">
6137 <table class=
"table">
6140 <th class=
"swagger-request-security-schema"></th>
6141 <th class=
"swagger-request-security-scopes"></th>
6147 <a href=
"#security-definition-OAuth2">OAuth2
</a>
6157 <div id=
"operation--videos--id--comments--commentId--delete" class=
"operation panel" data-traverse-target=
"operation--videos--id--comments--commentId--delete">
6158 <!-- <section class="operation-tags row"> -->
6159 <!-- <div class="doc-copy"> -->
6160 <div class=
"operation-tags">
6161 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
6166 <h2 class=
"operation-title">
6167 <span class=
"operation-name">
6168 <span class=
"operation-name">DELETE
</span>
6169 <span class=
"operation-path">/videos/{id}/comments/{commentId}
</span>
6172 <div class=
"doc-row">
6173 <div class=
"doc-copy">
6174 <section class=
"swagger-request-params">
6175 <div class=
"prop-row prop-group">
6176 <div class=
"prop-name">
6177 <div class=
"prop-title">id:
6178 <span class=
"prop-type">
6179 <span class=
"json-property-type">string
</span>
6180 <span class=
"json-property-range" title=
"Value limits"></span>
6183 <span class=
"json-property-required"></span>
6184 <div class=
"prop-subtitle"> in path
</div>
6186 <div class=
"prop-value">
6187 <p>The video id or uuid
</p>
6190 <div class=
"prop-row prop-group">
6191 <div class=
"prop-name">
6192 <div class=
"prop-title">threadId:
6193 <span class=
"prop-type">
6194 <span class=
"json-property-type">number
</span>
6195 <span class=
"json-property-range" title=
"Value limits"></span>
6198 <span class=
"json-property-required"></span>
6199 <div class=
"prop-subtitle"> in path
</div>
6201 <div class=
"prop-value">
6202 <p>The comment id
</p>
6207 <div class=
"doc-examples"></div>
6209 <div class=
"doc-row">
6210 <div class=
"doc-copy">
6211 <section class=
"swagger-responses">
6212 <div class=
"prop-row prop-group">
6213 <div class=
"prop-name">
6214 <div class=
"prop-title">204 No Content
</div>
6216 <div class=
"prop-value">
6217 <p>Successful operation
</p>
6222 <div class=
"doc-examples">
6223 <h5>Response Content-Types:
6224 <span>application/json
</span>
6228 <div class=
"doc-row">
6229 <div class=
"doc-copy">
6230 <section class=
"swagger-request-security">
6231 <table class=
"table">
6234 <th class=
"swagger-request-security-schema"></th>
6235 <th class=
"swagger-request-security-scopes"></th>
6241 <a href=
"#security-definition-OAuth2">OAuth2
</a>
6251 <h1 id=
"tag-VideoRate" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoRate">VideoRate
</h1>
6252 <div id=
"operation--videos--id--rate-put" class=
"operation panel" data-traverse-target=
"operation--videos--id--rate-put">
6253 <!-- <section class="operation-tags row"> -->
6254 <!-- <div class="doc-copy"> -->
6255 <div class=
"operation-tags">
6256 <a class=
"label" href=
"#tag-VideoRate">VideoRate
</a>
6261 <h2 class=
"operation-title">
6262 <span class=
"operation-name">
6263 <span class=
"operation-name">PUT
</span>
6264 <span class=
"operation-path">/videos/{id}/rate
</span>
6267 <div class=
"doc-row">
6268 <div class=
"doc-copy">
6269 <section class=
"swagger-request-params">
6270 <div class=
"prop-row prop-group">
6271 <div class=
"prop-name">
6272 <div class=
"prop-title">id:
6273 <span class=
"prop-type">
6274 <span class=
"json-property-type">string
</span>
6275 <span class=
"json-property-range" title=
"Value limits"></span>
6278 <span class=
"json-property-required"></span>
6279 <div class=
"prop-subtitle"> in path
</div>
6281 <div class=
"prop-value">
6282 <p>The video id or uuid
</p>
6287 <div class=
"doc-examples"></div>
6289 <div class=
"doc-row">
6290 <div class=
"doc-copy">
6291 <section class=
"swagger-responses">
6292 <div class=
"prop-row prop-group">
6293 <div class=
"prop-name">
6294 <div class=
"prop-title">204 No Content
</div>
6296 <div class=
"prop-value">
6297 <p>Successful operation
</p>
6302 <div class=
"doc-examples">
6303 <h5>Response Content-Types:
6304 <span>application/json
</span>
6308 <div class=
"doc-row">
6309 <div class=
"doc-copy">
6310 <section class=
"swagger-request-security">
6311 <table class=
"table">
6314 <th class=
"swagger-request-security-schema"></th>
6315 <th class=
"swagger-request-security-scopes"></th>
6321 <a href=
"#security-definition-OAuth2">OAuth2
</a>
6331 <h1>Schema Definitions
</h1>
6332 <div id=
"definition-VideoConstantNumber" class=
"definition panel" data-traverse-target=
"definition-VideoConstantNumber">
6333 <h2 class=
"panel-title">
6334 <a name=
"/definitions/VideoConstantNumber"></a>VideoConstantNumber:
6335 <!-- <span class="json-property-type">
6336 <span class="json-property-type">object</span>
6337 <span class="json-property-range" title="Value limits"></span>
6342 <div class=
"doc-row">
6343 <div class=
"doc-copy">
6344 <section class=
"json-schema-properties">
6346 <dt data-property-name=
"id">
6347 <span class=
"json-property-name">id:
</span>
6348 <span class=
"json-property-type">number
</span>
6349 <span class=
"json-property-range" title=
"Value limits"></span>
6351 <dt data-property-name=
"label">
6352 <span class=
"json-property-name">label:
</span>
6353 <span class=
"json-property-type">string
</span>
6354 <span class=
"json-property-range" title=
"Value limits"></span>
6359 <div class=
"doc-examples">
6362 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6363 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6364 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6372 <div id=
"definition-VideoConstantString" class=
"definition panel" data-traverse-target=
"definition-VideoConstantString">
6373 <h2 class=
"panel-title">
6374 <a name=
"/definitions/VideoConstantString"></a>VideoConstantString:
6375 <!-- <span class="json-property-type">
6376 <span class="json-property-type">object</span>
6377 <span class="json-property-range" title="Value limits"></span>
6382 <div class=
"doc-row">
6383 <div class=
"doc-copy">
6384 <section class=
"json-schema-properties">
6386 <dt data-property-name=
"id">
6387 <span class=
"json-property-name">id:
</span>
6388 <span class=
"json-property-type">string
</span>
6389 <span class=
"json-property-range" title=
"Value limits"></span>
6391 <dt data-property-name=
"label">
6392 <span class=
"json-property-name">label:
</span>
6393 <span class=
"json-property-type">string
</span>
6394 <span class=
"json-property-range" title=
"Value limits"></span>
6399 <div class=
"doc-examples">
6402 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6403 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
6404 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6412 <div id=
"definition-VideoPrivacy" class=
"definition panel" data-traverse-target=
"definition-VideoPrivacy">
6413 <h2 class=
"panel-title">
6414 <a name=
"/definitions/VideoPrivacy"></a>VideoPrivacy: string
6415 <!-- <span class="json-property-type">
6416 <span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values">
6417 <span class="json-property-enum-item">Public</span>,
6418 <span class="json-property-enum-item">Unlisted</span>,
6419 <span class="json-property-enum-item">Private</span>
6421 <span class="json-property-range" title="Value limits"></span>
6426 <div class=
"doc-row">
6427 <div class=
"doc-copy">
6428 <span class=
"json-property-type">string
</span>
6429 <span class=
"json-property-enum" title=
"Possible values">
6430 <span class=
"json-property-enum-item">Public
</span>,
6431 <span class=
"json-property-enum-item">Unlisted
</span>,
6432 <span class=
"json-property-enum-item">Private
</span>
6434 <span class=
"json-property-range" title=
"Value limits"></span>
6438 <div id=
"definition-Video" class=
"definition panel" data-traverse-target=
"definition-Video">
6439 <h2 class=
"panel-title">
6440 <a name=
"/definitions/Video"></a>Video:
6441 <!-- <span class="json-property-type">
6442 <span class="json-property-type">object</span>
6443 <span class="json-property-range" title="Value limits"></span>
6448 <div class=
"doc-row">
6449 <div class=
"doc-copy">
6450 <section class=
"json-schema-properties">
6452 <dt data-property-name=
"id">
6453 <span class=
"json-property-name">id:
</span>
6454 <span class=
"json-property-type">number
</span>
6455 <span class=
"json-property-range" title=
"Value limits"></span>
6457 <dt data-property-name=
"uuid">
6458 <span class=
"json-property-name">uuid:
</span>
6459 <span class=
"json-property-type">string
</span>
6460 <span class=
"json-property-range" title=
"Value limits"></span>
6462 <dt data-property-name=
"createdAt">
6463 <span class=
"json-property-name">createdAt:
</span>
6464 <span class=
"json-property-type">string
</span>
6465 <span class=
"json-property-range" title=
"Value limits"></span>
6467 <dt data-property-name=
"publishedAt">
6468 <span class=
"json-property-name">publishedAt:
</span>
6469 <span class=
"json-property-type">string
</span>
6470 <span class=
"json-property-range" title=
"Value limits"></span>
6472 <dt data-property-name=
"updatedAt">
6473 <span class=
"json-property-name">updatedAt:
</span>
6474 <span class=
"json-property-type">string
</span>
6475 <span class=
"json-property-range" title=
"Value limits"></span>
6477 <dt data-property-name=
"category">
6478 <span class=
"json-property-name">category:
</span>
6479 <span class=
"json-property-type">
6481 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstantNumber">VideoConstantNumber
</a>
6484 <span class=
"json-property-range" title=
"Value limits"></span>
6486 <dt data-property-name=
"licence">
6487 <span class=
"json-property-name">licence:
</span>
6488 <span class=
"json-property-type">
6490 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstantNumber">VideoConstantNumber
</a>
6493 <span class=
"json-property-range" title=
"Value limits"></span>
6495 <dt data-property-name=
"language">
6496 <span class=
"json-property-name">language:
</span>
6497 <span class=
"json-property-type">
6499 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstantString">VideoConstantString
</a>
6502 <span class=
"json-property-range" title=
"Value limits"></span>
6504 <dt data-property-name=
"privacy">
6505 <span class=
"json-property-name">privacy:
</span>
6506 <span class=
"json-property-type">
6508 <a class=
"json-schema-ref" href=
"#/definitions/VideoPrivacy">VideoPrivacy
</a>
6511 <span class=
"json-property-range" title=
"Value limits"></span>
6513 <dt data-property-name=
"description">
6514 <span class=
"json-property-name">description:
</span>
6515 <span class=
"json-property-type">string
</span>
6516 <span class=
"json-property-range" title=
"Value limits"></span>
6518 <dt data-property-name=
"duration">
6519 <span class=
"json-property-name">duration:
</span>
6520 <span class=
"json-property-type">number
</span>
6521 <span class=
"json-property-range" title=
"Value limits"></span>
6523 <dt data-property-name=
"isLocal">
6524 <span class=
"json-property-name">isLocal:
</span>
6525 <span class=
"json-property-type">boolean
</span>
6526 <span class=
"json-property-range" title=
"Value limits"></span>
6528 <dt data-property-name=
"name">
6529 <span class=
"json-property-name">name:
</span>
6530 <span class=
"json-property-type">string
</span>
6531 <span class=
"json-property-range" title=
"Value limits"></span>
6533 <dt data-property-name=
"thumbnailPath">
6534 <span class=
"json-property-name">thumbnailPath:
</span>
6535 <span class=
"json-property-type">string
</span>
6536 <span class=
"json-property-range" title=
"Value limits"></span>
6538 <dt data-property-name=
"previewPath">
6539 <span class=
"json-property-name">previewPath:
</span>
6540 <span class=
"json-property-type">string
</span>
6541 <span class=
"json-property-range" title=
"Value limits"></span>
6543 <dt data-property-name=
"embedPath">
6544 <span class=
"json-property-name">embedPath:
</span>
6545 <span class=
"json-property-type">string
</span>
6546 <span class=
"json-property-range" title=
"Value limits"></span>
6548 <dt data-property-name=
"views">
6549 <span class=
"json-property-name">views:
</span>
6550 <span class=
"json-property-type">number
</span>
6551 <span class=
"json-property-range" title=
"Value limits"></span>
6553 <dt data-property-name=
"likes">
6554 <span class=
"json-property-name">likes:
</span>
6555 <span class=
"json-property-type">number
</span>
6556 <span class=
"json-property-range" title=
"Value limits"></span>
6558 <dt data-property-name=
"dislikes">
6559 <span class=
"json-property-name">dislikes:
</span>
6560 <span class=
"json-property-type">number
</span>
6561 <span class=
"json-property-range" title=
"Value limits"></span>
6563 <dt data-property-name=
"nsfw">
6564 <span class=
"json-property-name">nsfw:
</span>
6565 <span class=
"json-property-type">boolean
</span>
6566 <span class=
"json-property-range" title=
"Value limits"></span>
6568 <dt data-property-name=
"account">
6569 <span class=
"json-property-name">account:
</span>
6570 <span class=
"json-property-type">object
</span>
6571 <span class=
"json-property-range" title=
"Value limits"></span>
6573 <dt class=
"json-inner-schema">
6574 <section class=
"json-schema-properties">
6576 <dt data-property-name=
"name">
6577 <span class=
"json-property-name">name:
</span>
6578 <span class=
"json-property-type">string
</span>
6579 <span class=
"json-property-range" title=
"Value limits"></span>
6581 <dt data-property-name=
"displayName">
6582 <span class=
"json-property-name">displayName:
</span>
6583 <span class=
"json-property-type">string
</span>
6584 <span class=
"json-property-range" title=
"Value limits"></span>
6586 <dt data-property-name=
"url">
6587 <span class=
"json-property-name">url:
</span>
6588 <span class=
"json-property-type">string
</span>
6589 <span class=
"json-property-range" title=
"Value limits"></span>
6591 <dt data-property-name=
"host">
6592 <span class=
"json-property-name">host:
</span>
6593 <span class=
"json-property-type">string
</span>
6594 <span class=
"json-property-range" title=
"Value limits"></span>
6596 <dt data-property-name=
"avatar">
6597 <span class=
"json-property-name">avatar:
</span>
6598 <span class=
"json-property-type">
6600 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
6603 <span class=
"json-property-range" title=
"Value limits"></span>
6611 <div class=
"doc-examples">
6614 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6615 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6616 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6617 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6618 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6619 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6620 <span class=
"hljs-attr">"category
"</span>: {
6621 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6622 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6624 <span class=
"hljs-attr">"licence
"</span>: {
6625 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6626 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6628 <span class=
"hljs-attr">"language
"</span>: {
6629 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
6630 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6632 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
6633 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6634 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6635 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6636 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6637 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6638 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6639 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6640 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6641 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6642 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6643 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6644 <span class=
"hljs-attr">"account
"</span>: {
6645 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6646 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6647 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6648 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6649 <span class=
"hljs-attr">"avatar
"</span>: {
6650 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6651 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6652 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6662 <div id=
"definition-VideoAbuse" class=
"definition panel" data-traverse-target=
"definition-VideoAbuse">
6663 <h2 class=
"panel-title">
6664 <a name=
"/definitions/VideoAbuse"></a>VideoAbuse:
6665 <!-- <span class="json-property-type">
6666 <span class="json-property-type">object</span>
6667 <span class="json-property-range" title="Value limits"></span>
6672 <div class=
"doc-row">
6673 <div class=
"doc-copy">
6674 <section class=
"json-schema-properties">
6676 <dt data-property-name=
"id">
6677 <span class=
"json-property-name">id:
</span>
6678 <span class=
"json-property-type">number
</span>
6679 <span class=
"json-property-range" title=
"Value limits"></span>
6681 <dt data-property-name=
"reason">
6682 <span class=
"json-property-name">reason:
</span>
6683 <span class=
"json-property-type">string
</span>
6684 <span class=
"json-property-range" title=
"Value limits"></span>
6686 <dt data-property-name=
"reporterAccount">
6687 <span class=
"json-property-name">reporterAccount:
</span>
6688 <span class=
"json-property-type">
6690 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
6693 <span class=
"json-property-range" title=
"Value limits"></span>
6695 <dt data-property-name=
"video">
6696 <span class=
"json-property-name">video:
</span>
6697 <span class=
"json-property-type">object
</span>
6698 <span class=
"json-property-range" title=
"Value limits"></span>
6700 <dt class=
"json-inner-schema">
6701 <section class=
"json-schema-properties">
6703 <dt data-property-name=
"id">
6704 <span class=
"json-property-name">id:
</span>
6705 <span class=
"json-property-type">number
</span>
6706 <span class=
"json-property-range" title=
"Value limits"></span>
6708 <dt data-property-name=
"name">
6709 <span class=
"json-property-name">name:
</span>
6710 <span class=
"json-property-type">string
</span>
6711 <span class=
"json-property-range" title=
"Value limits"></span>
6713 <dt data-property-name=
"uuid">
6714 <span class=
"json-property-name">uuid:
</span>
6715 <span class=
"json-property-type">string
</span>
6716 <span class=
"json-property-range" title=
"Value limits"></span>
6718 <dt data-property-name=
"url">
6719 <span class=
"json-property-name">url:
</span>
6720 <span class=
"json-property-type">string
</span>
6721 <span class=
"json-property-range" title=
"Value limits"></span>
6726 <dt data-property-name=
"createdAt">
6727 <span class=
"json-property-name">createdAt:
</span>
6728 <span class=
"json-property-type">string
</span>
6729 <span class=
"json-property-range" title=
"Value limits"></span>
6734 <div class=
"doc-examples">
6737 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6738 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6739 <span class=
"hljs-attr">"reason
"</span>:
<span class=
"hljs-string">"string
"</span>,
6740 <span class=
"hljs-attr">"reporterAccount
"</span>: {
6741 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6742 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6743 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6744 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6745 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6746 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6747 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6748 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6749 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6750 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6751 <span class=
"hljs-attr">"avatar
"</span>: {
6752 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6753 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6754 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6757 <span class=
"hljs-attr">"video
"</span>: {
6758 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6759 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6760 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6761 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>
6763 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6771 <div id=
"definition-VideoBlacklist" class=
"definition panel" data-traverse-target=
"definition-VideoBlacklist">
6772 <h2 class=
"panel-title">
6773 <a name=
"/definitions/VideoBlacklist"></a>VideoBlacklist:
6774 <!-- <span class="json-property-type">
6775 <span class="json-property-type">object</span>
6776 <span class="json-property-range" title="Value limits"></span>
6781 <div class=
"doc-row">
6782 <div class=
"doc-copy">
6783 <section class=
"json-schema-properties">
6785 <dt data-property-name=
"id">
6786 <span class=
"json-property-name">id:
</span>
6787 <span class=
"json-property-type">number
</span>
6788 <span class=
"json-property-range" title=
"Value limits"></span>
6790 <dt data-property-name=
"videoId">
6791 <span class=
"json-property-name">videoId:
</span>
6792 <span class=
"json-property-type">number
</span>
6793 <span class=
"json-property-range" title=
"Value limits"></span>
6795 <dt data-property-name=
"createdAt">
6796 <span class=
"json-property-name">createdAt:
</span>
6797 <span class=
"json-property-type">string
</span>
6798 <span class=
"json-property-range" title=
"Value limits"></span>
6800 <dt data-property-name=
"updatedAt">
6801 <span class=
"json-property-name">updatedAt:
</span>
6802 <span class=
"json-property-type">string
</span>
6803 <span class=
"json-property-range" title=
"Value limits"></span>
6805 <dt data-property-name=
"name">
6806 <span class=
"json-property-name">name:
</span>
6807 <span class=
"json-property-type">string
</span>
6808 <span class=
"json-property-range" title=
"Value limits"></span>
6810 <dt data-property-name=
"uuid">
6811 <span class=
"json-property-name">uuid:
</span>
6812 <span class=
"json-property-type">string
</span>
6813 <span class=
"json-property-range" title=
"Value limits"></span>
6815 <dt data-property-name=
"description">
6816 <span class=
"json-property-name">description:
</span>
6817 <span class=
"json-property-type">string
</span>
6818 <span class=
"json-property-range" title=
"Value limits"></span>
6820 <dt data-property-name=
"duration">
6821 <span class=
"json-property-name">duration:
</span>
6822 <span class=
"json-property-type">number
</span>
6823 <span class=
"json-property-range" title=
"Value limits"></span>
6825 <dt data-property-name=
"views">
6826 <span class=
"json-property-name">views:
</span>
6827 <span class=
"json-property-type">number
</span>
6828 <span class=
"json-property-range" title=
"Value limits"></span>
6830 <dt data-property-name=
"likes">
6831 <span class=
"json-property-name">likes:
</span>
6832 <span class=
"json-property-type">number
</span>
6833 <span class=
"json-property-range" title=
"Value limits"></span>
6835 <dt data-property-name=
"dislikes">
6836 <span class=
"json-property-name">dislikes:
</span>
6837 <span class=
"json-property-type">number
</span>
6838 <span class=
"json-property-range" title=
"Value limits"></span>
6840 <dt data-property-name=
"nsfw">
6841 <span class=
"json-property-name">nsfw:
</span>
6842 <span class=
"json-property-type">boolean
</span>
6843 <span class=
"json-property-range" title=
"Value limits"></span>
6848 <div class=
"doc-examples">
6851 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6852 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6853 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6854 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6855 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6856 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6857 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6858 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6859 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6860 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6861 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6862 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6863 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
6871 <div id=
"definition-VideoChannel" class=
"definition panel" data-traverse-target=
"definition-VideoChannel">
6872 <h2 class=
"panel-title">
6873 <a name=
"/definitions/VideoChannel"></a>VideoChannel:
6874 <!-- <span class="json-property-type">
6875 <span class="json-property-type">object</span>
6876 <span class="json-property-range" title="Value limits"></span>
6881 <div class=
"doc-row">
6882 <div class=
"doc-copy">
6883 <section class=
"json-schema-properties">
6885 <dt data-property-name=
"displayName">
6886 <span class=
"json-property-name">displayName:
</span>
6887 <span class=
"json-property-type">string
</span>
6888 <span class=
"json-property-range" title=
"Value limits"></span>
6890 <dt data-property-name=
"description">
6891 <span class=
"json-property-name">description:
</span>
6892 <span class=
"json-property-type">string
</span>
6893 <span class=
"json-property-range" title=
"Value limits"></span>
6895 <dt data-property-name=
"isLocal">
6896 <span class=
"json-property-name">isLocal:
</span>
6897 <span class=
"json-property-type">boolean
</span>
6898 <span class=
"json-property-range" title=
"Value limits"></span>
6900 <dt data-property-name=
"ownerAccount">
6901 <span class=
"json-property-name">ownerAccount:
</span>
6902 <span class=
"json-property-type">object
</span>
6903 <span class=
"json-property-range" title=
"Value limits"></span>
6905 <dt class=
"json-inner-schema">
6906 <section class=
"json-schema-properties">
6908 <dt data-property-name=
"id">
6909 <span class=
"json-property-name">id:
</span>
6910 <span class=
"json-property-type">number
</span>
6911 <span class=
"json-property-range" title=
"Value limits"></span>
6913 <dt data-property-name=
"uuid">
6914 <span class=
"json-property-name">uuid:
</span>
6915 <span class=
"json-property-type">string
</span>
6916 <span class=
"json-property-range" title=
"Value limits"></span>
6924 <div class=
"doc-examples">
6927 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6928 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6929 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6930 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6931 <span class=
"hljs-attr">"ownerAccount
"</span>: {
6932 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6933 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
6942 <div id=
"definition-VideoComment" class=
"definition panel" data-traverse-target=
"definition-VideoComment">
6943 <h2 class=
"panel-title">
6944 <a name=
"/definitions/VideoComment"></a>VideoComment:
6945 <!-- <span class="json-property-type">
6946 <span class="json-property-type">object</span>
6947 <span class="json-property-range" title="Value limits"></span>
6952 <div class=
"doc-row">
6953 <div class=
"doc-copy">
6954 <section class=
"json-schema-properties">
6956 <dt data-property-name=
"id">
6957 <span class=
"json-property-name">id:
</span>
6958 <span class=
"json-property-type">number
</span>
6959 <span class=
"json-property-range" title=
"Value limits"></span>
6961 <dt data-property-name=
"url">
6962 <span class=
"json-property-name">url:
</span>
6963 <span class=
"json-property-type">string
</span>
6964 <span class=
"json-property-range" title=
"Value limits"></span>
6966 <dt data-property-name=
"text">
6967 <span class=
"json-property-name">text:
</span>
6968 <span class=
"json-property-type">string
</span>
6969 <span class=
"json-property-range" title=
"Value limits"></span>
6971 <dt data-property-name=
"threadId">
6972 <span class=
"json-property-name">threadId:
</span>
6973 <span class=
"json-property-type">number
</span>
6974 <span class=
"json-property-range" title=
"Value limits"></span>
6976 <dt data-property-name=
"inReplyToCommentId">
6977 <span class=
"json-property-name">inReplyToCommentId:
</span>
6978 <span class=
"json-property-type">number
</span>
6979 <span class=
"json-property-range" title=
"Value limits"></span>
6981 <dt data-property-name=
"videoId">
6982 <span class=
"json-property-name">videoId:
</span>
6983 <span class=
"json-property-type">number
</span>
6984 <span class=
"json-property-range" title=
"Value limits"></span>
6986 <dt data-property-name=
"createdAt">
6987 <span class=
"json-property-name">createdAt:
</span>
6988 <span class=
"json-property-type">string
</span>
6989 <span class=
"json-property-range" title=
"Value limits"></span>
6991 <dt data-property-name=
"updatedAt">
6992 <span class=
"json-property-name">updatedAt:
</span>
6993 <span class=
"json-property-type">string
</span>
6994 <span class=
"json-property-range" title=
"Value limits"></span>
6996 <dt data-property-name=
"totalReplies">
6997 <span class=
"json-property-name">totalReplies:
</span>
6998 <span class=
"json-property-type">number
</span>
6999 <span class=
"json-property-range" title=
"Value limits"></span>
7001 <dt data-property-name=
"account">
7002 <span class=
"json-property-name">account:
</span>
7003 <span class=
"json-property-type">
7005 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
7008 <span class=
"json-property-range" title=
"Value limits"></span>
7013 <div class=
"doc-examples">
7016 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7017 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7018 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7019 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7020 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7021 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7022 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7023 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7024 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7025 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7026 <span class=
"hljs-attr">"account
"</span>: {
7027 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7028 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7029 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7030 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7031 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7032 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7033 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7034 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7035 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7036 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7037 <span class=
"hljs-attr">"avatar
"</span>: {
7038 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7039 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7040 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7050 <div id=
"definition-VideoCommentThreadTree" class=
"definition panel" data-traverse-target=
"definition-VideoCommentThreadTree">
7051 <h2 class=
"panel-title">
7052 <a name=
"/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree:
7053 <!-- <span class="json-property-type">
7054 <span class="json-property-type">object</span>
7055 <span class="json-property-range" title="Value limits"></span>
7060 <div class=
"doc-row">
7061 <div class=
"doc-copy">
7062 <section class=
"json-schema-properties">
7064 <dt data-property-name=
"comment">
7065 <span class=
"json-property-name">comment:
</span>
7066 <span class=
"json-property-type">
7068 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
7071 <span class=
"json-property-range" title=
"Value limits"></span>
7073 <dt data-property-name=
"children">
7074 <span class=
"json-property-name">children:
</span>
7075 <span class=
"json-property-type">
7076 <span class=
"json-schema-ref-array">
7077 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
7080 <span class=
"json-property-range" title=
"Value limits"></span>
7082 <dt class=
"json-inner-schema">
7083 <section class=
"json-schema-array-items">
7084 <span class=
"json-property-type">
7086 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
7089 <span class=
"json-property-range" title=
"Value limits"></span>
7090 <div class=
"json-inner-schema"> </div>
7096 <div class=
"doc-examples">
7099 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7100 <span class=
"hljs-attr">"comment
"</span>: {
7101 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7102 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7103 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7104 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7105 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7106 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7107 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7108 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7109 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7110 <span class=
"hljs-attr">"account
"</span>: {
7111 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7112 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7113 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7114 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7115 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7116 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7117 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7118 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7119 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7120 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7121 <span class=
"hljs-attr">"avatar
"</span>: {
7122 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7123 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7124 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7128 <span class=
"hljs-attr">"children
"</span>: [
7130 <span class=
"hljs-attr">"comment
"</span>: {
7131 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7132 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7133 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7134 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7135 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7136 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7137 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7138 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7139 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7140 <span class=
"hljs-attr">"account
"</span>: {
7141 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7142 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7143 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7144 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7145 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7146 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7147 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7148 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7149 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7150 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7151 <span class=
"hljs-attr">"avatar
"</span>: {
7152 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7153 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7154 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7158 <span class=
"hljs-attr">"children
"</span>: [
7160 <span class=
"hljs-attr">"comment
"</span>: {
7161 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7162 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7163 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7164 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7165 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7166 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7167 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7168 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7169 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7170 <span class=
"hljs-attr">"account
"</span>: {
7171 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7172 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7173 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7174 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7175 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7176 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7177 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7178 <span class=
"hljs-attr">"followersCount
"</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">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7181 <span class=
"hljs-attr">"avatar
"</span>: {
7182 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7183 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7184 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7199 <div id=
"definition-Avatar" class=
"definition panel" data-traverse-target=
"definition-Avatar">
7200 <h2 class=
"panel-title">
7201 <a name=
"/definitions/Avatar"></a>Avatar:
7202 <!-- <span class="json-property-type">
7203 <span class="json-property-type">object</span>
7204 <span class="json-property-range" title="Value limits"></span>
7209 <div class=
"doc-row">
7210 <div class=
"doc-copy">
7211 <section class=
"json-schema-properties">
7213 <dt data-property-name=
"path">
7214 <span class=
"json-property-name">path:
</span>
7215 <span class=
"json-property-type">string
</span>
7216 <span class=
"json-property-range" title=
"Value limits"></span>
7218 <dt data-property-name=
"createdAt">
7219 <span class=
"json-property-name">createdAt:
</span>
7220 <span class=
"json-property-type">string
</span>
7221 <span class=
"json-property-range" title=
"Value limits"></span>
7223 <dt data-property-name=
"updatedAt">
7224 <span class=
"json-property-name">updatedAt:
</span>
7225 <span class=
"json-property-type">string
</span>
7226 <span class=
"json-property-range" title=
"Value limits"></span>
7231 <div class=
"doc-examples">
7234 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7235 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7236 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7237 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7245 <div id=
"definition-Actor" class=
"definition panel" data-traverse-target=
"definition-Actor">
7246 <h2 class=
"panel-title">
7247 <a name=
"/definitions/Actor"></a>Actor:
7248 <!-- <span class="json-property-type">
7249 <span class="json-property-type">object</span>
7250 <span class="json-property-range" title="Value limits"></span>
7255 <div class=
"doc-row">
7256 <div class=
"doc-copy">
7257 <section class=
"json-schema-properties">
7259 <dt data-property-name=
"id">
7260 <span class=
"json-property-name">id:
</span>
7261 <span class=
"json-property-type">number
</span>
7262 <span class=
"json-property-range" title=
"Value limits"></span>
7264 <dt data-property-name=
"uuid">
7265 <span class=
"json-property-name">uuid:
</span>
7266 <span class=
"json-property-type">string
</span>
7267 <span class=
"json-property-range" title=
"Value limits"></span>
7269 <dt data-property-name=
"url">
7270 <span class=
"json-property-name">url:
</span>
7271 <span class=
"json-property-type">string
</span>
7272 <span class=
"json-property-range" title=
"Value limits"></span>
7274 <dt data-property-name=
"name">
7275 <span class=
"json-property-name">name:
</span>
7276 <span class=
"json-property-type">string
</span>
7277 <span class=
"json-property-range" title=
"Value limits"></span>
7279 <dt data-property-name=
"host">
7280 <span class=
"json-property-name">host:
</span>
7281 <span class=
"json-property-type">string
</span>
7282 <span class=
"json-property-range" title=
"Value limits"></span>
7284 <dt data-property-name=
"followingCount">
7285 <span class=
"json-property-name">followingCount:
</span>
7286 <span class=
"json-property-type">number
</span>
7287 <span class=
"json-property-range" title=
"Value limits"></span>
7289 <dt data-property-name=
"followersCount">
7290 <span class=
"json-property-name">followersCount:
</span>
7291 <span class=
"json-property-type">number
</span>
7292 <span class=
"json-property-range" title=
"Value limits"></span>
7294 <dt data-property-name=
"createdAt">
7295 <span class=
"json-property-name">createdAt:
</span>
7296 <span class=
"json-property-type">string
</span>
7297 <span class=
"json-property-range" title=
"Value limits"></span>
7299 <dt data-property-name=
"updatedAt">
7300 <span class=
"json-property-name">updatedAt:
</span>
7301 <span class=
"json-property-type">string
</span>
7302 <span class=
"json-property-range" title=
"Value limits"></span>
7304 <dt data-property-name=
"avatar">
7305 <span class=
"json-property-name">avatar:
</span>
7306 <span class=
"json-property-type">
7308 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
7311 <span class=
"json-property-range" title=
"Value limits"></span>
7316 <div class=
"doc-examples">
7319 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7320 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7321 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7322 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7323 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7324 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7325 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7326 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7327 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7328 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7329 <span class=
"hljs-attr">"avatar
"</span>: {
7330 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7331 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7332 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7341 <div id=
"definition-Account" class=
"definition panel" data-traverse-target=
"definition-Account">
7342 <h2 class=
"panel-title">
7343 <a name=
"/definitions/Account"></a>Account:
7344 <!-- <span class="json-property-type">
7345 <span class="json-property-type"></span>
7346 <span class="json-property-range" title="Value limits"></span>
7351 <div class=
"doc-row">
7352 <div class=
"doc-copy">
7353 <section class=
"json-schema-allOf">
7354 <section class=
"json-schema-allOf-inherited">
7357 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7361 <section class=
"json-schema-allOf-additional">
7362 <section class=
"json-schema-properties">
7364 <dt data-property-name=
"displayName">
7365 <span class=
"json-property-name">displayName:
</span>
7366 <span class=
"json-property-type">string
</span>
7367 <span class=
"json-property-range" title=
"Value limits"></span>
7374 <div class=
"doc-examples">
7377 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7378 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7379 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7380 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7381 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7382 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7383 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7384 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7385 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7386 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7387 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7388 <span class=
"hljs-attr">"avatar
"</span>: {
7389 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7390 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7391 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7400 <div id=
"definition-User" class=
"definition panel" data-traverse-target=
"definition-User">
7401 <h2 class=
"panel-title">
7402 <a name=
"/definitions/User"></a>User:
7403 <!-- <span class="json-property-type">
7404 <span class="json-property-type">object</span>
7405 <span class="json-property-range" title="Value limits"></span>
7410 <div class=
"doc-row">
7411 <div class=
"doc-copy">
7412 <section class=
"json-schema-properties">
7414 <dt data-property-name=
"id">
7415 <span class=
"json-property-name">id:
</span>
7416 <span class=
"json-property-type">number
</span>
7417 <span class=
"json-property-range" title=
"Value limits"></span>
7419 <dt data-property-name=
"username">
7420 <span class=
"json-property-name">username:
</span>
7421 <span class=
"json-property-type">string
</span>
7422 <span class=
"json-property-range" title=
"Value limits"></span>
7424 <dt data-property-name=
"email">
7425 <span class=
"json-property-name">email:
</span>
7426 <span class=
"json-property-type">string
</span>
7427 <span class=
"json-property-range" title=
"Value limits"></span>
7429 <dt data-property-name=
"displayNSFW">
7430 <span class=
"json-property-name">displayNSFW:
</span>
7431 <span class=
"json-property-type">boolean
</span>
7432 <span class=
"json-property-range" title=
"Value limits"></span>
7434 <dt data-property-name=
"autoPlayVideo">
7435 <span class=
"json-property-name">autoPlayVideo:
</span>
7436 <span class=
"json-property-type">boolean
</span>
7437 <span class=
"json-property-range" title=
"Value limits"></span>
7439 <dt data-property-name=
"role">
7440 <span class=
"json-property-name">role:
</span>
7441 <span class=
"json-property-type">string
</span>
7442 <span class=
"json-property-enum" title=
"Possible values">
7443 <span class=
"json-property-enum-item">User
</span>,
7444 <span class=
"json-property-enum-item">Moderator
</span>,
7445 <span class=
"json-property-enum-item">Administrator
</span>
7447 <span class=
"json-property-range" title=
"Value limits"></span>
7449 <dt data-property-name=
"videoQuota">
7450 <span class=
"json-property-name">videoQuota:
</span>
7451 <span class=
"json-property-type">number
</span>
7452 <span class=
"json-property-range" title=
"Value limits"></span>
7454 <dt data-property-name=
"createdAt">
7455 <span class=
"json-property-name">createdAt:
</span>
7456 <span class=
"json-property-type">string
</span>
7457 <span class=
"json-property-range" title=
"Value limits"></span>
7459 <dt data-property-name=
"account">
7460 <span class=
"json-property-name">account:
</span>
7461 <span class=
"json-property-type">
7463 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
7466 <span class=
"json-property-range" title=
"Value limits"></span>
7468 <dt data-property-name=
"videoChannels">
7469 <span class=
"json-property-name">videoChannels:
</span>
7470 <span class=
"json-property-type">
7471 <span class=
"json-schema-ref-array">
7472 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
7475 <span class=
"json-property-range" title=
"Value limits"></span>
7477 <dt class=
"json-inner-schema">
7478 <section class=
"json-schema-array-items">
7479 <span class=
"json-property-type">
7481 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
7484 <span class=
"json-property-range" title=
"Value limits"></span>
7485 <div class=
"json-inner-schema"> </div>
7491 <div class=
"doc-examples">
7494 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7495 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7496 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
7497 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
7498 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7499 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7500 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
7501 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
7502 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7503 <span class=
"hljs-attr">"account
"</span>: {
7504 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7505 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7506 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7507 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7508 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7509 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7510 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7511 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</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>,
7514 <span class=
"hljs-attr">"avatar
"</span>: {
7515 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7516 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7517 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7520 <span class=
"hljs-attr">"videoChannels
"</span>: [
7522 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7523 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
7524 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7525 <span class=
"hljs-attr">"ownerAccount
"</span>: {
7526 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7527 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
7538 <div id=
"definition-ServerConfig" class=
"definition panel" data-traverse-target=
"definition-ServerConfig">
7539 <h2 class=
"panel-title">
7540 <a name=
"/definitions/ServerConfig"></a>ServerConfig:
7541 <!-- <span class="json-property-type">
7542 <span class="json-property-type">object</span>
7543 <span class="json-property-range" title="Value limits"></span>
7548 <div class=
"doc-row">
7549 <div class=
"doc-copy">
7550 <section class=
"json-schema-properties">
7552 <dt data-property-name=
"signup">
7553 <span class=
"json-property-name">signup:
</span>
7554 <span class=
"json-property-type">object
</span>
7555 <span class=
"json-property-range" title=
"Value limits"></span>
7557 <dt class=
"json-inner-schema">
7558 <section class=
"json-schema-properties">
7560 <dt data-property-name=
"allowed">
7561 <span class=
"json-property-name">allowed:
</span>
7562 <span class=
"json-property-type">boolean
</span>
7563 <span class=
"json-property-range" title=
"Value limits"></span>
7568 <dt data-property-name=
"transcoding">
7569 <span class=
"json-property-name">transcoding:
</span>
7570 <span class=
"json-property-type">object
</span>
7571 <span class=
"json-property-range" title=
"Value limits"></span>
7573 <dt class=
"json-inner-schema">
7574 <section class=
"json-schema-properties">
7576 <dt data-property-name=
"enabledResolutions">
7577 <span class=
"json-property-name">enabledResolutions:
</span>
7578 <span class=
"json-property-type">number[]
</span>
7579 <span class=
"json-property-range" title=
"Value limits"></span>
7581 <dt class=
"json-inner-schema">
7582 <section class=
"json-schema-array-items">
7583 <span class=
"json-property-type">number
</span>
7584 <span class=
"json-property-range" title=
"Value limits"></span>
7585 <div class=
"json-inner-schema"> </div>
7591 <dt data-property-name=
"avatar">
7592 <span class=
"json-property-name">avatar:
</span>
7593 <span class=
"json-property-type">object
</span>
7594 <span class=
"json-property-range" title=
"Value limits"></span>
7596 <dt class=
"json-inner-schema">
7597 <section class=
"json-schema-properties">
7599 <dt data-property-name=
"file">
7600 <span class=
"json-property-name">file:
</span>
7601 <span class=
"json-property-type">object
</span>
7602 <span class=
"json-property-range" title=
"Value limits"></span>
7604 <dt class=
"json-inner-schema">
7605 <section class=
"json-schema-properties">
7607 <dt data-property-name=
"size">
7608 <span class=
"json-property-name">size:
</span>
7609 <span class=
"json-property-type">object
</span>
7610 <span class=
"json-property-range" title=
"Value limits"></span>
7612 <dt class=
"json-inner-schema">
7613 <section class=
"json-schema-properties">
7615 <dt data-property-name=
"max">
7616 <span class=
"json-property-name">max:
</span>
7617 <span class=
"json-property-type">number
</span>
7618 <span class=
"json-property-range" title=
"Value limits"></span>
7626 <dt data-property-name=
"extensions">
7627 <span class=
"json-property-name">extensions:
</span>
7628 <span class=
"json-property-type">string[]
</span>
7629 <span class=
"json-property-range" title=
"Value limits"></span>
7631 <dt class=
"json-inner-schema">
7632 <section class=
"json-schema-array-items">
7633 <span class=
"json-property-type">string
</span>
7634 <span class=
"json-property-range" title=
"Value limits"></span>
7635 <div class=
"json-inner-schema"> </div>
7641 <dt data-property-name=
"video">
7642 <span class=
"json-property-name">video:
</span>
7643 <span class=
"json-property-type">object
</span>
7644 <span class=
"json-property-range" title=
"Value limits"></span>
7646 <dt class=
"json-inner-schema">
7647 <section class=
"json-schema-properties">
7649 <dt data-property-name=
"file">
7650 <span class=
"json-property-name">file:
</span>
7651 <span class=
"json-property-type">object
</span>
7652 <span class=
"json-property-range" title=
"Value limits"></span>
7654 <dt class=
"json-inner-schema">
7655 <section class=
"json-schema-properties">
7657 <dt data-property-name=
"extensions">
7658 <span class=
"json-property-name">extensions:
</span>
7659 <span class=
"json-property-type">string[]
</span>
7660 <span class=
"json-property-range" title=
"Value limits"></span>
7662 <dt class=
"json-inner-schema">
7663 <section class=
"json-schema-array-items">
7664 <span class=
"json-property-type">string
</span>
7665 <span class=
"json-property-range" title=
"Value limits"></span>
7666 <div class=
"json-inner-schema"> </div>
7678 <div class=
"doc-examples">
7681 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7682 <span class=
"hljs-attr">"signup
"</span>: {
7683 <span class=
"hljs-attr">"allowed
"</span>:
<span class=
"hljs-string">"boolean
"</span>
7685 <span class=
"hljs-attr">"transcoding
"</span>: {
7686 <span class=
"hljs-attr">"enabledResolutions
"</span>: [
7687 <span class=
"hljs-string">"number
"</span>
7690 <span class=
"hljs-attr">"avatar
"</span>: {
7691 <span class=
"hljs-attr">"file
"</span>: {
7692 <span class=
"hljs-attr">"size
"</span>: {
7693 <span class=
"hljs-attr">"max
"</span>:
<span class=
"hljs-string">"number
"</span>
7696 <span class=
"hljs-attr">"extensions
"</span>: [
7697 <span class=
"hljs-string">"string
"</span>
7700 <span class=
"hljs-attr">"video
"</span>: {
7701 <span class=
"hljs-attr">"file
"</span>: {
7702 <span class=
"hljs-attr">"extensions
"</span>: [
7703 <span class=
"hljs-string">"string
"</span>
7714 <div id=
"definition-Follow" class=
"definition panel" data-traverse-target=
"definition-Follow">
7715 <h2 class=
"panel-title">
7716 <a name=
"/definitions/Follow"></a>Follow:
7717 <!-- <span class="json-property-type">
7718 <span class="json-property-type">object</span>
7719 <span class="json-property-range" title="Value limits"></span>
7724 <div class=
"doc-row">
7725 <div class=
"doc-copy">
7726 <section class=
"json-schema-properties">
7728 <dt data-property-name=
"id">
7729 <span class=
"json-property-name">id:
</span>
7730 <span class=
"json-property-type">number
</span>
7731 <span class=
"json-property-range" title=
"Value limits"></span>
7733 <dt data-property-name=
"follower">
7734 <span class=
"json-property-name">follower:
</span>
7735 <span class=
"json-property-type">
7737 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7740 <span class=
"json-property-range" title=
"Value limits"></span>
7742 <dt data-property-name=
"following">
7743 <span class=
"json-property-name">following:
</span>
7744 <span class=
"json-property-type">
7746 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7749 <span class=
"json-property-range" title=
"Value limits"></span>
7751 <dt data-property-name=
"score">
7752 <span class=
"json-property-name">score:
</span>
7753 <span class=
"json-property-type">number
</span>
7754 <span class=
"json-property-range" title=
"Value limits"></span>
7756 <dt data-property-name=
"state">
7757 <span class=
"json-property-name">state:
</span>
7758 <span class=
"json-property-type">string
</span>
7759 <span class=
"json-property-enum" title=
"Possible values">
7760 <span class=
"json-property-enum-item">pending
</span>,
7761 <span class=
"json-property-enum-item">accepted
</span>
7763 <span class=
"json-property-range" title=
"Value limits"></span>
7765 <dt data-property-name=
"createdAt">
7766 <span class=
"json-property-name">createdAt:
</span>
7767 <span class=
"json-property-type">string
</span>
7768 <span class=
"json-property-range" title=
"Value limits"></span>
7770 <dt data-property-name=
"updatedAt">
7771 <span class=
"json-property-name">updatedAt:
</span>
7772 <span class=
"json-property-type">string
</span>
7773 <span class=
"json-property-range" title=
"Value limits"></span>
7778 <div class=
"doc-examples">
7781 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7782 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7783 <span class=
"hljs-attr">"follower
"</span>: {
7784 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7785 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7786 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7787 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7788 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7789 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7790 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7791 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7792 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7793 <span class=
"hljs-attr">"avatar
"</span>: {
7794 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7795 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7796 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7799 <span class=
"hljs-attr">"following
"</span>: {
7800 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7801 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7802 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7803 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7804 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7805 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7806 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7807 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7808 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7809 <span class=
"hljs-attr">"avatar
"</span>: {
7810 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7811 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7812 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7815 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
7816 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
7817 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7818 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7826 <div id=
"definition-Job" class=
"definition panel" data-traverse-target=
"definition-Job">
7827 <h2 class=
"panel-title">
7828 <a name=
"/definitions/Job"></a>Job:
7829 <!-- <span class="json-property-type">
7830 <span class="json-property-type">object</span>
7831 <span class="json-property-range" title="Value limits"></span>
7836 <div class=
"doc-row">
7837 <div class=
"doc-copy">
7838 <section class=
"json-schema-properties">
7840 <dt data-property-name=
"id">
7841 <span class=
"json-property-name">id:
</span>
7842 <span class=
"json-property-type">number
</span>
7843 <span class=
"json-property-range" title=
"Value limits"></span>
7845 <dt data-property-name=
"state">
7846 <span class=
"json-property-name">state:
</span>
7847 <span class=
"json-property-type">string
</span>
7848 <span class=
"json-property-enum" title=
"Possible values">
7849 <span class=
"json-property-enum-item">pending
</span>,
7850 <span class=
"json-property-enum-item">processing
</span>,
7851 <span class=
"json-property-enum-item">error
</span>,
7852 <span class=
"json-property-enum-item">success
</span>
7854 <span class=
"json-property-range" title=
"Value limits"></span>
7856 <dt data-property-name=
"category">
7857 <span class=
"json-property-name">category:
</span>
7858 <span class=
"json-property-type">string
</span>
7859 <span class=
"json-property-enum" title=
"Possible values">
7860 <span class=
"json-property-enum-item">transcoding
</span>,
7861 <span class=
"json-property-enum-item">activitypub-http
</span>
7863 <span class=
"json-property-range" title=
"Value limits"></span>
7865 <dt data-property-name=
"handlerName">
7866 <span class=
"json-property-name">handlerName:
</span>
7867 <span class=
"json-property-type">string
</span>
7868 <span class=
"json-property-range" title=
"Value limits"></span>
7870 <dt data-property-name=
"handlerInputData">
7871 <span class=
"json-property-name">handlerInputData:
</span>
7872 <span class=
"json-property-type">string
</span>
7873 <span class=
"json-property-range" title=
"Value limits"></span>
7875 <dt data-property-name=
"createdAt">
7876 <span class=
"json-property-name">createdAt:
</span>
7877 <span class=
"json-property-type">string
</span>
7878 <span class=
"json-property-range" title=
"Value limits"></span>
7880 <dt data-property-name=
"updatedAt">
7881 <span class=
"json-property-name">updatedAt:
</span>
7882 <span class=
"json-property-type">string
</span>
7883 <span class=
"json-property-range" title=
"Value limits"></span>
7888 <div class=
"doc-examples">
7891 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7892 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7893 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
7894 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"string
"</span>,
7895 <span class=
"hljs-attr">"handlerName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7896 <span class=
"hljs-attr">"handlerInputData
"</span>:
<span class=
"hljs-string">"string
"</span>,
7897 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7898 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7906 <div id=
"definition-AddUserResponse" class=
"definition panel" data-traverse-target=
"definition-AddUserResponse">
7907 <h2 class=
"panel-title">
7908 <a name=
"/definitions/AddUserResponse"></a>AddUserResponse:
7909 <!-- <span class="json-property-type">
7910 <span class="json-property-type">object</span>
7911 <span class="json-property-range" title="Value limits"></span>
7916 <div class=
"doc-row">
7917 <div class=
"doc-copy">
7918 <section class=
"json-schema-properties">
7920 <dt data-property-name=
"id">
7921 <span class=
"json-property-name">id:
</span>
7922 <span class=
"json-property-type">number
</span>
7923 <span class=
"json-property-range" title=
"Value limits"></span>
7925 <dt data-property-name=
"uuid">
7926 <span class=
"json-property-name">uuid:
</span>
7927 <span class=
"json-property-type">string
</span>
7928 <span class=
"json-property-range" title=
"Value limits"></span>
7933 <div class=
"doc-examples">
7936 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7937 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7938 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
7946 <div id=
"definition-VideoUploadResponse" class=
"definition panel" data-traverse-target=
"definition-VideoUploadResponse">
7947 <h2 class=
"panel-title">
7948 <a name=
"/definitions/VideoUploadResponse"></a>VideoUploadResponse:
7949 <!-- <span class="json-property-type">
7950 <span class="json-property-type">object</span>
7951 <span class="json-property-range" title="Value limits"></span>
7956 <div class=
"doc-row">
7957 <div class=
"doc-copy">
7958 <section class=
"json-schema-properties">
7960 <dt data-property-name=
"video">
7961 <span class=
"json-property-name">video:
</span>
7962 <span class=
"json-property-type">object
</span>
7963 <span class=
"json-property-range" title=
"Value limits"></span>
7965 <dt class=
"json-inner-schema">
7966 <section class=
"json-schema-properties">
7968 <dt data-property-name=
"id">
7969 <span class=
"json-property-name">id:
</span>
7970 <span class=
"json-property-type">number
</span>
7971 <span class=
"json-property-range" title=
"Value limits"></span>
7973 <dt data-property-name=
"uuid">
7974 <span class=
"json-property-name">uuid:
</span>
7975 <span class=
"json-property-type">string
</span>
7976 <span class=
"json-property-range" title=
"Value limits"></span>
7984 <div class=
"doc-examples">
7987 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7988 <span class=
"hljs-attr">"video
"</span>: {
7989 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7990 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
7999 <div id=
"definition-CommentThreadResponse" class=
"definition panel" data-traverse-target=
"definition-CommentThreadResponse">
8000 <h2 class=
"panel-title">
8001 <a name=
"/definitions/CommentThreadResponse"></a>CommentThreadResponse:
8002 <!-- <span class="json-property-type">
8003 <span class="json-property-type">object</span>
8004 <span class="json-property-range" title="Value limits"></span>
8009 <div class=
"doc-row">
8010 <div class=
"doc-copy">
8011 <section class=
"json-schema-properties">
8013 <dt data-property-name=
"total">
8014 <span class=
"json-property-name">total:
</span>
8015 <span class=
"json-property-type">number
</span>
8016 <span class=
"json-property-range" title=
"Value limits"></span>
8018 <dt data-property-name=
"data">
8019 <span class=
"json-property-name">data:
</span>
8020 <span class=
"json-property-type">
8021 <span class=
"json-schema-ref-array">
8022 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
8025 <span class=
"json-property-range" title=
"Value limits"></span>
8027 <dt class=
"json-inner-schema">
8028 <section class=
"json-schema-array-items">
8029 <span class=
"json-property-type">
8031 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
8034 <span class=
"json-property-range" title=
"Value limits"></span>
8035 <div class=
"json-inner-schema"> </div>
8041 <div class=
"doc-examples">
8044 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8045 <span class=
"hljs-attr">"total
"</span>:
<span class=
"hljs-string">"number
"</span>,
8046 <span class=
"hljs-attr">"data
"</span>: [
8048 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
8049 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
8050 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
8051 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
8052 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
8053 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
8054 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8055 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8056 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
8057 <span class=
"hljs-attr">"account
"</span>: {
8058 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
8059 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
8060 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
8061 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
8062 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
8063 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
8064 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
8065 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
8066 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8067 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8068 <span class=
"hljs-attr">"avatar
"</span>: {
8069 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
8070 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8071 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
8083 <div id=
"definition-CommentThreadPostResponse" class=
"definition panel" data-traverse-target=
"definition-CommentThreadPostResponse">
8084 <h2 class=
"panel-title">
8085 <a name=
"/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse:
8086 <!-- <span class="json-property-type">
8087 <span class="json-property-type">object</span>
8088 <span class="json-property-range" title="Value limits"></span>
8093 <div class=
"doc-row">
8094 <div class=
"doc-copy">
8095 <section class=
"json-schema-properties">
8097 <dt data-property-name=
"comment">
8098 <span class=
"json-property-name">comment:
</span>
8099 <span class=
"json-property-type">
8101 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
8104 <span class=
"json-property-range" title=
"Value limits"></span>
8109 <div class=
"doc-examples">
8112 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8113 <span class=
"hljs-attr">"comment
"</span>: {
8114 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
8115 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
8116 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
8117 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
8118 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
8119 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
8120 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8121 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8122 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
8123 <span class=
"hljs-attr">"account
"</span>: {
8124 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
8125 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
8126 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
8127 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
8128 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
8129 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
8130 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
8131 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
8132 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8133 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8134 <span class=
"hljs-attr">"avatar
"</span>: {
8135 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
8136 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8137 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
8148 <div id=
"definition-AddUser" class=
"definition panel" data-traverse-target=
"definition-AddUser">
8149 <h2 class=
"panel-title">
8150 <a name=
"/definitions/AddUser"></a>AddUser:
8151 <!-- <span class="json-property-type">
8152 <span class="json-property-type">object</span>
8153 <span class="json-property-range" title="Value limits"></span>
8158 <div class=
"doc-row">
8159 <div class=
"doc-copy">
8160 <section class=
"json-schema-properties">
8162 <dt data-property-name=
"username" class=
"has-description">
8163 <span class=
"json-property-name">username:
</span>
8164 <span class=
"json-property-type">string
</span>
8165 <span class=
"json-property-range" title=
"Value limits"></span>
8166 <span class=
"json-property-required"></span>
8169 <p>The user username
</p>
8171 <dt data-property-name=
"password" class=
"has-description">
8172 <span class=
"json-property-name">password:
</span>
8173 <span class=
"json-property-type">string
</span>
8174 <span class=
"json-property-range" title=
"Value limits"></span>
8175 <span class=
"json-property-required"></span>
8178 <p>The user password
</p>
8180 <dt data-property-name=
"email" class=
"has-description">
8181 <span class=
"json-property-name">email:
</span>
8182 <span class=
"json-property-type">string
</span>
8183 <span class=
"json-property-range" title=
"Value limits"></span>
8184 <span class=
"json-property-required"></span>
8187 <p>The user email
</p>
8189 <dt data-property-name=
"videoQuota" class=
"has-description">
8190 <span class=
"json-property-name">videoQuota:
</span>
8191 <span class=
"json-property-type">string
</span>
8192 <span class=
"json-property-range" title=
"Value limits"></span>
8193 <span class=
"json-property-required"></span>
8196 <p>The user videoQuota
</p>
8198 <dt data-property-name=
"role" class=
"has-description">
8199 <span class=
"json-property-name">role:
</span>
8200 <span class=
"json-property-type">string
</span>
8201 <span class=
"json-property-range" title=
"Value limits"></span>
8202 <span class=
"json-property-required"></span>
8205 <p>The user role
</p>
8210 <div class=
"doc-examples">
8213 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8214 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
8215 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
8216 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
8217 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
8218 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
8226 <div id=
"definition-UpdateUser" class=
"definition panel" data-traverse-target=
"definition-UpdateUser">
8227 <h2 class=
"panel-title">
8228 <a name=
"/definitions/UpdateUser"></a>UpdateUser:
8229 <!-- <span class="json-property-type">
8230 <span class="json-property-type">object</span>
8231 <span class="json-property-range" title="Value limits"></span>
8236 <div class=
"doc-row">
8237 <div class=
"doc-copy">
8238 <section class=
"json-schema-properties">
8240 <dt data-property-name=
"id" class=
"has-description">
8241 <span class=
"json-property-name">id:
</span>
8242 <span class=
"json-property-type">string
</span>
8243 <span class=
"json-property-range" title=
"Value limits"></span>
8244 <span class=
"json-property-required"></span>
8249 <dt data-property-name=
"email" class=
"has-description">
8250 <span class=
"json-property-name">email:
</span>
8251 <span class=
"json-property-type">string
</span>
8252 <span class=
"json-property-range" title=
"Value limits"></span>
8253 <span class=
"json-property-required"></span>
8256 <p>The updated email of the user
</p>
8258 <dt data-property-name=
"videoQuota" class=
"has-description">
8259 <span class=
"json-property-name">videoQuota:
</span>
8260 <span class=
"json-property-type">string
</span>
8261 <span class=
"json-property-range" title=
"Value limits"></span>
8262 <span class=
"json-property-required"></span>
8265 <p>The updated videoQuota of the user
</p>
8267 <dt data-property-name=
"role" class=
"has-description">
8268 <span class=
"json-property-name">role:
</span>
8269 <span class=
"json-property-type">string
</span>
8270 <span class=
"json-property-range" title=
"Value limits"></span>
8271 <span class=
"json-property-required"></span>
8274 <p>The updated role of the user
</p>
8279 <div class=
"doc-examples">
8282 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8283 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
8284 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
8285 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
8286 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
8294 <div id=
"definition-UpdateMe" class=
"definition panel" data-traverse-target=
"definition-UpdateMe">
8295 <h2 class=
"panel-title">
8296 <a name=
"/definitions/UpdateMe"></a>UpdateMe:
8297 <!-- <span class="json-property-type">
8298 <span class="json-property-type">object</span>
8299 <span class="json-property-range" title="Value limits"></span>
8304 <div class=
"doc-row">
8305 <div class=
"doc-copy">
8306 <section class=
"json-schema-properties">
8308 <dt data-property-name=
"password" class=
"has-description">
8309 <span class=
"json-property-name">password:
</span>
8310 <span class=
"json-property-type">string
</span>
8311 <span class=
"json-property-range" title=
"Value limits"></span>
8312 <span class=
"json-property-required"></span>
8315 <p>Your new password
</p>
8317 <dt data-property-name=
"email" class=
"has-description">
8318 <span class=
"json-property-name">email:
</span>
8319 <span class=
"json-property-type">string
</span>
8320 <span class=
"json-property-range" title=
"Value limits"></span>
8321 <span class=
"json-property-required"></span>
8324 <p>Your new email
</p>
8326 <dt data-property-name=
"displayNSFW" class=
"has-description">
8327 <span class=
"json-property-name">displayNSFW:
</span>
8328 <span class=
"json-property-type">string
</span>
8329 <span class=
"json-property-range" title=
"Value limits"></span>
8330 <span class=
"json-property-required"></span>
8333 <p>Your new displayNSFW
</p>
8335 <dt data-property-name=
"autoPlayVideo" class=
"has-description">
8336 <span class=
"json-property-name">autoPlayVideo:
</span>
8337 <span class=
"json-property-type">string
</span>
8338 <span class=
"json-property-range" title=
"Value limits"></span>
8339 <span class=
"json-property-required"></span>
8342 <p>Your new autoPlayVideo
</p>
8347 <div class=
"doc-examples">
8350 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8351 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
8352 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
8353 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"string
"</span>,
8354 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"string
"</span>
8362 <div id=
"definition-GetMeVideoRating" class=
"definition panel" data-traverse-target=
"definition-GetMeVideoRating">
8363 <h2 class=
"panel-title">
8364 <a name=
"/definitions/GetMeVideoRating"></a>GetMeVideoRating:
8365 <!-- <span class="json-property-type">
8366 <span class="json-property-type">object</span>
8367 <span class="json-property-range" title="Value limits"></span>
8372 <div class=
"doc-row">
8373 <div class=
"doc-copy">
8374 <section class=
"json-schema-properties">
8376 <dt data-property-name=
"id" class=
"has-description">
8377 <span class=
"json-property-name">id:
</span>
8378 <span class=
"json-property-type">string
</span>
8379 <span class=
"json-property-range" title=
"Value limits"></span>
8380 <span class=
"json-property-required"></span>
8383 <p>Id of the video
</p>
8385 <dt data-property-name=
"rating" class=
"has-description">
8386 <span class=
"json-property-name">rating:
</span>
8387 <span class=
"json-property-type">number
</span>
8388 <span class=
"json-property-range" title=
"Value limits"></span>
8389 <span class=
"json-property-required"></span>
8392 <p>Rating of the video
</p>
8397 <div class=
"doc-examples">
8400 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8401 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
8402 <span class=
"hljs-attr">"rating
"</span>:
<span class=
"hljs-string">"number
"</span>
8410 <div id=
"definition-RegisterUser" class=
"definition panel" data-traverse-target=
"definition-RegisterUser">
8411 <h2 class=
"panel-title">
8412 <a name=
"/definitions/RegisterUser"></a>RegisterUser:
8413 <!-- <span class="json-property-type">
8414 <span class="json-property-type">object</span>
8415 <span class="json-property-range" title="Value limits"></span>
8420 <div class=
"doc-row">
8421 <div class=
"doc-copy">
8422 <section class=
"json-schema-properties">
8424 <dt data-property-name=
"username" class=
"has-description">
8425 <span class=
"json-property-name">username:
</span>
8426 <span class=
"json-property-type">string
</span>
8427 <span class=
"json-property-range" title=
"Value limits"></span>
8428 <span class=
"json-property-required"></span>
8431 <p>The username of the user
</p>
8433 <dt data-property-name=
"password" class=
"has-description">
8434 <span class=
"json-property-name">password:
</span>
8435 <span class=
"json-property-type">string
</span>
8436 <span class=
"json-property-range" title=
"Value limits"></span>
8437 <span class=
"json-property-required"></span>
8440 <p>The password of the user
</p>
8442 <dt data-property-name=
"email" class=
"has-description">
8443 <span class=
"json-property-name">email:
</span>
8444 <span class=
"json-property-type">string
</span>
8445 <span class=
"json-property-range" title=
"Value limits"></span>
8446 <span class=
"json-property-required"></span>
8449 <p>The email of the user
</p>
8454 <div class=
"doc-examples">
8457 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8458 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
8459 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
8460 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>
8468 <div id=
"definition-VideoChannelInput" class=
"definition panel" data-traverse-target=
"definition-VideoChannelInput">
8469 <h2 class=
"panel-title">
8470 <a name=
"/definitions/VideoChannelInput"></a>VideoChannelInput:
8471 <!-- <span class="json-property-type">
8472 <span class="json-property-type">object</span>
8473 <span class="json-property-range" title="Value limits"></span>
8478 <div class=
"doc-row">
8479 <div class=
"doc-copy">
8480 <section class=
"json-schema-properties">
8482 <dt data-property-name=
"name">
8483 <span class=
"json-property-name">name:
</span>
8484 <span class=
"json-property-type">string
</span>
8485 <span class=
"json-property-range" title=
"Value limits"></span>
8487 <dt data-property-name=
"description">
8488 <span class=
"json-property-name">description:
</span>
8489 <span class=
"json-property-type">string
</span>
8490 <span class=
"json-property-range" title=
"Value limits"></span>
8495 <div class=
"doc-examples">
8498 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8499 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
8500 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
8508 <div class=
"doc-row no-margin">
8509 <div class=
"doc-copy doc-separator">
8510 <a class=
"powered-by" href=
"https://sourcey.com/spectacle">Documentation by
8511 <span>Spectacle
</span>