2 <html class=
"no-js" lang=
"en">
4 <meta charset=
"utf-8" />
5 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0" />
6 <title>PeerTube | API Reference
</title>
7 <link rel=
"stylesheet" href=
"stylesheets/foundation.min.css" />
8 <link rel=
"stylesheet" href=
"stylesheets/spectacle.min.css" />
9 <script src=
"https://code.jquery.com/jquery-2.1.4.min.js"></script>
10 <!-- <script src="javascripts/foundation.js"></script> -->
11 <script src=
"javascripts/spectacle.min.js"></script>
14 <div id=
"page" class=
"drawer-layout drawer-slide-right-large">
16 <button class=
"close-button" aria-label=
"Close menu" type=
"button" data-drawer-close
>
17 <span aria-hidden=
"true">×
</span>
19 <nav id=
"nav" role=
"navigation">
21 <a href=
"#introduction">Introduction
</a>
22 <a href=
"#authentication">Authentication
</a>
25 <a href=
"#tag-Accounts">Accounts
</a>
28 <a href=
"#operation--accounts--name--get"> GET /accounts/{name}
</a>
31 <a href=
"#operation--accounts--name--videos-get"> GET /accounts/{name}/videos
</a>
34 <a href=
"#operation--accounts-get"> GET /accounts
</a>
39 <a href=
"#tag-Config">Config
</a>
42 <a href=
"#operation--config-get"> GET /config
</a>
47 <a href=
"#tag-Feeds">Feeds
</a>
50 <a href=
"#operation--feeds-videos.-format--get"> GET /feeds/videos.{format}
</a>
55 <a href=
"#tag-Job">Job
</a>
58 <a href=
"#operation--jobs-get"> GET /jobs
</a>
63 <a href=
"#tag-ServerFollowing">ServerFollowing
</a>
66 <a href=
"#operation--server-following--host--delete"> DELETE /server/following/{host}
</a>
69 <a href=
"#operation--server-followers-get"> GET /server/followers
</a>
72 <a href=
"#operation--server-following-get"> GET /server/following
</a>
75 <a href=
"#operation--server-following-post"> POST /server/following
</a>
80 <a href=
"#tag-User">User
</a>
83 <a href=
"#operation--users-post"> POST /users
</a>
86 <a href=
"#operation--users-get"> GET /users
</a>
89 <a href=
"#operation--users--id--delete"> DELETE /users/{id}
</a>
92 <a href=
"#operation--users--id--get"> GET /users/{id}
</a>
95 <a href=
"#operation--users--id--put"> PUT /users/{id}
</a>
98 <a href=
"#operation--users-me-get"> GET /users/me
</a>
101 <a href=
"#operation--users-me-put"> PUT /users/me
</a>
104 <a href=
"#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used
</a>
107 <a href=
"#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating
</a>
110 <a href=
"#operation--users-me-videos-get"> GET /users/me/videos
</a>
113 <a href=
"#operation--users-register-post"> POST /users/register
</a>
116 <a href=
"#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick
</a>
121 <a href=
"#tag-Video">Video
</a>
124 <a href=
"#operation--videos-get"> GET /videos
</a>
127 <a href=
"#operation--videos-categories-get"> GET /videos/categories
</a>
130 <a href=
"#operation--videos-licences-get"> GET /videos/licences
</a>
133 <a href=
"#operation--videos-languages-get"> GET /videos/languages
</a>
136 <a href=
"#operation--videos-privacies-get"> GET /videos/privacies
</a>
139 <a href=
"#operation--videos-search-get"> GET /videos/search
</a>
142 <a href=
"#operation--videos--id--put"> PUT /videos/{id}
</a>
145 <a href=
"#operation--videos--id--get"> GET /videos/{id}
</a>
148 <a href=
"#operation--videos--id--delete"> DELETE /videos/{id}
</a>
151 <a href=
"#operation--videos--id--description-get"> GET /videos/{id}/description
</a>
154 <a href=
"#operation--videos--id--views-post"> POST /videos/{id}/views
</a>
157 <a href=
"#operation--videos-upload-post"> POST /videos/upload
</a>
162 <a href=
"#tag-VideoAbuse">VideoAbuse
</a>
165 <a href=
"#operation--videos-abuse-get"> GET /videos/abuse
</a>
168 <a href=
"#operation--videos--id--abuse-post"> POST /videos/{id}/abuse
</a>
173 <a href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
176 <a href=
"#operation--videos--videoId--blacklist-post"> POST /videos/{videoId}/blacklist
</a>
179 <a href=
"#operation--videos--videoId--blacklist-delete"> DELETE /videos/{videoId}/blacklist
</a>
182 <a href=
"#operation--videos-blacklist-get"> GET /videos/blacklist
</a>
187 <a href=
"#tag-VideoChannel">VideoChannel
</a>
190 <a href=
"#operation--video-channels-get"> GET /video-channels
</a>
193 <a href=
"#operation--video-channels-post"> POST /video-channels
</a>
196 <a href=
"#operation--video-channels--id--get"> GET /video-channels/{id}
</a>
199 <a href=
"#operation--video-channels--id--put"> PUT /video-channels/{id}
</a>
202 <a href=
"#operation--video-channels--id--delete"> DELETE /video-channels/{id}
</a>
205 <a href=
"#operation--video-channels--id--videos-get"> GET /video-channels/{id}/videos
</a>
208 <a href=
"#operation--accounts--name--video-channels-get"> GET /accounts/{name}/video-channels
</a>
213 <a href=
"#tag-VideoComment">VideoComment
</a>
216 <a href=
"#operation--videos--videoId--comment-threads-get"> GET /videos/{videoId}/comment-threads
</a>
219 <a href=
"#operation--videos--videoId--comment-threads-post"> POST /videos/{videoId}/comment-threads
</a>
222 <a href=
"#operation--videos--videoId--comment-threads--threadId--get"> GET /videos/{videoId}/comment-threads/{threadId}
</a>
225 <a href=
"#operation--videos--videoId--comments--commentId--post"> POST /videos/{videoId}/comments/{commentId}
</a>
228 <a href=
"#operation--videos--videoId--comments--commentId--delete"> DELETE /videos/{videoId}/comments/{commentId}
</a>
233 <a href=
"#tag-VideoRate">VideoRate
</a>
236 <a href=
"#operation--videos--id--rate-put"> PUT /videos/{id}/rate
</a>
240 <h5>Schema Definitions
</h5>
241 <a href=
"#definition-VideoConstantNumber"> VideoConstantNumber
</a>
242 <a href=
"#definition-VideoConstantString"> VideoConstantString
</a>
243 <a href=
"#definition-VideoPrivacy"> VideoPrivacy
</a>
244 <a href=
"#definition-Video"> Video
</a>
245 <a href=
"#definition-VideoAbuse"> VideoAbuse
</a>
246 <a href=
"#definition-VideoBlacklist"> VideoBlacklist
</a>
247 <a href=
"#definition-VideoChannel"> VideoChannel
</a>
248 <a href=
"#definition-VideoComment"> VideoComment
</a>
249 <a href=
"#definition-VideoCommentThreadTree"> VideoCommentThreadTree
</a>
250 <a href=
"#definition-Avatar"> Avatar
</a>
251 <a href=
"#definition-Actor"> Actor
</a>
252 <a href=
"#definition-Account"> Account
</a>
253 <a href=
"#definition-User"> User
</a>
254 <a href=
"#definition-ServerConfig"> ServerConfig
</a>
255 <a href=
"#definition-Follow"> Follow
</a>
256 <a href=
"#definition-Job"> Job
</a>
257 <a href=
"#definition-AddUserResponse"> AddUserResponse
</a>
258 <a href=
"#definition-VideoUploadResponse"> VideoUploadResponse
</a>
259 <a href=
"#definition-CommentThreadResponse"> CommentThreadResponse
</a>
260 <a href=
"#definition-CommentThreadPostResponse"> CommentThreadPostResponse
</a>
261 <a href=
"#definition-AddUser"> AddUser
</a>
262 <a href=
"#definition-UpdateUser"> UpdateUser
</a>
263 <a href=
"#definition-UpdateMe"> UpdateMe
</a>
264 <a href=
"#definition-GetMeVideoRating"> GetMeVideoRating
</a>
265 <a href=
"#definition-RegisterUser"> RegisterUser
</a>
266 <a href=
"#definition-VideoChannelInput"> VideoChannelInput
</a>
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
</div>
357 <span class=
"json-property-required"></span>
358 <div class=
"prop-subtitle"> in path
</div>
359 <div class=
"prop-subtitle">
360 <span class=
"json-property-type">string
</span>
361 <span class=
"json-property-range" title=
"Value limits"></span>
364 <div class=
"prop-value">
365 <p>The name of the account (chocobozzz or
366 <a href=
"mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re
</a> for example)
</p>
369 <div class=
"prop-row prop-group">
370 <div class=
"prop-name">
371 <div class=
"prop-title">start
</div>
372 <div class=
"prop-subtitle"> in query
</div>
373 <div class=
"prop-subtitle">
374 <span class=
"json-property-type">number
</span>
375 <span class=
"json-property-range" title=
"Value limits"></span>
378 <div class=
"prop-value">
382 <div class=
"prop-row prop-group">
383 <div class=
"prop-name">
384 <div class=
"prop-title">stop
</div>
385 <div class=
"prop-subtitle"> in query
</div>
386 <div class=
"prop-subtitle">
387 <span class=
"json-property-type">number
</span>
388 <span class=
"json-property-range" title=
"Value limits"></span>
391 <div class=
"prop-value">
395 <div class=
"prop-row prop-group">
396 <div class=
"prop-name">
397 <div class=
"prop-title">sort
</div>
398 <div class=
"prop-subtitle"> in query
</div>
399 <div class=
"prop-subtitle">
400 <span class=
"json-property-type">number
</span>
401 <span class=
"json-property-range" title=
"Value limits"></span>
404 <div class=
"prop-value">
410 <div class=
"doc-examples"></div>
412 <div class=
"doc-row">
413 <div class=
"doc-copy">
414 <section class=
"swagger-responses">
415 <div class=
"prop-row prop-group">
416 <div class=
"prop-name">
417 <div class=
"prop-title">200 OK
</div>
418 <div class=
"prop-ref">
420 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
423 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
425 <div class=
"prop-value">
426 <p>successful operation
</p>
431 <div class=
"doc-examples">
432 <h5>Response Content-Types:
433 <span>application/json
</span>
437 <span>(
200 OK)
</span>
439 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
440 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
441 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
442 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
443 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
444 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
445 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
446 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
447 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
448 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
449 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
450 <span class=
"hljs-attr">"avatar
"</span>: {
451 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</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>
462 <div id=
"operation--accounts--name--videos-get" class=
"operation panel" data-traverse-target=
"operation--accounts--name--videos-get">
463 <!-- <section class="operation-tags row"> -->
464 <!-- <div class="doc-copy"> -->
465 <div class=
"operation-tags">
466 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
471 <h2 class=
"operation-title">
472 <span class=
"operation-name">
473 <span class=
"operation-name">GET
</span>
474 <span class=
"operation-path">/accounts/{name}/videos
</span>
477 <div class=
"doc-row">
478 <div class=
"doc-copy">
479 <section class=
"swagger-request-params">
480 <div class=
"prop-row prop-group">
481 <div class=
"prop-name">
482 <div class=
"prop-title">name
</div>
483 <span class=
"json-property-required"></span>
484 <div class=
"prop-subtitle"> in path
</div>
485 <div class=
"prop-subtitle">
486 <span class=
"json-property-type">string
</span>
487 <span class=
"json-property-range" title=
"Value limits"></span>
490 <div class=
"prop-value">
491 <p>The name of the account (chocobozzz or
492 <a href=
"mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re
</a> for example)
</p>
497 <div class=
"doc-examples"></div>
499 <div class=
"doc-row">
500 <div class=
"doc-copy">
501 <section class=
"swagger-responses">
502 <div class=
"prop-row prop-group">
503 <div class=
"prop-name">
504 <div class=
"prop-title">200 OK
</div>
505 <div class=
"prop-ref">
507 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
510 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
512 <div class=
"prop-value">
513 <p>successful operation
</p>
518 <div class=
"doc-examples">
519 <h5>Response Content-Types:
520 <span>application/json
</span>
524 <span>(
200 OK)
</span>
526 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
527 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
528 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
529 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
530 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
531 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
532 <span class=
"hljs-attr">"category
"</span>: {
533 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
534 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
536 <span class=
"hljs-attr">"licence
"</span>: {
537 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
538 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
540 <span class=
"hljs-attr">"language
"</span>: {
541 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
542 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
544 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
545 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
546 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
547 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
548 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
549 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
550 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
551 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
552 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
553 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
554 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
555 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
556 <span class=
"hljs-attr">"account
"</span>: {
557 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
558 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
559 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
560 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
561 <span class=
"hljs-attr">"avatar
"</span>: {
562 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
563 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
564 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
574 <div id=
"operation--accounts-get" class=
"operation panel" data-traverse-target=
"operation--accounts-get">
575 <!-- <section class="operation-tags row"> -->
576 <!-- <div class="doc-copy"> -->
577 <div class=
"operation-tags">
578 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
583 <h2 class=
"operation-title">
584 <span class=
"operation-name">
585 <span class=
"operation-name">GET
</span>
586 <span class=
"operation-path">/accounts
</span>
589 <div class=
"doc-row">
590 <div class=
"doc-copy"> </div>
591 <div class=
"doc-examples"></div>
593 <div class=
"doc-row">
594 <div class=
"doc-copy">
595 <section class=
"swagger-responses">
596 <div class=
"prop-row prop-group">
597 <div class=
"prop-name">
598 <div class=
"prop-title">200 OK
</div>
599 <div class=
"prop-ref">
600 <span class=
"json-schema-ref-array">
601 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
604 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
606 <div class=
"prop-value">
607 <p>successful operation
</p>
610 <div class=
"prop-row prop-inner">
611 <div class=
"prop-name">type
</div>
612 <div class=
"prop-value">
613 <span class=
"json-property-type">
614 <span class=
"json-schema-ref-array">
615 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
618 <span class=
"json-property-range" title=
"Value limits"></span>
623 <div class=
"doc-examples">
624 <h5>Response Content-Types:
625 <span>application/json
</span>
629 <span>(
200 OK)
</span>
631 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
633 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
634 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
635 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
636 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
637 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
638 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
639 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
640 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
641 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
642 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
643 <span class=
"hljs-attr">"avatar
"</span>: {
644 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
645 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
646 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
656 <h1 id=
"tag-Config" class=
"swagger-summary-tag" data-traverse-target=
"tag-Config">Config
</h1>
657 <div id=
"operation--config-get" class=
"operation panel" data-traverse-target=
"operation--config-get">
658 <!-- <section class="operation-tags row"> -->
659 <!-- <div class="doc-copy"> -->
660 <div class=
"operation-tags">
661 <a class=
"label" href=
"#tag-Config">Config
</a>
666 <h2 class=
"operation-title">
667 <span class=
"operation-name">
668 <span class=
"operation-name">GET
</span>
669 <span class=
"operation-path">/config
</span>
672 <div class=
"doc-row">
673 <div class=
"doc-copy"> </div>
674 <div class=
"doc-examples"></div>
676 <div class=
"doc-row">
677 <div class=
"doc-copy">
678 <section class=
"swagger-responses">
679 <div class=
"prop-row prop-group">
680 <div class=
"prop-name">
681 <div class=
"prop-title">200 OK
</div>
682 <div class=
"prop-ref">
684 <a class=
"json-schema-ref" href=
"#/definitions/ServerConfig">ServerConfig
</a>
687 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
689 <div class=
"prop-value">
690 <p>successful operation
</p>
695 <div class=
"doc-examples">
696 <h5>Response Content-Types:
697 <span>application/json
</span>
701 <span>(
200 OK)
</span>
703 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
704 <span class=
"hljs-attr">"signup
"</span>: {
705 <span class=
"hljs-attr">"allowed
"</span>:
<span class=
"hljs-string">"boolean
"</span>
707 <span class=
"hljs-attr">"transcoding
"</span>: {
708 <span class=
"hljs-attr">"enabledResolutions
"</span>: [
709 <span class=
"hljs-string">"number
"</span>
712 <span class=
"hljs-attr">"avatar
"</span>: {
713 <span class=
"hljs-attr">"file
"</span>: {
714 <span class=
"hljs-attr">"size
"</span>: {
715 <span class=
"hljs-attr">"max
"</span>:
<span class=
"hljs-string">"number
"</span>
718 <span class=
"hljs-attr">"extensions
"</span>: [
719 <span class=
"hljs-string">"string
"</span>
722 <span class=
"hljs-attr">"video
"</span>: {
723 <span class=
"hljs-attr">"file
"</span>: {
724 <span class=
"hljs-attr">"extensions
"</span>: [
725 <span class=
"hljs-string">"string
"</span>
736 <h1 id=
"tag-Feeds" class=
"swagger-summary-tag" data-traverse-target=
"tag-Feeds">Feeds
</h1>
737 <div id=
"operation--feeds-videos.-format--get" class=
"operation panel" data-traverse-target=
"operation--feeds-videos.-format--get">
738 <!-- <section class="operation-tags row"> -->
739 <!-- <div class="doc-copy"> -->
740 <div class=
"operation-tags">
741 <a class=
"label" href=
"#tag-Feeds">Feeds
</a>
746 <h2 class=
"operation-title">
747 <span class=
"operation-name">
748 <span class=
"operation-name">GET
</span>
749 <span class=
"operation-path">/feeds/videos.{format}
</span>
752 <div class=
"doc-row">
753 <div class=
"doc-copy">
754 <section class=
"swagger-request-params">
755 <div class=
"prop-row prop-group">
756 <div class=
"prop-name">
757 <div class=
"prop-title">format
</div>
758 <span class=
"json-property-required"></span>
759 <div class=
"prop-subtitle"> in path
</div>
760 <div class=
"prop-subtitle">
761 <span class=
"json-property-type">string
</span>
762 <span class=
"json-property-enum" title=
"Possible values">
763 <span class=
"json-property-enum-item json-property-enum-default-value">xml
</span>,
764 <span class=
"json-property-enum-item">atom
</span>,
765 <span class=
"json-property-enum-item">json
</span>
767 <span class=
"json-property-range" title=
"Value limits"></span>
768 <span class=
"json-property-default-value" title=
"Default value">xml
</span>
771 <div class=
"prop-value">
772 <p>The format expected (xml defaults to RSS
2.0, atom to ATOM
1.0 and json to JSON FEED
1.0</p>
775 <div class=
"prop-row prop-group">
776 <div class=
"prop-name">
777 <div class=
"prop-title">accountId
</div>
778 <div class=
"prop-subtitle"> in query
</div>
779 <div class=
"prop-subtitle">
780 <span class=
"json-property-type">number
</span>
781 <span class=
"json-property-range" title=
"Value limits"></span>
784 <div class=
"prop-value">
785 <p>The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds
</p>
788 <div class=
"prop-row prop-group">
789 <div class=
"prop-name">
790 <div class=
"prop-title">accountName
</div>
791 <div class=
"prop-subtitle"> in query
</div>
792 <div class=
"prop-subtitle">
793 <span class=
"json-property-type">string
</span>
794 <span class=
"json-property-range" title=
"Value limits"></span>
797 <div class=
"prop-value">
798 <p>The name of the local account to filter to
</p>
803 <div class=
"doc-examples"></div>
805 <div class=
"doc-row">
806 <div class=
"doc-copy">
807 <section class=
"swagger-responses">
808 <div class=
"prop-row prop-group">
809 <div class=
"prop-name">
810 <div class=
"prop-title">200 OK
</div>
812 <div class=
"prop-value">
813 <p>successful operation
</p>
818 <div class=
"doc-examples">
819 <h5>Response Content-Types:
820 <span>application/atom+xml, application/rss+xml, application/json
</span>
825 <h1 id=
"tag-Job" class=
"swagger-summary-tag" data-traverse-target=
"tag-Job">Job
</h1>
826 <div id=
"operation--jobs-get" class=
"operation panel" data-traverse-target=
"operation--jobs-get">
827 <!-- <section class="operation-tags row"> -->
828 <!-- <div class="doc-copy"> -->
829 <div class=
"operation-tags">
830 <a class=
"label" href=
"#tag-Job">Job
</a>
835 <h2 class=
"operation-title">
836 <span class=
"operation-name">
837 <span class=
"operation-name">GET
</span>
838 <span class=
"operation-path">/jobs
</span>
841 <div class=
"doc-row">
842 <div class=
"doc-copy">
843 <section class=
"swagger-request-params">
844 <div class=
"prop-row prop-group">
845 <div class=
"prop-name">
846 <div class=
"prop-title">state
</div>
847 <span class=
"json-property-required"></span>
848 <div class=
"prop-subtitle"> in path
</div>
849 <div class=
"prop-subtitle">
850 <span class=
"json-property-type">string
</span>
851 <span class=
"json-property-range" title=
"Value limits"></span>
854 <div class=
"prop-value">
855 <p>The id of the account
</p>
858 <div class=
"prop-row prop-group">
859 <div class=
"prop-name">
860 <div class=
"prop-title">start
</div>
861 <div class=
"prop-subtitle"> in query
</div>
862 <div class=
"prop-subtitle">
863 <span class=
"json-property-type">number
</span>
864 <span class=
"json-property-range" title=
"Value limits"></span>
867 <div class=
"prop-value">
871 <div class=
"prop-row prop-group">
872 <div class=
"prop-name">
873 <div class=
"prop-title">count
</div>
874 <div class=
"prop-subtitle"> in query
</div>
875 <div class=
"prop-subtitle">
876 <span class=
"json-property-type">number
</span>
877 <span class=
"json-property-range" title=
"Value limits"></span>
880 <div class=
"prop-value">
881 <p class=
"no-description">(no description)
</p>
884 <div class=
"prop-row prop-group">
885 <div class=
"prop-name">
886 <div class=
"prop-title">sort
</div>
887 <div class=
"prop-subtitle"> in query
</div>
888 <div class=
"prop-subtitle">
889 <span class=
"json-property-type">number
</span>
890 <span class=
"json-property-range" title=
"Value limits"></span>
893 <div class=
"prop-value">
899 <div class=
"doc-examples"></div>
901 <div class=
"doc-row">
902 <div class=
"doc-copy">
903 <section class=
"swagger-responses">
904 <div class=
"prop-row prop-group">
905 <div class=
"prop-name">
906 <div class=
"prop-title">200 OK
</div>
907 <div class=
"prop-ref">
908 <span class=
"json-schema-ref-array">
909 <a class=
"json-schema-ref" href=
"#/definitions/Job">Job
</a>
912 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
914 <div class=
"prop-value">
915 <p>successful operation
</p>
918 <div class=
"prop-row prop-inner">
919 <div class=
"prop-name">type
</div>
920 <div class=
"prop-value">
921 <span class=
"json-property-type">
922 <span class=
"json-schema-ref-array">
923 <a class=
"json-schema-ref" href=
"#/definitions/Job">Job
</a>
926 <span class=
"json-property-range" title=
"Value limits"></span>
931 <div class=
"doc-examples">
932 <h5>Response Content-Types:
933 <span>application/json
</span>
937 <span>(
200 OK)
</span>
939 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
941 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
942 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
943 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"string
"</span>,
944 <span class=
"hljs-attr">"handlerName
"</span>:
<span class=
"hljs-string">"string
"</span>,
945 <span class=
"hljs-attr">"handlerInputData
"</span>:
<span class=
"hljs-string">"string
"</span>,
946 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
947 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
955 <div class=
"doc-row">
956 <div class=
"doc-copy">
957 <section class=
"swagger-request-security">
958 <table class=
"table">
961 <th class=
"swagger-request-security-schema"></th>
962 <th class=
"swagger-request-security-scopes"></th>
968 <a href=
"#security-definition-OAuth2">OAuth2
</a>
978 <h1 id=
"tag-ServerFollowing" class=
"swagger-summary-tag" data-traverse-target=
"tag-ServerFollowing">ServerFollowing
</h1>
979 <div id=
"operation--server-following--host--delete" class=
"operation panel" data-traverse-target=
"operation--server-following--host--delete">
980 <!-- <section class="operation-tags row"> -->
981 <!-- <div class="doc-copy"> -->
982 <div class=
"operation-tags">
983 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
988 <h2 class=
"operation-title">
989 <span class=
"operation-name">
990 <span class=
"operation-name">DELETE
</span>
991 <span class=
"operation-path">/server/following/{host}
</span>
994 <div class=
"doc-row">
995 <div class=
"doc-copy">
996 <section class=
"swagger-request-params">
997 <div class=
"prop-row prop-group">
998 <div class=
"prop-name">
999 <div class=
"prop-title">host
</div>
1000 <span class=
"json-property-required"></span>
1001 <div class=
"prop-subtitle"> in path
</div>
1002 <div class=
"prop-subtitle">
1003 <span class=
"json-property-type">string
</span>
1004 <span class=
"json-property-range" title=
"Value limits"></span>
1007 <div class=
"prop-value">
1008 <p>The host to unfollow
</p>
1013 <div class=
"doc-examples"></div>
1015 <div class=
"doc-row">
1016 <div class=
"doc-copy">
1017 <section class=
"swagger-responses">
1018 <div class=
"prop-row prop-group">
1019 <div class=
"prop-name">
1020 <div class=
"prop-title">201 Created
</div>
1022 <div class=
"prop-value">
1023 <p>successful operation
</p>
1028 <div class=
"doc-examples">
1029 <h5>Response Content-Types:
1030 <span>application/json
</span>
1034 <div class=
"doc-row">
1035 <div class=
"doc-copy">
1036 <section class=
"swagger-request-security">
1037 <table class=
"table">
1040 <th class=
"swagger-request-security-schema"></th>
1041 <th class=
"swagger-request-security-scopes"></th>
1047 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1057 <div id=
"operation--server-followers-get" class=
"operation panel" data-traverse-target=
"operation--server-followers-get">
1058 <!-- <section class="operation-tags row"> -->
1059 <!-- <div class="doc-copy"> -->
1060 <div class=
"operation-tags">
1061 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1066 <h2 class=
"operation-title">
1067 <span class=
"operation-name">
1068 <span class=
"operation-name">GET
</span>
1069 <span class=
"operation-path">/server/followers
</span>
1072 <div class=
"doc-row">
1073 <div class=
"doc-copy">
1074 <section class=
"swagger-request-params">
1075 <div class=
"prop-row prop-group">
1076 <div class=
"prop-name">
1077 <div class=
"prop-title">start
</div>
1078 <div class=
"prop-subtitle"> in query
</div>
1079 <div class=
"prop-subtitle">
1080 <span class=
"json-property-type">number
</span>
1081 <span class=
"json-property-range" title=
"Value limits"></span>
1084 <div class=
"prop-value">
1085 <p>starting page
</p>
1088 <div class=
"prop-row prop-group">
1089 <div class=
"prop-name">
1090 <div class=
"prop-title">stop
</div>
1091 <div class=
"prop-subtitle"> in query
</div>
1092 <div class=
"prop-subtitle">
1093 <span class=
"json-property-type">number
</span>
1094 <span class=
"json-property-range" title=
"Value limits"></span>
1097 <div class=
"prop-value">
1098 <p>stopping page
</p>
1101 <div class=
"prop-row prop-group">
1102 <div class=
"prop-name">
1103 <div class=
"prop-title">sort
</div>
1104 <div class=
"prop-subtitle"> in query
</div>
1105 <div class=
"prop-subtitle">
1106 <span class=
"json-property-type">number
</span>
1107 <span class=
"json-property-range" title=
"Value limits"></span>
1110 <div class=
"prop-value">
1116 <div class=
"doc-examples"></div>
1118 <div class=
"doc-row">
1119 <div class=
"doc-copy">
1120 <section class=
"swagger-responses">
1121 <div class=
"prop-row prop-group">
1122 <div class=
"prop-name">
1123 <div class=
"prop-title">200 OK
</div>
1124 <div class=
"prop-ref">
1125 <span class=
"json-schema-ref-array">
1126 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1129 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1131 <div class=
"prop-value">
1132 <p>successful operation
</p>
1135 <div class=
"prop-row prop-inner">
1136 <div class=
"prop-name">type
</div>
1137 <div class=
"prop-value">
1138 <span class=
"json-property-type">
1139 <span class=
"json-schema-ref-array">
1140 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1143 <span class=
"json-property-range" title=
"Value limits"></span>
1148 <div class=
"doc-examples">
1149 <h5>Response Content-Types:
1150 <span>application/json
</span>
1153 <h5>Response Example
1154 <span>(
200 OK)
</span>
1156 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1158 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1159 <span class=
"hljs-attr">"follower
"</span>: {
1160 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1161 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1162 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1163 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1164 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1165 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1166 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1167 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1168 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1169 <span class=
"hljs-attr">"avatar
"</span>: {
1170 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1171 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1172 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1175 <span class=
"hljs-attr">"following
"</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">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1192 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1193 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1194 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1203 <div id=
"operation--server-following-get" class=
"operation panel" data-traverse-target=
"operation--server-following-get">
1204 <!-- <section class="operation-tags row"> -->
1205 <!-- <div class="doc-copy"> -->
1206 <div class=
"operation-tags">
1207 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1212 <h2 class=
"operation-title">
1213 <span class=
"operation-name">
1214 <span class=
"operation-name">GET
</span>
1215 <span class=
"operation-path">/server/following
</span>
1218 <div class=
"doc-row">
1219 <div class=
"doc-copy">
1220 <section class=
"swagger-request-params">
1221 <div class=
"prop-row prop-group">
1222 <div class=
"prop-name">
1223 <div class=
"prop-title">start
</div>
1224 <div class=
"prop-subtitle"> in query
</div>
1225 <div class=
"prop-subtitle">
1226 <span class=
"json-property-type">number
</span>
1227 <span class=
"json-property-range" title=
"Value limits"></span>
1230 <div class=
"prop-value">
1231 <p>starting page
</p>
1234 <div class=
"prop-row prop-group">
1235 <div class=
"prop-name">
1236 <div class=
"prop-title">stop
</div>
1237 <div class=
"prop-subtitle"> in query
</div>
1238 <div class=
"prop-subtitle">
1239 <span class=
"json-property-type">number
</span>
1240 <span class=
"json-property-range" title=
"Value limits"></span>
1243 <div class=
"prop-value">
1244 <p>stopping page
</p>
1247 <div class=
"prop-row prop-group">
1248 <div class=
"prop-name">
1249 <div class=
"prop-title">sort
</div>
1250 <div class=
"prop-subtitle"> in query
</div>
1251 <div class=
"prop-subtitle">
1252 <span class=
"json-property-type">number
</span>
1253 <span class=
"json-property-range" title=
"Value limits"></span>
1256 <div class=
"prop-value">
1262 <div class=
"doc-examples"></div>
1264 <div class=
"doc-row">
1265 <div class=
"doc-copy">
1266 <section class=
"swagger-responses">
1267 <div class=
"prop-row prop-group">
1268 <div class=
"prop-name">
1269 <div class=
"prop-title">200 OK
</div>
1270 <div class=
"prop-ref">
1271 <span class=
"json-schema-ref-array">
1272 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1275 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1277 <div class=
"prop-value">
1278 <p>successful operation
</p>
1281 <div class=
"prop-row prop-inner">
1282 <div class=
"prop-name">type
</div>
1283 <div class=
"prop-value">
1284 <span class=
"json-property-type">
1285 <span class=
"json-schema-ref-array">
1286 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1289 <span class=
"json-property-range" title=
"Value limits"></span>
1294 <div class=
"doc-examples">
1295 <h5>Response Content-Types:
1296 <span>application/json
</span>
1299 <h5>Response Example
1300 <span>(
200 OK)
</span>
1302 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1304 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1305 <span class=
"hljs-attr">"follower
"</span>: {
1306 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1307 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1308 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1309 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1310 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1311 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1312 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1313 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1314 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1315 <span class=
"hljs-attr">"avatar
"</span>: {
1316 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1317 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1318 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1321 <span class=
"hljs-attr">"following
"</span>: {
1322 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1323 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1324 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1325 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1326 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1327 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1328 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1329 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1330 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1331 <span class=
"hljs-attr">"avatar
"</span>: {
1332 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1333 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1334 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1337 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1338 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1339 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1340 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1349 <div id=
"operation--server-following-post" class=
"operation panel" data-traverse-target=
"operation--server-following-post">
1350 <!-- <section class="operation-tags row"> -->
1351 <!-- <div class="doc-copy"> -->
1352 <div class=
"operation-tags">
1353 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1358 <h2 class=
"operation-title">
1359 <span class=
"operation-name">
1360 <span class=
"operation-name">POST
</span>
1361 <span class=
"operation-path">/server/following
</span>
1364 <div class=
"doc-row">
1365 <div class=
"doc-copy">
1366 <section class=
"swagger-request-body">
1367 <div class=
"prop-row">
1368 <div class=
"prop-name">
1369 <div class=
"swagger-request-model">
1371 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1375 <div class=
"prop-value columns small-6">
1376 <!-- <div class="swagger-request-description"> -->
1383 <div class=
"doc-examples">
1385 <h5>Request Content-Types:
1386 <span>application/json
</span>
1388 <h5>Request Example
</h5>
1389 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1390 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1391 <span class=
"hljs-attr">"follower
"</span>: {
1392 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1393 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1394 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1395 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1396 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1397 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1398 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1399 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1400 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1401 <span class=
"hljs-attr">"avatar
"</span>: {
1402 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1403 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1404 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1407 <span class=
"hljs-attr">"following
"</span>: {
1408 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1409 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1410 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1411 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1412 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1413 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1414 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1415 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1416 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1417 <span class=
"hljs-attr">"avatar
"</span>: {
1418 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1419 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1420 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1423 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1424 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1425 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1426 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1433 <div class=
"doc-row">
1434 <div class=
"doc-copy">
1435 <section class=
"swagger-responses">
1436 <div class=
"prop-row prop-group">
1437 <div class=
"prop-name">
1438 <div class=
"prop-title">204 No Content
</div>
1440 <div class=
"prop-value">
1441 <p>successful operation
</p>
1446 <div class=
"doc-examples">
1447 <h5>Response Content-Types:
1448 <span>application/json
</span>
1452 <div class=
"doc-row">
1453 <div class=
"doc-copy">
1454 <section class=
"swagger-request-security">
1455 <table class=
"table">
1458 <th class=
"swagger-request-security-schema"></th>
1459 <th class=
"swagger-request-security-scopes"></th>
1465 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1475 <h1 id=
"tag-User" class=
"swagger-summary-tag" data-traverse-target=
"tag-User">User
</h1>
1476 <div id=
"operation--users-post" class=
"operation panel" data-traverse-target=
"operation--users-post">
1477 <!-- <section class="operation-tags row"> -->
1478 <!-- <div class="doc-copy"> -->
1479 <div class=
"operation-tags">
1480 <a class=
"label" href=
"#tag-User">User
</a>
1485 <h2 class=
"operation-title">
1486 <span class=
"operation-name">
1487 <span class=
"operation-name">POST
</span>
1488 <span class=
"operation-path">/users
</span>
1491 <div class=
"doc-row">
1492 <div class=
"doc-copy">
1493 <section class=
"swagger-request-body">
1494 <div class=
"prop-row">
1495 <div class=
"prop-name">
1496 <div class=
"swagger-request-model">
1498 <a class=
"json-schema-ref" href=
"#/definitions/AddUser">AddUser
</a>
1502 <div class=
"prop-value columns small-6">
1503 <!-- <div class="swagger-request-description"> -->
1504 <p>User to create
</p>
1510 <div class=
"doc-examples">
1512 <h5>Request Content-Types:
1513 <span>application/json
</span>
1515 <h5>Request Example
</h5>
1516 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1517 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1518 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
1519 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1520 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
1521 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
1528 <div class=
"doc-row">
1529 <div class=
"doc-copy">
1530 <section class=
"swagger-responses">
1531 <div class=
"prop-row prop-group">
1532 <div class=
"prop-name">
1533 <div class=
"prop-title">200 OK
</div>
1534 <div class=
"prop-ref">
1536 <a class=
"json-schema-ref" href=
"#/definitions/AddUserResponse">AddUserResponse
</a>
1539 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1541 <div class=
"prop-value">
1542 <p>successful operation
</p>
1547 <div class=
"doc-examples">
1548 <h5>Response Content-Types:
1549 <span>application/json
</span>
1552 <h5>Response Example
1553 <span>(
200 OK)
</span>
1555 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1556 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1557 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1564 <div class=
"doc-row">
1565 <div class=
"doc-copy">
1566 <section class=
"swagger-request-security">
1567 <table class=
"table">
1570 <th class=
"swagger-request-security-schema"></th>
1571 <th class=
"swagger-request-security-scopes"></th>
1577 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1587 <div id=
"operation--users-get" class=
"operation panel" data-traverse-target=
"operation--users-get">
1588 <!-- <section class="operation-tags row"> -->
1589 <!-- <div class="doc-copy"> -->
1590 <div class=
"operation-tags">
1591 <a class=
"label" href=
"#tag-User">User
</a>
1596 <h2 class=
"operation-title">
1597 <span class=
"operation-name">
1598 <span class=
"operation-name">GET
</span>
1599 <span class=
"operation-path">/users
</span>
1602 <div class=
"doc-row">
1603 <div class=
"doc-copy">
1604 <section class=
"swagger-request-params">
1605 <div class=
"prop-row prop-group">
1606 <div class=
"prop-name">
1607 <div class=
"prop-title">start
</div>
1608 <div class=
"prop-subtitle"> in query
</div>
1609 <div class=
"prop-subtitle">
1610 <span class=
"json-property-type">number
</span>
1611 <span class=
"json-property-range" title=
"Value limits"></span>
1614 <div class=
"prop-value">
1615 <p>starting page
</p>
1618 <div class=
"prop-row prop-group">
1619 <div class=
"prop-name">
1620 <div class=
"prop-title">stop
</div>
1621 <div class=
"prop-subtitle"> in query
</div>
1622 <div class=
"prop-subtitle">
1623 <span class=
"json-property-type">number
</span>
1624 <span class=
"json-property-range" title=
"Value limits"></span>
1627 <div class=
"prop-value">
1628 <p>stopping page
</p>
1631 <div class=
"prop-row prop-group">
1632 <div class=
"prop-name">
1633 <div class=
"prop-title">sort
</div>
1634 <div class=
"prop-subtitle"> in query
</div>
1635 <div class=
"prop-subtitle">
1636 <span class=
"json-property-type">number
</span>
1637 <span class=
"json-property-range" title=
"Value limits"></span>
1640 <div class=
"prop-value">
1646 <div class=
"doc-examples"></div>
1648 <div class=
"doc-row">
1649 <div class=
"doc-copy">
1650 <section class=
"swagger-responses">
1651 <div class=
"prop-row prop-group">
1652 <div class=
"prop-name">
1653 <div class=
"prop-title">200 OK
</div>
1654 <div class=
"prop-ref">
1655 <span class=
"json-schema-ref-array">
1656 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1659 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1661 <div class=
"prop-value">
1662 <p>successful operation
</p>
1665 <div class=
"prop-row prop-inner">
1666 <div class=
"prop-name">type
</div>
1667 <div class=
"prop-value">
1668 <span class=
"json-property-type">
1669 <span class=
"json-schema-ref-array">
1670 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1673 <span class=
"json-property-range" title=
"Value limits"></span>
1678 <div class=
"doc-examples">
1679 <h5>Response Content-Types:
1680 <span>application/json
</span>
1683 <h5>Response Example
1684 <span>(
200 OK)
</span>
1686 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1688 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1689 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1690 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1691 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1692 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1693 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1694 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1695 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1696 <span class=
"hljs-attr">"account
"</span>: {
1697 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1698 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1699 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1700 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1701 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1702 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1703 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1704 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1705 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1706 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1707 <span class=
"hljs-attr">"avatar
"</span>: {
1708 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1709 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1710 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1713 <span class=
"hljs-attr">"videoChannels
"</span>: [
1715 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1716 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1717 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1718 <span class=
"hljs-attr">"ownerAccount
"</span>: {
1719 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1720 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1731 <div class=
"doc-row">
1732 <div class=
"doc-copy">
1733 <section class=
"swagger-request-security">
1734 <table class=
"table">
1737 <th class=
"swagger-request-security-schema"></th>
1738 <th class=
"swagger-request-security-scopes"></th>
1744 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1754 <div id=
"operation--users--id--delete" class=
"operation panel" data-traverse-target=
"operation--users--id--delete">
1755 <!-- <section class="operation-tags row"> -->
1756 <!-- <div class="doc-copy"> -->
1757 <div class=
"operation-tags">
1758 <a class=
"label" href=
"#tag-User">User
</a>
1763 <h2 class=
"operation-title">
1764 <span class=
"operation-name">
1765 <span class=
"operation-name">DELETE
</span>
1766 <span class=
"operation-path">/users/{id}
</span>
1769 <div class=
"doc-row">
1770 <div class=
"doc-copy">
1771 <section class=
"swagger-request-params">
1772 <div class=
"prop-row prop-group">
1773 <div class=
"prop-name">
1774 <div class=
"prop-title">id
</div>
1775 <span class=
"json-property-required"></span>
1776 <div class=
"prop-subtitle"> in path
</div>
1777 <div class=
"prop-subtitle">
1778 <span class=
"json-property-type">string
</span>
1779 <span class=
"json-property-range" title=
"Value limits"></span>
1782 <div class=
"prop-value">
1788 <div class=
"doc-examples"></div>
1790 <div class=
"doc-row">
1791 <div class=
"doc-copy">
1792 <section class=
"swagger-responses">
1793 <div class=
"prop-row prop-group">
1794 <div class=
"prop-name">
1795 <div class=
"prop-title">204 No Content
</div>
1797 <div class=
"prop-value">
1798 <p>successful operation
</p>
1803 <div class=
"doc-examples">
1804 <h5>Response Content-Types:
1805 <span>application/json
</span>
1809 <div class=
"doc-row">
1810 <div class=
"doc-copy">
1811 <section class=
"swagger-request-security">
1812 <table class=
"table">
1815 <th class=
"swagger-request-security-schema"></th>
1816 <th class=
"swagger-request-security-scopes"></th>
1822 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1832 <div id=
"operation--users--id--get" class=
"operation panel" data-traverse-target=
"operation--users--id--get">
1833 <!-- <section class="operation-tags row"> -->
1834 <!-- <div class="doc-copy"> -->
1835 <div class=
"operation-tags">
1836 <a class=
"label" href=
"#tag-User">User
</a>
1841 <h2 class=
"operation-title">
1842 <span class=
"operation-name">
1843 <span class=
"operation-name">GET
</span>
1844 <span class=
"operation-path">/users/{id}
</span>
1847 <div class=
"doc-row">
1848 <div class=
"doc-copy">
1849 <section class=
"swagger-request-params">
1850 <div class=
"prop-row prop-group">
1851 <div class=
"prop-name">
1852 <div class=
"prop-title">id
</div>
1853 <span class=
"json-property-required"></span>
1854 <div class=
"prop-subtitle"> in path
</div>
1855 <div class=
"prop-subtitle">
1856 <span class=
"json-property-type">string
</span>
1857 <span class=
"json-property-range" title=
"Value limits"></span>
1860 <div class=
"prop-value">
1866 <div class=
"doc-examples"></div>
1868 <div class=
"doc-row">
1869 <div class=
"doc-copy">
1870 <section class=
"swagger-responses">
1871 <div class=
"prop-row prop-group">
1872 <div class=
"prop-name">
1873 <div class=
"prop-title">200 OK
</div>
1874 <div class=
"prop-ref">
1876 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1879 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1881 <div class=
"prop-value">
1882 <p>successful operation
</p>
1887 <div class=
"doc-examples">
1888 <h5>Response Content-Types:
1889 <span>application/json
</span>
1892 <h5>Response Example
1893 <span>(
200 OK)
</span>
1895 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1896 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1897 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1898 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1899 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1900 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1901 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1902 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1903 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1904 <span class=
"hljs-attr">"account
"</span>: {
1905 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1906 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1907 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1908 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1909 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1910 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1911 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1912 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1913 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1914 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1915 <span class=
"hljs-attr">"avatar
"</span>: {
1916 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1917 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1918 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1921 <span class=
"hljs-attr">"videoChannels
"</span>: [
1923 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1924 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1925 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1926 <span class=
"hljs-attr">"ownerAccount
"</span>: {
1927 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1928 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1938 <div class=
"doc-row">
1939 <div class=
"doc-copy">
1940 <section class=
"swagger-request-security">
1941 <table class=
"table">
1944 <th class=
"swagger-request-security-schema"></th>
1945 <th class=
"swagger-request-security-scopes"></th>
1951 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1961 <div id=
"operation--users--id--put" class=
"operation panel" data-traverse-target=
"operation--users--id--put">
1962 <!-- <section class="operation-tags row"> -->
1963 <!-- <div class="doc-copy"> -->
1964 <div class=
"operation-tags">
1965 <a class=
"label" href=
"#tag-User">User
</a>
1970 <h2 class=
"operation-title">
1971 <span class=
"operation-name">
1972 <span class=
"operation-name">PUT
</span>
1973 <span class=
"operation-path">/users/{id}
</span>
1976 <div class=
"doc-row">
1977 <div class=
"doc-copy">
1978 <section class=
"swagger-request-body">
1979 <div class=
"prop-row">
1980 <div class=
"prop-name">
1981 <div class=
"swagger-request-model">
1983 <a class=
"json-schema-ref" href=
"#/definitions/UpdateUser">UpdateUser
</a>
1987 <div class=
"prop-value columns small-6">
1988 <!-- <div class="swagger-request-description"> -->
1994 <section class=
"swagger-request-params">
1995 <div class=
"prop-row prop-group">
1996 <div class=
"prop-name">
1997 <div class=
"prop-title">id
</div>
1998 <span class=
"json-property-required"></span>
1999 <div class=
"prop-subtitle"> in path
</div>
2000 <div class=
"prop-subtitle">
2001 <span class=
"json-property-type">string
</span>
2002 <span class=
"json-property-range" title=
"Value limits"></span>
2005 <div class=
"prop-value">
2011 <div class=
"doc-examples">
2013 <h5>Request Content-Types:
2014 <span>application/json
</span>
2016 <h5>Request Example
</h5>
2017 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2018 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2019 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
2020 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
2021 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
2028 <div class=
"doc-row">
2029 <div class=
"doc-copy">
2030 <section class=
"swagger-responses">
2031 <div class=
"prop-row prop-group">
2032 <div class=
"prop-name">
2033 <div class=
"prop-title">204 No Content
</div>
2035 <div class=
"prop-value">
2036 <p>successful operation
</p>
2041 <div class=
"doc-examples">
2042 <h5>Response Content-Types:
2043 <span>application/json
</span>
2047 <div class=
"doc-row">
2048 <div class=
"doc-copy">
2049 <section class=
"swagger-request-security">
2050 <table class=
"table">
2053 <th class=
"swagger-request-security-schema"></th>
2054 <th class=
"swagger-request-security-scopes"></th>
2060 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2070 <div id=
"operation--users-me-get" class=
"operation panel" data-traverse-target=
"operation--users-me-get">
2071 <!-- <section class="operation-tags row"> -->
2072 <!-- <div class="doc-copy"> -->
2073 <div class=
"operation-tags">
2074 <a class=
"label" href=
"#tag-User">User
</a>
2079 <h2 class=
"operation-title">
2080 <span class=
"operation-name">
2081 <span class=
"operation-name">GET
</span>
2082 <span class=
"operation-path">/users/me
</span>
2085 <div class=
"doc-row">
2086 <div class=
"doc-copy"> </div>
2087 <div class=
"doc-examples"></div>
2089 <div class=
"doc-row">
2090 <div class=
"doc-copy">
2091 <section class=
"swagger-responses">
2092 <div class=
"prop-row prop-group">
2093 <div class=
"prop-name">
2094 <div class=
"prop-title">200 OK
</div>
2095 <div class=
"prop-ref">
2096 <span class=
"json-schema-ref-array">
2097 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
2100 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2102 <div class=
"prop-value">
2103 <p>successful operation
</p>
2106 <div class=
"prop-row prop-inner">
2107 <div class=
"prop-name">type
</div>
2108 <div class=
"prop-value">
2109 <span class=
"json-property-type">
2110 <span class=
"json-schema-ref-array">
2111 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
2114 <span class=
"json-property-range" title=
"Value limits"></span>
2119 <div class=
"doc-examples">
2120 <h5>Response Content-Types:
2121 <span>application/json
</span>
2124 <h5>Response Example
2125 <span>(
200 OK)
</span>
2127 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2129 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2130 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
2131 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
2132 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2133 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2134 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
2135 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
2136 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2137 <span class=
"hljs-attr">"account
"</span>: {
2138 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2139 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2140 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2141 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2142 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2143 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2144 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
2145 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
2146 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2147 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2148 <span class=
"hljs-attr">"avatar
"</span>: {
2149 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2150 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2151 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2154 <span class=
"hljs-attr">"videoChannels
"</span>: [
2156 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2157 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2158 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2159 <span class=
"hljs-attr">"ownerAccount
"</span>: {
2160 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2161 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
2172 <div class=
"doc-row">
2173 <div class=
"doc-copy">
2174 <section class=
"swagger-request-security">
2175 <table class=
"table">
2178 <th class=
"swagger-request-security-schema"></th>
2179 <th class=
"swagger-request-security-scopes"></th>
2185 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2195 <div id=
"operation--users-me-put" class=
"operation panel" data-traverse-target=
"operation--users-me-put">
2196 <!-- <section class="operation-tags row"> -->
2197 <!-- <div class="doc-copy"> -->
2198 <div class=
"operation-tags">
2199 <a class=
"label" href=
"#tag-User">User
</a>
2204 <h2 class=
"operation-title">
2205 <span class=
"operation-name">
2206 <span class=
"operation-name">PUT
</span>
2207 <span class=
"operation-path">/users/me
</span>
2210 <div class=
"doc-row">
2211 <div class=
"doc-copy">
2212 <section class=
"swagger-request-body">
2213 <div class=
"prop-row">
2214 <div class=
"prop-name">
2215 <div class=
"swagger-request-model">
2217 <a class=
"json-schema-ref" href=
"#/definitions/UpdateMe">UpdateMe
</a>
2221 <div class=
"prop-value columns small-6">
2222 <!-- <div class="swagger-request-description"> -->
2229 <div class=
"doc-examples">
2231 <h5>Request Content-Types:
2232 <span>application/json
</span>
2234 <h5>Request Example
</h5>
2235 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2236 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
2237 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
2238 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"string
"</span>,
2239 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"string
"</span>
2246 <div class=
"doc-row">
2247 <div class=
"doc-copy">
2248 <section class=
"swagger-responses">
2249 <div class=
"prop-row prop-group">
2250 <div class=
"prop-name">
2251 <div class=
"prop-title">204 No Content
</div>
2253 <div class=
"prop-value">
2254 <p>successful operation
</p>
2259 <div class=
"doc-examples">
2260 <h5>Response Content-Types:
2261 <span>application/json
</span>
2265 <div class=
"doc-row">
2266 <div class=
"doc-copy">
2267 <section class=
"swagger-request-security">
2268 <table class=
"table">
2271 <th class=
"swagger-request-security-schema"></th>
2272 <th class=
"swagger-request-security-scopes"></th>
2278 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2288 <div id=
"operation--users-me-video-quota-used-get" class=
"operation panel" data-traverse-target=
"operation--users-me-video-quota-used-get">
2289 <!-- <section class="operation-tags row"> -->
2290 <!-- <div class="doc-copy"> -->
2291 <div class=
"operation-tags">
2292 <a class=
"label" href=
"#tag-User">User
</a>
2297 <h2 class=
"operation-title">
2298 <span class=
"operation-name">
2299 <span class=
"operation-name">GET
</span>
2300 <span class=
"operation-path">/users/me/video-quota-used
</span>
2303 <div class=
"doc-row">
2304 <div class=
"doc-copy"> </div>
2305 <div class=
"doc-examples"></div>
2307 <div class=
"doc-row">
2308 <div class=
"doc-copy">
2309 <section class=
"swagger-responses">
2310 <div class=
"prop-row prop-group">
2311 <div class=
"prop-name">
2312 <div class=
"prop-title">200 OK
</div>
2313 <div class=
"prop-ref"></div>
2314 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2316 <div class=
"prop-value">
2317 <p>successful operation
</p>
2320 <div class=
"prop-row prop-inner">
2321 <div class=
"prop-name">type
</div>
2322 <div class=
"prop-value">
2323 <span class=
"json-property-type">number
</span>
2324 <span class=
"json-property-range" title=
"Value limits"></span>
2329 <div class=
"doc-examples">
2330 <h5>Response Content-Types:
2331 <span>application/json
</span>
2334 <h5>Response Example
2335 <span>(
200 OK)
</span>
2337 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json"><span class=
"hljs-string">"number
"</span>
2343 <div class=
"doc-row">
2344 <div class=
"doc-copy">
2345 <section class=
"swagger-request-security">
2346 <table class=
"table">
2349 <th class=
"swagger-request-security-schema"></th>
2350 <th class=
"swagger-request-security-scopes"></th>
2356 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2366 <div id=
"operation--users-me-videos--videoId--rating-get" class=
"operation panel" data-traverse-target=
"operation--users-me-videos--videoId--rating-get">
2367 <!-- <section class="operation-tags row"> -->
2368 <!-- <div class="doc-copy"> -->
2369 <div class=
"operation-tags">
2370 <a class=
"label" href=
"#tag-User">User
</a>
2375 <h2 class=
"operation-title">
2376 <span class=
"operation-name">
2377 <span class=
"operation-name">GET
</span>
2378 <span class=
"operation-path">/users/me/videos/{videoId}/rating
</span>
2381 <div class=
"doc-row">
2382 <div class=
"doc-copy">
2383 <section class=
"swagger-request-params">
2384 <div class=
"prop-row prop-group">
2385 <div class=
"prop-name">
2386 <div class=
"prop-title">videoId
</div>
2387 <span class=
"json-property-required"></span>
2388 <div class=
"prop-subtitle"> in path
</div>
2389 <div class=
"prop-subtitle">
2390 <span class=
"json-property-type">string
</span>
2391 <span class=
"json-property-range" title=
"Value limits"></span>
2394 <div class=
"prop-value">
2395 <p>The video id
</p>
2400 <div class=
"doc-examples"></div>
2402 <div class=
"doc-row">
2403 <div class=
"doc-copy">
2404 <section class=
"swagger-responses">
2405 <div class=
"prop-row prop-group">
2406 <div class=
"prop-name">
2407 <div class=
"prop-title">200 OK
</div>
2408 <div class=
"prop-ref">
2410 <a class=
"json-schema-ref" href=
"#/definitions/GetMeVideoRating">GetMeVideoRating
</a>
2413 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2415 <div class=
"prop-value">
2416 <p>successful operation
</p>
2421 <div class=
"doc-examples">
2422 <h5>Response Content-Types:
2423 <span>application/json
</span>
2426 <h5>Response Example
2427 <span>(
200 OK)
</span>
2429 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2430 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2431 <span class=
"hljs-attr">"rating
"</span>:
<span class=
"hljs-string">"number
"</span>
2438 <div class=
"doc-row">
2439 <div class=
"doc-copy">
2440 <section class=
"swagger-request-security">
2441 <table class=
"table">
2444 <th class=
"swagger-request-security-schema"></th>
2445 <th class=
"swagger-request-security-scopes"></th>
2451 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2461 <div id=
"operation--users-me-videos-get" class=
"operation panel" data-traverse-target=
"operation--users-me-videos-get">
2462 <!-- <section class="operation-tags row"> -->
2463 <!-- <div class="doc-copy"> -->
2464 <div class=
"operation-tags">
2465 <a class=
"label" href=
"#tag-User">User
</a>
2470 <h2 class=
"operation-title">
2471 <span class=
"operation-name">
2472 <span class=
"operation-name">GET
</span>
2473 <span class=
"operation-path">/users/me/videos
</span>
2476 <div class=
"doc-row">
2477 <div class=
"doc-copy">
2478 <section class=
"swagger-request-params">
2479 <div class=
"prop-row prop-group">
2480 <div class=
"prop-name">
2481 <div class=
"prop-title">start
</div>
2482 <div class=
"prop-subtitle"> in query
</div>
2483 <div class=
"prop-subtitle">
2484 <span class=
"json-property-type">number
</span>
2485 <span class=
"json-property-range" title=
"Value limits"></span>
2488 <div class=
"prop-value">
2489 <p>starting page
</p>
2492 <div class=
"prop-row prop-group">
2493 <div class=
"prop-name">
2494 <div class=
"prop-title">stop
</div>
2495 <div class=
"prop-subtitle"> in query
</div>
2496 <div class=
"prop-subtitle">
2497 <span class=
"json-property-type">number
</span>
2498 <span class=
"json-property-range" title=
"Value limits"></span>
2501 <div class=
"prop-value">
2502 <p>stopping page
</p>
2505 <div class=
"prop-row prop-group">
2506 <div class=
"prop-name">
2507 <div class=
"prop-title">sort
</div>
2508 <div class=
"prop-subtitle"> in query
</div>
2509 <div class=
"prop-subtitle">
2510 <span class=
"json-property-type">number
</span>
2511 <span class=
"json-property-range" title=
"Value limits"></span>
2514 <div class=
"prop-value">
2520 <div class=
"doc-examples"></div>
2522 <div class=
"doc-row">
2523 <div class=
"doc-copy">
2524 <section class=
"swagger-responses">
2525 <div class=
"prop-row prop-group">
2526 <div class=
"prop-name">
2527 <div class=
"prop-title">200 OK
</div>
2528 <div class=
"prop-ref">
2529 <span class=
"json-schema-ref-array">
2530 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2533 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2535 <div class=
"prop-value">
2536 <p>successful operation
</p>
2539 <div class=
"prop-row prop-inner">
2540 <div class=
"prop-name">type
</div>
2541 <div class=
"prop-value">
2542 <span class=
"json-property-type">
2543 <span class=
"json-schema-ref-array">
2544 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2547 <span class=
"json-property-range" title=
"Value limits"></span>
2552 <div class=
"doc-examples">
2553 <h5>Response Content-Types:
2554 <span>application/json
</span>
2557 <h5>Response Example
2558 <span>(
200 OK)
</span>
2560 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2562 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2563 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2564 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2565 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2566 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2567 <span class=
"hljs-attr">"category
"</span>: {
2568 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2569 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2571 <span class=
"hljs-attr">"licence
"</span>: {
2572 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2573 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2575 <span class=
"hljs-attr">"language
"</span>: {
2576 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2577 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2579 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
2580 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2581 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2582 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2583 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2584 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2585 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2586 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2587 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2588 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2589 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2590 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2591 <span class=
"hljs-attr">"account
"</span>: {
2592 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2593 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2594 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2595 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2596 <span class=
"hljs-attr">"avatar
"</span>: {
2597 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2598 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2599 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2609 <div class=
"doc-row">
2610 <div class=
"doc-copy">
2611 <section class=
"swagger-request-security">
2612 <table class=
"table">
2615 <th class=
"swagger-request-security-schema"></th>
2616 <th class=
"swagger-request-security-scopes"></th>
2622 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2632 <div id=
"operation--users-register-post" class=
"operation panel" data-traverse-target=
"operation--users-register-post">
2633 <!-- <section class="operation-tags row"> -->
2634 <!-- <div class="doc-copy"> -->
2635 <div class=
"operation-tags">
2636 <a class=
"label" href=
"#tag-User">User
</a>
2641 <h2 class=
"operation-title">
2642 <span class=
"operation-name">
2643 <span class=
"operation-name">POST
</span>
2644 <span class=
"operation-path">/users/register
</span>
2647 <div class=
"doc-row">
2648 <div class=
"doc-copy">
2649 <section class=
"swagger-request-body">
2650 <div class=
"prop-row">
2651 <div class=
"prop-name">
2652 <div class=
"swagger-request-model">
2654 <a class=
"json-schema-ref" href=
"#/definitions/RegisterUser">RegisterUser
</a>
2658 <div class=
"prop-value columns small-6">
2659 <!-- <div class="swagger-request-description"> -->
2666 <div class=
"doc-examples">
2668 <h5>Request Content-Types:
2669 <span>application/json
</span>
2671 <h5>Request Example
</h5>
2672 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2673 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
2674 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
2675 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>
2682 <div class=
"doc-row">
2683 <div class=
"doc-copy">
2684 <section class=
"swagger-responses">
2685 <div class=
"prop-row prop-group">
2686 <div class=
"prop-name">
2687 <div class=
"prop-title">204 No Content
</div>
2689 <div class=
"prop-value">
2690 <p>successful operation
</p>
2695 <div class=
"doc-examples">
2696 <h5>Response Content-Types:
2697 <span>application/json
</span>
2702 <div id=
"operation--users-me-avatar-pick-post" class=
"operation panel" data-traverse-target=
"operation--users-me-avatar-pick-post">
2703 <!-- <section class="operation-tags row"> -->
2704 <!-- <div class="doc-copy"> -->
2705 <div class=
"operation-tags">
2706 <a class=
"label" href=
"#tag-User">User
</a>
2711 <h2 class=
"operation-title">
2712 <span class=
"operation-name">
2713 <span class=
"operation-name">POST
</span>
2714 <span class=
"operation-path">/users/me/avatar/pick
</span>
2717 <div class=
"doc-row">
2718 <div class=
"doc-copy">
2719 <section class=
"swagger-request-params">
2720 <div class=
"prop-row prop-group">
2721 <div class=
"prop-name">
2722 <div class=
"prop-title">avatarfile
</div>
2723 <div class=
"prop-subtitle"> in formData
</div>
2724 <div class=
"prop-subtitle">
2725 <span class=
"json-property-type">file
</span>
2726 <span class=
"json-property-range" title=
"Value limits"></span>
2729 <div class=
"prop-value">
2730 <p>The file to upload.
</p>
2735 <div class=
"doc-examples"></div>
2737 <div class=
"doc-row">
2738 <div class=
"doc-copy">
2739 <section class=
"swagger-responses">
2740 <div class=
"prop-row prop-group">
2741 <div class=
"prop-name">
2742 <div class=
"prop-title">200 OK
</div>
2743 <div class=
"prop-ref">
2745 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
2748 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2750 <div class=
"prop-value">
2751 <p>successful operation
</p>
2756 <div class=
"doc-examples">
2757 <h5>Response Content-Types:
2758 <span>application/json
</span>
2761 <h5>Response Example
2762 <span>(
200 OK)
</span>
2764 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2765 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2766 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2767 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2774 <div class=
"doc-row">
2775 <div class=
"doc-copy">
2776 <section class=
"swagger-request-security">
2777 <table class=
"table">
2780 <th class=
"swagger-request-security-schema"></th>
2781 <th class=
"swagger-request-security-scopes"></th>
2787 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2797 <h1 id=
"tag-Video" class=
"swagger-summary-tag" data-traverse-target=
"tag-Video">Video
</h1>
2798 <div id=
"operation--videos-get" class=
"operation panel" data-traverse-target=
"operation--videos-get">
2799 <!-- <section class="operation-tags row"> -->
2800 <!-- <div class="doc-copy"> -->
2801 <div class=
"operation-tags">
2802 <a class=
"label" href=
"#tag-Video">Video
</a>
2807 <h2 class=
"operation-title">
2808 <span class=
"operation-name">
2809 <span class=
"operation-name">GET
</span>
2810 <span class=
"operation-path">/videos
</span>
2813 <div class=
"doc-row">
2814 <div class=
"doc-copy">
2815 <section class=
"swagger-request-params">
2816 <div class=
"prop-row prop-group">
2817 <div class=
"prop-name">
2818 <div class=
"prop-title">start
</div>
2819 <div class=
"prop-subtitle"> in query
</div>
2820 <div class=
"prop-subtitle">
2821 <span class=
"json-property-type">number
</span>
2822 <span class=
"json-property-range" title=
"Value limits"></span>
2825 <div class=
"prop-value">
2826 <p>starting page
</p>
2829 <div class=
"prop-row prop-group">
2830 <div class=
"prop-name">
2831 <div class=
"prop-title">stop
</div>
2832 <div class=
"prop-subtitle"> in query
</div>
2833 <div class=
"prop-subtitle">
2834 <span class=
"json-property-type">number
</span>
2835 <span class=
"json-property-range" title=
"Value limits"></span>
2838 <div class=
"prop-value">
2839 <p>stopping page
</p>
2842 <div class=
"prop-row prop-group">
2843 <div class=
"prop-name">
2844 <div class=
"prop-title">sort
</div>
2845 <div class=
"prop-subtitle"> in query
</div>
2846 <div class=
"prop-subtitle">
2847 <span class=
"json-property-type">number
</span>
2848 <span class=
"json-property-range" title=
"Value limits"></span>
2851 <div class=
"prop-value">
2857 <div class=
"doc-examples"></div>
2859 <div class=
"doc-row">
2860 <div class=
"doc-copy">
2861 <section class=
"swagger-responses">
2862 <div class=
"prop-row prop-group">
2863 <div class=
"prop-name">
2864 <div class=
"prop-title">200 OK
</div>
2865 <div class=
"prop-ref">
2866 <span class=
"json-schema-ref-array">
2867 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2870 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2872 <div class=
"prop-value">
2873 <p>successful operation
</p>
2876 <div class=
"prop-row prop-inner">
2877 <div class=
"prop-name">type
</div>
2878 <div class=
"prop-value">
2879 <span class=
"json-property-type">
2880 <span class=
"json-schema-ref-array">
2881 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2884 <span class=
"json-property-range" title=
"Value limits"></span>
2889 <div class=
"doc-examples">
2890 <h5>Response Content-Types:
2891 <span>application/json
</span>
2894 <h5>Response Example
2895 <span>(
200 OK)
</span>
2897 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2899 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2900 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2901 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2902 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2903 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2904 <span class=
"hljs-attr">"category
"</span>: {
2905 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2906 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2908 <span class=
"hljs-attr">"licence
"</span>: {
2909 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2910 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2912 <span class=
"hljs-attr">"language
"</span>: {
2913 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2914 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2916 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
2917 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2918 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2919 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2920 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2921 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2922 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2923 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2924 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2925 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2926 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2927 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2928 <span class=
"hljs-attr">"account
"</span>: {
2929 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2930 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2931 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2932 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2933 <span class=
"hljs-attr">"avatar
"</span>: {
2934 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2935 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2936 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2947 <div id=
"operation--videos-categories-get" class=
"operation panel" data-traverse-target=
"operation--videos-categories-get">
2948 <!-- <section class="operation-tags row"> -->
2949 <!-- <div class="doc-copy"> -->
2950 <div class=
"operation-tags">
2951 <a class=
"label" href=
"#tag-Video">Video
</a>
2956 <h2 class=
"operation-title">
2957 <span class=
"operation-name">
2958 <span class=
"operation-name">GET
</span>
2959 <span class=
"operation-path">/videos/categories
</span>
2962 <div class=
"doc-row">
2963 <div class=
"doc-copy"> </div>
2964 <div class=
"doc-examples"></div>
2966 <div class=
"doc-row">
2967 <div class=
"doc-copy">
2968 <section class=
"swagger-responses">
2969 <div class=
"prop-row prop-group">
2970 <div class=
"prop-name">
2971 <div class=
"prop-title">200 OK
</div>
2972 <div class=
"prop-ref"></div>
2973 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2975 <div class=
"prop-value">
2976 <p>successful operation
</p>
2979 <div class=
"prop-row prop-inner">
2980 <div class=
"prop-name">type
</div>
2981 <div class=
"prop-value">
2982 <span class=
"json-property-type">string[]
</span>
2983 <span class=
"json-property-range" title=
"Value limits"></span>
2988 <div class=
"doc-examples">
2989 <h5>Response Content-Types:
2990 <span>application/json
</span>
2993 <h5>Response Example
2994 <span>(
200 OK)
</span>
2996 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2997 <span class=
"hljs-string">"string
"</span>
3005 <div id=
"operation--videos-licences-get" class=
"operation panel" data-traverse-target=
"operation--videos-licences-get">
3006 <!-- <section class="operation-tags row"> -->
3007 <!-- <div class="doc-copy"> -->
3008 <div class=
"operation-tags">
3009 <a class=
"label" href=
"#tag-Video">Video
</a>
3014 <h2 class=
"operation-title">
3015 <span class=
"operation-name">
3016 <span class=
"operation-name">GET
</span>
3017 <span class=
"operation-path">/videos/licences
</span>
3020 <div class=
"doc-row">
3021 <div class=
"doc-copy"> </div>
3022 <div class=
"doc-examples"></div>
3024 <div class=
"doc-row">
3025 <div class=
"doc-copy">
3026 <section class=
"swagger-responses">
3027 <div class=
"prop-row prop-group">
3028 <div class=
"prop-name">
3029 <div class=
"prop-title">200 OK
</div>
3030 <div class=
"prop-ref"></div>
3031 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3033 <div class=
"prop-value">
3034 <p>successful operation
</p>
3037 <div class=
"prop-row prop-inner">
3038 <div class=
"prop-name">type
</div>
3039 <div class=
"prop-value">
3040 <span class=
"json-property-type">string[]
</span>
3041 <span class=
"json-property-range" title=
"Value limits"></span>
3046 <div class=
"doc-examples">
3047 <h5>Response Content-Types:
3048 <span>application/json
</span>
3051 <h5>Response Example
3052 <span>(
200 OK)
</span>
3054 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3055 <span class=
"hljs-string">"string
"</span>
3063 <div id=
"operation--videos-languages-get" class=
"operation panel" data-traverse-target=
"operation--videos-languages-get">
3064 <!-- <section class="operation-tags row"> -->
3065 <!-- <div class="doc-copy"> -->
3066 <div class=
"operation-tags">
3067 <a class=
"label" href=
"#tag-Video">Video
</a>
3072 <h2 class=
"operation-title">
3073 <span class=
"operation-name">
3074 <span class=
"operation-name">GET
</span>
3075 <span class=
"operation-path">/videos/languages
</span>
3078 <div class=
"doc-row">
3079 <div class=
"doc-copy"> </div>
3080 <div class=
"doc-examples"></div>
3082 <div class=
"doc-row">
3083 <div class=
"doc-copy">
3084 <section class=
"swagger-responses">
3085 <div class=
"prop-row prop-group">
3086 <div class=
"prop-name">
3087 <div class=
"prop-title">200 OK
</div>
3088 <div class=
"prop-ref"></div>
3089 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3091 <div class=
"prop-value">
3092 <p>successful operation
</p>
3095 <div class=
"prop-row prop-inner">
3096 <div class=
"prop-name">type
</div>
3097 <div class=
"prop-value">
3098 <span class=
"json-property-type">string[]
</span>
3099 <span class=
"json-property-range" title=
"Value limits"></span>
3104 <div class=
"doc-examples">
3105 <h5>Response Content-Types:
3106 <span>application/json
</span>
3109 <h5>Response Example
3110 <span>(
200 OK)
</span>
3112 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3113 <span class=
"hljs-string">"string
"</span>
3121 <div id=
"operation--videos-privacies-get" class=
"operation panel" data-traverse-target=
"operation--videos-privacies-get">
3122 <!-- <section class="operation-tags row"> -->
3123 <!-- <div class="doc-copy"> -->
3124 <div class=
"operation-tags">
3125 <a class=
"label" href=
"#tag-Video">Video
</a>
3130 <h2 class=
"operation-title">
3131 <span class=
"operation-name">
3132 <span class=
"operation-name">GET
</span>
3133 <span class=
"operation-path">/videos/privacies
</span>
3136 <div class=
"doc-row">
3137 <div class=
"doc-copy"> </div>
3138 <div class=
"doc-examples"></div>
3140 <div class=
"doc-row">
3141 <div class=
"doc-copy">
3142 <section class=
"swagger-responses">
3143 <div class=
"prop-row prop-group">
3144 <div class=
"prop-name">
3145 <div class=
"prop-title">200 OK
</div>
3146 <div class=
"prop-ref"></div>
3147 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3149 <div class=
"prop-value">
3150 <p>successful operation
</p>
3153 <div class=
"prop-row prop-inner">
3154 <div class=
"prop-name">type
</div>
3155 <div class=
"prop-value">
3156 <span class=
"json-property-type">string[]
</span>
3157 <span class=
"json-property-range" title=
"Value limits"></span>
3162 <div class=
"doc-examples">
3163 <h5>Response Content-Types:
3164 <span>application/json
</span>
3167 <h5>Response Example
3168 <span>(
200 OK)
</span>
3170 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3171 <span class=
"hljs-string">"string
"</span>
3179 <div id=
"operation--videos-search-get" class=
"operation panel" data-traverse-target=
"operation--videos-search-get">
3180 <!-- <section class="operation-tags row"> -->
3181 <!-- <div class="doc-copy"> -->
3182 <div class=
"operation-tags">
3183 <a class=
"label" href=
"#tag-Video">Video
</a>
3188 <h2 class=
"operation-title">
3189 <span class=
"operation-name">
3190 <span class=
"operation-name">GET
</span>
3191 <span class=
"operation-path">/videos/search
</span>
3194 <div class=
"doc-row">
3195 <div class=
"doc-copy">
3196 <section class=
"swagger-request-params">
3197 <div class=
"prop-row prop-group">
3198 <div class=
"prop-name">
3199 <div class=
"prop-title">start
</div>
3200 <div class=
"prop-subtitle"> in query
</div>
3201 <div class=
"prop-subtitle">
3202 <span class=
"json-property-type">number
</span>
3203 <span class=
"json-property-range" title=
"Value limits"></span>
3206 <div class=
"prop-value">
3207 <p>starting page
</p>
3210 <div class=
"prop-row prop-group">
3211 <div class=
"prop-name">
3212 <div class=
"prop-title">stop
</div>
3213 <div class=
"prop-subtitle"> in query
</div>
3214 <div class=
"prop-subtitle">
3215 <span class=
"json-property-type">number
</span>
3216 <span class=
"json-property-range" title=
"Value limits"></span>
3219 <div class=
"prop-value">
3220 <p>stopping page
</p>
3223 <div class=
"prop-row prop-group">
3224 <div class=
"prop-name">
3225 <div class=
"prop-title">sort
</div>
3226 <div class=
"prop-subtitle"> in query
</div>
3227 <div class=
"prop-subtitle">
3228 <span class=
"json-property-type">number
</span>
3229 <span class=
"json-property-range" title=
"Value limits"></span>
3232 <div class=
"prop-value">
3238 <div class=
"doc-examples"></div>
3240 <div class=
"doc-row">
3241 <div class=
"doc-copy">
3242 <section class=
"swagger-responses">
3243 <div class=
"prop-row prop-group">
3244 <div class=
"prop-name">
3245 <div class=
"prop-title">200 OK
</div>
3246 <div class=
"prop-ref">
3247 <span class=
"json-schema-ref-array">
3248 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3251 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3253 <div class=
"prop-value">
3254 <p>successful operation
</p>
3257 <div class=
"prop-row prop-inner">
3258 <div class=
"prop-name">type
</div>
3259 <div class=
"prop-value">
3260 <span class=
"json-property-type">
3261 <span class=
"json-schema-ref-array">
3262 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3265 <span class=
"json-property-range" title=
"Value limits"></span>
3270 <div class=
"doc-examples">
3271 <h5>Response Content-Types:
3272 <span>application/json
</span>
3275 <h5>Response Example
3276 <span>(
200 OK)
</span>
3278 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3280 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3281 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3282 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3283 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3284 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3285 <span class=
"hljs-attr">"category
"</span>: {
3286 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3287 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3289 <span class=
"hljs-attr">"licence
"</span>: {
3290 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3291 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3293 <span class=
"hljs-attr">"language
"</span>: {
3294 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
3295 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3297 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3298 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3299 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3300 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3301 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3302 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3303 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3304 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3305 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3306 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3307 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3308 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3309 <span class=
"hljs-attr">"account
"</span>: {
3310 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3311 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3312 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3313 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3314 <span class=
"hljs-attr">"avatar
"</span>: {
3315 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3316 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3317 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3328 <div id=
"operation--videos--id--put" class=
"operation panel" data-traverse-target=
"operation--videos--id--put">
3329 <!-- <section class="operation-tags row"> -->
3330 <!-- <div class="doc-copy"> -->
3331 <div class=
"operation-tags">
3332 <a class=
"label" href=
"#tag-Video">Video
</a>
3337 <h2 class=
"operation-title">
3338 <span class=
"operation-name">
3339 <span class=
"operation-name">PUT
</span>
3340 <span class=
"operation-path">/videos/{id}
</span>
3343 <div class=
"doc-row">
3344 <div class=
"doc-copy">
3345 <section class=
"swagger-request-params">
3346 <div class=
"prop-row prop-group">
3347 <div class=
"prop-name">
3348 <div class=
"prop-title">id
</div>
3349 <span class=
"json-property-required"></span>
3350 <div class=
"prop-subtitle"> in path
</div>
3351 <div class=
"prop-subtitle">
3352 <span class=
"json-property-type">string
</span>
3353 <span class=
"json-property-range" title=
"Value limits"></span>
3356 <div class=
"prop-value">
3360 <div class=
"prop-row prop-group">
3361 <div class=
"prop-name">
3362 <div class=
"prop-title">thumbnailfile
</div>
3363 <div class=
"prop-subtitle"> in formData
</div>
3364 <div class=
"prop-subtitle">
3365 <span class=
"json-property-type">file
</span>
3366 <span class=
"json-property-range" title=
"Value limits"></span>
3369 <div class=
"prop-value">
3370 <p>Video thumbnail file
</p>
3373 <div class=
"prop-row prop-group">
3374 <div class=
"prop-name">
3375 <div class=
"prop-title">previewfile
</div>
3376 <div class=
"prop-subtitle"> in formData
</div>
3377 <div class=
"prop-subtitle">
3378 <span class=
"json-property-type">file
</span>
3379 <span class=
"json-property-range" title=
"Value limits"></span>
3382 <div class=
"prop-value">
3383 <p>Video preview file
</p>
3386 <div class=
"prop-row prop-group">
3387 <div class=
"prop-name">
3388 <div class=
"prop-title">category
</div>
3389 <div class=
"prop-subtitle"> in formData
</div>
3390 <div class=
"prop-subtitle">
3391 <span class=
"json-property-type">number
</span>
3392 <span class=
"json-property-range" title=
"Value limits"></span>
3395 <div class=
"prop-value">
3396 <p>Video category
</p>
3399 <div class=
"prop-row prop-group">
3400 <div class=
"prop-name">
3401 <div class=
"prop-title">licence
</div>
3402 <div class=
"prop-subtitle"> in formData
</div>
3403 <div class=
"prop-subtitle">
3404 <span class=
"json-property-type">number
</span>
3405 <span class=
"json-property-range" title=
"Value limits"></span>
3408 <div class=
"prop-value">
3409 <p>Video licence
</p>
3412 <div class=
"prop-row prop-group">
3413 <div class=
"prop-name">
3414 <div class=
"prop-title">language
</div>
3415 <div class=
"prop-subtitle"> in formData
</div>
3416 <div class=
"prop-subtitle">
3417 <span class=
"json-property-type">string
</span>
3418 <span class=
"json-property-range" title=
"Value limits"></span>
3421 <div class=
"prop-value">
3422 <p>Video language
</p>
3425 <div class=
"prop-row prop-group">
3426 <div class=
"prop-name">
3427 <div class=
"prop-title">description
</div>
3428 <div class=
"prop-subtitle"> in formData
</div>
3429 <div class=
"prop-subtitle">
3430 <span class=
"json-property-type">string
</span>
3431 <span class=
"json-property-range" title=
"Value limits"></span>
3434 <div class=
"prop-value">
3435 <p>Video description
</p>
3438 <div class=
"prop-row prop-group">
3439 <div class=
"prop-name">
3440 <div class=
"prop-title">waitTranscoding
</div>
3441 <div class=
"prop-subtitle"> in formData
</div>
3442 <div class=
"prop-subtitle">
3443 <span class=
"json-property-type">boolean
</span>
3444 <span class=
"json-property-range" title=
"Value limits"></span>
3447 <div class=
"prop-value">
3448 <p>Whether or not we wait transcoding before publish the video
</p>
3451 <div class=
"prop-row prop-group">
3452 <div class=
"prop-name">
3453 <div class=
"prop-title">support
</div>
3454 <div class=
"prop-subtitle"> in formData
</div>
3455 <div class=
"prop-subtitle">
3456 <span class=
"json-property-type">string
</span>
3457 <span class=
"json-property-range" title=
"Value limits"></span>
3460 <div class=
"prop-value">
3461 <p>Text describing how to support the video uploader
</p>
3464 <div class=
"prop-row prop-group">
3465 <div class=
"prop-name">
3466 <div class=
"prop-title">nsfw
</div>
3467 <div class=
"prop-subtitle"> in formData
</div>
3468 <div class=
"prop-subtitle">
3469 <span class=
"json-property-type">boolean
</span>
3470 <span class=
"json-property-range" title=
"Value limits"></span>
3473 <div class=
"prop-value">
3474 <p>Whether or not this video contains sensitive content
</p>
3477 <div class=
"prop-row prop-group">
3478 <div class=
"prop-name">
3479 <div class=
"prop-title">name
</div>
3480 <div class=
"prop-subtitle"> in formData
</div>
3481 <div class=
"prop-subtitle">
3482 <span class=
"json-property-type">string
</span>
3483 <span class=
"json-property-range" title=
"Value limits"></span>
3486 <div class=
"prop-value">
3490 <div class=
"prop-row prop-group">
3491 <div class=
"prop-name">
3492 <div class=
"prop-title">tags
</div>
3493 <div class=
"prop-subtitle"> in formData
</div>
3494 <div class=
"prop-subtitle">
3495 <span class=
"json-property-type">string[]
</span>
3496 <span class=
"json-property-range" title=
"Value limits"></span>
3499 <div class=
"prop-value">
3503 <div class=
"prop-row prop-group">
3504 <div class=
"prop-name">
3505 <div class=
"prop-title">commentsEnabled
</div>
3506 <div class=
"prop-subtitle"> in formData
</div>
3507 <div class=
"prop-subtitle">
3508 <span class=
"json-property-type">boolean
</span>
3509 <span class=
"json-property-range" title=
"Value limits"></span>
3512 <div class=
"prop-value">
3513 <p>Enable or disable comments for this video
</p>
3516 <div class=
"prop-row prop-group">
3517 <div class=
"prop-name">
3518 <div class=
"prop-title">privacy
</div>
3519 <div class=
"prop-subtitle"> in formData
</div>
3520 <div class=
"prop-subtitle">
3521 <span class=
"json-property-type">string
</span>
3522 <span class=
"json-property-enum" title=
"Possible values">
3523 <span class=
"json-property-enum-item">Public
</span>,
3524 <span class=
"json-property-enum-item">Unlisted
</span>
3526 <span class=
"json-property-range" title=
"Value limits"></span>
3529 <div class=
"prop-value">
3530 <p>Video privacy
</p>
3535 <div class=
"doc-examples"></div>
3537 <div class=
"doc-row">
3538 <div class=
"doc-copy">
3539 <section class=
"swagger-responses">
3540 <div class=
"prop-row prop-group">
3541 <div class=
"prop-name">
3542 <div class=
"prop-title">200 OK
</div>
3543 <div class=
"prop-ref">
3545 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3548 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3550 <div class=
"prop-value">
3551 <p>successful operation
</p>
3556 <div class=
"doc-examples">
3557 <h5>Response Content-Types:
3558 <span>application/json
</span>
3561 <h5>Response Example
3562 <span>(
200 OK)
</span>
3564 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3565 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3566 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3567 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3568 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3569 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3570 <span class=
"hljs-attr">"category
"</span>: {
3571 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3572 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3574 <span class=
"hljs-attr">"licence
"</span>: {
3575 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3576 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3578 <span class=
"hljs-attr">"language
"</span>: {
3579 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
3580 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3582 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3583 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3584 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3585 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3586 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3587 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3588 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3589 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3590 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3591 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3592 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3593 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3594 <span class=
"hljs-attr">"account
"</span>: {
3595 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3596 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3597 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3598 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3599 <span class=
"hljs-attr">"avatar
"</span>: {
3600 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3601 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3602 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3611 <div class=
"doc-row">
3612 <div class=
"doc-copy">
3613 <section class=
"swagger-request-security">
3614 <table class=
"table">
3617 <th class=
"swagger-request-security-schema"></th>
3618 <th class=
"swagger-request-security-scopes"></th>
3624 <a href=
"#security-definition-OAuth2">OAuth2
</a>
3634 <div id=
"operation--videos--id--get" class=
"operation panel" data-traverse-target=
"operation--videos--id--get">
3635 <!-- <section class="operation-tags row"> -->
3636 <!-- <div class="doc-copy"> -->
3637 <div class=
"operation-tags">
3638 <a class=
"label" href=
"#tag-Video">Video
</a>
3643 <h2 class=
"operation-title">
3644 <span class=
"operation-name">
3645 <span class=
"operation-name">GET
</span>
3646 <span class=
"operation-path">/videos/{id}
</span>
3649 <div class=
"doc-row">
3650 <div class=
"doc-copy">
3651 <section class=
"swagger-request-params">
3652 <div class=
"prop-row prop-group">
3653 <div class=
"prop-name">
3654 <div class=
"prop-title">id
</div>
3655 <span class=
"json-property-required"></span>
3656 <div class=
"prop-subtitle"> in path
</div>
3657 <div class=
"prop-subtitle">
3658 <span class=
"json-property-type">string
</span>
3659 <span class=
"json-property-range" title=
"Value limits"></span>
3662 <div class=
"prop-value">
3663 <p>The video id
</p>
3668 <div class=
"doc-examples"></div>
3670 <div class=
"doc-row">
3671 <div class=
"doc-copy">
3672 <section class=
"swagger-responses">
3673 <div class=
"prop-row prop-group">
3674 <div class=
"prop-name">
3675 <div class=
"prop-title">200 OK
</div>
3676 <div class=
"prop-ref">
3678 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3681 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3683 <div class=
"prop-value">
3684 <p>successful operation
</p>
3689 <div class=
"doc-examples">
3690 <h5>Response Content-Types:
3691 <span>application/json
</span>
3694 <h5>Response Example
3695 <span>(
200 OK)
</span>
3697 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3698 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3699 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3700 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3701 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3702 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3703 <span class=
"hljs-attr">"category
"</span>: {
3704 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3705 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3707 <span class=
"hljs-attr">"licence
"</span>: {
3708 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3709 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3711 <span class=
"hljs-attr">"language
"</span>: {
3712 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
3713 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3715 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3716 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3717 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3718 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3719 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3720 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3721 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3722 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3723 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3724 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3725 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3726 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3727 <span class=
"hljs-attr">"account
"</span>: {
3728 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3729 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3730 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3731 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3732 <span class=
"hljs-attr">"avatar
"</span>: {
3733 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3734 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3735 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3745 <div id=
"operation--videos--id--delete" class=
"operation panel" data-traverse-target=
"operation--videos--id--delete">
3746 <!-- <section class="operation-tags row"> -->
3747 <!-- <div class="doc-copy"> -->
3748 <div class=
"operation-tags">
3749 <a class=
"label" href=
"#tag-Video">Video
</a>
3754 <h2 class=
"operation-title">
3755 <span class=
"operation-name">
3756 <span class=
"operation-name">DELETE
</span>
3757 <span class=
"operation-path">/videos/{id}
</span>
3760 <div class=
"doc-row">
3761 <div class=
"doc-copy">
3762 <section class=
"swagger-request-params">
3763 <div class=
"prop-row prop-group">
3764 <div class=
"prop-name">
3765 <div class=
"prop-title">id
</div>
3766 <span class=
"json-property-required"></span>
3767 <div class=
"prop-subtitle"> in path
</div>
3768 <div class=
"prop-subtitle">
3769 <span class=
"json-property-type">string
</span>
3770 <span class=
"json-property-range" title=
"Value limits"></span>
3773 <div class=
"prop-value">
3774 <p>The video id
</p>
3779 <div class=
"doc-examples"></div>
3781 <div class=
"doc-row">
3782 <div class=
"doc-copy">
3783 <section class=
"swagger-responses">
3784 <div class=
"prop-row prop-group">
3785 <div class=
"prop-name">
3786 <div class=
"prop-title">204 No Content
</div>
3788 <div class=
"prop-value">
3789 <p>successful operation
</p>
3794 <div class=
"doc-examples">
3795 <h5>Response Content-Types:
3796 <span>application/json
</span>
3800 <div class=
"doc-row">
3801 <div class=
"doc-copy">
3802 <section class=
"swagger-request-security">
3803 <table class=
"table">
3806 <th class=
"swagger-request-security-schema"></th>
3807 <th class=
"swagger-request-security-scopes"></th>
3813 <a href=
"#security-definition-OAuth2">OAuth2
</a>
3823 <div id=
"operation--videos--id--description-get" class=
"operation panel" data-traverse-target=
"operation--videos--id--description-get">
3824 <!-- <section class="operation-tags row"> -->
3825 <!-- <div class="doc-copy"> -->
3826 <div class=
"operation-tags">
3827 <a class=
"label" href=
"#tag-Video">Video
</a>
3832 <h2 class=
"operation-title">
3833 <span class=
"operation-name">
3834 <span class=
"operation-name">GET
</span>
3835 <span class=
"operation-path">/videos/{id}/description
</span>
3838 <div class=
"doc-row">
3839 <div class=
"doc-copy">
3840 <section class=
"swagger-request-params">
3841 <div class=
"prop-row prop-group">
3842 <div class=
"prop-name">
3843 <div class=
"prop-title">id
</div>
3844 <span class=
"json-property-required"></span>
3845 <div class=
"prop-subtitle"> in path
</div>
3846 <div class=
"prop-subtitle">
3847 <span class=
"json-property-type">string
</span>
3848 <span class=
"json-property-range" title=
"Value limits"></span>
3851 <div class=
"prop-value">
3852 <p>The video id
</p>
3857 <div class=
"doc-examples"></div>
3859 <div class=
"doc-row">
3860 <div class=
"doc-copy">
3861 <section class=
"swagger-responses">
3862 <div class=
"prop-row prop-group">
3863 <div class=
"prop-name">
3864 <div class=
"prop-title">200 OK
</div>
3865 <div class=
"prop-ref"></div>
3866 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3868 <div class=
"prop-value">
3869 <p>successful operation
</p>
3872 <div class=
"prop-row prop-inner">
3873 <div class=
"prop-name">type
</div>
3874 <div class=
"prop-value">
3875 <span class=
"json-property-type">string
</span>
3876 <span class=
"json-property-range" title=
"Value limits"></span>
3881 <div class=
"doc-examples">
3882 <h5>Response Content-Types:
3883 <span>application/json
</span>
3886 <h5>Response Example
3887 <span>(
200 OK)
</span>
3889 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json"><span class=
"hljs-string">"string
"</span>
3896 <div id=
"operation--videos--id--views-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--views-post">
3897 <!-- <section class="operation-tags row"> -->
3898 <!-- <div class="doc-copy"> -->
3899 <div class=
"operation-tags">
3900 <a class=
"label" href=
"#tag-Video">Video
</a>
3905 <h2 class=
"operation-title">
3906 <span class=
"operation-name">
3907 <span class=
"operation-name">POST
</span>
3908 <span class=
"operation-path">/videos/{id}/views
</span>
3911 <div class=
"doc-row">
3912 <div class=
"doc-copy">
3913 <section class=
"swagger-request-params">
3914 <div class=
"prop-row prop-group">
3915 <div class=
"prop-name">
3916 <div class=
"prop-title">id
</div>
3917 <span class=
"json-property-required"></span>
3918 <div class=
"prop-subtitle"> in path
</div>
3919 <div class=
"prop-subtitle">
3920 <span class=
"json-property-type">string
</span>
3921 <span class=
"json-property-range" title=
"Value limits"></span>
3924 <div class=
"prop-value">
3925 <p>The video id
</p>
3930 <div class=
"doc-examples"></div>
3932 <div class=
"doc-row">
3933 <div class=
"doc-copy">
3934 <section class=
"swagger-responses">
3935 <div class=
"prop-row prop-group">
3936 <div class=
"prop-name">
3937 <div class=
"prop-title">204 No Content
</div>
3939 <div class=
"prop-value">
3940 <p>successful operation
</p>
3945 <div class=
"doc-examples">
3946 <h5>Response Content-Types:
3947 <span>application/json
</span>
3952 <div id=
"operation--videos-upload-post" class=
"operation panel" data-traverse-target=
"operation--videos-upload-post">
3953 <!-- <section class="operation-tags row"> -->
3954 <!-- <div class="doc-copy"> -->
3955 <div class=
"operation-tags">
3956 <a class=
"label" href=
"#tag-Video">Video
</a>
3961 <h2 class=
"operation-title">
3962 <span class=
"operation-name">
3963 <span class=
"operation-name">POST
</span>
3964 <span class=
"operation-path">/videos/upload
</span>
3967 <div class=
"doc-row">
3968 <div class=
"doc-copy">
3969 <section class=
"swagger-request-params">
3970 <div class=
"prop-row prop-group">
3971 <div class=
"prop-name">
3972 <div class=
"prop-title">videofile
</div>
3973 <span class=
"json-property-required"></span>
3974 <div class=
"prop-subtitle"> in formData
</div>
3975 <div class=
"prop-subtitle">
3976 <span class=
"json-property-type">file
</span>
3977 <span class=
"json-property-range" title=
"Value limits"></span>
3980 <div class=
"prop-value">
3984 <div class=
"prop-row prop-group">
3985 <div class=
"prop-name">
3986 <div class=
"prop-title">thumbnailfile
</div>
3987 <span class=
"json-property-required"></span>
3988 <div class=
"prop-subtitle"> in formData
</div>
3989 <div class=
"prop-subtitle">
3990 <span class=
"json-property-type">file
</span>
3991 <span class=
"json-property-range" title=
"Value limits"></span>
3994 <div class=
"prop-value">
3995 <p>Video thumbnail file
</p>
3998 <div class=
"prop-row prop-group">
3999 <div class=
"prop-name">
4000 <div class=
"prop-title">previewfile
</div>
4001 <span class=
"json-property-required"></span>
4002 <div class=
"prop-subtitle"> in formData
</div>
4003 <div class=
"prop-subtitle">
4004 <span class=
"json-property-type">file
</span>
4005 <span class=
"json-property-range" title=
"Value limits"></span>
4008 <div class=
"prop-value">
4009 <p>Video preview file
</p>
4012 <div class=
"prop-row prop-group">
4013 <div class=
"prop-name">
4014 <div class=
"prop-title">category
</div>
4015 <div class=
"prop-subtitle"> in formData
</div>
4016 <div class=
"prop-subtitle">
4017 <span class=
"json-property-type">number
</span>
4018 <span class=
"json-property-range" title=
"Value limits"></span>
4021 <div class=
"prop-value">
4022 <p>Video category
</p>
4025 <div class=
"prop-row prop-group">
4026 <div class=
"prop-name">
4027 <div class=
"prop-title">waitTranscoding
</div>
4028 <div class=
"prop-subtitle"> in formData
</div>
4029 <div class=
"prop-subtitle">
4030 <span class=
"json-property-type">boolean
</span>
4031 <span class=
"json-property-range" title=
"Value limits"></span>
4034 <div class=
"prop-value">
4035 <p>Whether or not we wait transcoding before publish the video
</p>
4038 <div class=
"prop-row prop-group">
4039 <div class=
"prop-name">
4040 <div class=
"prop-title">licence
</div>
4041 <div class=
"prop-subtitle"> in formData
</div>
4042 <div class=
"prop-subtitle">
4043 <span class=
"json-property-type">number
</span>
4044 <span class=
"json-property-range" title=
"Value limits"></span>
4047 <div class=
"prop-value">
4048 <p>Video licence
</p>
4051 <div class=
"prop-row prop-group">
4052 <div class=
"prop-name">
4053 <div class=
"prop-title">language
</div>
4054 <div class=
"prop-subtitle"> in formData
</div>
4055 <div class=
"prop-subtitle">
4056 <span class=
"json-property-type">string
</span>
4057 <span class=
"json-property-range" title=
"Value limits"></span>
4060 <div class=
"prop-value">
4061 <p>Video language
</p>
4064 <div class=
"prop-row prop-group">
4065 <div class=
"prop-name">
4066 <div class=
"prop-title">description
</div>
4067 <div class=
"prop-subtitle"> in formData
</div>
4068 <div class=
"prop-subtitle">
4069 <span class=
"json-property-type">string
</span>
4070 <span class=
"json-property-range" title=
"Value limits"></span>
4073 <div class=
"prop-value">
4074 <p>Video description
</p>
4077 <div class=
"prop-row prop-group">
4078 <div class=
"prop-name">
4079 <div class=
"prop-title">support
</div>
4080 <div class=
"prop-subtitle"> in formData
</div>
4081 <div class=
"prop-subtitle">
4082 <span class=
"json-property-type">string
</span>
4083 <span class=
"json-property-range" title=
"Value limits"></span>
4086 <div class=
"prop-value">
4087 <p>Text describing how to support the video uploader
</p>
4090 <div class=
"prop-row prop-group">
4091 <div class=
"prop-name">
4092 <div class=
"prop-title">channelId
</div>
4093 <span class=
"json-property-required"></span>
4094 <div class=
"prop-subtitle"> in formData
</div>
4095 <div class=
"prop-subtitle">
4096 <span class=
"json-property-type">number
</span>
4097 <span class=
"json-property-range" title=
"Value limits"></span>
4100 <div class=
"prop-value">
4101 <p>Channel id that will contain this video
</p>
4104 <div class=
"prop-row prop-group">
4105 <div class=
"prop-name">
4106 <div class=
"prop-title">nsfw
</div>
4107 <span class=
"json-property-required"></span>
4108 <div class=
"prop-subtitle"> in formData
</div>
4109 <div class=
"prop-subtitle">
4110 <span class=
"json-property-type">boolean
</span>
4111 <span class=
"json-property-range" title=
"Value limits"></span>
4114 <div class=
"prop-value">
4115 <p>Whether or not this video contains sensitive content
</p>
4118 <div class=
"prop-row prop-group">
4119 <div class=
"prop-name">
4120 <div class=
"prop-title">name
</div>
4121 <span class=
"json-property-required"></span>
4122 <div class=
"prop-subtitle"> in formData
</div>
4123 <div class=
"prop-subtitle">
4124 <span class=
"json-property-type">string
</span>
4125 <span class=
"json-property-range" title=
"Value limits"></span>
4128 <div class=
"prop-value">
4132 <div class=
"prop-row prop-group">
4133 <div class=
"prop-name">
4134 <div class=
"prop-title">tags
</div>
4135 <div class=
"prop-subtitle"> in formData
</div>
4136 <div class=
"prop-subtitle">
4137 <span class=
"json-property-type">string[]
</span>
4138 <span class=
"json-property-range" title=
"Value limits"></span>
4141 <div class=
"prop-value">
4145 <div class=
"prop-row prop-group">
4146 <div class=
"prop-name">
4147 <div class=
"prop-title">commentsEnabled
</div>
4148 <div class=
"prop-subtitle"> in formData
</div>
4149 <div class=
"prop-subtitle">
4150 <span class=
"json-property-type">boolean
</span>
4151 <span class=
"json-property-range" title=
"Value limits"></span>
4154 <div class=
"prop-value">
4155 <p>Enable or disable comments for this video
</p>
4158 <div class=
"prop-row prop-group">
4159 <div class=
"prop-name">
4160 <div class=
"prop-title">privacy
</div>
4161 <span class=
"json-property-required"></span>
4162 <div class=
"prop-subtitle"> in formData
</div>
4163 <div class=
"prop-subtitle">
4164 <span class=
"json-property-type">string
</span>
4165 <span class=
"json-property-enum" title=
"Possible values">
4166 <span class=
"json-property-enum-item">Public
</span>,
4167 <span class=
"json-property-enum-item">Unlisted
</span>,
4168 <span class=
"json-property-enum-item">Private
</span>
4170 <span class=
"json-property-range" title=
"Value limits"></span>
4173 <div class=
"prop-value">
4174 <p>Video privacy
</p>
4179 <div class=
"doc-examples"></div>
4181 <div class=
"doc-row">
4182 <div class=
"doc-copy">
4183 <section class=
"swagger-responses">
4184 <div class=
"prop-row prop-group">
4185 <div class=
"prop-name">
4186 <div class=
"prop-title">200 OK
</div>
4187 <div class=
"prop-ref">
4189 <a class=
"json-schema-ref" href=
"#/definitions/VideoUploadResponse">VideoUploadResponse
</a>
4192 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4194 <div class=
"prop-value">
4195 <p>successful operation
</p>
4200 <div class=
"doc-examples">
4201 <h5>Response Content-Types:
4202 <span>application/json
</span>
4205 <h5>Response Example
4206 <span>(
200 OK)
</span>
4208 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4209 <span class=
"hljs-attr">"video
"</span>: {
4210 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4211 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
4219 <div class=
"doc-row">
4220 <div class=
"doc-copy">
4221 <section class=
"swagger-request-security">
4222 <table class=
"table">
4225 <th class=
"swagger-request-security-schema"></th>
4226 <th class=
"swagger-request-security-scopes"></th>
4232 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4242 <h1 id=
"tag-VideoAbuse" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoAbuse">VideoAbuse
</h1>
4243 <div id=
"operation--videos-abuse-get" class=
"operation panel" data-traverse-target=
"operation--videos-abuse-get">
4244 <!-- <section class="operation-tags row"> -->
4245 <!-- <div class="doc-copy"> -->
4246 <div class=
"operation-tags">
4247 <a class=
"label" href=
"#tag-VideoAbuse">VideoAbuse
</a>
4252 <h2 class=
"operation-title">
4253 <span class=
"operation-name">
4254 <span class=
"operation-name">GET
</span>
4255 <span class=
"operation-path">/videos/abuse
</span>
4258 <div class=
"doc-row">
4259 <div class=
"doc-copy">
4260 <section class=
"swagger-request-params">
4261 <div class=
"prop-row prop-group">
4262 <div class=
"prop-name">
4263 <div class=
"prop-title">start
</div>
4264 <div class=
"prop-subtitle"> in query
</div>
4265 <div class=
"prop-subtitle">
4266 <span class=
"json-property-type">number
</span>
4267 <span class=
"json-property-range" title=
"Value limits"></span>
4270 <div class=
"prop-value">
4271 <p>starting page
</p>
4274 <div class=
"prop-row prop-group">
4275 <div class=
"prop-name">
4276 <div class=
"prop-title">stop
</div>
4277 <div class=
"prop-subtitle"> in query
</div>
4278 <div class=
"prop-subtitle">
4279 <span class=
"json-property-type">number
</span>
4280 <span class=
"json-property-range" title=
"Value limits"></span>
4283 <div class=
"prop-value">
4284 <p>stopping page
</p>
4287 <div class=
"prop-row prop-group">
4288 <div class=
"prop-name">
4289 <div class=
"prop-title">sort
</div>
4290 <div class=
"prop-subtitle"> in query
</div>
4291 <div class=
"prop-subtitle">
4292 <span class=
"json-property-type">number
</span>
4293 <span class=
"json-property-range" title=
"Value limits"></span>
4296 <div class=
"prop-value">
4302 <div class=
"doc-examples"></div>
4304 <div class=
"doc-row">
4305 <div class=
"doc-copy">
4306 <section class=
"swagger-responses">
4307 <div class=
"prop-row prop-group">
4308 <div class=
"prop-name">
4309 <div class=
"prop-title">200 OK
</div>
4310 <div class=
"prop-ref">
4311 <span class=
"json-schema-ref-array">
4312 <a class=
"json-schema-ref" href=
"#/definitions/VideoAbuse">VideoAbuse
</a>
4315 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4317 <div class=
"prop-value">
4318 <p>successful operation
</p>
4321 <div class=
"prop-row prop-inner">
4322 <div class=
"prop-name">type
</div>
4323 <div class=
"prop-value">
4324 <span class=
"json-property-type">
4325 <span class=
"json-schema-ref-array">
4326 <a class=
"json-schema-ref" href=
"#/definitions/VideoAbuse">VideoAbuse
</a>
4329 <span class=
"json-property-range" title=
"Value limits"></span>
4334 <div class=
"doc-examples">
4335 <h5>Response Content-Types:
4336 <span>application/json
</span>
4339 <h5>Response Example
4340 <span>(
200 OK)
</span>
4342 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4344 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4345 <span class=
"hljs-attr">"reason
"</span>:
<span class=
"hljs-string">"string
"</span>,
4346 <span class=
"hljs-attr">"reporterAccount
"</span>: {
4347 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4348 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4349 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4350 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4351 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4352 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4353 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4354 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4355 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4356 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4357 <span class=
"hljs-attr">"avatar
"</span>: {
4358 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4359 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4360 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4363 <span class=
"hljs-attr">"video
"</span>: {
4364 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4365 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4366 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4367 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>
4369 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4377 <div class=
"doc-row">
4378 <div class=
"doc-copy">
4379 <section class=
"swagger-request-security">
4380 <table class=
"table">
4383 <th class=
"swagger-request-security-schema"></th>
4384 <th class=
"swagger-request-security-scopes"></th>
4390 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4400 <div id=
"operation--videos--id--abuse-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--abuse-post">
4401 <!-- <section class="operation-tags row"> -->
4402 <!-- <div class="doc-copy"> -->
4403 <div class=
"operation-tags">
4404 <a class=
"label" href=
"#tag-VideoAbuse">VideoAbuse
</a>
4409 <h2 class=
"operation-title">
4410 <span class=
"operation-name">
4411 <span class=
"operation-name">POST
</span>
4412 <span class=
"operation-path">/videos/{id}/abuse
</span>
4415 <div class=
"doc-row">
4416 <div class=
"doc-copy">
4417 <section class=
"swagger-request-params">
4418 <div class=
"prop-row prop-group">
4419 <div class=
"prop-name">
4420 <div class=
"prop-title">id
</div>
4421 <span class=
"json-property-required"></span>
4422 <div class=
"prop-subtitle"> in path
</div>
4423 <div class=
"prop-subtitle">
4424 <span class=
"json-property-type">string
</span>
4425 <span class=
"json-property-range" title=
"Value limits"></span>
4428 <div class=
"prop-value">
4429 <p>The video id
</p>
4434 <div class=
"doc-examples"></div>
4436 <div class=
"doc-row">
4437 <div class=
"doc-copy">
4438 <section class=
"swagger-responses">
4439 <div class=
"prop-row prop-group">
4440 <div class=
"prop-name">
4441 <div class=
"prop-title">204 No Content
</div>
4443 <div class=
"prop-value">
4444 <p>successful operation
</p>
4449 <div class=
"doc-examples">
4450 <h5>Response Content-Types:
4451 <span>application/json
</span>
4455 <div class=
"doc-row">
4456 <div class=
"doc-copy">
4457 <section class=
"swagger-request-security">
4458 <table class=
"table">
4461 <th class=
"swagger-request-security-schema"></th>
4462 <th class=
"swagger-request-security-scopes"></th>
4468 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4478 <h1 id=
"tag-VideoBlacklist" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoBlacklist">VideoBlacklist
</h1>
4479 <div id=
"operation--videos--videoId--blacklist-post" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--blacklist-post">
4480 <!-- <section class="operation-tags row"> -->
4481 <!-- <div class="doc-copy"> -->
4482 <div class=
"operation-tags">
4483 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4488 <h2 class=
"operation-title">
4489 <span class=
"operation-name">
4490 <span class=
"operation-name">POST
</span>
4491 <span class=
"operation-path">/videos/{videoId}/blacklist
</span>
4494 <div class=
"doc-row">
4495 <div class=
"doc-copy">
4496 <section class=
"swagger-request-params">
4497 <div class=
"prop-row prop-group">
4498 <div class=
"prop-name">
4499 <div class=
"prop-title">videoId
</div>
4500 <span class=
"json-property-required"></span>
4501 <div class=
"prop-subtitle"> in path
</div>
4502 <div class=
"prop-subtitle">
4503 <span class=
"json-property-type">string
</span>
4504 <span class=
"json-property-range" title=
"Value limits"></span>
4507 <div class=
"prop-value">
4508 <p>The video id
</p>
4513 <div class=
"doc-examples"></div>
4515 <div class=
"doc-row">
4516 <div class=
"doc-copy">
4517 <section class=
"swagger-responses">
4518 <div class=
"prop-row prop-group">
4519 <div class=
"prop-name">
4520 <div class=
"prop-title">204 No Content
</div>
4522 <div class=
"prop-value">
4523 <p>successful operation
</p>
4528 <div class=
"doc-examples">
4529 <h5>Response Content-Types:
4530 <span>application/json
</span>
4534 <div class=
"doc-row">
4535 <div class=
"doc-copy">
4536 <section class=
"swagger-request-security">
4537 <table class=
"table">
4540 <th class=
"swagger-request-security-schema"></th>
4541 <th class=
"swagger-request-security-scopes"></th>
4547 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4557 <div id=
"operation--videos--videoId--blacklist-delete" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--blacklist-delete">
4558 <!-- <section class="operation-tags row"> -->
4559 <!-- <div class="doc-copy"> -->
4560 <div class=
"operation-tags">
4561 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4566 <h2 class=
"operation-title">
4567 <span class=
"operation-name">
4568 <span class=
"operation-name">DELETE
</span>
4569 <span class=
"operation-path">/videos/{videoId}/blacklist
</span>
4572 <div class=
"doc-row">
4573 <div class=
"doc-copy">
4574 <section class=
"swagger-request-params">
4575 <div class=
"prop-row prop-group">
4576 <div class=
"prop-name">
4577 <div class=
"prop-title">videoId
</div>
4578 <span class=
"json-property-required"></span>
4579 <div class=
"prop-subtitle"> in path
</div>
4580 <div class=
"prop-subtitle">
4581 <span class=
"json-property-type">string
</span>
4582 <span class=
"json-property-range" title=
"Value limits"></span>
4585 <div class=
"prop-value">
4586 <p>The video id
</p>
4591 <div class=
"doc-examples"></div>
4593 <div class=
"doc-row">
4594 <div class=
"doc-copy">
4595 <section class=
"swagger-responses">
4596 <div class=
"prop-row prop-group">
4597 <div class=
"prop-name">
4598 <div class=
"prop-title">204 No Content
</div>
4600 <div class=
"prop-value">
4601 <p>successful operation
</p>
4606 <div class=
"doc-examples">
4607 <h5>Response Content-Types:
4608 <span>application/json
</span>
4612 <div class=
"doc-row">
4613 <div class=
"doc-copy">
4614 <section class=
"swagger-request-security">
4615 <table class=
"table">
4618 <th class=
"swagger-request-security-schema"></th>
4619 <th class=
"swagger-request-security-scopes"></th>
4625 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4635 <div id=
"operation--videos-blacklist-get" class=
"operation panel" data-traverse-target=
"operation--videos-blacklist-get">
4636 <!-- <section class="operation-tags row"> -->
4637 <!-- <div class="doc-copy"> -->
4638 <div class=
"operation-tags">
4639 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4644 <h2 class=
"operation-title">
4645 <span class=
"operation-name">
4646 <span class=
"operation-name">GET
</span>
4647 <span class=
"operation-path">/videos/blacklist
</span>
4650 <div class=
"doc-row">
4651 <div class=
"doc-copy">
4652 <section class=
"swagger-request-params">
4653 <div class=
"prop-row prop-group">
4654 <div class=
"prop-name">
4655 <div class=
"prop-title">start
</div>
4656 <div class=
"prop-subtitle"> in query
</div>
4657 <div class=
"prop-subtitle">
4658 <span class=
"json-property-type">number
</span>
4659 <span class=
"json-property-range" title=
"Value limits"></span>
4662 <div class=
"prop-value">
4663 <p>starting page
</p>
4666 <div class=
"prop-row prop-group">
4667 <div class=
"prop-name">
4668 <div class=
"prop-title">stop
</div>
4669 <div class=
"prop-subtitle"> in query
</div>
4670 <div class=
"prop-subtitle">
4671 <span class=
"json-property-type">number
</span>
4672 <span class=
"json-property-range" title=
"Value limits"></span>
4675 <div class=
"prop-value">
4676 <p>stopping page
</p>
4679 <div class=
"prop-row prop-group">
4680 <div class=
"prop-name">
4681 <div class=
"prop-title">sort
</div>
4682 <div class=
"prop-subtitle"> in query
</div>
4683 <div class=
"prop-subtitle">
4684 <span class=
"json-property-type">number
</span>
4685 <span class=
"json-property-range" title=
"Value limits"></span>
4688 <div class=
"prop-value">
4694 <div class=
"doc-examples"></div>
4696 <div class=
"doc-row">
4697 <div class=
"doc-copy">
4698 <section class=
"swagger-responses">
4699 <div class=
"prop-row prop-group">
4700 <div class=
"prop-name">
4701 <div class=
"prop-title">200 OK
</div>
4702 <div class=
"prop-ref">
4703 <span class=
"json-schema-ref-array">
4704 <a class=
"json-schema-ref" href=
"#/definitions/VideoBlacklist">VideoBlacklist
</a>
4707 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4709 <div class=
"prop-value">
4710 <p>successful operation
</p>
4713 <div class=
"prop-row prop-inner">
4714 <div class=
"prop-name">type
</div>
4715 <div class=
"prop-value">
4716 <span class=
"json-property-type">
4717 <span class=
"json-schema-ref-array">
4718 <a class=
"json-schema-ref" href=
"#/definitions/VideoBlacklist">VideoBlacklist
</a>
4721 <span class=
"json-property-range" title=
"Value limits"></span>
4726 <div class=
"doc-examples">
4727 <h5>Response Content-Types:
4728 <span>application/json
</span>
4731 <h5>Response Example
4732 <span>(
200 OK)
</span>
4734 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4736 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4737 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4738 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4739 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4740 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4741 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4742 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4743 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
4744 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
4745 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4746 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4747 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
4755 <div class=
"doc-row">
4756 <div class=
"doc-copy">
4757 <section class=
"swagger-request-security">
4758 <table class=
"table">
4761 <th class=
"swagger-request-security-schema"></th>
4762 <th class=
"swagger-request-security-scopes"></th>
4768 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4778 <h1 id=
"tag-VideoChannel" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoChannel">VideoChannel
</h1>
4779 <div id=
"operation--video-channels-get" class=
"operation panel" data-traverse-target=
"operation--video-channels-get">
4780 <!-- <section class="operation-tags row"> -->
4781 <!-- <div class="doc-copy"> -->
4782 <div class=
"operation-tags">
4783 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4788 <h2 class=
"operation-title">
4789 <span class=
"operation-name">
4790 <span class=
"operation-name">GET
</span>
4791 <span class=
"operation-path">/video-channels
</span>
4794 <div class=
"doc-row">
4795 <div class=
"doc-copy">
4796 <section class=
"swagger-request-params">
4797 <div class=
"prop-row prop-group">
4798 <div class=
"prop-name">
4799 <div class=
"prop-title">start
</div>
4800 <div class=
"prop-subtitle"> in query
</div>
4801 <div class=
"prop-subtitle">
4802 <span class=
"json-property-type">number
</span>
4803 <span class=
"json-property-range" title=
"Value limits"></span>
4806 <div class=
"prop-value">
4807 <p>starting page
</p>
4810 <div class=
"prop-row prop-group">
4811 <div class=
"prop-name">
4812 <div class=
"prop-title">stop
</div>
4813 <div class=
"prop-subtitle"> in query
</div>
4814 <div class=
"prop-subtitle">
4815 <span class=
"json-property-type">number
</span>
4816 <span class=
"json-property-range" title=
"Value limits"></span>
4819 <div class=
"prop-value">
4820 <p>stopping page
</p>
4823 <div class=
"prop-row prop-group">
4824 <div class=
"prop-name">
4825 <div class=
"prop-title">sort
</div>
4826 <div class=
"prop-subtitle"> in query
</div>
4827 <div class=
"prop-subtitle">
4828 <span class=
"json-property-type">number
</span>
4829 <span class=
"json-property-range" title=
"Value limits"></span>
4832 <div class=
"prop-value">
4838 <div class=
"doc-examples"></div>
4840 <div class=
"doc-row">
4841 <div class=
"doc-copy">
4842 <section class=
"swagger-responses">
4843 <div class=
"prop-row prop-group">
4844 <div class=
"prop-name">
4845 <div class=
"prop-title">200 OK
</div>
4846 <div class=
"prop-ref">
4847 <span class=
"json-schema-ref-array">
4848 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4851 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4853 <div class=
"prop-value">
4854 <p>successful operation
</p>
4857 <div class=
"prop-row prop-inner">
4858 <div class=
"prop-name">type
</div>
4859 <div class=
"prop-value">
4860 <span class=
"json-property-type">
4861 <span class=
"json-schema-ref-array">
4862 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4865 <span class=
"json-property-range" title=
"Value limits"></span>
4870 <div class=
"doc-examples">
4871 <h5>Response Content-Types:
4872 <span>application/json
</span>
4875 <h5>Response Example
4876 <span>(
200 OK)
</span>
4878 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4880 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4881 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4882 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4883 <span class=
"hljs-attr">"ownerAccount
"</span>: {
4884 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4885 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
4895 <div id=
"operation--video-channels-post" class=
"operation panel" data-traverse-target=
"operation--video-channels-post">
4896 <!-- <section class="operation-tags row"> -->
4897 <!-- <div class="doc-copy"> -->
4898 <div class=
"operation-tags">
4899 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4904 <h2 class=
"operation-title">
4905 <span class=
"operation-name">
4906 <span class=
"operation-name">POST
</span>
4907 <span class=
"operation-path">/video-channels
</span>
4910 <div class=
"doc-row">
4911 <div class=
"doc-copy">
4912 <section class=
"swagger-request-body">
4913 <div class=
"prop-row">
4914 <div class=
"prop-name">
4915 <div class=
"swagger-request-model">
4917 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannelInput">VideoChannelInput
</a>
4921 <div class=
"prop-value columns small-6">
4922 <!-- <div class="swagger-request-description"> -->
4929 <div class=
"doc-examples">
4931 <h5>Request Content-Types:
4932 <span>application/json
</span>
4934 <h5>Request Example
</h5>
4935 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4936 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4937 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
4944 <div class=
"doc-row">
4945 <div class=
"doc-copy">
4946 <section class=
"swagger-responses">
4947 <div class=
"prop-row prop-group">
4948 <div class=
"prop-name">
4949 <div class=
"prop-title">204 No Content
</div>
4951 <div class=
"prop-value">
4952 <p>successful operation
</p>
4957 <div class=
"doc-examples">
4958 <h5>Response Content-Types:
4959 <span>application/json
</span>
4963 <div class=
"doc-row">
4964 <div class=
"doc-copy">
4965 <section class=
"swagger-request-security">
4966 <table class=
"table">
4969 <th class=
"swagger-request-security-schema"></th>
4970 <th class=
"swagger-request-security-scopes"></th>
4976 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4986 <div id=
"operation--video-channels--id--get" class=
"operation panel" data-traverse-target=
"operation--video-channels--id--get">
4987 <!-- <section class="operation-tags row"> -->
4988 <!-- <div class="doc-copy"> -->
4989 <div class=
"operation-tags">
4990 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4995 <h2 class=
"operation-title">
4996 <span class=
"operation-name">
4997 <span class=
"operation-name">GET
</span>
4998 <span class=
"operation-path">/video-channels/{id}
</span>
5001 <div class=
"doc-row">
5002 <div class=
"doc-copy">
5003 <section class=
"swagger-request-params">
5004 <div class=
"prop-row prop-group">
5005 <div class=
"prop-name">
5006 <div class=
"prop-title">id
</div>
5007 <span class=
"json-property-required"></span>
5008 <div class=
"prop-subtitle"> in path
</div>
5009 <div class=
"prop-subtitle">
5010 <span class=
"json-property-type">string
</span>
5011 <span class=
"json-property-range" title=
"Value limits"></span>
5014 <div class=
"prop-value">
5015 <p>The video channel id
</p>
5020 <div class=
"doc-examples"></div>
5022 <div class=
"doc-row">
5023 <div class=
"doc-copy">
5024 <section class=
"swagger-responses">
5025 <div class=
"prop-row prop-group">
5026 <div class=
"prop-name">
5027 <div class=
"prop-title">200 OK
</div>
5028 <div class=
"prop-ref">
5030 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
5033 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5035 <div class=
"prop-value">
5036 <p>successful operation
</p>
5041 <div class=
"doc-examples">
5042 <h5>Response Content-Types:
5043 <span>application/json
</span>
5046 <h5>Response Example
5047 <span>(
200 OK)
</span>
5049 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5050 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5051 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5052 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5053 <span class=
"hljs-attr">"ownerAccount
"</span>: {
5054 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5055 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
5064 <div id=
"operation--video-channels--id--put" class=
"operation panel" data-traverse-target=
"operation--video-channels--id--put">
5065 <!-- <section class="operation-tags row"> -->
5066 <!-- <div class="doc-copy"> -->
5067 <div class=
"operation-tags">
5068 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5073 <h2 class=
"operation-title">
5074 <span class=
"operation-name">
5075 <span class=
"operation-name">PUT
</span>
5076 <span class=
"operation-path">/video-channels/{id}
</span>
5079 <div class=
"doc-row">
5080 <div class=
"doc-copy">
5081 <section class=
"swagger-request-body">
5082 <div class=
"prop-row">
5083 <div class=
"prop-name">
5084 <div class=
"swagger-request-model">
5086 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannelInput">VideoChannelInput
</a>
5090 <div class=
"prop-value columns small-6">
5091 <!-- <div class="swagger-request-description"> -->
5097 <section class=
"swagger-request-params">
5098 <div class=
"prop-row prop-group">
5099 <div class=
"prop-name">
5100 <div class=
"prop-title">id
</div>
5101 <span class=
"json-property-required"></span>
5102 <div class=
"prop-subtitle"> in path
</div>
5103 <div class=
"prop-subtitle">
5104 <span class=
"json-property-type">string
</span>
5105 <span class=
"json-property-range" title=
"Value limits"></span>
5108 <div class=
"prop-value">
5109 <p>The video channel id
</p>
5114 <div class=
"doc-examples">
5116 <h5>Request Content-Types:
5117 <span>application/json
</span>
5119 <h5>Request Example
</h5>
5120 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5121 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5122 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
5129 <div class=
"doc-row">
5130 <div class=
"doc-copy">
5131 <section class=
"swagger-responses">
5132 <div class=
"prop-row prop-group">
5133 <div class=
"prop-name">
5134 <div class=
"prop-title">204 No Content
</div>
5136 <div class=
"prop-value">
5137 <p>successful operation
</p>
5142 <div class=
"doc-examples">
5143 <h5>Response Content-Types:
5144 <span>application/json
</span>
5148 <div class=
"doc-row">
5149 <div class=
"doc-copy">
5150 <section class=
"swagger-request-security">
5151 <table class=
"table">
5154 <th class=
"swagger-request-security-schema"></th>
5155 <th class=
"swagger-request-security-scopes"></th>
5161 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5171 <div id=
"operation--video-channels--id--delete" class=
"operation panel" data-traverse-target=
"operation--video-channels--id--delete">
5172 <!-- <section class="operation-tags row"> -->
5173 <!-- <div class="doc-copy"> -->
5174 <div class=
"operation-tags">
5175 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5180 <h2 class=
"operation-title">
5181 <span class=
"operation-name">
5182 <span class=
"operation-name">DELETE
</span>
5183 <span class=
"operation-path">/video-channels/{id}
</span>
5186 <div class=
"doc-row">
5187 <div class=
"doc-copy">
5188 <section class=
"swagger-request-params">
5189 <div class=
"prop-row prop-group">
5190 <div class=
"prop-name">
5191 <div class=
"prop-title">id
</div>
5192 <span class=
"json-property-required"></span>
5193 <div class=
"prop-subtitle"> in path
</div>
5194 <div class=
"prop-subtitle">
5195 <span class=
"json-property-type">string
</span>
5196 <span class=
"json-property-range" title=
"Value limits"></span>
5199 <div class=
"prop-value">
5200 <p>The video channel id
</p>
5205 <div class=
"doc-examples"></div>
5207 <div class=
"doc-row">
5208 <div class=
"doc-copy">
5209 <section class=
"swagger-responses">
5210 <div class=
"prop-row prop-group">
5211 <div class=
"prop-name">
5212 <div class=
"prop-title">204 No Content
</div>
5214 <div class=
"prop-value">
5215 <p>successful operation
</p>
5220 <div class=
"doc-examples">
5221 <h5>Response Content-Types:
5222 <span>application/json
</span>
5226 <div class=
"doc-row">
5227 <div class=
"doc-copy">
5228 <section class=
"swagger-request-security">
5229 <table class=
"table">
5232 <th class=
"swagger-request-security-schema"></th>
5233 <th class=
"swagger-request-security-scopes"></th>
5239 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5249 <div id=
"operation--video-channels--id--videos-get" class=
"operation panel" data-traverse-target=
"operation--video-channels--id--videos-get">
5250 <!-- <section class="operation-tags row"> -->
5251 <!-- <div class="doc-copy"> -->
5252 <div class=
"operation-tags">
5253 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5258 <h2 class=
"operation-title">
5259 <span class=
"operation-name">
5260 <span class=
"operation-name">GET
</span>
5261 <span class=
"operation-path">/video-channels/{id}/videos
</span>
5264 <div class=
"doc-row">
5265 <div class=
"doc-copy">
5266 <section class=
"swagger-request-params">
5267 <div class=
"prop-row prop-group">
5268 <div class=
"prop-name">
5269 <div class=
"prop-title">id
</div>
5270 <span class=
"json-property-required"></span>
5271 <div class=
"prop-subtitle"> in path
</div>
5272 <div class=
"prop-subtitle">
5273 <span class=
"json-property-type">string
</span>
5274 <span class=
"json-property-range" title=
"Value limits"></span>
5277 <div class=
"prop-value">
5278 <p>The video channel id
</p>
5283 <div class=
"doc-examples"></div>
5285 <div class=
"doc-row">
5286 <div class=
"doc-copy">
5287 <section class=
"swagger-responses">
5288 <div class=
"prop-row prop-group">
5289 <div class=
"prop-name">
5290 <div class=
"prop-title">200 OK
</div>
5291 <div class=
"prop-ref">
5293 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
5296 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5298 <div class=
"prop-value">
5299 <p>successful operation
</p>
5304 <div class=
"doc-examples">
5305 <h5>Response Content-Types:
5306 <span>application/json
</span>
5309 <h5>Response Example
5310 <span>(
200 OK)
</span>
5312 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5313 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5314 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5315 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5316 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5317 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5318 <span class=
"hljs-attr">"category
"</span>: {
5319 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5320 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5322 <span class=
"hljs-attr">"licence
"</span>: {
5323 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5324 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5326 <span class=
"hljs-attr">"language
"</span>: {
5327 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
5328 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5330 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
5331 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5332 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
5333 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5334 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5335 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5336 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5337 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5338 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
5339 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5340 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5341 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5342 <span class=
"hljs-attr">"account
"</span>: {
5343 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5344 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5345 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5346 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5347 <span class=
"hljs-attr">"avatar
"</span>: {
5348 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5349 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5350 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5360 <div id=
"operation--accounts--name--video-channels-get" class=
"operation panel" data-traverse-target=
"operation--accounts--name--video-channels-get">
5361 <!-- <section class="operation-tags row"> -->
5362 <!-- <div class="doc-copy"> -->
5363 <div class=
"operation-tags">
5364 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5369 <h2 class=
"operation-title">
5370 <span class=
"operation-name">
5371 <span class=
"operation-name">GET
</span>
5372 <span class=
"operation-path">/accounts/{name}/video-channels
</span>
5375 <div class=
"doc-row">
5376 <div class=
"doc-copy">
5377 <section class=
"swagger-request-params">
5378 <div class=
"prop-row prop-group">
5379 <div class=
"prop-name">
5380 <div class=
"prop-title">name
</div>
5381 <span class=
"json-property-required"></span>
5382 <div class=
"prop-subtitle"> in path
</div>
5383 <div class=
"prop-subtitle">
5384 <span class=
"json-property-type">string
</span>
5385 <span class=
"json-property-range" title=
"Value limits"></span>
5388 <div class=
"prop-value">
5389 <p>The name of the account (chocobozzz or
5390 <a href=
"mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re
</a> for example)
</p>
5395 <div class=
"doc-examples"></div>
5397 <div class=
"doc-row">
5398 <div class=
"doc-copy">
5399 <section class=
"swagger-responses">
5400 <div class=
"prop-row prop-group">
5401 <div class=
"prop-name">
5402 <div class=
"prop-title">200 OK
</div>
5403 <div class=
"prop-ref">
5404 <span class=
"json-schema-ref-array">
5405 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
5408 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5410 <div class=
"prop-value">
5411 <p>successful operation
</p>
5414 <div class=
"prop-row prop-inner">
5415 <div class=
"prop-name">type
</div>
5416 <div class=
"prop-value">
5417 <span class=
"json-property-type">
5418 <span class=
"json-schema-ref-array">
5419 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
5422 <span class=
"json-property-range" title=
"Value limits"></span>
5427 <div class=
"doc-examples">
5428 <h5>Response Content-Types:
5429 <span>application/json
</span>
5432 <h5>Response Example
5433 <span>(
200 OK)
</span>
5435 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
5437 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5438 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5439 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5440 <span class=
"hljs-attr">"ownerAccount
"</span>: {
5441 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5442 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
5452 <h1 id=
"tag-VideoComment" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoComment">VideoComment
</h1>
5453 <div id=
"operation--videos--videoId--comment-threads-get" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comment-threads-get">
5454 <!-- <section class="operation-tags row"> -->
5455 <!-- <div class="doc-copy"> -->
5456 <div class=
"operation-tags">
5457 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5462 <h2 class=
"operation-title">
5463 <span class=
"operation-name">
5464 <span class=
"operation-name">GET
</span>
5465 <span class=
"operation-path">/videos/{videoId}/comment-threads
</span>
5468 <div class=
"doc-row">
5469 <div class=
"doc-copy">
5470 <section class=
"swagger-request-params">
5471 <div class=
"prop-row prop-group">
5472 <div class=
"prop-name">
5473 <div class=
"prop-title">videoId
</div>
5474 <span class=
"json-property-required"></span>
5475 <div class=
"prop-subtitle"> in path
</div>
5476 <div class=
"prop-subtitle">
5477 <span class=
"json-property-type">string
</span>
5478 <span class=
"json-property-range" title=
"Value limits"></span>
5481 <div class=
"prop-value">
5482 <p>The video id
</p>
5485 <div class=
"prop-row prop-group">
5486 <div class=
"prop-name">
5487 <div class=
"prop-title">start
</div>
5488 <div class=
"prop-subtitle"> in query
</div>
5489 <div class=
"prop-subtitle">
5490 <span class=
"json-property-type">number
</span>
5491 <span class=
"json-property-range" title=
"Value limits"></span>
5494 <div class=
"prop-value">
5495 <p>starting page
</p>
5498 <div class=
"prop-row prop-group">
5499 <div class=
"prop-name">
5500 <div class=
"prop-title">stop
</div>
5501 <div class=
"prop-subtitle"> in query
</div>
5502 <div class=
"prop-subtitle">
5503 <span class=
"json-property-type">number
</span>
5504 <span class=
"json-property-range" title=
"Value limits"></span>
5507 <div class=
"prop-value">
5508 <p>stopping page
</p>
5511 <div class=
"prop-row prop-group">
5512 <div class=
"prop-name">
5513 <div class=
"prop-title">sort
</div>
5514 <div class=
"prop-subtitle"> in query
</div>
5515 <div class=
"prop-subtitle">
5516 <span class=
"json-property-type">number
</span>
5517 <span class=
"json-property-range" title=
"Value limits"></span>
5520 <div class=
"prop-value">
5526 <div class=
"doc-examples"></div>
5528 <div class=
"doc-row">
5529 <div class=
"doc-copy">
5530 <section class=
"swagger-responses">
5531 <div class=
"prop-row prop-group">
5532 <div class=
"prop-name">
5533 <div class=
"prop-title">200 OK
</div>
5534 <div class=
"prop-ref">
5536 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadResponse">CommentThreadResponse
</a>
5539 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5541 <div class=
"prop-value">
5542 <p>successful operation
</p>
5547 <div class=
"doc-examples">
5548 <h5>Response Content-Types:
5549 <span>application/json
</span>
5552 <h5>Response Example
5553 <span>(
200 OK)
</span>
5555 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5556 <span class=
"hljs-attr">"total
"</span>:
<span class=
"hljs-string">"number
"</span>,
5557 <span class=
"hljs-attr">"data
"</span>: [
5559 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5560 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5561 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5562 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5563 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5564 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5565 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5566 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5567 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5568 <span class=
"hljs-attr">"account
"</span>: {
5569 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5570 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5571 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5572 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5573 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5574 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5575 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5576 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5577 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5578 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5579 <span class=
"hljs-attr">"avatar
"</span>: {
5580 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5581 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5582 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5594 <div id=
"operation--videos--videoId--comment-threads-post" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comment-threads-post">
5595 <!-- <section class="operation-tags row"> -->
5596 <!-- <div class="doc-copy"> -->
5597 <div class=
"operation-tags">
5598 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5603 <h2 class=
"operation-title">
5604 <span class=
"operation-name">
5605 <span class=
"operation-name">POST
</span>
5606 <span class=
"operation-path">/videos/{videoId}/comment-threads
</span>
5609 <div class=
"doc-row">
5610 <div class=
"doc-copy">
5611 <section class=
"swagger-request-params">
5612 <div class=
"prop-row prop-group">
5613 <div class=
"prop-name">
5614 <div class=
"prop-title">videoId
</div>
5615 <span class=
"json-property-required"></span>
5616 <div class=
"prop-subtitle"> in path
</div>
5617 <div class=
"prop-subtitle">
5618 <span class=
"json-property-type">string
</span>
5619 <span class=
"json-property-range" title=
"Value limits"></span>
5622 <div class=
"prop-value">
5623 <p>The video id
</p>
5628 <div class=
"doc-examples"></div>
5630 <div class=
"doc-row">
5631 <div class=
"doc-copy">
5632 <section class=
"swagger-responses">
5633 <div class=
"prop-row prop-group">
5634 <div class=
"prop-name">
5635 <div class=
"prop-title">200 OK
</div>
5636 <div class=
"prop-ref">
5638 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadPostResponse">CommentThreadPostResponse
</a>
5641 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5643 <div class=
"prop-value">
5644 <p>successful operation
</p>
5649 <div class=
"doc-examples">
5650 <h5>Response Content-Types:
5651 <span>application/json
</span>
5654 <h5>Response Example
5655 <span>(
200 OK)
</span>
5657 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5658 <span class=
"hljs-attr">"comment
"</span>: {
5659 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5660 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5661 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5662 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5663 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5664 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5665 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5666 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5667 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5668 <span class=
"hljs-attr">"account
"</span>: {
5669 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5670 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5671 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5672 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5673 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5674 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5675 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5676 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5677 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5678 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5679 <span class=
"hljs-attr">"avatar
"</span>: {
5680 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5681 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5682 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5692 <div class=
"doc-row">
5693 <div class=
"doc-copy">
5694 <section class=
"swagger-request-security">
5695 <table class=
"table">
5698 <th class=
"swagger-request-security-schema"></th>
5699 <th class=
"swagger-request-security-scopes"></th>
5705 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5715 <div id=
"operation--videos--videoId--comment-threads--threadId--get" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comment-threads--threadId--get">
5716 <!-- <section class="operation-tags row"> -->
5717 <!-- <div class="doc-copy"> -->
5718 <div class=
"operation-tags">
5719 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5724 <h2 class=
"operation-title">
5725 <span class=
"operation-name">
5726 <span class=
"operation-name">GET
</span>
5727 <span class=
"operation-path">/videos/{videoId}/comment-threads/{threadId}
</span>
5730 <div class=
"doc-row">
5731 <div class=
"doc-copy">
5732 <section class=
"swagger-request-params">
5733 <div class=
"prop-row prop-group">
5734 <div class=
"prop-name">
5735 <div class=
"prop-title">videoId
</div>
5736 <span class=
"json-property-required"></span>
5737 <div class=
"prop-subtitle"> in path
</div>
5738 <div class=
"prop-subtitle">
5739 <span class=
"json-property-type">string
</span>
5740 <span class=
"json-property-range" title=
"Value limits"></span>
5743 <div class=
"prop-value">
5744 <p>The video id
</p>
5747 <div class=
"prop-row prop-group">
5748 <div class=
"prop-name">
5749 <div class=
"prop-title">threadId
</div>
5750 <span class=
"json-property-required"></span>
5751 <div class=
"prop-subtitle"> in path
</div>
5752 <div class=
"prop-subtitle">
5753 <span class=
"json-property-type">string
</span>
5754 <span class=
"json-property-range" title=
"Value limits"></span>
5757 <div class=
"prop-value">
5758 <p>The thread id
</p>
5763 <div class=
"doc-examples"></div>
5765 <div class=
"doc-row">
5766 <div class=
"doc-copy">
5767 <section class=
"swagger-responses">
5768 <div class=
"prop-row prop-group">
5769 <div class=
"prop-name">
5770 <div class=
"prop-title">200 OK
</div>
5771 <div class=
"prop-ref">
5773 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
5776 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5778 <div class=
"prop-value">
5779 <p>successful operation
</p>
5784 <div class=
"doc-examples">
5785 <h5>Response Content-Types:
5786 <span>application/json
</span>
5789 <h5>Response Example
5790 <span>(
200 OK)
</span>
5792 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5793 <span class=
"hljs-attr">"comment
"</span>: {
5794 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5795 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5796 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5797 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5798 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5799 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5800 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5801 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5802 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5803 <span class=
"hljs-attr">"account
"</span>: {
5804 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5805 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5806 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5807 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5808 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5809 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5810 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5811 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5812 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5813 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5814 <span class=
"hljs-attr">"avatar
"</span>: {
5815 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5816 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5817 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5821 <span class=
"hljs-attr">"children
"</span>: [
5823 <span class=
"hljs-attr">"comment
"</span>: {
5824 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5825 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5826 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5827 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5828 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5829 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5830 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5831 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5832 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5833 <span class=
"hljs-attr">"account
"</span>: {
5834 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5835 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5836 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5837 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5838 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5839 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5840 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5841 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5842 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5843 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5844 <span class=
"hljs-attr">"avatar
"</span>: {
5845 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5846 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5847 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5851 <span class=
"hljs-attr">"children
"</span>: [
5853 <span class=
"hljs-attr">"comment
"</span>: {
5854 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5855 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5856 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5857 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5858 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5859 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5860 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5861 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5862 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5863 <span class=
"hljs-attr">"account
"</span>: {
5864 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5865 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5866 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5867 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5868 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5869 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5870 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5871 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5872 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5873 <span class=
"hljs-attr">"avatar
"</span>: {
5874 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5875 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5876 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5891 <div id=
"operation--videos--videoId--comments--commentId--post" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comments--commentId--post">
5892 <!-- <section class="operation-tags row"> -->
5893 <!-- <div class="doc-copy"> -->
5894 <div class=
"operation-tags">
5895 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5900 <h2 class=
"operation-title">
5901 <span class=
"operation-name">
5902 <span class=
"operation-name">POST
</span>
5903 <span class=
"operation-path">/videos/{videoId}/comments/{commentId}
</span>
5906 <div class=
"doc-row">
5907 <div class=
"doc-copy">
5908 <section class=
"swagger-request-params">
5909 <div class=
"prop-row prop-group">
5910 <div class=
"prop-name">
5911 <div class=
"prop-title">videoId
</div>
5912 <span class=
"json-property-required"></span>
5913 <div class=
"prop-subtitle"> in path
</div>
5914 <div class=
"prop-subtitle">
5915 <span class=
"json-property-type">string
</span>
5916 <span class=
"json-property-range" title=
"Value limits"></span>
5919 <div class=
"prop-value">
5920 <p>The video id
</p>
5923 <div class=
"prop-row prop-group">
5924 <div class=
"prop-name">
5925 <div class=
"prop-title">commentId
</div>
5926 <span class=
"json-property-required"></span>
5927 <div class=
"prop-subtitle"> in path
</div>
5928 <div class=
"prop-subtitle">
5929 <span class=
"json-property-type">string
</span>
5930 <span class=
"json-property-range" title=
"Value limits"></span>
5933 <div class=
"prop-value">
5934 <p>The comment id
</p>
5939 <div class=
"doc-examples"></div>
5941 <div class=
"doc-row">
5942 <div class=
"doc-copy">
5943 <section class=
"swagger-responses">
5944 <div class=
"prop-row prop-group">
5945 <div class=
"prop-name">
5946 <div class=
"prop-title">200 OK
</div>
5947 <div class=
"prop-ref">
5949 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadPostResponse">CommentThreadPostResponse
</a>
5952 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5954 <div class=
"prop-value">
5955 <p>successful operation
</p>
5960 <div class=
"doc-examples">
5961 <h5>Response Content-Types:
5962 <span>application/json
</span>
5965 <h5>Response Example
5966 <span>(
200 OK)
</span>
5968 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5969 <span class=
"hljs-attr">"comment
"</span>: {
5970 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5971 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5972 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5973 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5974 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5975 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5976 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5977 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5978 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5979 <span class=
"hljs-attr">"account
"</span>: {
5980 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5981 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5982 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5983 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5984 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5985 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5986 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5987 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5988 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5989 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5990 <span class=
"hljs-attr">"avatar
"</span>: {
5991 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5992 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5993 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6003 <div class=
"doc-row">
6004 <div class=
"doc-copy">
6005 <section class=
"swagger-request-security">
6006 <table class=
"table">
6009 <th class=
"swagger-request-security-schema"></th>
6010 <th class=
"swagger-request-security-scopes"></th>
6016 <a href=
"#security-definition-OAuth2">OAuth2
</a>
6026 <div id=
"operation--videos--videoId--comments--commentId--delete" class=
"operation panel" data-traverse-target=
"operation--videos--videoId--comments--commentId--delete">
6027 <!-- <section class="operation-tags row"> -->
6028 <!-- <div class="doc-copy"> -->
6029 <div class=
"operation-tags">
6030 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
6035 <h2 class=
"operation-title">
6036 <span class=
"operation-name">
6037 <span class=
"operation-name">DELETE
</span>
6038 <span class=
"operation-path">/videos/{videoId}/comments/{commentId}
</span>
6041 <div class=
"doc-row">
6042 <div class=
"doc-copy">
6043 <section class=
"swagger-request-params">
6044 <div class=
"prop-row prop-group">
6045 <div class=
"prop-name">
6046 <div class=
"prop-title">videoId
</div>
6047 <span class=
"json-property-required"></span>
6048 <div class=
"prop-subtitle"> in path
</div>
6049 <div class=
"prop-subtitle">
6050 <span class=
"json-property-type">string
</span>
6051 <span class=
"json-property-range" title=
"Value limits"></span>
6054 <div class=
"prop-value">
6055 <p>The video id
</p>
6058 <div class=
"prop-row prop-group">
6059 <div class=
"prop-name">
6060 <div class=
"prop-title">commentId
</div>
6061 <span class=
"json-property-required"></span>
6062 <div class=
"prop-subtitle"> in path
</div>
6063 <div class=
"prop-subtitle">
6064 <span class=
"json-property-type">string
</span>
6065 <span class=
"json-property-range" title=
"Value limits"></span>
6068 <div class=
"prop-value">
6069 <p>The comment id
</p>
6074 <div class=
"doc-examples"></div>
6076 <div class=
"doc-row">
6077 <div class=
"doc-copy">
6078 <section class=
"swagger-responses">
6079 <div class=
"prop-row prop-group">
6080 <div class=
"prop-name">
6081 <div class=
"prop-title">204 No Content
</div>
6083 <div class=
"prop-value">
6084 <p>successful operation
</p>
6089 <div class=
"doc-examples">
6090 <h5>Response Content-Types:
6091 <span>application/json
</span>
6095 <div class=
"doc-row">
6096 <div class=
"doc-copy">
6097 <section class=
"swagger-request-security">
6098 <table class=
"table">
6101 <th class=
"swagger-request-security-schema"></th>
6102 <th class=
"swagger-request-security-scopes"></th>
6108 <a href=
"#security-definition-OAuth2">OAuth2
</a>
6118 <h1 id=
"tag-VideoRate" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoRate">VideoRate
</h1>
6119 <div id=
"operation--videos--id--rate-put" class=
"operation panel" data-traverse-target=
"operation--videos--id--rate-put">
6120 <!-- <section class="operation-tags row"> -->
6121 <!-- <div class="doc-copy"> -->
6122 <div class=
"operation-tags">
6123 <a class=
"label" href=
"#tag-VideoRate">VideoRate
</a>
6128 <h2 class=
"operation-title">
6129 <span class=
"operation-name">
6130 <span class=
"operation-name">PUT
</span>
6131 <span class=
"operation-path">/videos/{id}/rate
</span>
6134 <div class=
"doc-row">
6135 <div class=
"doc-copy">
6136 <section class=
"swagger-request-params">
6137 <div class=
"prop-row prop-group">
6138 <div class=
"prop-name">
6139 <div class=
"prop-title">id
</div>
6140 <span class=
"json-property-required"></span>
6141 <div class=
"prop-subtitle"> in path
</div>
6142 <div class=
"prop-subtitle">
6143 <span class=
"json-property-type">string
</span>
6144 <span class=
"json-property-range" title=
"Value limits"></span>
6147 <div class=
"prop-value">
6148 <p>The video id
</p>
6153 <div class=
"doc-examples"></div>
6155 <div class=
"doc-row">
6156 <div class=
"doc-copy">
6157 <section class=
"swagger-responses">
6158 <div class=
"prop-row prop-group">
6159 <div class=
"prop-name">
6160 <div class=
"prop-title">204 No Content
</div>
6162 <div class=
"prop-value">
6163 <p>successful operation
</p>
6168 <div class=
"doc-examples">
6169 <h5>Response Content-Types:
6170 <span>application/json
</span>
6174 <div class=
"doc-row">
6175 <div class=
"doc-copy">
6176 <section class=
"swagger-request-security">
6177 <table class=
"table">
6180 <th class=
"swagger-request-security-schema"></th>
6181 <th class=
"swagger-request-security-scopes"></th>
6187 <a href=
"#security-definition-OAuth2">OAuth2
</a>
6197 <h1>Schema Definitions
</h1>
6198 <div id=
"definition-VideoConstantNumber" class=
"definition panel" data-traverse-target=
"definition-VideoConstantNumber">
6199 <h2 class=
"panel-title">
6200 <a name=
"/definitions/VideoConstantNumber"></a>VideoConstantNumber:
6201 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6202 <span class="json-property-range" title="Value limits"></span>
6207 <div class=
"doc-row">
6208 <div class=
"doc-copy">
6209 <section class=
"json-schema-properties">
6211 <dt data-property-name=
"id">
6212 <span class=
"json-property-name">id:
</span>
6213 <span class=
"json-property-type">number
</span>
6214 <span class=
"json-property-range" title=
"Value limits"></span>
6216 <dt data-property-name=
"label">
6217 <span class=
"json-property-name">label:
</span>
6218 <span class=
"json-property-type">string
</span>
6219 <span class=
"json-property-range" title=
"Value limits"></span>
6224 <div class=
"doc-examples">
6227 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6228 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6229 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6237 <div id=
"definition-VideoConstantString" class=
"definition panel" data-traverse-target=
"definition-VideoConstantString">
6238 <h2 class=
"panel-title">
6239 <a name=
"/definitions/VideoConstantString"></a>VideoConstantString:
6240 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6241 <span class="json-property-range" title="Value limits"></span>
6246 <div class=
"doc-row">
6247 <div class=
"doc-copy">
6248 <section class=
"json-schema-properties">
6250 <dt data-property-name=
"id">
6251 <span class=
"json-property-name">id:
</span>
6252 <span class=
"json-property-type">string
</span>
6253 <span class=
"json-property-range" title=
"Value limits"></span>
6255 <dt data-property-name=
"label">
6256 <span class=
"json-property-name">label:
</span>
6257 <span class=
"json-property-type">string
</span>
6258 <span class=
"json-property-range" title=
"Value limits"></span>
6263 <div class=
"doc-examples">
6266 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6267 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
6268 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6276 <div id=
"definition-VideoPrivacy" class=
"definition panel" data-traverse-target=
"definition-VideoPrivacy">
6277 <h2 class=
"panel-title">
6278 <a name=
"/definitions/VideoPrivacy"></a>VideoPrivacy: string
6279 <!-- <span class="json-property-type"><span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values">
6280 <span class="json-property-enum-item">Public</span>,
6281 <span class="json-property-enum-item">Unlisted</span>,
6282 <span class="json-property-enum-item">Private</span>
6284 <span class="json-property-range" title="Value limits"></span>
6289 <div class=
"doc-row">
6290 <div class=
"doc-copy">
6291 <span class=
"json-property-type">string
</span>
6292 <span class=
"json-property-enum" title=
"Possible values">
6293 <span class=
"json-property-enum-item">Public
</span>,
6294 <span class=
"json-property-enum-item">Unlisted
</span>,
6295 <span class=
"json-property-enum-item">Private
</span>
6297 <span class=
"json-property-range" title=
"Value limits"></span>
6301 <div id=
"definition-Video" class=
"definition panel" data-traverse-target=
"definition-Video">
6302 <h2 class=
"panel-title">
6303 <a name=
"/definitions/Video"></a>Video:
6304 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6305 <span class="json-property-range" title="Value limits"></span>
6310 <div class=
"doc-row">
6311 <div class=
"doc-copy">
6312 <section class=
"json-schema-properties">
6314 <dt data-property-name=
"id">
6315 <span class=
"json-property-name">id:
</span>
6316 <span class=
"json-property-type">number
</span>
6317 <span class=
"json-property-range" title=
"Value limits"></span>
6319 <dt data-property-name=
"uuid">
6320 <span class=
"json-property-name">uuid:
</span>
6321 <span class=
"json-property-type">string
</span>
6322 <span class=
"json-property-range" title=
"Value limits"></span>
6324 <dt data-property-name=
"createdAt">
6325 <span class=
"json-property-name">createdAt:
</span>
6326 <span class=
"json-property-type">string
</span>
6327 <span class=
"json-property-range" title=
"Value limits"></span>
6329 <dt data-property-name=
"publishedAt">
6330 <span class=
"json-property-name">publishedAt:
</span>
6331 <span class=
"json-property-type">string
</span>
6332 <span class=
"json-property-range" title=
"Value limits"></span>
6334 <dt data-property-name=
"updatedAt">
6335 <span class=
"json-property-name">updatedAt:
</span>
6336 <span class=
"json-property-type">string
</span>
6337 <span class=
"json-property-range" title=
"Value limits"></span>
6339 <dt data-property-name=
"category">
6340 <span class=
"json-property-name">category:
</span>
6341 <span class=
"json-property-type">
6343 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstantNumber">VideoConstantNumber
</a>
6346 <span class=
"json-property-range" title=
"Value limits"></span>
6348 <dt data-property-name=
"licence">
6349 <span class=
"json-property-name">licence:
</span>
6350 <span class=
"json-property-type">
6352 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstantNumber">VideoConstantNumber
</a>
6355 <span class=
"json-property-range" title=
"Value limits"></span>
6357 <dt data-property-name=
"language">
6358 <span class=
"json-property-name">language:
</span>
6359 <span class=
"json-property-type">
6361 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstantString">VideoConstantString
</a>
6364 <span class=
"json-property-range" title=
"Value limits"></span>
6366 <dt data-property-name=
"privacy">
6367 <span class=
"json-property-name">privacy:
</span>
6368 <span class=
"json-property-type">
6370 <a class=
"json-schema-ref" href=
"#/definitions/VideoPrivacy">VideoPrivacy
</a>
6373 <span class=
"json-property-range" title=
"Value limits"></span>
6375 <dt data-property-name=
"description">
6376 <span class=
"json-property-name">description:
</span>
6377 <span class=
"json-property-type">string
</span>
6378 <span class=
"json-property-range" title=
"Value limits"></span>
6380 <dt data-property-name=
"duration">
6381 <span class=
"json-property-name">duration:
</span>
6382 <span class=
"json-property-type">number
</span>
6383 <span class=
"json-property-range" title=
"Value limits"></span>
6385 <dt data-property-name=
"isLocal">
6386 <span class=
"json-property-name">isLocal:
</span>
6387 <span class=
"json-property-type">boolean
</span>
6388 <span class=
"json-property-range" title=
"Value limits"></span>
6390 <dt data-property-name=
"name">
6391 <span class=
"json-property-name">name:
</span>
6392 <span class=
"json-property-type">string
</span>
6393 <span class=
"json-property-range" title=
"Value limits"></span>
6395 <dt data-property-name=
"thumbnailPath">
6396 <span class=
"json-property-name">thumbnailPath:
</span>
6397 <span class=
"json-property-type">string
</span>
6398 <span class=
"json-property-range" title=
"Value limits"></span>
6400 <dt data-property-name=
"previewPath">
6401 <span class=
"json-property-name">previewPath:
</span>
6402 <span class=
"json-property-type">string
</span>
6403 <span class=
"json-property-range" title=
"Value limits"></span>
6405 <dt data-property-name=
"embedPath">
6406 <span class=
"json-property-name">embedPath:
</span>
6407 <span class=
"json-property-type">string
</span>
6408 <span class=
"json-property-range" title=
"Value limits"></span>
6410 <dt data-property-name=
"views">
6411 <span class=
"json-property-name">views:
</span>
6412 <span class=
"json-property-type">number
</span>
6413 <span class=
"json-property-range" title=
"Value limits"></span>
6415 <dt data-property-name=
"likes">
6416 <span class=
"json-property-name">likes:
</span>
6417 <span class=
"json-property-type">number
</span>
6418 <span class=
"json-property-range" title=
"Value limits"></span>
6420 <dt data-property-name=
"dislikes">
6421 <span class=
"json-property-name">dislikes:
</span>
6422 <span class=
"json-property-type">number
</span>
6423 <span class=
"json-property-range" title=
"Value limits"></span>
6425 <dt data-property-name=
"nsfw">
6426 <span class=
"json-property-name">nsfw:
</span>
6427 <span class=
"json-property-type">boolean
</span>
6428 <span class=
"json-property-range" title=
"Value limits"></span>
6430 <dt data-property-name=
"account">
6431 <span class=
"json-property-name">account:
</span>
6432 <span class=
"json-property-type">object
</span>
6433 <span class=
"json-property-range" title=
"Value limits"></span>
6435 <dt class=
"json-inner-schema">
6436 <section class=
"json-schema-properties">
6438 <dt data-property-name=
"name">
6439 <span class=
"json-property-name">name:
</span>
6440 <span class=
"json-property-type">string
</span>
6441 <span class=
"json-property-range" title=
"Value limits"></span>
6443 <dt data-property-name=
"displayName">
6444 <span class=
"json-property-name">displayName:
</span>
6445 <span class=
"json-property-type">string
</span>
6446 <span class=
"json-property-range" title=
"Value limits"></span>
6448 <dt data-property-name=
"url">
6449 <span class=
"json-property-name">url:
</span>
6450 <span class=
"json-property-type">string
</span>
6451 <span class=
"json-property-range" title=
"Value limits"></span>
6453 <dt data-property-name=
"host">
6454 <span class=
"json-property-name">host:
</span>
6455 <span class=
"json-property-type">string
</span>
6456 <span class=
"json-property-range" title=
"Value limits"></span>
6458 <dt data-property-name=
"avatar">
6459 <span class=
"json-property-name">avatar:
</span>
6460 <span class=
"json-property-type">
6462 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
6465 <span class=
"json-property-range" title=
"Value limits"></span>
6473 <div class=
"doc-examples">
6476 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6477 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6478 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6479 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6480 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6481 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6482 <span class=
"hljs-attr">"category
"</span>: {
6483 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6484 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6486 <span class=
"hljs-attr">"licence
"</span>: {
6487 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6488 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6490 <span class=
"hljs-attr">"language
"</span>: {
6491 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
6492 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6494 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
6495 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6496 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6497 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6498 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6499 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6500 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6501 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6502 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6503 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6504 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6505 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6506 <span class=
"hljs-attr">"account
"</span>: {
6507 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6508 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6509 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6510 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6511 <span class=
"hljs-attr">"avatar
"</span>: {
6512 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6513 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6514 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6524 <div id=
"definition-VideoAbuse" class=
"definition panel" data-traverse-target=
"definition-VideoAbuse">
6525 <h2 class=
"panel-title">
6526 <a name=
"/definitions/VideoAbuse"></a>VideoAbuse:
6527 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6528 <span class="json-property-range" title="Value limits"></span>
6533 <div class=
"doc-row">
6534 <div class=
"doc-copy">
6535 <section class=
"json-schema-properties">
6537 <dt data-property-name=
"id">
6538 <span class=
"json-property-name">id:
</span>
6539 <span class=
"json-property-type">number
</span>
6540 <span class=
"json-property-range" title=
"Value limits"></span>
6542 <dt data-property-name=
"reason">
6543 <span class=
"json-property-name">reason:
</span>
6544 <span class=
"json-property-type">string
</span>
6545 <span class=
"json-property-range" title=
"Value limits"></span>
6547 <dt data-property-name=
"reporterAccount">
6548 <span class=
"json-property-name">reporterAccount:
</span>
6549 <span class=
"json-property-type">
6551 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
6554 <span class=
"json-property-range" title=
"Value limits"></span>
6556 <dt data-property-name=
"video">
6557 <span class=
"json-property-name">video:
</span>
6558 <span class=
"json-property-type">object
</span>
6559 <span class=
"json-property-range" title=
"Value limits"></span>
6561 <dt class=
"json-inner-schema">
6562 <section class=
"json-schema-properties">
6564 <dt data-property-name=
"id">
6565 <span class=
"json-property-name">id:
</span>
6566 <span class=
"json-property-type">number
</span>
6567 <span class=
"json-property-range" title=
"Value limits"></span>
6569 <dt data-property-name=
"name">
6570 <span class=
"json-property-name">name:
</span>
6571 <span class=
"json-property-type">string
</span>
6572 <span class=
"json-property-range" title=
"Value limits"></span>
6574 <dt data-property-name=
"uuid">
6575 <span class=
"json-property-name">uuid:
</span>
6576 <span class=
"json-property-type">string
</span>
6577 <span class=
"json-property-range" title=
"Value limits"></span>
6579 <dt data-property-name=
"url">
6580 <span class=
"json-property-name">url:
</span>
6581 <span class=
"json-property-type">string
</span>
6582 <span class=
"json-property-range" title=
"Value limits"></span>
6587 <dt data-property-name=
"createdAt">
6588 <span class=
"json-property-name">createdAt:
</span>
6589 <span class=
"json-property-type">string
</span>
6590 <span class=
"json-property-range" title=
"Value limits"></span>
6595 <div class=
"doc-examples">
6598 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6599 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6600 <span class=
"hljs-attr">"reason
"</span>:
<span class=
"hljs-string">"string
"</span>,
6601 <span class=
"hljs-attr">"reporterAccount
"</span>: {
6602 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6603 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6604 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6605 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6606 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6607 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6608 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6609 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6610 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6611 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6612 <span class=
"hljs-attr">"avatar
"</span>: {
6613 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6614 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6615 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6618 <span class=
"hljs-attr">"video
"</span>: {
6619 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6620 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6621 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6622 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>
6624 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6632 <div id=
"definition-VideoBlacklist" class=
"definition panel" data-traverse-target=
"definition-VideoBlacklist">
6633 <h2 class=
"panel-title">
6634 <a name=
"/definitions/VideoBlacklist"></a>VideoBlacklist:
6635 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6636 <span class="json-property-range" title="Value limits"></span>
6641 <div class=
"doc-row">
6642 <div class=
"doc-copy">
6643 <section class=
"json-schema-properties">
6645 <dt data-property-name=
"id">
6646 <span class=
"json-property-name">id:
</span>
6647 <span class=
"json-property-type">number
</span>
6648 <span class=
"json-property-range" title=
"Value limits"></span>
6650 <dt data-property-name=
"videoId">
6651 <span class=
"json-property-name">videoId:
</span>
6652 <span class=
"json-property-type">number
</span>
6653 <span class=
"json-property-range" title=
"Value limits"></span>
6655 <dt data-property-name=
"createdAt">
6656 <span class=
"json-property-name">createdAt:
</span>
6657 <span class=
"json-property-type">string
</span>
6658 <span class=
"json-property-range" title=
"Value limits"></span>
6660 <dt data-property-name=
"updatedAt">
6661 <span class=
"json-property-name">updatedAt:
</span>
6662 <span class=
"json-property-type">string
</span>
6663 <span class=
"json-property-range" title=
"Value limits"></span>
6665 <dt data-property-name=
"name">
6666 <span class=
"json-property-name">name:
</span>
6667 <span class=
"json-property-type">string
</span>
6668 <span class=
"json-property-range" title=
"Value limits"></span>
6670 <dt data-property-name=
"uuid">
6671 <span class=
"json-property-name">uuid:
</span>
6672 <span class=
"json-property-type">string
</span>
6673 <span class=
"json-property-range" title=
"Value limits"></span>
6675 <dt data-property-name=
"description">
6676 <span class=
"json-property-name">description:
</span>
6677 <span class=
"json-property-type">string
</span>
6678 <span class=
"json-property-range" title=
"Value limits"></span>
6680 <dt data-property-name=
"duration">
6681 <span class=
"json-property-name">duration:
</span>
6682 <span class=
"json-property-type">number
</span>
6683 <span class=
"json-property-range" title=
"Value limits"></span>
6685 <dt data-property-name=
"views">
6686 <span class=
"json-property-name">views:
</span>
6687 <span class=
"json-property-type">number
</span>
6688 <span class=
"json-property-range" title=
"Value limits"></span>
6690 <dt data-property-name=
"likes">
6691 <span class=
"json-property-name">likes:
</span>
6692 <span class=
"json-property-type">number
</span>
6693 <span class=
"json-property-range" title=
"Value limits"></span>
6695 <dt data-property-name=
"dislikes">
6696 <span class=
"json-property-name">dislikes:
</span>
6697 <span class=
"json-property-type">number
</span>
6698 <span class=
"json-property-range" title=
"Value limits"></span>
6700 <dt data-property-name=
"nsfw">
6701 <span class=
"json-property-name">nsfw:
</span>
6702 <span class=
"json-property-type">boolean
</span>
6703 <span class=
"json-property-range" title=
"Value limits"></span>
6708 <div class=
"doc-examples">
6711 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6712 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6713 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6714 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6715 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6716 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6717 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6718 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6719 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6720 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6721 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6722 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6723 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
6731 <div id=
"definition-VideoChannel" class=
"definition panel" data-traverse-target=
"definition-VideoChannel">
6732 <h2 class=
"panel-title">
6733 <a name=
"/definitions/VideoChannel"></a>VideoChannel:
6734 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6735 <span class="json-property-range" title="Value limits"></span>
6740 <div class=
"doc-row">
6741 <div class=
"doc-copy">
6742 <section class=
"json-schema-properties">
6744 <dt data-property-name=
"displayName">
6745 <span class=
"json-property-name">displayName:
</span>
6746 <span class=
"json-property-type">string
</span>
6747 <span class=
"json-property-range" title=
"Value limits"></span>
6749 <dt data-property-name=
"description">
6750 <span class=
"json-property-name">description:
</span>
6751 <span class=
"json-property-type">string
</span>
6752 <span class=
"json-property-range" title=
"Value limits"></span>
6754 <dt data-property-name=
"isLocal">
6755 <span class=
"json-property-name">isLocal:
</span>
6756 <span class=
"json-property-type">boolean
</span>
6757 <span class=
"json-property-range" title=
"Value limits"></span>
6759 <dt data-property-name=
"ownerAccount">
6760 <span class=
"json-property-name">ownerAccount:
</span>
6761 <span class=
"json-property-type">object
</span>
6762 <span class=
"json-property-range" title=
"Value limits"></span>
6764 <dt class=
"json-inner-schema">
6765 <section class=
"json-schema-properties">
6767 <dt data-property-name=
"id">
6768 <span class=
"json-property-name">id:
</span>
6769 <span class=
"json-property-type">number
</span>
6770 <span class=
"json-property-range" title=
"Value limits"></span>
6772 <dt data-property-name=
"uuid">
6773 <span class=
"json-property-name">uuid:
</span>
6774 <span class=
"json-property-type">string
</span>
6775 <span class=
"json-property-range" title=
"Value limits"></span>
6783 <div class=
"doc-examples">
6786 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6787 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6788 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6789 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6790 <span class=
"hljs-attr">"ownerAccount
"</span>: {
6791 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6792 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
6801 <div id=
"definition-VideoComment" class=
"definition panel" data-traverse-target=
"definition-VideoComment">
6802 <h2 class=
"panel-title">
6803 <a name=
"/definitions/VideoComment"></a>VideoComment:
6804 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6805 <span class="json-property-range" title="Value limits"></span>
6810 <div class=
"doc-row">
6811 <div class=
"doc-copy">
6812 <section class=
"json-schema-properties">
6814 <dt data-property-name=
"id">
6815 <span class=
"json-property-name">id:
</span>
6816 <span class=
"json-property-type">number
</span>
6817 <span class=
"json-property-range" title=
"Value limits"></span>
6819 <dt data-property-name=
"url">
6820 <span class=
"json-property-name">url:
</span>
6821 <span class=
"json-property-type">string
</span>
6822 <span class=
"json-property-range" title=
"Value limits"></span>
6824 <dt data-property-name=
"text">
6825 <span class=
"json-property-name">text:
</span>
6826 <span class=
"json-property-type">string
</span>
6827 <span class=
"json-property-range" title=
"Value limits"></span>
6829 <dt data-property-name=
"threadId">
6830 <span class=
"json-property-name">threadId:
</span>
6831 <span class=
"json-property-type">number
</span>
6832 <span class=
"json-property-range" title=
"Value limits"></span>
6834 <dt data-property-name=
"inReplyToCommentId">
6835 <span class=
"json-property-name">inReplyToCommentId:
</span>
6836 <span class=
"json-property-type">number
</span>
6837 <span class=
"json-property-range" title=
"Value limits"></span>
6839 <dt data-property-name=
"videoId">
6840 <span class=
"json-property-name">videoId:
</span>
6841 <span class=
"json-property-type">number
</span>
6842 <span class=
"json-property-range" title=
"Value limits"></span>
6844 <dt data-property-name=
"createdAt">
6845 <span class=
"json-property-name">createdAt:
</span>
6846 <span class=
"json-property-type">string
</span>
6847 <span class=
"json-property-range" title=
"Value limits"></span>
6849 <dt data-property-name=
"updatedAt">
6850 <span class=
"json-property-name">updatedAt:
</span>
6851 <span class=
"json-property-type">string
</span>
6852 <span class=
"json-property-range" title=
"Value limits"></span>
6854 <dt data-property-name=
"totalReplies">
6855 <span class=
"json-property-name">totalReplies:
</span>
6856 <span class=
"json-property-type">number
</span>
6857 <span class=
"json-property-range" title=
"Value limits"></span>
6859 <dt data-property-name=
"account">
6860 <span class=
"json-property-name">account:
</span>
6861 <span class=
"json-property-type">
6863 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
6866 <span class=
"json-property-range" title=
"Value limits"></span>
6871 <div class=
"doc-examples">
6874 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6875 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6876 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6877 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6878 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6879 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6880 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6881 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6882 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6883 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6884 <span class=
"hljs-attr">"account
"</span>: {
6885 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6886 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6887 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6888 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6889 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6890 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6891 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6892 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6893 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6894 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6895 <span class=
"hljs-attr">"avatar
"</span>: {
6896 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6897 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6898 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6908 <div id=
"definition-VideoCommentThreadTree" class=
"definition panel" data-traverse-target=
"definition-VideoCommentThreadTree">
6909 <h2 class=
"panel-title">
6910 <a name=
"/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree:
6911 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6912 <span class="json-property-range" title="Value limits"></span>
6917 <div class=
"doc-row">
6918 <div class=
"doc-copy">
6919 <section class=
"json-schema-properties">
6921 <dt data-property-name=
"comment">
6922 <span class=
"json-property-name">comment:
</span>
6923 <span class=
"json-property-type">
6925 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
6928 <span class=
"json-property-range" title=
"Value limits"></span>
6930 <dt data-property-name=
"children">
6931 <span class=
"json-property-name">children:
</span>
6932 <span class=
"json-property-type">
6933 <span class=
"json-schema-ref-array">
6934 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
6937 <span class=
"json-property-range" title=
"Value limits"></span>
6939 <dt class=
"json-inner-schema">
6940 <section class=
"json-schema-array-items">
6941 <span class=
"json-property-type">
6943 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
6946 <span class=
"json-property-range" title=
"Value limits"></span>
6947 <div class=
"json-inner-schema"> </div>
6953 <div class=
"doc-examples">
6956 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6957 <span class=
"hljs-attr">"comment
"</span>: {
6958 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6959 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6960 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6961 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6962 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6963 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6964 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6965 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6966 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6967 <span class=
"hljs-attr">"account
"</span>: {
6968 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6969 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6970 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6971 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6972 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6973 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6974 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6975 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6976 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6977 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6978 <span class=
"hljs-attr">"avatar
"</span>: {
6979 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6980 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6981 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6985 <span class=
"hljs-attr">"children
"</span>: [
6987 <span class=
"hljs-attr">"comment
"</span>: {
6988 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6989 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6990 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
6991 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6992 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6993 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6994 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6995 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6996 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
6997 <span class=
"hljs-attr">"account
"</span>: {
6998 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6999 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7000 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7001 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7002 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7003 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7004 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7005 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7006 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7007 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7008 <span class=
"hljs-attr">"avatar
"</span>: {
7009 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7010 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7011 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7015 <span class=
"hljs-attr">"children
"</span>: [
7017 <span class=
"hljs-attr">"comment
"</span>: {
7018 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7019 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7020 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7021 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7022 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7023 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7024 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7025 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7026 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7027 <span class=
"hljs-attr">"account
"</span>: {
7028 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7029 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7030 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7031 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7032 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7033 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7034 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7035 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7036 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7037 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7038 <span class=
"hljs-attr">"avatar
"</span>: {
7039 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7040 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7041 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7056 <div id=
"definition-Avatar" class=
"definition panel" data-traverse-target=
"definition-Avatar">
7057 <h2 class=
"panel-title">
7058 <a name=
"/definitions/Avatar"></a>Avatar:
7059 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7060 <span class="json-property-range" title="Value limits"></span>
7065 <div class=
"doc-row">
7066 <div class=
"doc-copy">
7067 <section class=
"json-schema-properties">
7069 <dt data-property-name=
"path">
7070 <span class=
"json-property-name">path:
</span>
7071 <span class=
"json-property-type">string
</span>
7072 <span class=
"json-property-range" title=
"Value limits"></span>
7074 <dt data-property-name=
"createdAt">
7075 <span class=
"json-property-name">createdAt:
</span>
7076 <span class=
"json-property-type">string
</span>
7077 <span class=
"json-property-range" title=
"Value limits"></span>
7079 <dt data-property-name=
"updatedAt">
7080 <span class=
"json-property-name">updatedAt:
</span>
7081 <span class=
"json-property-type">string
</span>
7082 <span class=
"json-property-range" title=
"Value limits"></span>
7087 <div class=
"doc-examples">
7090 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7091 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7092 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7093 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7101 <div id=
"definition-Actor" class=
"definition panel" data-traverse-target=
"definition-Actor">
7102 <h2 class=
"panel-title">
7103 <a name=
"/definitions/Actor"></a>Actor:
7104 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7105 <span class="json-property-range" title="Value limits"></span>
7110 <div class=
"doc-row">
7111 <div class=
"doc-copy">
7112 <section class=
"json-schema-properties">
7114 <dt data-property-name=
"id">
7115 <span class=
"json-property-name">id:
</span>
7116 <span class=
"json-property-type">number
</span>
7117 <span class=
"json-property-range" title=
"Value limits"></span>
7119 <dt data-property-name=
"uuid">
7120 <span class=
"json-property-name">uuid:
</span>
7121 <span class=
"json-property-type">string
</span>
7122 <span class=
"json-property-range" title=
"Value limits"></span>
7124 <dt data-property-name=
"url">
7125 <span class=
"json-property-name">url:
</span>
7126 <span class=
"json-property-type">string
</span>
7127 <span class=
"json-property-range" title=
"Value limits"></span>
7129 <dt data-property-name=
"name">
7130 <span class=
"json-property-name">name:
</span>
7131 <span class=
"json-property-type">string
</span>
7132 <span class=
"json-property-range" title=
"Value limits"></span>
7134 <dt data-property-name=
"host">
7135 <span class=
"json-property-name">host:
</span>
7136 <span class=
"json-property-type">string
</span>
7137 <span class=
"json-property-range" title=
"Value limits"></span>
7139 <dt data-property-name=
"followingCount">
7140 <span class=
"json-property-name">followingCount:
</span>
7141 <span class=
"json-property-type">number
</span>
7142 <span class=
"json-property-range" title=
"Value limits"></span>
7144 <dt data-property-name=
"followersCount">
7145 <span class=
"json-property-name">followersCount:
</span>
7146 <span class=
"json-property-type">number
</span>
7147 <span class=
"json-property-range" title=
"Value limits"></span>
7149 <dt data-property-name=
"createdAt">
7150 <span class=
"json-property-name">createdAt:
</span>
7151 <span class=
"json-property-type">string
</span>
7152 <span class=
"json-property-range" title=
"Value limits"></span>
7154 <dt data-property-name=
"updatedAt">
7155 <span class=
"json-property-name">updatedAt:
</span>
7156 <span class=
"json-property-type">string
</span>
7157 <span class=
"json-property-range" title=
"Value limits"></span>
7159 <dt data-property-name=
"avatar">
7160 <span class=
"json-property-name">avatar:
</span>
7161 <span class=
"json-property-type">
7163 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
7166 <span class=
"json-property-range" title=
"Value limits"></span>
7171 <div class=
"doc-examples">
7174 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7175 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7176 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7177 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7178 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7179 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7180 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7181 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7182 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7183 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7184 <span class=
"hljs-attr">"avatar
"</span>: {
7185 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7186 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7187 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7196 <div id=
"definition-Account" class=
"definition panel" data-traverse-target=
"definition-Account">
7197 <h2 class=
"panel-title">
7198 <a name=
"/definitions/Account"></a>Account:
7199 <!-- <span class="json-property-type"><span class="json-property-type"></span>
7200 <span class="json-property-range" title="Value limits"></span>
7205 <div class=
"doc-row">
7206 <div class=
"doc-copy">
7207 <section class=
"json-schema-allOf">
7208 <section class=
"json-schema-allOf-inherited">
7211 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7215 <section class=
"json-schema-allOf-additional">
7216 <section class=
"json-schema-properties">
7218 <dt data-property-name=
"displayName">
7219 <span class=
"json-property-name">displayName:
</span>
7220 <span class=
"json-property-type">string
</span>
7221 <span class=
"json-property-range" title=
"Value limits"></span>
7228 <div class=
"doc-examples">
7231 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7232 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7233 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7234 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7235 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7236 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7237 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7238 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7239 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7240 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7241 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7242 <span class=
"hljs-attr">"avatar
"</span>: {
7243 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7244 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7245 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7254 <div id=
"definition-User" class=
"definition panel" data-traverse-target=
"definition-User">
7255 <h2 class=
"panel-title">
7256 <a name=
"/definitions/User"></a>User:
7257 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7258 <span class="json-property-range" title="Value limits"></span>
7263 <div class=
"doc-row">
7264 <div class=
"doc-copy">
7265 <section class=
"json-schema-properties">
7267 <dt data-property-name=
"id">
7268 <span class=
"json-property-name">id:
</span>
7269 <span class=
"json-property-type">number
</span>
7270 <span class=
"json-property-range" title=
"Value limits"></span>
7272 <dt data-property-name=
"username">
7273 <span class=
"json-property-name">username:
</span>
7274 <span class=
"json-property-type">string
</span>
7275 <span class=
"json-property-range" title=
"Value limits"></span>
7277 <dt data-property-name=
"email">
7278 <span class=
"json-property-name">email:
</span>
7279 <span class=
"json-property-type">string
</span>
7280 <span class=
"json-property-range" title=
"Value limits"></span>
7282 <dt data-property-name=
"displayNSFW">
7283 <span class=
"json-property-name">displayNSFW:
</span>
7284 <span class=
"json-property-type">boolean
</span>
7285 <span class=
"json-property-range" title=
"Value limits"></span>
7287 <dt data-property-name=
"autoPlayVideo">
7288 <span class=
"json-property-name">autoPlayVideo:
</span>
7289 <span class=
"json-property-type">boolean
</span>
7290 <span class=
"json-property-range" title=
"Value limits"></span>
7292 <dt data-property-name=
"role">
7293 <span class=
"json-property-name">role:
</span>
7294 <span class=
"json-property-type">string
</span>
7295 <span class=
"json-property-enum" title=
"Possible values">
7296 <span class=
"json-property-enum-item">User
</span>,
7297 <span class=
"json-property-enum-item">Moderator
</span>,
7298 <span class=
"json-property-enum-item">Administrator
</span>
7300 <span class=
"json-property-range" title=
"Value limits"></span>
7302 <dt data-property-name=
"videoQuota">
7303 <span class=
"json-property-name">videoQuota:
</span>
7304 <span class=
"json-property-type">number
</span>
7305 <span class=
"json-property-range" title=
"Value limits"></span>
7307 <dt data-property-name=
"createdAt">
7308 <span class=
"json-property-name">createdAt:
</span>
7309 <span class=
"json-property-type">string
</span>
7310 <span class=
"json-property-range" title=
"Value limits"></span>
7312 <dt data-property-name=
"account">
7313 <span class=
"json-property-name">account:
</span>
7314 <span class=
"json-property-type">
7316 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
7319 <span class=
"json-property-range" title=
"Value limits"></span>
7321 <dt data-property-name=
"videoChannels">
7322 <span class=
"json-property-name">videoChannels:
</span>
7323 <span class=
"json-property-type">
7324 <span class=
"json-schema-ref-array">
7325 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
7328 <span class=
"json-property-range" title=
"Value limits"></span>
7330 <dt class=
"json-inner-schema">
7331 <section class=
"json-schema-array-items">
7332 <span class=
"json-property-type">
7334 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
7337 <span class=
"json-property-range" title=
"Value limits"></span>
7338 <div class=
"json-inner-schema"> </div>
7344 <div class=
"doc-examples">
7347 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7348 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7349 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
7350 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
7351 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7352 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7353 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
7354 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
7355 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7356 <span class=
"hljs-attr">"account
"</span>: {
7357 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7358 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7359 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7360 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7361 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7362 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7363 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7364 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7365 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7366 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7367 <span class=
"hljs-attr">"avatar
"</span>: {
7368 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7369 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7370 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7373 <span class=
"hljs-attr">"videoChannels
"</span>: [
7375 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7376 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
7377 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7378 <span class=
"hljs-attr">"ownerAccount
"</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>
7391 <div id=
"definition-ServerConfig" class=
"definition panel" data-traverse-target=
"definition-ServerConfig">
7392 <h2 class=
"panel-title">
7393 <a name=
"/definitions/ServerConfig"></a>ServerConfig:
7394 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7395 <span class="json-property-range" title="Value limits"></span>
7400 <div class=
"doc-row">
7401 <div class=
"doc-copy">
7402 <section class=
"json-schema-properties">
7404 <dt data-property-name=
"signup">
7405 <span class=
"json-property-name">signup:
</span>
7406 <span class=
"json-property-type">object
</span>
7407 <span class=
"json-property-range" title=
"Value limits"></span>
7409 <dt class=
"json-inner-schema">
7410 <section class=
"json-schema-properties">
7412 <dt data-property-name=
"allowed">
7413 <span class=
"json-property-name">allowed:
</span>
7414 <span class=
"json-property-type">boolean
</span>
7415 <span class=
"json-property-range" title=
"Value limits"></span>
7420 <dt data-property-name=
"transcoding">
7421 <span class=
"json-property-name">transcoding:
</span>
7422 <span class=
"json-property-type">object
</span>
7423 <span class=
"json-property-range" title=
"Value limits"></span>
7425 <dt class=
"json-inner-schema">
7426 <section class=
"json-schema-properties">
7428 <dt data-property-name=
"enabledResolutions">
7429 <span class=
"json-property-name">enabledResolutions:
</span>
7430 <span class=
"json-property-type">number[]
</span>
7431 <span class=
"json-property-range" title=
"Value limits"></span>
7433 <dt class=
"json-inner-schema">
7434 <section class=
"json-schema-array-items">
7435 <span class=
"json-property-type">number
</span>
7436 <span class=
"json-property-range" title=
"Value limits"></span>
7437 <div class=
"json-inner-schema"> </div>
7443 <dt data-property-name=
"avatar">
7444 <span class=
"json-property-name">avatar:
</span>
7445 <span class=
"json-property-type">object
</span>
7446 <span class=
"json-property-range" title=
"Value limits"></span>
7448 <dt class=
"json-inner-schema">
7449 <section class=
"json-schema-properties">
7451 <dt data-property-name=
"file">
7452 <span class=
"json-property-name">file:
</span>
7453 <span class=
"json-property-type">object
</span>
7454 <span class=
"json-property-range" title=
"Value limits"></span>
7456 <dt class=
"json-inner-schema">
7457 <section class=
"json-schema-properties">
7459 <dt data-property-name=
"size">
7460 <span class=
"json-property-name">size:
</span>
7461 <span class=
"json-property-type">object
</span>
7462 <span class=
"json-property-range" title=
"Value limits"></span>
7464 <dt class=
"json-inner-schema">
7465 <section class=
"json-schema-properties">
7467 <dt data-property-name=
"max">
7468 <span class=
"json-property-name">max:
</span>
7469 <span class=
"json-property-type">number
</span>
7470 <span class=
"json-property-range" title=
"Value limits"></span>
7478 <dt data-property-name=
"extensions">
7479 <span class=
"json-property-name">extensions:
</span>
7480 <span class=
"json-property-type">string[]
</span>
7481 <span class=
"json-property-range" title=
"Value limits"></span>
7483 <dt class=
"json-inner-schema">
7484 <section class=
"json-schema-array-items">
7485 <span class=
"json-property-type">string
</span>
7486 <span class=
"json-property-range" title=
"Value limits"></span>
7487 <div class=
"json-inner-schema"> </div>
7493 <dt data-property-name=
"video">
7494 <span class=
"json-property-name">video:
</span>
7495 <span class=
"json-property-type">object
</span>
7496 <span class=
"json-property-range" title=
"Value limits"></span>
7498 <dt class=
"json-inner-schema">
7499 <section class=
"json-schema-properties">
7501 <dt data-property-name=
"file">
7502 <span class=
"json-property-name">file:
</span>
7503 <span class=
"json-property-type">object
</span>
7504 <span class=
"json-property-range" title=
"Value limits"></span>
7506 <dt class=
"json-inner-schema">
7507 <section class=
"json-schema-properties">
7509 <dt data-property-name=
"extensions">
7510 <span class=
"json-property-name">extensions:
</span>
7511 <span class=
"json-property-type">string[]
</span>
7512 <span class=
"json-property-range" title=
"Value limits"></span>
7514 <dt class=
"json-inner-schema">
7515 <section class=
"json-schema-array-items">
7516 <span class=
"json-property-type">string
</span>
7517 <span class=
"json-property-range" title=
"Value limits"></span>
7518 <div class=
"json-inner-schema"> </div>
7530 <div class=
"doc-examples">
7533 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7534 <span class=
"hljs-attr">"signup
"</span>: {
7535 <span class=
"hljs-attr">"allowed
"</span>:
<span class=
"hljs-string">"boolean
"</span>
7537 <span class=
"hljs-attr">"transcoding
"</span>: {
7538 <span class=
"hljs-attr">"enabledResolutions
"</span>: [
7539 <span class=
"hljs-string">"number
"</span>
7542 <span class=
"hljs-attr">"avatar
"</span>: {
7543 <span class=
"hljs-attr">"file
"</span>: {
7544 <span class=
"hljs-attr">"size
"</span>: {
7545 <span class=
"hljs-attr">"max
"</span>:
<span class=
"hljs-string">"number
"</span>
7548 <span class=
"hljs-attr">"extensions
"</span>: [
7549 <span class=
"hljs-string">"string
"</span>
7552 <span class=
"hljs-attr">"video
"</span>: {
7553 <span class=
"hljs-attr">"file
"</span>: {
7554 <span class=
"hljs-attr">"extensions
"</span>: [
7555 <span class=
"hljs-string">"string
"</span>
7566 <div id=
"definition-Follow" class=
"definition panel" data-traverse-target=
"definition-Follow">
7567 <h2 class=
"panel-title">
7568 <a name=
"/definitions/Follow"></a>Follow:
7569 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7570 <span class="json-property-range" title="Value limits"></span>
7575 <div class=
"doc-row">
7576 <div class=
"doc-copy">
7577 <section class=
"json-schema-properties">
7579 <dt data-property-name=
"id">
7580 <span class=
"json-property-name">id:
</span>
7581 <span class=
"json-property-type">number
</span>
7582 <span class=
"json-property-range" title=
"Value limits"></span>
7584 <dt data-property-name=
"follower">
7585 <span class=
"json-property-name">follower:
</span>
7586 <span class=
"json-property-type">
7588 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7591 <span class=
"json-property-range" title=
"Value limits"></span>
7593 <dt data-property-name=
"following">
7594 <span class=
"json-property-name">following:
</span>
7595 <span class=
"json-property-type">
7597 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7600 <span class=
"json-property-range" title=
"Value limits"></span>
7602 <dt data-property-name=
"score">
7603 <span class=
"json-property-name">score:
</span>
7604 <span class=
"json-property-type">number
</span>
7605 <span class=
"json-property-range" title=
"Value limits"></span>
7607 <dt data-property-name=
"state">
7608 <span class=
"json-property-name">state:
</span>
7609 <span class=
"json-property-type">string
</span>
7610 <span class=
"json-property-enum" title=
"Possible values">
7611 <span class=
"json-property-enum-item">pending
</span>,
7612 <span class=
"json-property-enum-item">accepted
</span>
7614 <span class=
"json-property-range" title=
"Value limits"></span>
7616 <dt data-property-name=
"createdAt">
7617 <span class=
"json-property-name">createdAt:
</span>
7618 <span class=
"json-property-type">string
</span>
7619 <span class=
"json-property-range" title=
"Value limits"></span>
7621 <dt data-property-name=
"updatedAt">
7622 <span class=
"json-property-name">updatedAt:
</span>
7623 <span class=
"json-property-type">string
</span>
7624 <span class=
"json-property-range" title=
"Value limits"></span>
7629 <div class=
"doc-examples">
7632 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7633 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7634 <span class=
"hljs-attr">"follower
"</span>: {
7635 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7636 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7637 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7638 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7639 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7640 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7641 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7642 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7643 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7644 <span class=
"hljs-attr">"avatar
"</span>: {
7645 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7646 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7647 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7650 <span class=
"hljs-attr">"following
"</span>: {
7651 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7652 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7653 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7654 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7655 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7656 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7657 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7658 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7659 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7660 <span class=
"hljs-attr">"avatar
"</span>: {
7661 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7662 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7663 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7666 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
7667 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
7668 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7669 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7677 <div id=
"definition-Job" class=
"definition panel" data-traverse-target=
"definition-Job">
7678 <h2 class=
"panel-title">
7679 <a name=
"/definitions/Job"></a>Job:
7680 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7681 <span class="json-property-range" title="Value limits"></span>
7686 <div class=
"doc-row">
7687 <div class=
"doc-copy">
7688 <section class=
"json-schema-properties">
7690 <dt data-property-name=
"id">
7691 <span class=
"json-property-name">id:
</span>
7692 <span class=
"json-property-type">number
</span>
7693 <span class=
"json-property-range" title=
"Value limits"></span>
7695 <dt data-property-name=
"state">
7696 <span class=
"json-property-name">state:
</span>
7697 <span class=
"json-property-type">string
</span>
7698 <span class=
"json-property-enum" title=
"Possible values">
7699 <span class=
"json-property-enum-item">pending
</span>,
7700 <span class=
"json-property-enum-item">processing
</span>,
7701 <span class=
"json-property-enum-item">error
</span>,
7702 <span class=
"json-property-enum-item">success
</span>
7704 <span class=
"json-property-range" title=
"Value limits"></span>
7706 <dt data-property-name=
"category">
7707 <span class=
"json-property-name">category:
</span>
7708 <span class=
"json-property-type">string
</span>
7709 <span class=
"json-property-enum" title=
"Possible values">
7710 <span class=
"json-property-enum-item">transcoding
</span>,
7711 <span class=
"json-property-enum-item">activitypub-http
</span>
7713 <span class=
"json-property-range" title=
"Value limits"></span>
7715 <dt data-property-name=
"handlerName">
7716 <span class=
"json-property-name">handlerName:
</span>
7717 <span class=
"json-property-type">string
</span>
7718 <span class=
"json-property-range" title=
"Value limits"></span>
7720 <dt data-property-name=
"handlerInputData">
7721 <span class=
"json-property-name">handlerInputData:
</span>
7722 <span class=
"json-property-type">string
</span>
7723 <span class=
"json-property-range" title=
"Value limits"></span>
7725 <dt data-property-name=
"createdAt">
7726 <span class=
"json-property-name">createdAt:
</span>
7727 <span class=
"json-property-type">string
</span>
7728 <span class=
"json-property-range" title=
"Value limits"></span>
7730 <dt data-property-name=
"updatedAt">
7731 <span class=
"json-property-name">updatedAt:
</span>
7732 <span class=
"json-property-type">string
</span>
7733 <span class=
"json-property-range" title=
"Value limits"></span>
7738 <div class=
"doc-examples">
7741 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7742 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7743 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
7744 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"string
"</span>,
7745 <span class=
"hljs-attr">"handlerName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7746 <span class=
"hljs-attr">"handlerInputData
"</span>:
<span class=
"hljs-string">"string
"</span>,
7747 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7748 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7756 <div id=
"definition-AddUserResponse" class=
"definition panel" data-traverse-target=
"definition-AddUserResponse">
7757 <h2 class=
"panel-title">
7758 <a name=
"/definitions/AddUserResponse"></a>AddUserResponse:
7759 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7760 <span class="json-property-range" title="Value limits"></span>
7765 <div class=
"doc-row">
7766 <div class=
"doc-copy">
7767 <section class=
"json-schema-properties">
7769 <dt data-property-name=
"id">
7770 <span class=
"json-property-name">id:
</span>
7771 <span class=
"json-property-type">number
</span>
7772 <span class=
"json-property-range" title=
"Value limits"></span>
7774 <dt data-property-name=
"uuid">
7775 <span class=
"json-property-name">uuid:
</span>
7776 <span class=
"json-property-type">string
</span>
7777 <span class=
"json-property-range" title=
"Value limits"></span>
7782 <div class=
"doc-examples">
7785 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7786 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7787 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
7795 <div id=
"definition-VideoUploadResponse" class=
"definition panel" data-traverse-target=
"definition-VideoUploadResponse">
7796 <h2 class=
"panel-title">
7797 <a name=
"/definitions/VideoUploadResponse"></a>VideoUploadResponse:
7798 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7799 <span class="json-property-range" title="Value limits"></span>
7804 <div class=
"doc-row">
7805 <div class=
"doc-copy">
7806 <section class=
"json-schema-properties">
7808 <dt data-property-name=
"video">
7809 <span class=
"json-property-name">video:
</span>
7810 <span class=
"json-property-type">object
</span>
7811 <span class=
"json-property-range" title=
"Value limits"></span>
7813 <dt class=
"json-inner-schema">
7814 <section class=
"json-schema-properties">
7816 <dt data-property-name=
"id">
7817 <span class=
"json-property-name">id:
</span>
7818 <span class=
"json-property-type">number
</span>
7819 <span class=
"json-property-range" title=
"Value limits"></span>
7821 <dt data-property-name=
"uuid">
7822 <span class=
"json-property-name">uuid:
</span>
7823 <span class=
"json-property-type">string
</span>
7824 <span class=
"json-property-range" title=
"Value limits"></span>
7832 <div class=
"doc-examples">
7835 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7836 <span class=
"hljs-attr">"video
"</span>: {
7837 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7838 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
7847 <div id=
"definition-CommentThreadResponse" class=
"definition panel" data-traverse-target=
"definition-CommentThreadResponse">
7848 <h2 class=
"panel-title">
7849 <a name=
"/definitions/CommentThreadResponse"></a>CommentThreadResponse:
7850 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7851 <span class="json-property-range" title="Value limits"></span>
7856 <div class=
"doc-row">
7857 <div class=
"doc-copy">
7858 <section class=
"json-schema-properties">
7860 <dt data-property-name=
"total">
7861 <span class=
"json-property-name">total:
</span>
7862 <span class=
"json-property-type">number
</span>
7863 <span class=
"json-property-range" title=
"Value limits"></span>
7865 <dt data-property-name=
"data">
7866 <span class=
"json-property-name">data:
</span>
7867 <span class=
"json-property-type">
7868 <span class=
"json-schema-ref-array">
7869 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
7872 <span class=
"json-property-range" title=
"Value limits"></span>
7874 <dt class=
"json-inner-schema">
7875 <section class=
"json-schema-array-items">
7876 <span class=
"json-property-type">
7878 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
7881 <span class=
"json-property-range" title=
"Value limits"></span>
7882 <div class=
"json-inner-schema"> </div>
7888 <div class=
"doc-examples">
7891 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7892 <span class=
"hljs-attr">"total
"</span>:
<span class=
"hljs-string">"number
"</span>,
7893 <span class=
"hljs-attr">"data
"</span>: [
7895 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7896 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7897 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7898 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7899 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7900 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7901 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7902 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7903 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7904 <span class=
"hljs-attr">"account
"</span>: {
7905 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7906 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7907 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7908 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7909 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7910 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7911 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7912 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7913 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7914 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7915 <span class=
"hljs-attr">"avatar
"</span>: {
7916 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7917 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7918 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7930 <div id=
"definition-CommentThreadPostResponse" class=
"definition panel" data-traverse-target=
"definition-CommentThreadPostResponse">
7931 <h2 class=
"panel-title">
7932 <a name=
"/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse:
7933 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7934 <span class="json-property-range" title="Value limits"></span>
7939 <div class=
"doc-row">
7940 <div class=
"doc-copy">
7941 <section class=
"json-schema-properties">
7943 <dt data-property-name=
"comment">
7944 <span class=
"json-property-name">comment:
</span>
7945 <span class=
"json-property-type">
7947 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
7950 <span class=
"json-property-range" title=
"Value limits"></span>
7955 <div class=
"doc-examples">
7958 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7959 <span class=
"hljs-attr">"comment
"</span>: {
7960 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7961 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7962 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7963 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7964 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7965 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7966 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7967 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7968 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7969 <span class=
"hljs-attr">"account
"</span>: {
7970 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7971 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7972 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7973 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7974 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7975 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7976 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7977 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7978 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7979 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7980 <span class=
"hljs-attr">"avatar
"</span>: {
7981 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7982 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7983 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7994 <div id=
"definition-AddUser" class=
"definition panel" data-traverse-target=
"definition-AddUser">
7995 <h2 class=
"panel-title">
7996 <a name=
"/definitions/AddUser"></a>AddUser:
7997 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7998 <span class="json-property-range" title="Value limits"></span>
8003 <div class=
"doc-row">
8004 <div class=
"doc-copy">
8005 <section class=
"json-schema-properties">
8007 <dt data-property-name=
"username" class=
"has-description">
8008 <span class=
"json-property-name">username:
</span>
8009 <span class=
"json-property-type">string
</span>
8010 <span class=
"json-property-range" title=
"Value limits"></span>
8011 <span class=
"json-property-required"></span>
8014 <p>The user username
</p>
8016 <dt data-property-name=
"password" class=
"has-description">
8017 <span class=
"json-property-name">password:
</span>
8018 <span class=
"json-property-type">string
</span>
8019 <span class=
"json-property-range" title=
"Value limits"></span>
8020 <span class=
"json-property-required"></span>
8023 <p>The user password
</p>
8025 <dt data-property-name=
"email" class=
"has-description">
8026 <span class=
"json-property-name">email:
</span>
8027 <span class=
"json-property-type">string
</span>
8028 <span class=
"json-property-range" title=
"Value limits"></span>
8029 <span class=
"json-property-required"></span>
8032 <p>The user email
</p>
8034 <dt data-property-name=
"videoQuota" class=
"has-description">
8035 <span class=
"json-property-name">videoQuota:
</span>
8036 <span class=
"json-property-type">string
</span>
8037 <span class=
"json-property-range" title=
"Value limits"></span>
8038 <span class=
"json-property-required"></span>
8041 <p>The user videoQuota
</p>
8043 <dt data-property-name=
"role" class=
"has-description">
8044 <span class=
"json-property-name">role:
</span>
8045 <span class=
"json-property-type">string
</span>
8046 <span class=
"json-property-range" title=
"Value limits"></span>
8047 <span class=
"json-property-required"></span>
8050 <p>The user role
</p>
8055 <div class=
"doc-examples">
8058 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8059 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
8060 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
8061 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
8062 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
8063 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
8071 <div id=
"definition-UpdateUser" class=
"definition panel" data-traverse-target=
"definition-UpdateUser">
8072 <h2 class=
"panel-title">
8073 <a name=
"/definitions/UpdateUser"></a>UpdateUser:
8074 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8075 <span class="json-property-range" title="Value limits"></span>
8080 <div class=
"doc-row">
8081 <div class=
"doc-copy">
8082 <section class=
"json-schema-properties">
8084 <dt data-property-name=
"id" class=
"has-description">
8085 <span class=
"json-property-name">id:
</span>
8086 <span class=
"json-property-type">string
</span>
8087 <span class=
"json-property-range" title=
"Value limits"></span>
8088 <span class=
"json-property-required"></span>
8093 <dt data-property-name=
"email" class=
"has-description">
8094 <span class=
"json-property-name">email:
</span>
8095 <span class=
"json-property-type">string
</span>
8096 <span class=
"json-property-range" title=
"Value limits"></span>
8097 <span class=
"json-property-required"></span>
8100 <p>The updated email of the user
</p>
8102 <dt data-property-name=
"videoQuota" class=
"has-description">
8103 <span class=
"json-property-name">videoQuota:
</span>
8104 <span class=
"json-property-type">string
</span>
8105 <span class=
"json-property-range" title=
"Value limits"></span>
8106 <span class=
"json-property-required"></span>
8109 <p>The updated videoQuota of the user
</p>
8111 <dt data-property-name=
"role" class=
"has-description">
8112 <span class=
"json-property-name">role:
</span>
8113 <span class=
"json-property-type">string
</span>
8114 <span class=
"json-property-range" title=
"Value limits"></span>
8115 <span class=
"json-property-required"></span>
8118 <p>The updated role of the user
</p>
8123 <div class=
"doc-examples">
8126 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8127 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
8128 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
8129 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
8130 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
8138 <div id=
"definition-UpdateMe" class=
"definition panel" data-traverse-target=
"definition-UpdateMe">
8139 <h2 class=
"panel-title">
8140 <a name=
"/definitions/UpdateMe"></a>UpdateMe:
8141 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8142 <span class="json-property-range" title="Value limits"></span>
8147 <div class=
"doc-row">
8148 <div class=
"doc-copy">
8149 <section class=
"json-schema-properties">
8151 <dt data-property-name=
"password" class=
"has-description">
8152 <span class=
"json-property-name">password:
</span>
8153 <span class=
"json-property-type">string
</span>
8154 <span class=
"json-property-range" title=
"Value limits"></span>
8155 <span class=
"json-property-required"></span>
8158 <p>Your new password
</p>
8160 <dt data-property-name=
"email" class=
"has-description">
8161 <span class=
"json-property-name">email:
</span>
8162 <span class=
"json-property-type">string
</span>
8163 <span class=
"json-property-range" title=
"Value limits"></span>
8164 <span class=
"json-property-required"></span>
8167 <p>Your new email
</p>
8169 <dt data-property-name=
"displayNSFW" class=
"has-description">
8170 <span class=
"json-property-name">displayNSFW:
</span>
8171 <span class=
"json-property-type">string
</span>
8172 <span class=
"json-property-range" title=
"Value limits"></span>
8173 <span class=
"json-property-required"></span>
8176 <p>Your new displayNSFW
</p>
8178 <dt data-property-name=
"autoPlayVideo" class=
"has-description">
8179 <span class=
"json-property-name">autoPlayVideo:
</span>
8180 <span class=
"json-property-type">string
</span>
8181 <span class=
"json-property-range" title=
"Value limits"></span>
8182 <span class=
"json-property-required"></span>
8185 <p>Your new autoPlayVideo
</p>
8190 <div class=
"doc-examples">
8193 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8194 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
8195 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
8196 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"string
"</span>,
8197 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"string
"</span>
8205 <div id=
"definition-GetMeVideoRating" class=
"definition panel" data-traverse-target=
"definition-GetMeVideoRating">
8206 <h2 class=
"panel-title">
8207 <a name=
"/definitions/GetMeVideoRating"></a>GetMeVideoRating:
8208 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8209 <span class="json-property-range" title="Value limits"></span>
8214 <div class=
"doc-row">
8215 <div class=
"doc-copy">
8216 <section class=
"json-schema-properties">
8218 <dt data-property-name=
"id" class=
"has-description">
8219 <span class=
"json-property-name">id:
</span>
8220 <span class=
"json-property-type">string
</span>
8221 <span class=
"json-property-range" title=
"Value limits"></span>
8222 <span class=
"json-property-required"></span>
8225 <p>Id of the video
</p>
8227 <dt data-property-name=
"rating" class=
"has-description">
8228 <span class=
"json-property-name">rating:
</span>
8229 <span class=
"json-property-type">number
</span>
8230 <span class=
"json-property-range" title=
"Value limits"></span>
8231 <span class=
"json-property-required"></span>
8234 <p>Rating of the video
</p>
8239 <div class=
"doc-examples">
8242 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8243 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
8244 <span class=
"hljs-attr">"rating
"</span>:
<span class=
"hljs-string">"number
"</span>
8252 <div id=
"definition-RegisterUser" class=
"definition panel" data-traverse-target=
"definition-RegisterUser">
8253 <h2 class=
"panel-title">
8254 <a name=
"/definitions/RegisterUser"></a>RegisterUser:
8255 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8256 <span class="json-property-range" title="Value limits"></span>
8261 <div class=
"doc-row">
8262 <div class=
"doc-copy">
8263 <section class=
"json-schema-properties">
8265 <dt data-property-name=
"username" class=
"has-description">
8266 <span class=
"json-property-name">username:
</span>
8267 <span class=
"json-property-type">string
</span>
8268 <span class=
"json-property-range" title=
"Value limits"></span>
8269 <span class=
"json-property-required"></span>
8272 <p>The username of the user
</p>
8274 <dt data-property-name=
"password" class=
"has-description">
8275 <span class=
"json-property-name">password:
</span>
8276 <span class=
"json-property-type">string
</span>
8277 <span class=
"json-property-range" title=
"Value limits"></span>
8278 <span class=
"json-property-required"></span>
8281 <p>The password of the user
</p>
8283 <dt data-property-name=
"email" class=
"has-description">
8284 <span class=
"json-property-name">email:
</span>
8285 <span class=
"json-property-type">string
</span>
8286 <span class=
"json-property-range" title=
"Value limits"></span>
8287 <span class=
"json-property-required"></span>
8290 <p>The email of the user
</p>
8295 <div class=
"doc-examples">
8298 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8299 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
8300 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
8301 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>
8309 <div id=
"definition-VideoChannelInput" class=
"definition panel" data-traverse-target=
"definition-VideoChannelInput">
8310 <h2 class=
"panel-title">
8311 <a name=
"/definitions/VideoChannelInput"></a>VideoChannelInput:
8312 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8313 <span class="json-property-range" title="Value limits"></span>
8318 <div class=
"doc-row">
8319 <div class=
"doc-copy">
8320 <section class=
"json-schema-properties">
8322 <dt data-property-name=
"name">
8323 <span class=
"json-property-name">name:
</span>
8324 <span class=
"json-property-type">string
</span>
8325 <span class=
"json-property-range" title=
"Value limits"></span>
8327 <dt data-property-name=
"description">
8328 <span class=
"json-property-name">description:
</span>
8329 <span class=
"json-property-type">string
</span>
8330 <span class=
"json-property-range" title=
"Value limits"></span>
8335 <div class=
"doc-examples">
8338 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8339 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
8340 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
8348 <div class=
"doc-row no-margin">
8349 <div class=
"doc-copy doc-separator">
8350 <a class=
"powered-by" href=
"https://sourcey.com/spectacle">Documentation by
8351 <span>Spectacle
</span>