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--id--put"> PUT /videos/{id}
</a>
142 <a href=
"#operation--videos--id--get"> GET /videos/{id}
</a>
145 <a href=
"#operation--videos--id--delete"> DELETE /videos/{id}
</a>
148 <a href=
"#operation--videos--id--description-get"> GET /videos/{id}/description
</a>
151 <a href=
"#operation--videos--id--views-post"> POST /videos/{id}/views
</a>
154 <a href=
"#operation--videos-upload-post"> POST /videos/upload
</a>
159 <a href=
"#tag-VideoAbuse">VideoAbuse
</a>
162 <a href=
"#operation--videos-abuse-get"> GET /videos/abuse
</a>
165 <a href=
"#operation--videos--id--abuse-post"> POST /videos/{id}/abuse
</a>
170 <a href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
173 <a href=
"#operation--videos--id--blacklist-post"> POST /videos/{id}/blacklist
</a>
176 <a href=
"#operation--videos--id--blacklist-delete"> DELETE /videos/{id}/blacklist
</a>
179 <a href=
"#operation--videos-blacklist-get"> GET /videos/blacklist
</a>
184 <a href=
"#tag-VideoChannel">VideoChannel
</a>
187 <a href=
"#operation--video-channels-get"> GET /video-channels
</a>
190 <a href=
"#operation--video-channels-post"> POST /video-channels
</a>
193 <a href=
"#operation--video-channels--id--get"> GET /video-channels/{id}
</a>
196 <a href=
"#operation--video-channels--id--put"> PUT /video-channels/{id}
</a>
199 <a href=
"#operation--video-channels--id--delete"> DELETE /video-channels/{id}
</a>
202 <a href=
"#operation--video-channels--id--videos-get"> GET /video-channels/{id}/videos
</a>
205 <a href=
"#operation--accounts--name--video-channels-get"> GET /accounts/{name}/video-channels
</a>
210 <a href=
"#tag-VideoComment">VideoComment
</a>
213 <a href=
"#operation--videos--id--comment-threads-get"> GET /videos/{id}/comment-threads
</a>
216 <a href=
"#operation--videos--id--comment-threads-post"> POST /videos/{id}/comment-threads
</a>
219 <a href=
"#operation--videos--id--comment-threads--threadId--get"> GET /videos/{id}/comment-threads/{threadId}
</a>
222 <a href=
"#operation--videos--id--comments--commentId--post"> POST /videos/{id}/comments/{commentId}
</a>
225 <a href=
"#operation--videos--id--comments--commentId--delete"> DELETE /videos/{id}/comments/{commentId}
</a>
230 <a href=
"#tag-VideoRate">VideoRate
</a>
233 <a href=
"#operation--videos--id--rate-put"> PUT /videos/{id}/rate
</a>
238 <a href=
"#tag-Search">Search
</a>
241 <a href=
"#operation--search-videos-get"> GET /search/videos
</a>
245 <h5>Schema Definitions
</h5>
246 <a href=
"#definition-VideoConstantNumber"> VideoConstantNumber
</a>
247 <a href=
"#definition-VideoConstantString"> VideoConstantString
</a>
248 <a href=
"#definition-VideoPrivacy"> VideoPrivacy
</a>
249 <a href=
"#definition-Video"> Video
</a>
250 <a href=
"#definition-VideoAbuse"> VideoAbuse
</a>
251 <a href=
"#definition-VideoBlacklist"> VideoBlacklist
</a>
252 <a href=
"#definition-VideoChannel"> VideoChannel
</a>
253 <a href=
"#definition-VideoComment"> VideoComment
</a>
254 <a href=
"#definition-VideoCommentThreadTree"> VideoCommentThreadTree
</a>
255 <a href=
"#definition-Avatar"> Avatar
</a>
256 <a href=
"#definition-Actor"> Actor
</a>
257 <a href=
"#definition-Account"> Account
</a>
258 <a href=
"#definition-User"> User
</a>
259 <a href=
"#definition-ServerConfig"> ServerConfig
</a>
260 <a href=
"#definition-Follow"> Follow
</a>
261 <a href=
"#definition-Job"> Job
</a>
262 <a href=
"#definition-AddUserResponse"> AddUserResponse
</a>
263 <a href=
"#definition-VideoUploadResponse"> VideoUploadResponse
</a>
264 <a href=
"#definition-CommentThreadResponse"> CommentThreadResponse
</a>
265 <a href=
"#definition-CommentThreadPostResponse"> CommentThreadPostResponse
</a>
266 <a href=
"#definition-AddUser"> AddUser
</a>
267 <a href=
"#definition-UpdateUser"> UpdateUser
</a>
268 <a href=
"#definition-UpdateMe"> UpdateMe
</a>
269 <a href=
"#definition-GetMeVideoRating"> GetMeVideoRating
</a>
270 <a href=
"#definition-RegisterUser"> RegisterUser
</a>
271 <a href=
"#definition-VideoChannelInput"> VideoChannelInput
</a>
274 <div id=
"docs" class=
"row collapse expanded drawer" data-drawer
>
275 <button class=
"floating-menu-icon" type=
"button" data-drawer-slide=
"right">
276 <span class=
"hamburger"></span>
278 <div class=
"example-box doc-content"></div>
280 <h1 class=
"doc-title">PeerTube
281 <span>API Reference
</span>
283 <div id=
"introduction" data-traverse-target=
"introduction">
284 <div class=
"doc-row">
285 <div class=
"doc-copy">
286 <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.
</p>
288 <div class=
"doc-examples">
290 <h5>API Endpoint
</h5>
291 <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1
</code></pre>
297 <span>1.0.0-beta
</span>
303 <!-- <h1 id="security" data-traverse-target="security">Security</h1> -->
304 <h1 id=
"authentication" data-traverse-target=
"authentication">Authentication
</h1>
305 <div id=
"security-definition-OAuth2" class=
"panel">
306 <div class=
"doc-row">
307 <div class=
"doc-copy">
308 <h3 class=
"security-definition-title">
309 <span class=
"security-name">OAuth2
</span>
310 <span class=
"swagger-security-definition-oauth2"></span>
312 <section class=
"security-definition-description">
314 <em>Authorization: Bearer mytoken
</em>
317 <section class=
"swagger-security-definition-properties">
318 <div class=
"prop-row security-definition-property">
319 <div class=
"prop-name">
320 <div class=
"prop-title security-definition-property-name">type
</div>
322 <div class=
"prop-value security-definition-property-type"> oauth2
</div>
324 <div class=
"prop-row security-definition-property">
325 <div class=
"prop-name">
326 <div class=
"prop-title security-definition-property-name">flow
</div>
328 <div class=
"prop-value security-definition-property-type"> password
</div>
330 <div class=
"prop-row security-definition-property">
331 <div class=
"prop-name">
332 <div class=
"prop-title security-definition-property-name">tokenUrl
</div>
334 <div class=
"prop-value security-definition-property-type"> https://peertube.example.com/api/v1/users/token
</div>
340 <h1 id=
"tag-Accounts" class=
"swagger-summary-tag" data-traverse-target=
"tag-Accounts">Accounts
</h1>
341 <div id=
"operation--accounts--name--get" class=
"operation panel" data-traverse-target=
"operation--accounts--name--get">
342 <!-- <section class="operation-tags row"> -->
343 <!-- <div class="doc-copy"> -->
344 <div class=
"operation-tags">
345 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
350 <h2 class=
"operation-title">
351 <span class=
"operation-name">
352 <span class=
"operation-name">GET
</span>
353 <span class=
"operation-path">/accounts/{name}
</span>
356 <div class=
"doc-row">
357 <div class=
"doc-copy">
358 <section class=
"swagger-request-params">
359 <div class=
"prop-row prop-group">
360 <div class=
"prop-name">
361 <div class=
"prop-title">name:
362 <span class=
"prop-type">
363 <span class=
"json-property-type">string
</span>
364 <span class=
"json-property-range" title=
"Value limits"></span>
367 <span class=
"json-property-required"></span>
368 <div class=
"prop-subtitle"> in path
</div>
370 <div class=
"prop-value">
371 <p>The name of the account (chocobozzz or
372 <a href=
"mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re
</a> for example)
</p>
375 <div class=
"prop-row prop-group">
376 <div class=
"prop-name">
377 <div class=
"prop-title">start:
378 <span class=
"prop-type">
379 <span class=
"json-property-type">number
</span>
380 <span class=
"json-property-range" title=
"Value limits"></span>
383 <div class=
"prop-subtitle"> in query
</div>
385 <div class=
"prop-value">
389 <div class=
"prop-row prop-group">
390 <div class=
"prop-name">
391 <div class=
"prop-title">count:
392 <span class=
"prop-type">
393 <span class=
"json-property-type">number
</span>
394 <span class=
"json-property-range" title=
"Value limits"></span>
397 <div class=
"prop-subtitle"> in query
</div>
399 <div class=
"prop-value">
400 <p>Number of items
</p>
403 <div class=
"prop-row prop-group">
404 <div class=
"prop-name">
405 <div class=
"prop-title">sort:
406 <span class=
"prop-type">
407 <span class=
"json-property-type">string
</span>
408 <span class=
"json-property-range" title=
"Value limits"></span>
411 <div class=
"prop-subtitle"> in query
</div>
413 <div class=
"prop-value">
414 <p>Sort column (-createdAt for example)
</p>
419 <div class=
"doc-examples"></div>
421 <div class=
"doc-row">
422 <div class=
"doc-copy">
423 <section class=
"swagger-responses">
424 <div class=
"prop-row prop-group">
425 <div class=
"prop-name">
426 <div class=
"prop-title">200 OK
</div>
427 <div class=
"prop-ref">
429 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
432 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
434 <div class=
"prop-value">
435 <p>successful operation
</p>
440 <div class=
"doc-examples">
441 <h5>Response Content-Types:
442 <span>application/json
</span>
446 <span>(
200 OK)
</span>
448 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
449 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
450 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
451 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
452 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
453 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
454 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
455 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
456 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
457 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
458 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
459 <span class=
"hljs-attr">"avatar
"</span>: {
460 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
461 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
462 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
471 <div id=
"operation--accounts--name--videos-get" class=
"operation panel" data-traverse-target=
"operation--accounts--name--videos-get">
472 <!-- <section class="operation-tags row"> -->
473 <!-- <div class="doc-copy"> -->
474 <div class=
"operation-tags">
475 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
480 <h2 class=
"operation-title">
481 <span class=
"operation-name">
482 <span class=
"operation-name">GET
</span>
483 <span class=
"operation-path">/accounts/{name}/videos
</span>
486 <div class=
"doc-row">
487 <div class=
"doc-copy">
488 <section class=
"swagger-request-params">
489 <div class=
"prop-row prop-group">
490 <div class=
"prop-name">
491 <div class=
"prop-title">name:
492 <span class=
"prop-type">
493 <span class=
"json-property-type">string
</span>
494 <span class=
"json-property-range" title=
"Value limits"></span>
497 <span class=
"json-property-required"></span>
498 <div class=
"prop-subtitle"> in path
</div>
500 <div class=
"prop-value">
501 <p>The name of the account (chocobozzz or
502 <a href=
"mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re
</a> for example)
</p>
507 <div class=
"doc-examples"></div>
509 <div class=
"doc-row">
510 <div class=
"doc-copy">
511 <section class=
"swagger-responses">
512 <div class=
"prop-row prop-group">
513 <div class=
"prop-name">
514 <div class=
"prop-title">200 OK
</div>
515 <div class=
"prop-ref">
517 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
520 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
522 <div class=
"prop-value">
523 <p>successful operation
</p>
528 <div class=
"doc-examples">
529 <h5>Response Content-Types:
530 <span>application/json
</span>
534 <span>(
200 OK)
</span>
536 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
537 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
538 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
539 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
540 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
541 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
542 <span class=
"hljs-attr">"category
"</span>: {
543 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
544 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
546 <span class=
"hljs-attr">"licence
"</span>: {
547 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
548 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
550 <span class=
"hljs-attr">"language
"</span>: {
551 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
552 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
554 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
555 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
556 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
557 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
558 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
559 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
560 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
561 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
562 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
563 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
564 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
565 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
566 <span class=
"hljs-attr">"account
"</span>: {
567 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
568 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
569 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
570 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
571 <span class=
"hljs-attr">"avatar
"</span>: {
572 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
573 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
574 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
584 <div id=
"operation--accounts-get" class=
"operation panel" data-traverse-target=
"operation--accounts-get">
585 <!-- <section class="operation-tags row"> -->
586 <!-- <div class="doc-copy"> -->
587 <div class=
"operation-tags">
588 <a class=
"label" href=
"#tag-Accounts">Accounts
</a>
593 <h2 class=
"operation-title">
594 <span class=
"operation-name">
595 <span class=
"operation-name">GET
</span>
596 <span class=
"operation-path">/accounts
</span>
599 <div class=
"doc-row">
600 <div class=
"doc-copy"> </div>
601 <div class=
"doc-examples"></div>
603 <div class=
"doc-row">
604 <div class=
"doc-copy">
605 <section class=
"swagger-responses">
606 <div class=
"prop-row prop-group">
607 <div class=
"prop-name">
608 <div class=
"prop-title">200 OK
</div>
609 <div class=
"prop-ref">
610 <span class=
"json-schema-ref-array">
611 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
614 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
616 <div class=
"prop-value">
617 <p>successful operation
</p>
620 <div class=
"prop-row prop-inner">
621 <div class=
"prop-name">type
</div>
622 <div class=
"prop-value">
623 <span class=
"json-property-type">
624 <span class=
"json-schema-ref-array">
625 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
628 <span class=
"json-property-range" title=
"Value limits"></span>
633 <div class=
"doc-examples">
634 <h5>Response Content-Types:
635 <span>application/json
</span>
639 <span>(
200 OK)
</span>
641 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
643 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
644 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
645 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
646 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
647 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
648 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
649 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
650 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
651 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
652 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
653 <span class=
"hljs-attr">"avatar
"</span>: {
654 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
655 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
656 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
666 <h1 id=
"tag-Config" class=
"swagger-summary-tag" data-traverse-target=
"tag-Config">Config
</h1>
667 <div id=
"operation--config-get" class=
"operation panel" data-traverse-target=
"operation--config-get">
668 <!-- <section class="operation-tags row"> -->
669 <!-- <div class="doc-copy"> -->
670 <div class=
"operation-tags">
671 <a class=
"label" href=
"#tag-Config">Config
</a>
676 <h2 class=
"operation-title">
677 <span class=
"operation-name">
678 <span class=
"operation-name">GET
</span>
679 <span class=
"operation-path">/config
</span>
682 <div class=
"doc-row">
683 <div class=
"doc-copy"> </div>
684 <div class=
"doc-examples"></div>
686 <div class=
"doc-row">
687 <div class=
"doc-copy">
688 <section class=
"swagger-responses">
689 <div class=
"prop-row prop-group">
690 <div class=
"prop-name">
691 <div class=
"prop-title">200 OK
</div>
692 <div class=
"prop-ref">
694 <a class=
"json-schema-ref" href=
"#/definitions/ServerConfig">ServerConfig
</a>
697 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
699 <div class=
"prop-value">
700 <p>successful operation
</p>
705 <div class=
"doc-examples">
706 <h5>Response Content-Types:
707 <span>application/json
</span>
711 <span>(
200 OK)
</span>
713 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
714 <span class=
"hljs-attr">"signup
"</span>: {
715 <span class=
"hljs-attr">"allowed
"</span>:
<span class=
"hljs-string">"boolean
"</span>
717 <span class=
"hljs-attr">"transcoding
"</span>: {
718 <span class=
"hljs-attr">"enabledResolutions
"</span>: [
719 <span class=
"hljs-string">"number
"</span>
722 <span class=
"hljs-attr">"avatar
"</span>: {
723 <span class=
"hljs-attr">"file
"</span>: {
724 <span class=
"hljs-attr">"size
"</span>: {
725 <span class=
"hljs-attr">"max
"</span>:
<span class=
"hljs-string">"number
"</span>
728 <span class=
"hljs-attr">"extensions
"</span>: [
729 <span class=
"hljs-string">"string
"</span>
732 <span class=
"hljs-attr">"video
"</span>: {
733 <span class=
"hljs-attr">"file
"</span>: {
734 <span class=
"hljs-attr">"extensions
"</span>: [
735 <span class=
"hljs-string">"string
"</span>
746 <h1 id=
"tag-Feeds" class=
"swagger-summary-tag" data-traverse-target=
"tag-Feeds">Feeds
</h1>
747 <div id=
"operation--feeds-videos.-format--get" class=
"operation panel" data-traverse-target=
"operation--feeds-videos.-format--get">
748 <!-- <section class="operation-tags row"> -->
749 <!-- <div class="doc-copy"> -->
750 <div class=
"operation-tags">
751 <a class=
"label" href=
"#tag-Feeds">Feeds
</a>
756 <h2 class=
"operation-title">
757 <span class=
"operation-name">
758 <span class=
"operation-name">GET
</span>
759 <span class=
"operation-path">/feeds/videos.{format}
</span>
762 <div class=
"doc-row">
763 <div class=
"doc-copy">
764 <section class=
"swagger-request-params">
765 <div class=
"prop-row prop-group">
766 <div class=
"prop-name">
767 <div class=
"prop-title">format:
768 <span class=
"prop-type">
769 <span class=
"json-property-type">string
</span>
770 <span class=
"json-property-enum" title=
"Possible values">
771 <span class=
"json-property-enum-item json-property-enum-default-value">xml
</span>,
772 <span class=
"json-property-enum-item">atom
</span>,
773 <span class=
"json-property-enum-item">json
</span>
775 <span class=
"json-property-range" title=
"Value limits"></span>
776 <span class=
"json-property-default-value" title=
"Default value">xml
</span>
779 <span class=
"json-property-required"></span>
780 <div class=
"prop-subtitle"> in path
</div>
782 <div class=
"prop-value">
783 <p>The format expected (xml defaults to RSS
2.0, atom to ATOM
1.0 and json to JSON FEED
1.0</p>
786 <div class=
"prop-row prop-group">
787 <div class=
"prop-name">
788 <div class=
"prop-title">accountId:
789 <span class=
"prop-type">
790 <span class=
"json-property-type">number
</span>
791 <span class=
"json-property-range" title=
"Value limits"></span>
794 <div class=
"prop-subtitle"> in query
</div>
796 <div class=
"prop-value">
797 <p>The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds
</p>
800 <div class=
"prop-row prop-group">
801 <div class=
"prop-name">
802 <div class=
"prop-title">accountName:
803 <span class=
"prop-type">
804 <span class=
"json-property-type">string
</span>
805 <span class=
"json-property-range" title=
"Value limits"></span>
808 <div class=
"prop-subtitle"> in query
</div>
810 <div class=
"prop-value">
811 <p>The name of the local account to filter to
</p>
816 <div class=
"doc-examples"></div>
818 <div class=
"doc-row">
819 <div class=
"doc-copy">
820 <section class=
"swagger-responses">
821 <div class=
"prop-row prop-group">
822 <div class=
"prop-name">
823 <div class=
"prop-title">200 OK
</div>
825 <div class=
"prop-value">
826 <p>successful operation
</p>
831 <div class=
"doc-examples">
832 <h5>Response Content-Types:
833 <span>application/atom+xml, application/rss+xml, application/json
</span>
838 <h1 id=
"tag-Job" class=
"swagger-summary-tag" data-traverse-target=
"tag-Job">Job
</h1>
839 <div id=
"operation--jobs-get" class=
"operation panel" data-traverse-target=
"operation--jobs-get">
840 <!-- <section class="operation-tags row"> -->
841 <!-- <div class="doc-copy"> -->
842 <div class=
"operation-tags">
843 <a class=
"label" href=
"#tag-Job">Job
</a>
848 <h2 class=
"operation-title">
849 <span class=
"operation-name">
850 <span class=
"operation-name">GET
</span>
851 <span class=
"operation-path">/jobs
</span>
854 <div class=
"doc-row">
855 <div class=
"doc-copy">
856 <section class=
"swagger-request-params">
857 <div class=
"prop-row prop-group">
858 <div class=
"prop-name">
859 <div class=
"prop-title">state:
860 <span class=
"prop-type">
861 <span class=
"json-property-type">string
</span>
862 <span class=
"json-property-range" title=
"Value limits"></span>
865 <span class=
"json-property-required"></span>
866 <div class=
"prop-subtitle"> in path
</div>
868 <div class=
"prop-value">
869 <p>The state of the job
</p>
872 <div class=
"prop-row prop-group">
873 <div class=
"prop-name">
874 <div class=
"prop-title">start:
875 <span class=
"prop-type">
876 <span class=
"json-property-type">number
</span>
877 <span class=
"json-property-range" title=
"Value limits"></span>
880 <div class=
"prop-subtitle"> in query
</div>
882 <div class=
"prop-value">
886 <div class=
"prop-row prop-group">
887 <div class=
"prop-name">
888 <div class=
"prop-title">count:
889 <span class=
"prop-type">
890 <span class=
"json-property-type">number
</span>
891 <span class=
"json-property-range" title=
"Value limits"></span>
894 <div class=
"prop-subtitle"> in query
</div>
896 <div class=
"prop-value">
897 <p>Number of items
</p>
900 <div class=
"prop-row prop-group">
901 <div class=
"prop-name">
902 <div class=
"prop-title">sort:
903 <span class=
"prop-type">
904 <span class=
"json-property-type">string
</span>
905 <span class=
"json-property-range" title=
"Value limits"></span>
908 <div class=
"prop-subtitle"> in query
</div>
910 <div class=
"prop-value">
911 <p>Sort column (-createdAt for example)
</p>
916 <div class=
"doc-examples"></div>
918 <div class=
"doc-row">
919 <div class=
"doc-copy">
920 <section class=
"swagger-responses">
921 <div class=
"prop-row prop-group">
922 <div class=
"prop-name">
923 <div class=
"prop-title">200 OK
</div>
924 <div class=
"prop-ref">
925 <span class=
"json-schema-ref-array">
926 <a class=
"json-schema-ref" href=
"#/definitions/Job">Job
</a>
929 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
931 <div class=
"prop-value">
932 <p>successful operation
</p>
935 <div class=
"prop-row prop-inner">
936 <div class=
"prop-name">type
</div>
937 <div class=
"prop-value">
938 <span class=
"json-property-type">
939 <span class=
"json-schema-ref-array">
940 <a class=
"json-schema-ref" href=
"#/definitions/Job">Job
</a>
943 <span class=
"json-property-range" title=
"Value limits"></span>
948 <div class=
"doc-examples">
949 <h5>Response Content-Types:
950 <span>application/json
</span>
954 <span>(
200 OK)
</span>
956 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
958 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
959 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
960 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"string
"</span>,
961 <span class=
"hljs-attr">"handlerName
"</span>:
<span class=
"hljs-string">"string
"</span>,
962 <span class=
"hljs-attr">"handlerInputData
"</span>:
<span class=
"hljs-string">"string
"</span>,
963 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
964 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
972 <div class=
"doc-row">
973 <div class=
"doc-copy">
974 <section class=
"swagger-request-security">
975 <table class=
"table">
978 <th class=
"swagger-request-security-schema"></th>
979 <th class=
"swagger-request-security-scopes"></th>
985 <a href=
"#security-definition-OAuth2">OAuth2
</a>
995 <h1 id=
"tag-ServerFollowing" class=
"swagger-summary-tag" data-traverse-target=
"tag-ServerFollowing">ServerFollowing
</h1>
996 <div id=
"operation--server-following--host--delete" class=
"operation panel" data-traverse-target=
"operation--server-following--host--delete">
997 <!-- <section class="operation-tags row"> -->
998 <!-- <div class="doc-copy"> -->
999 <div class=
"operation-tags">
1000 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1005 <h2 class=
"operation-title">
1006 <span class=
"operation-name">
1007 <span class=
"operation-name">DELETE
</span>
1008 <span class=
"operation-path">/server/following/{host}
</span>
1011 <div class=
"doc-row">
1012 <div class=
"doc-copy">
1013 <section class=
"swagger-request-params">
1014 <div class=
"prop-row prop-group">
1015 <div class=
"prop-name">
1016 <div class=
"prop-title">host:
1017 <span class=
"prop-type">
1018 <span class=
"json-property-type">string
</span>
1019 <span class=
"json-property-range" title=
"Value limits"></span>
1022 <span class=
"json-property-required"></span>
1023 <div class=
"prop-subtitle"> in path
</div>
1025 <div class=
"prop-value">
1026 <p>The host to unfollow
</p>
1031 <div class=
"doc-examples"></div>
1033 <div class=
"doc-row">
1034 <div class=
"doc-copy">
1035 <section class=
"swagger-responses">
1036 <div class=
"prop-row prop-group">
1037 <div class=
"prop-name">
1038 <div class=
"prop-title">201 Created
</div>
1040 <div class=
"prop-value">
1041 <p>successful operation
</p>
1046 <div class=
"doc-examples">
1047 <h5>Response Content-Types:
1048 <span>application/json
</span>
1052 <div class=
"doc-row">
1053 <div class=
"doc-copy">
1054 <section class=
"swagger-request-security">
1055 <table class=
"table">
1058 <th class=
"swagger-request-security-schema"></th>
1059 <th class=
"swagger-request-security-scopes"></th>
1065 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1075 <div id=
"operation--server-followers-get" class=
"operation panel" data-traverse-target=
"operation--server-followers-get">
1076 <!-- <section class="operation-tags row"> -->
1077 <!-- <div class="doc-copy"> -->
1078 <div class=
"operation-tags">
1079 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1084 <h2 class=
"operation-title">
1085 <span class=
"operation-name">
1086 <span class=
"operation-name">GET
</span>
1087 <span class=
"operation-path">/server/followers
</span>
1090 <div class=
"doc-row">
1091 <div class=
"doc-copy">
1092 <section class=
"swagger-request-params">
1093 <div class=
"prop-row prop-group">
1094 <div class=
"prop-name">
1095 <div class=
"prop-title">start:
1096 <span class=
"prop-type">
1097 <span class=
"json-property-type">number
</span>
1098 <span class=
"json-property-range" title=
"Value limits"></span>
1101 <div class=
"prop-subtitle"> in query
</div>
1103 <div class=
"prop-value">
1107 <div class=
"prop-row prop-group">
1108 <div class=
"prop-name">
1109 <div class=
"prop-title">count:
1110 <span class=
"prop-type">
1111 <span class=
"json-property-type">number
</span>
1112 <span class=
"json-property-range" title=
"Value limits"></span>
1115 <div class=
"prop-subtitle"> in query
</div>
1117 <div class=
"prop-value">
1118 <p>Number of items
</p>
1121 <div class=
"prop-row prop-group">
1122 <div class=
"prop-name">
1123 <div class=
"prop-title">sort:
1124 <span class=
"prop-type">
1125 <span class=
"json-property-type">string
</span>
1126 <span class=
"json-property-range" title=
"Value limits"></span>
1129 <div class=
"prop-subtitle"> in query
</div>
1131 <div class=
"prop-value">
1132 <p>Sort column (-createdAt for example)
</p>
1137 <div class=
"doc-examples"></div>
1139 <div class=
"doc-row">
1140 <div class=
"doc-copy">
1141 <section class=
"swagger-responses">
1142 <div class=
"prop-row prop-group">
1143 <div class=
"prop-name">
1144 <div class=
"prop-title">200 OK
</div>
1145 <div class=
"prop-ref">
1146 <span class=
"json-schema-ref-array">
1147 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1150 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1152 <div class=
"prop-value">
1153 <p>successful operation
</p>
1156 <div class=
"prop-row prop-inner">
1157 <div class=
"prop-name">type
</div>
1158 <div class=
"prop-value">
1159 <span class=
"json-property-type">
1160 <span class=
"json-schema-ref-array">
1161 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1164 <span class=
"json-property-range" title=
"Value limits"></span>
1169 <div class=
"doc-examples">
1170 <h5>Response Content-Types:
1171 <span>application/json
</span>
1174 <h5>Response Example
1175 <span>(
200 OK)
</span>
1177 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1179 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1180 <span class=
"hljs-attr">"follower
"</span>: {
1181 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1182 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1183 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1184 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1185 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1186 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1187 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1188 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1189 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1190 <span class=
"hljs-attr">"avatar
"</span>: {
1191 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1192 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1193 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1196 <span class=
"hljs-attr">"following
"</span>: {
1197 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1198 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1199 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1200 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1201 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1202 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1203 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1204 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1205 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1206 <span class=
"hljs-attr">"avatar
"</span>: {
1207 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1208 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1209 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1212 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1213 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1214 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1215 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1224 <div id=
"operation--server-following-get" class=
"operation panel" data-traverse-target=
"operation--server-following-get">
1225 <!-- <section class="operation-tags row"> -->
1226 <!-- <div class="doc-copy"> -->
1227 <div class=
"operation-tags">
1228 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1233 <h2 class=
"operation-title">
1234 <span class=
"operation-name">
1235 <span class=
"operation-name">GET
</span>
1236 <span class=
"operation-path">/server/following
</span>
1239 <div class=
"doc-row">
1240 <div class=
"doc-copy">
1241 <section class=
"swagger-request-params">
1242 <div class=
"prop-row prop-group">
1243 <div class=
"prop-name">
1244 <div class=
"prop-title">start:
1245 <span class=
"prop-type">
1246 <span class=
"json-property-type">number
</span>
1247 <span class=
"json-property-range" title=
"Value limits"></span>
1250 <div class=
"prop-subtitle"> in query
</div>
1252 <div class=
"prop-value">
1256 <div class=
"prop-row prop-group">
1257 <div class=
"prop-name">
1258 <div class=
"prop-title">count:
1259 <span class=
"prop-type">
1260 <span class=
"json-property-type">number
</span>
1261 <span class=
"json-property-range" title=
"Value limits"></span>
1264 <div class=
"prop-subtitle"> in query
</div>
1266 <div class=
"prop-value">
1267 <p>Number of items
</p>
1270 <div class=
"prop-row prop-group">
1271 <div class=
"prop-name">
1272 <div class=
"prop-title">sort:
1273 <span class=
"prop-type">
1274 <span class=
"json-property-type">string
</span>
1275 <span class=
"json-property-range" title=
"Value limits"></span>
1278 <div class=
"prop-subtitle"> in query
</div>
1280 <div class=
"prop-value">
1281 <p>Sort column (-createdAt for example)
</p>
1286 <div class=
"doc-examples"></div>
1288 <div class=
"doc-row">
1289 <div class=
"doc-copy">
1290 <section class=
"swagger-responses">
1291 <div class=
"prop-row prop-group">
1292 <div class=
"prop-name">
1293 <div class=
"prop-title">200 OK
</div>
1294 <div class=
"prop-ref">
1295 <span class=
"json-schema-ref-array">
1296 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1299 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1301 <div class=
"prop-value">
1302 <p>successful operation
</p>
1305 <div class=
"prop-row prop-inner">
1306 <div class=
"prop-name">type
</div>
1307 <div class=
"prop-value">
1308 <span class=
"json-property-type">
1309 <span class=
"json-schema-ref-array">
1310 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1313 <span class=
"json-property-range" title=
"Value limits"></span>
1318 <div class=
"doc-examples">
1319 <h5>Response Content-Types:
1320 <span>application/json
</span>
1323 <h5>Response Example
1324 <span>(
200 OK)
</span>
1326 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1328 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1329 <span class=
"hljs-attr">"follower
"</span>: {
1330 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1331 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1332 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1333 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1334 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1335 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1336 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1337 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1338 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1339 <span class=
"hljs-attr">"avatar
"</span>: {
1340 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1341 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1342 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1345 <span class=
"hljs-attr">"following
"</span>: {
1346 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1347 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1348 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1349 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1350 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1351 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1352 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1353 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1354 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1355 <span class=
"hljs-attr">"avatar
"</span>: {
1356 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1357 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1358 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1361 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1362 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1363 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1364 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1373 <div id=
"operation--server-following-post" class=
"operation panel" data-traverse-target=
"operation--server-following-post">
1374 <!-- <section class="operation-tags row"> -->
1375 <!-- <div class="doc-copy"> -->
1376 <div class=
"operation-tags">
1377 <a class=
"label" href=
"#tag-ServerFollowing">ServerFollowing
</a>
1382 <h2 class=
"operation-title">
1383 <span class=
"operation-name">
1384 <span class=
"operation-name">POST
</span>
1385 <span class=
"operation-path">/server/following
</span>
1388 <div class=
"doc-row">
1389 <div class=
"doc-copy">
1390 <section class=
"swagger-request-body">
1391 <div class=
"prop-row">
1392 <div class=
"prop-name">
1393 <div class=
"swagger-request-model">
1395 <a class=
"json-schema-ref" href=
"#/definitions/Follow">Follow
</a>
1399 <div class=
"prop-value columns small-6">
1400 <!-- <div class="swagger-request-description"> -->
1407 <div class=
"doc-examples">
1409 <h5>Request Content-Types:
1410 <span>application/json
</span>
1412 <h5>Request Example
</h5>
1413 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1414 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1415 <span class=
"hljs-attr">"follower
"</span>: {
1416 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1417 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1418 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1419 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1420 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1421 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1422 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1423 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1424 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1425 <span class=
"hljs-attr">"avatar
"</span>: {
1426 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1427 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1428 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1431 <span class=
"hljs-attr">"following
"</span>: {
1432 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1433 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1434 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1435 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1436 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1437 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1438 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1439 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1440 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1441 <span class=
"hljs-attr">"avatar
"</span>: {
1442 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1443 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1444 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1447 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
1448 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
1449 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1450 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1457 <div class=
"doc-row">
1458 <div class=
"doc-copy">
1459 <section class=
"swagger-responses">
1460 <div class=
"prop-row prop-group">
1461 <div class=
"prop-name">
1462 <div class=
"prop-title">204 No Content
</div>
1464 <div class=
"prop-value">
1465 <p>Successful operation
</p>
1470 <div class=
"doc-examples">
1471 <h5>Response Content-Types:
1472 <span>application/json
</span>
1476 <div class=
"doc-row">
1477 <div class=
"doc-copy">
1478 <section class=
"swagger-request-security">
1479 <table class=
"table">
1482 <th class=
"swagger-request-security-schema"></th>
1483 <th class=
"swagger-request-security-scopes"></th>
1489 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1499 <h1 id=
"tag-User" class=
"swagger-summary-tag" data-traverse-target=
"tag-User">User
</h1>
1500 <div id=
"operation--users-post" class=
"operation panel" data-traverse-target=
"operation--users-post">
1501 <!-- <section class="operation-tags row"> -->
1502 <!-- <div class="doc-copy"> -->
1503 <div class=
"operation-tags">
1504 <a class=
"label" href=
"#tag-User">User
</a>
1509 <h2 class=
"operation-title">
1510 <span class=
"operation-name">
1511 <span class=
"operation-name">POST
</span>
1512 <span class=
"operation-path">/users
</span>
1515 <div class=
"doc-row">
1516 <div class=
"doc-copy">
1517 <section class=
"swagger-request-body">
1518 <div class=
"prop-row">
1519 <div class=
"prop-name">
1520 <div class=
"swagger-request-model">
1522 <a class=
"json-schema-ref" href=
"#/definitions/AddUser">AddUser
</a>
1526 <div class=
"prop-value columns small-6">
1527 <!-- <div class="swagger-request-description"> -->
1528 <p>User to create
</p>
1534 <div class=
"doc-examples">
1536 <h5>Request Content-Types:
1537 <span>application/json
</span>
1539 <h5>Request Example
</h5>
1540 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1541 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1542 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
1543 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1544 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
1545 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
1552 <div class=
"doc-row">
1553 <div class=
"doc-copy">
1554 <section class=
"swagger-responses">
1555 <div class=
"prop-row prop-group">
1556 <div class=
"prop-name">
1557 <div class=
"prop-title">200 OK
</div>
1558 <div class=
"prop-ref">
1560 <a class=
"json-schema-ref" href=
"#/definitions/AddUserResponse">AddUserResponse
</a>
1563 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1565 <div class=
"prop-value">
1566 <p>successful operation
</p>
1571 <div class=
"doc-examples">
1572 <h5>Response Content-Types:
1573 <span>application/json
</span>
1576 <h5>Response Example
1577 <span>(
200 OK)
</span>
1579 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1580 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1581 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1588 <div class=
"doc-row">
1589 <div class=
"doc-copy">
1590 <section class=
"swagger-request-security">
1591 <table class=
"table">
1594 <th class=
"swagger-request-security-schema"></th>
1595 <th class=
"swagger-request-security-scopes"></th>
1601 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1611 <div id=
"operation--users-get" class=
"operation panel" data-traverse-target=
"operation--users-get">
1612 <!-- <section class="operation-tags row"> -->
1613 <!-- <div class="doc-copy"> -->
1614 <div class=
"operation-tags">
1615 <a class=
"label" href=
"#tag-User">User
</a>
1620 <h2 class=
"operation-title">
1621 <span class=
"operation-name">
1622 <span class=
"operation-name">GET
</span>
1623 <span class=
"operation-path">/users
</span>
1626 <div class=
"doc-row">
1627 <div class=
"doc-copy">
1628 <section class=
"swagger-request-params">
1629 <div class=
"prop-row prop-group">
1630 <div class=
"prop-name">
1631 <div class=
"prop-title">start:
1632 <span class=
"prop-type">
1633 <span class=
"json-property-type">number
</span>
1634 <span class=
"json-property-range" title=
"Value limits"></span>
1637 <div class=
"prop-subtitle"> in query
</div>
1639 <div class=
"prop-value">
1643 <div class=
"prop-row prop-group">
1644 <div class=
"prop-name">
1645 <div class=
"prop-title">count:
1646 <span class=
"prop-type">
1647 <span class=
"json-property-type">number
</span>
1648 <span class=
"json-property-range" title=
"Value limits"></span>
1651 <div class=
"prop-subtitle"> in query
</div>
1653 <div class=
"prop-value">
1654 <p>Number of items
</p>
1657 <div class=
"prop-row prop-group">
1658 <div class=
"prop-name">
1659 <div class=
"prop-title">sort:
1660 <span class=
"prop-type">
1661 <span class=
"json-property-type">string
</span>
1662 <span class=
"json-property-range" title=
"Value limits"></span>
1665 <div class=
"prop-subtitle"> in query
</div>
1667 <div class=
"prop-value">
1668 <p>Sort column (-createdAt for example)
</p>
1673 <div class=
"doc-examples"></div>
1675 <div class=
"doc-row">
1676 <div class=
"doc-copy">
1677 <section class=
"swagger-responses">
1678 <div class=
"prop-row prop-group">
1679 <div class=
"prop-name">
1680 <div class=
"prop-title">200 OK
</div>
1681 <div class=
"prop-ref">
1682 <span class=
"json-schema-ref-array">
1683 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1686 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1688 <div class=
"prop-value">
1689 <p>successful operation
</p>
1692 <div class=
"prop-row prop-inner">
1693 <div class=
"prop-name">type
</div>
1694 <div class=
"prop-value">
1695 <span class=
"json-property-type">
1696 <span class=
"json-schema-ref-array">
1697 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1700 <span class=
"json-property-range" title=
"Value limits"></span>
1705 <div class=
"doc-examples">
1706 <h5>Response Content-Types:
1707 <span>application/json
</span>
1710 <h5>Response Example
1711 <span>(
200 OK)
</span>
1713 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
1715 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1716 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1717 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1718 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1719 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1720 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1721 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1722 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1723 <span class=
"hljs-attr">"account
"</span>: {
1724 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1725 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1726 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1727 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1728 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1729 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1730 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1731 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1732 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1733 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1734 <span class=
"hljs-attr">"avatar
"</span>: {
1735 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1736 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1737 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1740 <span class=
"hljs-attr">"videoChannels
"</span>: [
1742 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1743 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1744 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1745 <span class=
"hljs-attr">"ownerAccount
"</span>: {
1746 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1747 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1758 <div class=
"doc-row">
1759 <div class=
"doc-copy">
1760 <section class=
"swagger-request-security">
1761 <table class=
"table">
1764 <th class=
"swagger-request-security-schema"></th>
1765 <th class=
"swagger-request-security-scopes"></th>
1771 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1781 <div id=
"operation--users--id--delete" class=
"operation panel" data-traverse-target=
"operation--users--id--delete">
1782 <!-- <section class="operation-tags row"> -->
1783 <!-- <div class="doc-copy"> -->
1784 <div class=
"operation-tags">
1785 <a class=
"label" href=
"#tag-User">User
</a>
1790 <h2 class=
"operation-title">
1791 <span class=
"operation-name">
1792 <span class=
"operation-name">DELETE
</span>
1793 <span class=
"operation-path">/users/{id}
</span>
1796 <div class=
"doc-row">
1797 <div class=
"doc-copy">
1798 <section class=
"swagger-request-params">
1799 <div class=
"prop-row prop-group">
1800 <div class=
"prop-name">
1801 <div class=
"prop-title">id:
1802 <span class=
"prop-type">
1803 <span class=
"json-property-type">number
</span>
1804 <span class=
"json-property-range" title=
"Value limits"></span>
1807 <span class=
"json-property-required"></span>
1808 <div class=
"prop-subtitle"> in path
</div>
1810 <div class=
"prop-value">
1816 <div class=
"doc-examples"></div>
1818 <div class=
"doc-row">
1819 <div class=
"doc-copy">
1820 <section class=
"swagger-responses">
1821 <div class=
"prop-row prop-group">
1822 <div class=
"prop-name">
1823 <div class=
"prop-title">204 No Content
</div>
1825 <div class=
"prop-value">
1826 <p>Successful operation
</p>
1831 <div class=
"doc-examples">
1832 <h5>Response Content-Types:
1833 <span>application/json
</span>
1837 <div class=
"doc-row">
1838 <div class=
"doc-copy">
1839 <section class=
"swagger-request-security">
1840 <table class=
"table">
1843 <th class=
"swagger-request-security-schema"></th>
1844 <th class=
"swagger-request-security-scopes"></th>
1850 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1860 <div id=
"operation--users--id--get" class=
"operation panel" data-traverse-target=
"operation--users--id--get">
1861 <!-- <section class="operation-tags row"> -->
1862 <!-- <div class="doc-copy"> -->
1863 <div class=
"operation-tags">
1864 <a class=
"label" href=
"#tag-User">User
</a>
1869 <h2 class=
"operation-title">
1870 <span class=
"operation-name">
1871 <span class=
"operation-name">GET
</span>
1872 <span class=
"operation-path">/users/{id}
</span>
1875 <div class=
"doc-row">
1876 <div class=
"doc-copy">
1877 <section class=
"swagger-request-params">
1878 <div class=
"prop-row prop-group">
1879 <div class=
"prop-name">
1880 <div class=
"prop-title">id:
1881 <span class=
"prop-type">
1882 <span class=
"json-property-type">number
</span>
1883 <span class=
"json-property-range" title=
"Value limits"></span>
1886 <span class=
"json-property-required"></span>
1887 <div class=
"prop-subtitle"> in path
</div>
1889 <div class=
"prop-value">
1895 <div class=
"doc-examples"></div>
1897 <div class=
"doc-row">
1898 <div class=
"doc-copy">
1899 <section class=
"swagger-responses">
1900 <div class=
"prop-row prop-group">
1901 <div class=
"prop-name">
1902 <div class=
"prop-title">200 OK
</div>
1903 <div class=
"prop-ref">
1905 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
1908 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1910 <div class=
"prop-value">
1911 <p>successful operation
</p>
1916 <div class=
"doc-examples">
1917 <h5>Response Content-Types:
1918 <span>application/json
</span>
1921 <h5>Response Example
1922 <span>(
200 OK)
</span>
1924 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
1925 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1926 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
1927 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
1928 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1929 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1930 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
1931 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
1932 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1933 <span class=
"hljs-attr">"account
"</span>: {
1934 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1935 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1936 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
1937 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
1938 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
1939 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
1940 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1941 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
1942 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1943 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1944 <span class=
"hljs-attr">"avatar
"</span>: {
1945 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
1946 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
1947 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
1950 <span class=
"hljs-attr">"videoChannels
"</span>: [
1952 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
1953 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
1954 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
1955 <span class=
"hljs-attr">"ownerAccount
"</span>: {
1956 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
1957 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
1967 <div class=
"doc-row">
1968 <div class=
"doc-copy">
1969 <section class=
"swagger-request-security">
1970 <table class=
"table">
1973 <th class=
"swagger-request-security-schema"></th>
1974 <th class=
"swagger-request-security-scopes"></th>
1980 <a href=
"#security-definition-OAuth2">OAuth2
</a>
1990 <div id=
"operation--users--id--put" class=
"operation panel" data-traverse-target=
"operation--users--id--put">
1991 <!-- <section class="operation-tags row"> -->
1992 <!-- <div class="doc-copy"> -->
1993 <div class=
"operation-tags">
1994 <a class=
"label" href=
"#tag-User">User
</a>
1999 <h2 class=
"operation-title">
2000 <span class=
"operation-name">
2001 <span class=
"operation-name">PUT
</span>
2002 <span class=
"operation-path">/users/{id}
</span>
2005 <div class=
"doc-row">
2006 <div class=
"doc-copy">
2007 <section class=
"swagger-request-body">
2008 <div class=
"prop-row">
2009 <div class=
"prop-name">
2010 <div class=
"swagger-request-model">
2012 <a class=
"json-schema-ref" href=
"#/definitions/UpdateUser">UpdateUser
</a>
2016 <div class=
"prop-value columns small-6">
2017 <!-- <div class="swagger-request-description"> -->
2023 <section class=
"swagger-request-params">
2024 <div class=
"prop-row prop-group">
2025 <div class=
"prop-name">
2026 <div class=
"prop-title">id:
2027 <span class=
"prop-type">
2028 <span class=
"json-property-type">number
</span>
2029 <span class=
"json-property-range" title=
"Value limits"></span>
2032 <span class=
"json-property-required"></span>
2033 <div class=
"prop-subtitle"> in path
</div>
2035 <div class=
"prop-value">
2041 <div class=
"doc-examples">
2043 <h5>Request Content-Types:
2044 <span>application/json
</span>
2046 <h5>Request Example
</h5>
2047 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2048 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2049 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
2050 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
2051 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
2058 <div class=
"doc-row">
2059 <div class=
"doc-copy">
2060 <section class=
"swagger-responses">
2061 <div class=
"prop-row prop-group">
2062 <div class=
"prop-name">
2063 <div class=
"prop-title">204 No Content
</div>
2065 <div class=
"prop-value">
2066 <p>Successful operation
</p>
2071 <div class=
"doc-examples">
2072 <h5>Response Content-Types:
2073 <span>application/json
</span>
2077 <div class=
"doc-row">
2078 <div class=
"doc-copy">
2079 <section class=
"swagger-request-security">
2080 <table class=
"table">
2083 <th class=
"swagger-request-security-schema"></th>
2084 <th class=
"swagger-request-security-scopes"></th>
2090 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2100 <div id=
"operation--users-me-get" class=
"operation panel" data-traverse-target=
"operation--users-me-get">
2101 <!-- <section class="operation-tags row"> -->
2102 <!-- <div class="doc-copy"> -->
2103 <div class=
"operation-tags">
2104 <a class=
"label" href=
"#tag-User">User
</a>
2109 <h2 class=
"operation-title">
2110 <span class=
"operation-name">
2111 <span class=
"operation-name">GET
</span>
2112 <span class=
"operation-path">/users/me
</span>
2115 <div class=
"doc-row">
2116 <div class=
"doc-copy"> </div>
2117 <div class=
"doc-examples"></div>
2119 <div class=
"doc-row">
2120 <div class=
"doc-copy">
2121 <section class=
"swagger-responses">
2122 <div class=
"prop-row prop-group">
2123 <div class=
"prop-name">
2124 <div class=
"prop-title">200 OK
</div>
2125 <div class=
"prop-ref">
2126 <span class=
"json-schema-ref-array">
2127 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
2130 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2132 <div class=
"prop-value">
2133 <p>successful operation
</p>
2136 <div class=
"prop-row prop-inner">
2137 <div class=
"prop-name">type
</div>
2138 <div class=
"prop-value">
2139 <span class=
"json-property-type">
2140 <span class=
"json-schema-ref-array">
2141 <a class=
"json-schema-ref" href=
"#/definitions/User">User
</a>
2144 <span class=
"json-property-range" title=
"Value limits"></span>
2149 <div class=
"doc-examples">
2150 <h5>Response Content-Types:
2151 <span>application/json
</span>
2154 <h5>Response Example
2155 <span>(
200 OK)
</span>
2157 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2159 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2160 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
2161 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
2162 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2163 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2164 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
2165 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
2166 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2167 <span class=
"hljs-attr">"account
"</span>: {
2168 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2169 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2170 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2171 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2172 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2173 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2174 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
2175 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
2176 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2177 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2178 <span class=
"hljs-attr">"avatar
"</span>: {
2179 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2180 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2181 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2184 <span class=
"hljs-attr">"videoChannels
"</span>: [
2186 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2187 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2188 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2189 <span class=
"hljs-attr">"ownerAccount
"</span>: {
2190 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2191 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
2202 <div class=
"doc-row">
2203 <div class=
"doc-copy">
2204 <section class=
"swagger-request-security">
2205 <table class=
"table">
2208 <th class=
"swagger-request-security-schema"></th>
2209 <th class=
"swagger-request-security-scopes"></th>
2215 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2225 <div id=
"operation--users-me-put" class=
"operation panel" data-traverse-target=
"operation--users-me-put">
2226 <!-- <section class="operation-tags row"> -->
2227 <!-- <div class="doc-copy"> -->
2228 <div class=
"operation-tags">
2229 <a class=
"label" href=
"#tag-User">User
</a>
2234 <h2 class=
"operation-title">
2235 <span class=
"operation-name">
2236 <span class=
"operation-name">PUT
</span>
2237 <span class=
"operation-path">/users/me
</span>
2240 <div class=
"doc-row">
2241 <div class=
"doc-copy">
2242 <section class=
"swagger-request-body">
2243 <div class=
"prop-row">
2244 <div class=
"prop-name">
2245 <div class=
"swagger-request-model">
2247 <a class=
"json-schema-ref" href=
"#/definitions/UpdateMe">UpdateMe
</a>
2251 <div class=
"prop-value columns small-6">
2252 <!-- <div class="swagger-request-description"> -->
2259 <div class=
"doc-examples">
2261 <h5>Request Content-Types:
2262 <span>application/json
</span>
2264 <h5>Request Example
</h5>
2265 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2266 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
2267 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
2268 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"string
"</span>,
2269 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"string
"</span>
2276 <div class=
"doc-row">
2277 <div class=
"doc-copy">
2278 <section class=
"swagger-responses">
2279 <div class=
"prop-row prop-group">
2280 <div class=
"prop-name">
2281 <div class=
"prop-title">204 No Content
</div>
2283 <div class=
"prop-value">
2284 <p>Successful operation
</p>
2289 <div class=
"doc-examples">
2290 <h5>Response Content-Types:
2291 <span>application/json
</span>
2295 <div class=
"doc-row">
2296 <div class=
"doc-copy">
2297 <section class=
"swagger-request-security">
2298 <table class=
"table">
2301 <th class=
"swagger-request-security-schema"></th>
2302 <th class=
"swagger-request-security-scopes"></th>
2308 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2318 <div id=
"operation--users-me-video-quota-used-get" class=
"operation panel" data-traverse-target=
"operation--users-me-video-quota-used-get">
2319 <!-- <section class="operation-tags row"> -->
2320 <!-- <div class="doc-copy"> -->
2321 <div class=
"operation-tags">
2322 <a class=
"label" href=
"#tag-User">User
</a>
2327 <h2 class=
"operation-title">
2328 <span class=
"operation-name">
2329 <span class=
"operation-name">GET
</span>
2330 <span class=
"operation-path">/users/me/video-quota-used
</span>
2333 <div class=
"doc-row">
2334 <div class=
"doc-copy"> </div>
2335 <div class=
"doc-examples"></div>
2337 <div class=
"doc-row">
2338 <div class=
"doc-copy">
2339 <section class=
"swagger-responses">
2340 <div class=
"prop-row prop-group">
2341 <div class=
"prop-name">
2342 <div class=
"prop-title">200 OK
</div>
2343 <div class=
"prop-ref"> </div>
2344 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2346 <div class=
"prop-value">
2347 <p>successful operation
</p>
2350 <div class=
"prop-row prop-inner">
2351 <div class=
"prop-name">type
</div>
2352 <div class=
"prop-value">
2353 <span class=
"json-property-type">number
</span>
2354 <span class=
"json-property-range" title=
"Value limits"></span>
2359 <div class=
"doc-examples">
2360 <h5>Response Content-Types:
2361 <span>application/json
</span>
2364 <h5>Response Example
2365 <span>(
200 OK)
</span>
2367 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json"><span class=
"hljs-string">"number
"</span>
2373 <div class=
"doc-row">
2374 <div class=
"doc-copy">
2375 <section class=
"swagger-request-security">
2376 <table class=
"table">
2379 <th class=
"swagger-request-security-schema"></th>
2380 <th class=
"swagger-request-security-scopes"></th>
2386 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2396 <div id=
"operation--users-me-videos--videoId--rating-get" class=
"operation panel" data-traverse-target=
"operation--users-me-videos--videoId--rating-get">
2397 <!-- <section class="operation-tags row"> -->
2398 <!-- <div class="doc-copy"> -->
2399 <div class=
"operation-tags">
2400 <a class=
"label" href=
"#tag-User">User
</a>
2405 <h2 class=
"operation-title">
2406 <span class=
"operation-name">
2407 <span class=
"operation-name">GET
</span>
2408 <span class=
"operation-path">/users/me/videos/{videoId}/rating
</span>
2411 <div class=
"doc-row">
2412 <div class=
"doc-copy">
2413 <section class=
"swagger-request-params">
2414 <div class=
"prop-row prop-group">
2415 <div class=
"prop-name">
2416 <div class=
"prop-title">videoId:
2417 <span class=
"prop-type">
2418 <span class=
"json-property-type">string
</span>
2419 <span class=
"json-property-range" title=
"Value limits"></span>
2422 <span class=
"json-property-required"></span>
2423 <div class=
"prop-subtitle"> in path
</div>
2425 <div class=
"prop-value">
2426 <p>The video id
</p>
2431 <div class=
"doc-examples"></div>
2433 <div class=
"doc-row">
2434 <div class=
"doc-copy">
2435 <section class=
"swagger-responses">
2436 <div class=
"prop-row prop-group">
2437 <div class=
"prop-name">
2438 <div class=
"prop-title">200 OK
</div>
2439 <div class=
"prop-ref">
2441 <a class=
"json-schema-ref" href=
"#/definitions/GetMeVideoRating">GetMeVideoRating
</a>
2444 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2446 <div class=
"prop-value">
2447 <p>successful operation
</p>
2452 <div class=
"doc-examples">
2453 <h5>Response Content-Types:
2454 <span>application/json
</span>
2457 <h5>Response Example
2458 <span>(
200 OK)
</span>
2460 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2461 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2462 <span class=
"hljs-attr">"rating
"</span>:
<span class=
"hljs-string">"number
"</span>
2469 <div class=
"doc-row">
2470 <div class=
"doc-copy">
2471 <section class=
"swagger-request-security">
2472 <table class=
"table">
2475 <th class=
"swagger-request-security-schema"></th>
2476 <th class=
"swagger-request-security-scopes"></th>
2482 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2492 <div id=
"operation--users-me-videos-get" class=
"operation panel" data-traverse-target=
"operation--users-me-videos-get">
2493 <!-- <section class="operation-tags row"> -->
2494 <!-- <div class="doc-copy"> -->
2495 <div class=
"operation-tags">
2496 <a class=
"label" href=
"#tag-User">User
</a>
2501 <h2 class=
"operation-title">
2502 <span class=
"operation-name">
2503 <span class=
"operation-name">GET
</span>
2504 <span class=
"operation-path">/users/me/videos
</span>
2507 <div class=
"doc-row">
2508 <div class=
"doc-copy">
2509 <section class=
"swagger-request-params">
2510 <div class=
"prop-row prop-group">
2511 <div class=
"prop-name">
2512 <div class=
"prop-title">start:
2513 <span class=
"prop-type">
2514 <span class=
"json-property-type">number
</span>
2515 <span class=
"json-property-range" title=
"Value limits"></span>
2518 <div class=
"prop-subtitle"> in query
</div>
2520 <div class=
"prop-value">
2524 <div class=
"prop-row prop-group">
2525 <div class=
"prop-name">
2526 <div class=
"prop-title">count:
2527 <span class=
"prop-type">
2528 <span class=
"json-property-type">number
</span>
2529 <span class=
"json-property-range" title=
"Value limits"></span>
2532 <div class=
"prop-subtitle"> in query
</div>
2534 <div class=
"prop-value">
2535 <p>Number of items
</p>
2538 <div class=
"prop-row prop-group">
2539 <div class=
"prop-name">
2540 <div class=
"prop-title">sort:
2541 <span class=
"prop-type">
2542 <span class=
"json-property-type">string
</span>
2543 <span class=
"json-property-range" title=
"Value limits"></span>
2546 <div class=
"prop-subtitle"> in query
</div>
2548 <div class=
"prop-value">
2549 <p>Sort column (-createdAt for example)
</p>
2554 <div class=
"doc-examples"></div>
2556 <div class=
"doc-row">
2557 <div class=
"doc-copy">
2558 <section class=
"swagger-responses">
2559 <div class=
"prop-row prop-group">
2560 <div class=
"prop-name">
2561 <div class=
"prop-title">200 OK
</div>
2562 <div class=
"prop-ref">
2563 <span class=
"json-schema-ref-array">
2564 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2567 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2569 <div class=
"prop-value">
2570 <p>successful operation
</p>
2573 <div class=
"prop-row prop-inner">
2574 <div class=
"prop-name">type
</div>
2575 <div class=
"prop-value">
2576 <span class=
"json-property-type">
2577 <span class=
"json-schema-ref-array">
2578 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2581 <span class=
"json-property-range" title=
"Value limits"></span>
2586 <div class=
"doc-examples">
2587 <h5>Response Content-Types:
2588 <span>application/json
</span>
2591 <h5>Response Example
2592 <span>(
200 OK)
</span>
2594 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2596 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2597 <span class=
"hljs-attr">"uuid
"</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">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2600 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2601 <span class=
"hljs-attr">"category
"</span>: {
2602 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2603 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2605 <span class=
"hljs-attr">"licence
"</span>: {
2606 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2607 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2609 <span class=
"hljs-attr">"language
"</span>: {
2610 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2611 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2613 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
2614 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2615 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2616 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2617 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2618 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2619 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2620 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2621 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2622 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2623 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2624 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2625 <span class=
"hljs-attr">"account
"</span>: {
2626 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2627 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2628 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2629 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2630 <span class=
"hljs-attr">"avatar
"</span>: {
2631 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2632 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2633 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2643 <div class=
"doc-row">
2644 <div class=
"doc-copy">
2645 <section class=
"swagger-request-security">
2646 <table class=
"table">
2649 <th class=
"swagger-request-security-schema"></th>
2650 <th class=
"swagger-request-security-scopes"></th>
2656 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2666 <div id=
"operation--users-register-post" class=
"operation panel" data-traverse-target=
"operation--users-register-post">
2667 <!-- <section class="operation-tags row"> -->
2668 <!-- <div class="doc-copy"> -->
2669 <div class=
"operation-tags">
2670 <a class=
"label" href=
"#tag-User">User
</a>
2675 <h2 class=
"operation-title">
2676 <span class=
"operation-name">
2677 <span class=
"operation-name">POST
</span>
2678 <span class=
"operation-path">/users/register
</span>
2681 <div class=
"doc-row">
2682 <div class=
"doc-copy">
2683 <section class=
"swagger-request-body">
2684 <div class=
"prop-row">
2685 <div class=
"prop-name">
2686 <div class=
"swagger-request-model">
2688 <a class=
"json-schema-ref" href=
"#/definitions/RegisterUser">RegisterUser
</a>
2692 <div class=
"prop-value columns small-6">
2693 <!-- <div class="swagger-request-description"> -->
2700 <div class=
"doc-examples">
2702 <h5>Request Content-Types:
2703 <span>application/json
</span>
2705 <h5>Request Example
</h5>
2706 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2707 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
2708 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
2709 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>
2716 <div class=
"doc-row">
2717 <div class=
"doc-copy">
2718 <section class=
"swagger-responses">
2719 <div class=
"prop-row prop-group">
2720 <div class=
"prop-name">
2721 <div class=
"prop-title">204 No Content
</div>
2723 <div class=
"prop-value">
2724 <p>Successful operation
</p>
2729 <div class=
"doc-examples">
2730 <h5>Response Content-Types:
2731 <span>application/json
</span>
2736 <div id=
"operation--users-me-avatar-pick-post" class=
"operation panel" data-traverse-target=
"operation--users-me-avatar-pick-post">
2737 <!-- <section class="operation-tags row"> -->
2738 <!-- <div class="doc-copy"> -->
2739 <div class=
"operation-tags">
2740 <a class=
"label" href=
"#tag-User">User
</a>
2745 <h2 class=
"operation-title">
2746 <span class=
"operation-name">
2747 <span class=
"operation-name">POST
</span>
2748 <span class=
"operation-path">/users/me/avatar/pick
</span>
2751 <div class=
"doc-row">
2752 <div class=
"doc-copy">
2753 <section class=
"swagger-request-params">
2754 <div class=
"prop-row prop-group">
2755 <div class=
"prop-name">
2756 <div class=
"prop-title">avatarfile:
2757 <span class=
"prop-type">
2758 <span class=
"json-property-type">file
</span>
2759 <span class=
"json-property-range" title=
"Value limits"></span>
2762 <div class=
"prop-subtitle"> in formData
</div>
2764 <div class=
"prop-value">
2765 <p>The file to upload.
</p>
2770 <div class=
"doc-examples"></div>
2772 <div class=
"doc-row">
2773 <div class=
"doc-copy">
2774 <section class=
"swagger-responses">
2775 <div class=
"prop-row prop-group">
2776 <div class=
"prop-name">
2777 <div class=
"prop-title">200 OK
</div>
2778 <div class=
"prop-ref">
2780 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
2783 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2785 <div class=
"prop-value">
2786 <p>successful operation
</p>
2791 <div class=
"doc-examples">
2792 <h5>Response Content-Types:
2793 <span>application/json
</span>
2796 <h5>Response Example
2797 <span>(
200 OK)
</span>
2799 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
2800 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2801 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2802 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2809 <div class=
"doc-row">
2810 <div class=
"doc-copy">
2811 <section class=
"swagger-request-security">
2812 <table class=
"table">
2815 <th class=
"swagger-request-security-schema"></th>
2816 <th class=
"swagger-request-security-scopes"></th>
2822 <a href=
"#security-definition-OAuth2">OAuth2
</a>
2832 <h1 id=
"tag-Video" class=
"swagger-summary-tag" data-traverse-target=
"tag-Video">Video
</h1>
2833 <div id=
"operation--videos-get" class=
"operation panel" data-traverse-target=
"operation--videos-get">
2834 <!-- <section class="operation-tags row"> -->
2835 <!-- <div class="doc-copy"> -->
2836 <div class=
"operation-tags">
2837 <a class=
"label" href=
"#tag-Video">Video
</a>
2842 <h2 class=
"operation-title">
2843 <span class=
"operation-name">
2844 <span class=
"operation-name">GET
</span>
2845 <span class=
"operation-path">/videos
</span>
2848 <div class=
"doc-row">
2849 <div class=
"doc-copy">
2850 <section class=
"swagger-request-params">
2851 <div class=
"prop-row prop-group">
2852 <div class=
"prop-name">
2853 <div class=
"prop-title">category:
2854 <span class=
"prop-type">
2855 <span class=
"json-property-type">number
</span>
2856 <span class=
"json-property-range" title=
"Value limits"></span>
2859 <div class=
"prop-subtitle"> in query
</div>
2861 <div class=
"prop-value">
2862 <p>category id of the video
</p>
2865 <div class=
"prop-row prop-group">
2866 <div class=
"prop-name">
2867 <div class=
"prop-title">start:
2868 <span class=
"prop-type">
2869 <span class=
"json-property-type">number
</span>
2870 <span class=
"json-property-range" title=
"Value limits"></span>
2873 <div class=
"prop-subtitle"> in query
</div>
2875 <div class=
"prop-value">
2879 <div class=
"prop-row prop-group">
2880 <div class=
"prop-name">
2881 <div class=
"prop-title">count:
2882 <span class=
"prop-type">
2883 <span class=
"json-property-type">number
</span>
2884 <span class=
"json-property-range" title=
"Value limits"></span>
2887 <div class=
"prop-subtitle"> in query
</div>
2889 <div class=
"prop-value">
2890 <p>Number of items
</p>
2893 <div class=
"prop-row prop-group">
2894 <div class=
"prop-name">
2895 <div class=
"prop-title">sort:
2896 <span class=
"prop-type">
2897 <span class=
"json-property-type">string
</span>
2898 <span class=
"json-property-range" title=
"Value limits"></span>
2901 <div class=
"prop-subtitle"> in query
</div>
2903 <div class=
"prop-value">
2904 <p>Sort column (-createdAt for example)
</p>
2909 <div class=
"doc-examples"></div>
2911 <div class=
"doc-row">
2912 <div class=
"doc-copy">
2913 <section class=
"swagger-responses">
2914 <div class=
"prop-row prop-group">
2915 <div class=
"prop-name">
2916 <div class=
"prop-title">200 OK
</div>
2917 <div class=
"prop-ref">
2918 <span class=
"json-schema-ref-array">
2919 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2922 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2924 <div class=
"prop-value">
2925 <p>successful operation
</p>
2928 <div class=
"prop-row prop-inner">
2929 <div class=
"prop-name">type
</div>
2930 <div class=
"prop-value">
2931 <span class=
"json-property-type">
2932 <span class=
"json-schema-ref-array">
2933 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
2936 <span class=
"json-property-range" title=
"Value limits"></span>
2941 <div class=
"doc-examples">
2942 <h5>Response Content-Types:
2943 <span>application/json
</span>
2946 <h5>Response Example
2947 <span>(
200 OK)
</span>
2949 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
2951 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2952 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
2953 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2954 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2955 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2956 <span class=
"hljs-attr">"category
"</span>: {
2957 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2958 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2960 <span class=
"hljs-attr">"licence
"</span>: {
2961 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
2962 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2964 <span class=
"hljs-attr">"language
"</span>: {
2965 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
2966 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
2968 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
2969 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
2970 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
2971 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2972 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2973 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2974 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2975 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
2976 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
2977 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2978 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
2979 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
2980 <span class=
"hljs-attr">"account
"</span>: {
2981 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
2982 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
2983 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
2984 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
2985 <span class=
"hljs-attr">"avatar
"</span>: {
2986 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
2987 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
2988 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
2999 <div id=
"operation--videos-categories-get" class=
"operation panel" data-traverse-target=
"operation--videos-categories-get">
3000 <!-- <section class="operation-tags row"> -->
3001 <!-- <div class="doc-copy"> -->
3002 <div class=
"operation-tags">
3003 <a class=
"label" href=
"#tag-Video">Video
</a>
3008 <h2 class=
"operation-title">
3009 <span class=
"operation-name">
3010 <span class=
"operation-name">GET
</span>
3011 <span class=
"operation-path">/videos/categories
</span>
3014 <div class=
"doc-row">
3015 <div class=
"doc-copy"> </div>
3016 <div class=
"doc-examples"></div>
3018 <div class=
"doc-row">
3019 <div class=
"doc-copy">
3020 <section class=
"swagger-responses">
3021 <div class=
"prop-row prop-group">
3022 <div class=
"prop-name">
3023 <div class=
"prop-title">200 OK
</div>
3024 <div class=
"prop-ref"> </div>
3025 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3027 <div class=
"prop-value">
3028 <p>successful operation
</p>
3031 <div class=
"prop-row prop-inner">
3032 <div class=
"prop-name">type
</div>
3033 <div class=
"prop-value">
3034 <span class=
"json-property-type">string[]
</span>
3035 <span class=
"json-property-range" title=
"Value limits"></span>
3040 <div class=
"doc-examples">
3041 <h5>Response Content-Types:
3042 <span>application/json
</span>
3045 <h5>Response Example
3046 <span>(
200 OK)
</span>
3048 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3049 <span class=
"hljs-string">"string
"</span>
3057 <div id=
"operation--videos-licences-get" class=
"operation panel" data-traverse-target=
"operation--videos-licences-get">
3058 <!-- <section class="operation-tags row"> -->
3059 <!-- <div class="doc-copy"> -->
3060 <div class=
"operation-tags">
3061 <a class=
"label" href=
"#tag-Video">Video
</a>
3066 <h2 class=
"operation-title">
3067 <span class=
"operation-name">
3068 <span class=
"operation-name">GET
</span>
3069 <span class=
"operation-path">/videos/licences
</span>
3072 <div class=
"doc-row">
3073 <div class=
"doc-copy"> </div>
3074 <div class=
"doc-examples"></div>
3076 <div class=
"doc-row">
3077 <div class=
"doc-copy">
3078 <section class=
"swagger-responses">
3079 <div class=
"prop-row prop-group">
3080 <div class=
"prop-name">
3081 <div class=
"prop-title">200 OK
</div>
3082 <div class=
"prop-ref"> </div>
3083 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3085 <div class=
"prop-value">
3086 <p>successful operation
</p>
3089 <div class=
"prop-row prop-inner">
3090 <div class=
"prop-name">type
</div>
3091 <div class=
"prop-value">
3092 <span class=
"json-property-type">string[]
</span>
3093 <span class=
"json-property-range" title=
"Value limits"></span>
3098 <div class=
"doc-examples">
3099 <h5>Response Content-Types:
3100 <span>application/json
</span>
3103 <h5>Response Example
3104 <span>(
200 OK)
</span>
3106 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3107 <span class=
"hljs-string">"string
"</span>
3115 <div id=
"operation--videos-languages-get" class=
"operation panel" data-traverse-target=
"operation--videos-languages-get">
3116 <!-- <section class="operation-tags row"> -->
3117 <!-- <div class="doc-copy"> -->
3118 <div class=
"operation-tags">
3119 <a class=
"label" href=
"#tag-Video">Video
</a>
3124 <h2 class=
"operation-title">
3125 <span class=
"operation-name">
3126 <span class=
"operation-name">GET
</span>
3127 <span class=
"operation-path">/videos/languages
</span>
3130 <div class=
"doc-row">
3131 <div class=
"doc-copy"> </div>
3132 <div class=
"doc-examples"></div>
3134 <div class=
"doc-row">
3135 <div class=
"doc-copy">
3136 <section class=
"swagger-responses">
3137 <div class=
"prop-row prop-group">
3138 <div class=
"prop-name">
3139 <div class=
"prop-title">200 OK
</div>
3140 <div class=
"prop-ref"> </div>
3141 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3143 <div class=
"prop-value">
3144 <p>successful operation
</p>
3147 <div class=
"prop-row prop-inner">
3148 <div class=
"prop-name">type
</div>
3149 <div class=
"prop-value">
3150 <span class=
"json-property-type">string[]
</span>
3151 <span class=
"json-property-range" title=
"Value limits"></span>
3156 <div class=
"doc-examples">
3157 <h5>Response Content-Types:
3158 <span>application/json
</span>
3161 <h5>Response Example
3162 <span>(
200 OK)
</span>
3164 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3165 <span class=
"hljs-string">"string
"</span>
3173 <div id=
"operation--videos-privacies-get" class=
"operation panel" data-traverse-target=
"operation--videos-privacies-get">
3174 <!-- <section class="operation-tags row"> -->
3175 <!-- <div class="doc-copy"> -->
3176 <div class=
"operation-tags">
3177 <a class=
"label" href=
"#tag-Video">Video
</a>
3182 <h2 class=
"operation-title">
3183 <span class=
"operation-name">
3184 <span class=
"operation-name">GET
</span>
3185 <span class=
"operation-path">/videos/privacies
</span>
3188 <div class=
"doc-row">
3189 <div class=
"doc-copy"> </div>
3190 <div class=
"doc-examples"></div>
3192 <div class=
"doc-row">
3193 <div class=
"doc-copy">
3194 <section class=
"swagger-responses">
3195 <div class=
"prop-row prop-group">
3196 <div class=
"prop-name">
3197 <div class=
"prop-title">200 OK
</div>
3198 <div class=
"prop-ref"> </div>
3199 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3201 <div class=
"prop-value">
3202 <p>successful operation
</p>
3205 <div class=
"prop-row prop-inner">
3206 <div class=
"prop-name">type
</div>
3207 <div class=
"prop-value">
3208 <span class=
"json-property-type">string[]
</span>
3209 <span class=
"json-property-range" title=
"Value limits"></span>
3214 <div class=
"doc-examples">
3215 <h5>Response Content-Types:
3216 <span>application/json
</span>
3219 <h5>Response Example
3220 <span>(
200 OK)
</span>
3222 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
3223 <span class=
"hljs-string">"string
"</span>
3231 <div id=
"operation--videos--id--put" class=
"operation panel" data-traverse-target=
"operation--videos--id--put">
3232 <!-- <section class="operation-tags row"> -->
3233 <!-- <div class="doc-copy"> -->
3234 <div class=
"operation-tags">
3235 <a class=
"label" href=
"#tag-Video">Video
</a>
3240 <h2 class=
"operation-title">
3241 <span class=
"operation-name">
3242 <span class=
"operation-name">PUT
</span>
3243 <span class=
"operation-path">/videos/{id}
</span>
3246 <div class=
"doc-row">
3247 <div class=
"doc-copy">
3248 <section class=
"swagger-request-params">
3249 <div class=
"prop-row prop-group">
3250 <div class=
"prop-name">
3251 <div class=
"prop-title">id:
3252 <span class=
"prop-type">
3253 <span class=
"json-property-type">string
</span>
3254 <span class=
"json-property-range" title=
"Value limits"></span>
3257 <span class=
"json-property-required"></span>
3258 <div class=
"prop-subtitle"> in path
</div>
3260 <div class=
"prop-value">
3261 <p>The video id or uuid
</p>
3264 <div class=
"prop-row prop-group">
3265 <div class=
"prop-name">
3266 <div class=
"prop-title">thumbnailfile:
3267 <span class=
"prop-type">
3268 <span class=
"json-property-type">file
</span>
3269 <span class=
"json-property-range" title=
"Value limits"></span>
3272 <div class=
"prop-subtitle"> in formData
</div>
3274 <div class=
"prop-value">
3275 <p>Video thumbnail file
</p>
3278 <div class=
"prop-row prop-group">
3279 <div class=
"prop-name">
3280 <div class=
"prop-title">previewfile:
3281 <span class=
"prop-type">
3282 <span class=
"json-property-type">file
</span>
3283 <span class=
"json-property-range" title=
"Value limits"></span>
3286 <div class=
"prop-subtitle"> in formData
</div>
3288 <div class=
"prop-value">
3289 <p>Video preview file
</p>
3292 <div class=
"prop-row prop-group">
3293 <div class=
"prop-name">
3294 <div class=
"prop-title">category:
3295 <span class=
"prop-type">
3296 <span class=
"json-property-type">number
</span>
3297 <span class=
"json-property-range" title=
"Value limits"></span>
3300 <div class=
"prop-subtitle"> in formData
</div>
3302 <div class=
"prop-value">
3303 <p>Video category
</p>
3306 <div class=
"prop-row prop-group">
3307 <div class=
"prop-name">
3308 <div class=
"prop-title">licence:
3309 <span class=
"prop-type">
3310 <span class=
"json-property-type">number
</span>
3311 <span class=
"json-property-range" title=
"Value limits"></span>
3314 <div class=
"prop-subtitle"> in formData
</div>
3316 <div class=
"prop-value">
3317 <p>Video licence
</p>
3320 <div class=
"prop-row prop-group">
3321 <div class=
"prop-name">
3322 <div class=
"prop-title">language:
3323 <span class=
"prop-type">
3324 <span class=
"json-property-type">string
</span>
3325 <span class=
"json-property-range" title=
"Value limits"></span>
3328 <div class=
"prop-subtitle"> in formData
</div>
3330 <div class=
"prop-value">
3331 <p>Video language
</p>
3334 <div class=
"prop-row prop-group">
3335 <div class=
"prop-name">
3336 <div class=
"prop-title">description:
3337 <span class=
"prop-type">
3338 <span class=
"json-property-type">string
</span>
3339 <span class=
"json-property-range" title=
"Value limits"></span>
3342 <div class=
"prop-subtitle"> in formData
</div>
3344 <div class=
"prop-value">
3345 <p>Video description
</p>
3348 <div class=
"prop-row prop-group">
3349 <div class=
"prop-name">
3350 <div class=
"prop-title">waitTranscoding:
3351 <span class=
"prop-type">
3352 <span class=
"json-property-type">boolean
</span>
3353 <span class=
"json-property-range" title=
"Value limits"></span>
3356 <div class=
"prop-subtitle"> in formData
</div>
3358 <div class=
"prop-value">
3359 <p>Whether or not we wait transcoding before publish the video
</p>
3362 <div class=
"prop-row prop-group">
3363 <div class=
"prop-name">
3364 <div class=
"prop-title">support:
3365 <span class=
"prop-type">
3366 <span class=
"json-property-type">string
</span>
3367 <span class=
"json-property-range" title=
"Value limits"></span>
3370 <div class=
"prop-subtitle"> in formData
</div>
3372 <div class=
"prop-value">
3373 <p>Text describing how to support the video uploader
</p>
3376 <div class=
"prop-row prop-group">
3377 <div class=
"prop-name">
3378 <div class=
"prop-title">nsfw:
3379 <span class=
"prop-type">
3380 <span class=
"json-property-type">boolean
</span>
3381 <span class=
"json-property-range" title=
"Value limits"></span>
3384 <div class=
"prop-subtitle"> in formData
</div>
3386 <div class=
"prop-value">
3387 <p>Whether or not this video contains sensitive content
</p>
3390 <div class=
"prop-row prop-group">
3391 <div class=
"prop-name">
3392 <div class=
"prop-title">name:
3393 <span class=
"prop-type">
3394 <span class=
"json-property-type">string
</span>
3395 <span class=
"json-property-range" title=
"Value limits"></span>
3398 <div class=
"prop-subtitle"> in formData
</div>
3400 <div class=
"prop-value">
3404 <div class=
"prop-row prop-group">
3405 <div class=
"prop-name">
3406 <div class=
"prop-title">tags:
3407 <span class=
"prop-type">
3408 <span class=
"json-property-type">string[]
</span>
3409 <span class=
"json-property-range" title=
"Value limits"></span>
3412 <div class=
"prop-subtitle"> in formData
</div>
3414 <div class=
"prop-value">
3418 <div class=
"prop-row prop-group">
3419 <div class=
"prop-name">
3420 <div class=
"prop-title">commentsEnabled:
3421 <span class=
"prop-type">
3422 <span class=
"json-property-type">boolean
</span>
3423 <span class=
"json-property-range" title=
"Value limits"></span>
3426 <div class=
"prop-subtitle"> in formData
</div>
3428 <div class=
"prop-value">
3429 <p>Enable or disable comments for this video
</p>
3432 <div class=
"prop-row prop-group">
3433 <div class=
"prop-name">
3434 <div class=
"prop-title">privacy:
3435 <span class=
"prop-type">
3436 <span class=
"json-property-type">string
</span>
3437 <span class=
"json-property-enum" title=
"Possible values">
3438 <span class=
"json-property-enum-item">Public
</span>,
3439 <span class=
"json-property-enum-item">Unlisted
</span>
3441 <span class=
"json-property-range" title=
"Value limits"></span>
3444 <div class=
"prop-subtitle"> in formData
</div>
3446 <div class=
"prop-value">
3447 <p>Video privacy
</p>
3450 <div class=
"prop-row prop-group">
3451 <div class=
"prop-name">
3452 <div class=
"prop-title">scheduleUpdate:
3453 <span class=
"prop-type">
3454 <span class=
"json-property-type">object
</span>
3455 <span class=
"json-property-range" title=
"Value limits"></span>
3458 <div class=
"prop-subtitle"> in formData
</div>
3460 <div class=
"prop-value">
3461 <p>Schedule an update at a specific datetime
</p>
3466 <div class=
"doc-examples"></div>
3468 <div class=
"doc-row">
3469 <div class=
"doc-copy">
3470 <section class=
"swagger-responses">
3471 <div class=
"prop-row prop-group">
3472 <div class=
"prop-name">
3473 <div class=
"prop-title">200 OK
</div>
3474 <div class=
"prop-ref">
3476 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3479 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3481 <div class=
"prop-value">
3482 <p>successful operation
</p>
3487 <div class=
"doc-examples">
3488 <h5>Response Content-Types:
3489 <span>application/json
</span>
3492 <h5>Response Example
3493 <span>(
200 OK)
</span>
3495 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3496 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3497 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3498 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3499 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3500 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3501 <span class=
"hljs-attr">"category
"</span>: {
3502 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3503 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3505 <span class=
"hljs-attr">"licence
"</span>: {
3506 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3507 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3509 <span class=
"hljs-attr">"language
"</span>: {
3510 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
3511 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3513 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3514 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3515 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3516 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3517 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3518 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3519 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3520 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3521 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3522 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3523 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3524 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3525 <span class=
"hljs-attr">"account
"</span>: {
3526 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3527 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3528 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3529 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3530 <span class=
"hljs-attr">"avatar
"</span>: {
3531 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3532 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3533 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3542 <div class=
"doc-row">
3543 <div class=
"doc-copy">
3544 <section class=
"swagger-request-security">
3545 <table class=
"table">
3548 <th class=
"swagger-request-security-schema"></th>
3549 <th class=
"swagger-request-security-scopes"></th>
3555 <a href=
"#security-definition-OAuth2">OAuth2
</a>
3565 <div id=
"operation--videos--id--get" class=
"operation panel" data-traverse-target=
"operation--videos--id--get">
3566 <!-- <section class="operation-tags row"> -->
3567 <!-- <div class="doc-copy"> -->
3568 <div class=
"operation-tags">
3569 <a class=
"label" href=
"#tag-Video">Video
</a>
3574 <h2 class=
"operation-title">
3575 <span class=
"operation-name">
3576 <span class=
"operation-name">GET
</span>
3577 <span class=
"operation-path">/videos/{id}
</span>
3580 <div class=
"doc-row">
3581 <div class=
"doc-copy">
3582 <section class=
"swagger-request-params">
3583 <div class=
"prop-row prop-group">
3584 <div class=
"prop-name">
3585 <div class=
"prop-title">id:
3586 <span class=
"prop-type">
3587 <span class=
"json-property-type">string
</span>
3588 <span class=
"json-property-range" title=
"Value limits"></span>
3591 <span class=
"json-property-required"></span>
3592 <div class=
"prop-subtitle"> in path
</div>
3594 <div class=
"prop-value">
3595 <p>The video id or uuid
</p>
3600 <div class=
"doc-examples"></div>
3602 <div class=
"doc-row">
3603 <div class=
"doc-copy">
3604 <section class=
"swagger-responses">
3605 <div class=
"prop-row prop-group">
3606 <div class=
"prop-name">
3607 <div class=
"prop-title">200 OK
</div>
3608 <div class=
"prop-ref">
3610 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
3613 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3615 <div class=
"prop-value">
3616 <p>successful operation
</p>
3621 <div class=
"doc-examples">
3622 <h5>Response Content-Types:
3623 <span>application/json
</span>
3626 <h5>Response Example
3627 <span>(
200 OK)
</span>
3629 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
3630 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3631 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
3632 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3633 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3634 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3635 <span class=
"hljs-attr">"category
"</span>: {
3636 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3637 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3639 <span class=
"hljs-attr">"licence
"</span>: {
3640 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
3641 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3643 <span class=
"hljs-attr">"language
"</span>: {
3644 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
3645 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
3647 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
3648 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
3649 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
3650 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3651 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3652 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3653 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3654 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
3655 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
3656 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3657 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
3658 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
3659 <span class=
"hljs-attr">"account
"</span>: {
3660 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
3661 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
3662 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
3663 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
3664 <span class=
"hljs-attr">"avatar
"</span>: {
3665 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
3666 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
3667 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
3677 <div id=
"operation--videos--id--delete" class=
"operation panel" data-traverse-target=
"operation--videos--id--delete">
3678 <!-- <section class="operation-tags row"> -->
3679 <!-- <div class="doc-copy"> -->
3680 <div class=
"operation-tags">
3681 <a class=
"label" href=
"#tag-Video">Video
</a>
3686 <h2 class=
"operation-title">
3687 <span class=
"operation-name">
3688 <span class=
"operation-name">DELETE
</span>
3689 <span class=
"operation-path">/videos/{id}
</span>
3692 <div class=
"doc-row">
3693 <div class=
"doc-copy">
3694 <section class=
"swagger-request-params">
3695 <div class=
"prop-row prop-group">
3696 <div class=
"prop-name">
3697 <div class=
"prop-title">id:
3698 <span class=
"prop-type">
3699 <span class=
"json-property-type">string
</span>
3700 <span class=
"json-property-range" title=
"Value limits"></span>
3703 <span class=
"json-property-required"></span>
3704 <div class=
"prop-subtitle"> in path
</div>
3706 <div class=
"prop-value">
3707 <p>The video id or uuid
</p>
3712 <div class=
"doc-examples"></div>
3714 <div class=
"doc-row">
3715 <div class=
"doc-copy">
3716 <section class=
"swagger-responses">
3717 <div class=
"prop-row prop-group">
3718 <div class=
"prop-name">
3719 <div class=
"prop-title">204 No Content
</div>
3721 <div class=
"prop-value">
3722 <p>Successful operation
</p>
3727 <div class=
"doc-examples">
3728 <h5>Response Content-Types:
3729 <span>application/json
</span>
3733 <div class=
"doc-row">
3734 <div class=
"doc-copy">
3735 <section class=
"swagger-request-security">
3736 <table class=
"table">
3739 <th class=
"swagger-request-security-schema"></th>
3740 <th class=
"swagger-request-security-scopes"></th>
3746 <a href=
"#security-definition-OAuth2">OAuth2
</a>
3756 <div id=
"operation--videos--id--description-get" class=
"operation panel" data-traverse-target=
"operation--videos--id--description-get">
3757 <!-- <section class="operation-tags row"> -->
3758 <!-- <div class="doc-copy"> -->
3759 <div class=
"operation-tags">
3760 <a class=
"label" href=
"#tag-Video">Video
</a>
3765 <h2 class=
"operation-title">
3766 <span class=
"operation-name">
3767 <span class=
"operation-name">GET
</span>
3768 <span class=
"operation-path">/videos/{id}/description
</span>
3771 <div class=
"doc-row">
3772 <div class=
"doc-copy">
3773 <section class=
"swagger-request-params">
3774 <div class=
"prop-row prop-group">
3775 <div class=
"prop-name">
3776 <div class=
"prop-title">id:
3777 <span class=
"prop-type">
3778 <span class=
"json-property-type">string
</span>
3779 <span class=
"json-property-range" title=
"Value limits"></span>
3782 <span class=
"json-property-required"></span>
3783 <div class=
"prop-subtitle"> in path
</div>
3785 <div class=
"prop-value">
3786 <p>The video id or uuid
</p>
3791 <div class=
"doc-examples"></div>
3793 <div class=
"doc-row">
3794 <div class=
"doc-copy">
3795 <section class=
"swagger-responses">
3796 <div class=
"prop-row prop-group">
3797 <div class=
"prop-name">
3798 <div class=
"prop-title">200 OK
</div>
3799 <div class=
"prop-ref"> </div>
3800 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3802 <div class=
"prop-value">
3803 <p>successful operation
</p>
3806 <div class=
"prop-row prop-inner">
3807 <div class=
"prop-name">type
</div>
3808 <div class=
"prop-value">
3809 <span class=
"json-property-type">string
</span>
3810 <span class=
"json-property-range" title=
"Value limits"></span>
3815 <div class=
"doc-examples">
3816 <h5>Response Content-Types:
3817 <span>application/json
</span>
3820 <h5>Response Example
3821 <span>(
200 OK)
</span>
3823 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json"><span class=
"hljs-string">"string
"</span>
3830 <div id=
"operation--videos--id--views-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--views-post">
3831 <!-- <section class="operation-tags row"> -->
3832 <!-- <div class="doc-copy"> -->
3833 <div class=
"operation-tags">
3834 <a class=
"label" href=
"#tag-Video">Video
</a>
3839 <h2 class=
"operation-title">
3840 <span class=
"operation-name">
3841 <span class=
"operation-name">POST
</span>
3842 <span class=
"operation-path">/videos/{id}/views
</span>
3845 <div class=
"doc-row">
3846 <div class=
"doc-copy">
3847 <section class=
"swagger-request-params">
3848 <div class=
"prop-row prop-group">
3849 <div class=
"prop-name">
3850 <div class=
"prop-title">id:
3851 <span class=
"prop-type">
3852 <span class=
"json-property-type">string
</span>
3853 <span class=
"json-property-range" title=
"Value limits"></span>
3856 <span class=
"json-property-required"></span>
3857 <div class=
"prop-subtitle"> in path
</div>
3859 <div class=
"prop-value">
3860 <p>The video id or uuid
</p>
3865 <div class=
"doc-examples"></div>
3867 <div class=
"doc-row">
3868 <div class=
"doc-copy">
3869 <section class=
"swagger-responses">
3870 <div class=
"prop-row prop-group">
3871 <div class=
"prop-name">
3872 <div class=
"prop-title">204 No Content
</div>
3874 <div class=
"prop-value">
3875 <p>Successful operation
</p>
3880 <div class=
"doc-examples">
3881 <h5>Response Content-Types:
3882 <span>application/json
</span>
3887 <div id=
"operation--videos-upload-post" class=
"operation panel" data-traverse-target=
"operation--videos-upload-post">
3888 <!-- <section class="operation-tags row"> -->
3889 <!-- <div class="doc-copy"> -->
3890 <div class=
"operation-tags">
3891 <a class=
"label" href=
"#tag-Video">Video
</a>
3896 <h2 class=
"operation-title">
3897 <span class=
"operation-name">
3898 <span class=
"operation-name">POST
</span>
3899 <span class=
"operation-path">/videos/upload
</span>
3902 <div class=
"doc-row">
3903 <div class=
"doc-copy">
3904 <section class=
"swagger-request-params">
3905 <div class=
"prop-row prop-group">
3906 <div class=
"prop-name">
3907 <div class=
"prop-title">videofile:
3908 <span class=
"prop-type">
3909 <span class=
"json-property-type">file
</span>
3910 <span class=
"json-property-range" title=
"Value limits"></span>
3913 <span class=
"json-property-required"></span>
3914 <div class=
"prop-subtitle"> in formData
</div>
3916 <div class=
"prop-value">
3920 <div class=
"prop-row prop-group">
3921 <div class=
"prop-name">
3922 <div class=
"prop-title">channelId:
3923 <span class=
"prop-type">
3924 <span class=
"json-property-type">number
</span>
3925 <span class=
"json-property-range" title=
"Value limits"></span>
3928 <span class=
"json-property-required"></span>
3929 <div class=
"prop-subtitle"> in formData
</div>
3931 <div class=
"prop-value">
3932 <p>Channel id that will contain this video
</p>
3935 <div class=
"prop-row prop-group">
3936 <div class=
"prop-name">
3937 <div class=
"prop-title">thumbnailfile:
3938 <span class=
"prop-type">
3939 <span class=
"json-property-type">file
</span>
3940 <span class=
"json-property-range" title=
"Value limits"></span>
3943 <div class=
"prop-subtitle"> in formData
</div>
3945 <div class=
"prop-value">
3946 <p>Video thumbnail file
</p>
3949 <div class=
"prop-row prop-group">
3950 <div class=
"prop-name">
3951 <div class=
"prop-title">previewfile:
3952 <span class=
"prop-type">
3953 <span class=
"json-property-type">file
</span>
3954 <span class=
"json-property-range" title=
"Value limits"></span>
3957 <div class=
"prop-subtitle"> in formData
</div>
3959 <div class=
"prop-value">
3960 <p>Video preview file
</p>
3963 <div class=
"prop-row prop-group">
3964 <div class=
"prop-name">
3965 <div class=
"prop-title">category:
3966 <span class=
"prop-type">
3967 <span class=
"json-property-type">number
</span>
3968 <span class=
"json-property-range" title=
"Value limits"></span>
3971 <div class=
"prop-subtitle"> in formData
</div>
3973 <div class=
"prop-value">
3974 <p>Video category
</p>
3977 <div class=
"prop-row prop-group">
3978 <div class=
"prop-name">
3979 <div class=
"prop-title">licence:
3980 <span class=
"prop-type">
3981 <span class=
"json-property-type">number
</span>
3982 <span class=
"json-property-range" title=
"Value limits"></span>
3985 <div class=
"prop-subtitle"> in formData
</div>
3987 <div class=
"prop-value">
3988 <p>Video licence
</p>
3991 <div class=
"prop-row prop-group">
3992 <div class=
"prop-name">
3993 <div class=
"prop-title">language:
3994 <span class=
"prop-type">
3995 <span class=
"json-property-type">string
</span>
3996 <span class=
"json-property-range" title=
"Value limits"></span>
3999 <div class=
"prop-subtitle"> in formData
</div>
4001 <div class=
"prop-value">
4002 <p>Video language
</p>
4005 <div class=
"prop-row prop-group">
4006 <div class=
"prop-name">
4007 <div class=
"prop-title">description:
4008 <span class=
"prop-type">
4009 <span class=
"json-property-type">string
</span>
4010 <span class=
"json-property-range" title=
"Value limits"></span>
4013 <div class=
"prop-subtitle"> in formData
</div>
4015 <div class=
"prop-value">
4016 <p>Video description
</p>
4019 <div class=
"prop-row prop-group">
4020 <div class=
"prop-name">
4021 <div class=
"prop-title">waitTranscoding:
4022 <span class=
"prop-type">
4023 <span class=
"json-property-type">boolean
</span>
4024 <span class=
"json-property-range" title=
"Value limits"></span>
4027 <div class=
"prop-subtitle"> in formData
</div>
4029 <div class=
"prop-value">
4030 <p>Whether or not we wait transcoding before publish the video
</p>
4033 <div class=
"prop-row prop-group">
4034 <div class=
"prop-name">
4035 <div class=
"prop-title">support:
4036 <span class=
"prop-type">
4037 <span class=
"json-property-type">string
</span>
4038 <span class=
"json-property-range" title=
"Value limits"></span>
4041 <div class=
"prop-subtitle"> in formData
</div>
4043 <div class=
"prop-value">
4044 <p>Text describing how to support the video uploader
</p>
4047 <div class=
"prop-row prop-group">
4048 <div class=
"prop-name">
4049 <div class=
"prop-title">nsfw:
4050 <span class=
"prop-type">
4051 <span class=
"json-property-type">boolean
</span>
4052 <span class=
"json-property-range" title=
"Value limits"></span>
4055 <div class=
"prop-subtitle"> in formData
</div>
4057 <div class=
"prop-value">
4058 <p>Whether or not this video contains sensitive content
</p>
4061 <div class=
"prop-row prop-group">
4062 <div class=
"prop-name">
4063 <div class=
"prop-title">name:
4064 <span class=
"prop-type">
4065 <span class=
"json-property-type">string
</span>
4066 <span class=
"json-property-range" title=
"Value limits"></span>
4069 <div class=
"prop-subtitle"> in formData
</div>
4071 <div class=
"prop-value">
4075 <div class=
"prop-row prop-group">
4076 <div class=
"prop-name">
4077 <div class=
"prop-title">tags:
4078 <span class=
"prop-type">
4079 <span class=
"json-property-type">string[]
</span>
4080 <span class=
"json-property-range" title=
"Value limits"></span>
4083 <div class=
"prop-subtitle"> in formData
</div>
4085 <div class=
"prop-value">
4089 <div class=
"prop-row prop-group">
4090 <div class=
"prop-name">
4091 <div class=
"prop-title">commentsEnabled:
4092 <span class=
"prop-type">
4093 <span class=
"json-property-type">boolean
</span>
4094 <span class=
"json-property-range" title=
"Value limits"></span>
4097 <div class=
"prop-subtitle"> in formData
</div>
4099 <div class=
"prop-value">
4100 <p>Enable or disable comments for this video
</p>
4103 <div class=
"prop-row prop-group">
4104 <div class=
"prop-name">
4105 <div class=
"prop-title">privacy:
4106 <span class=
"prop-type">
4107 <span class=
"json-property-type">string
</span>
4108 <span class=
"json-property-enum" title=
"Possible values">
4109 <span class=
"json-property-enum-item">Public
</span>,
4110 <span class=
"json-property-enum-item">Unlisted
</span>
4112 <span class=
"json-property-range" title=
"Value limits"></span>
4115 <div class=
"prop-subtitle"> in formData
</div>
4117 <div class=
"prop-value">
4118 <p>Video privacy
</p>
4121 <div class=
"prop-row prop-group">
4122 <div class=
"prop-name">
4123 <div class=
"prop-title">scheduleUpdate:
4124 <span class=
"prop-type">
4125 <span class=
"json-property-type">object
</span>
4126 <span class=
"json-property-range" title=
"Value limits"></span>
4129 <div class=
"prop-subtitle"> in formData
</div>
4131 <div class=
"prop-value">
4132 <p>Schedule an update at a specific datetime
</p>
4137 <div class=
"doc-examples"></div>
4139 <div class=
"doc-row">
4140 <div class=
"doc-copy">
4141 <section class=
"swagger-responses">
4142 <div class=
"prop-row prop-group">
4143 <div class=
"prop-name">
4144 <div class=
"prop-title">200 OK
</div>
4145 <div class=
"prop-ref">
4147 <a class=
"json-schema-ref" href=
"#/definitions/VideoUploadResponse">VideoUploadResponse
</a>
4150 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4152 <div class=
"prop-value">
4153 <p>successful operation
</p>
4158 <div class=
"doc-examples">
4159 <h5>Response Content-Types:
4160 <span>application/json
</span>
4163 <h5>Response Example
4164 <span>(
200 OK)
</span>
4166 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4167 <span class=
"hljs-attr">"video
"</span>: {
4168 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4169 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
4177 <div class=
"doc-row">
4178 <div class=
"doc-copy">
4179 <section class=
"swagger-request-security">
4180 <table class=
"table">
4183 <th class=
"swagger-request-security-schema"></th>
4184 <th class=
"swagger-request-security-scopes"></th>
4190 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4200 <h1 id=
"tag-VideoAbuse" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoAbuse">VideoAbuse
</h1>
4201 <div id=
"operation--videos-abuse-get" class=
"operation panel" data-traverse-target=
"operation--videos-abuse-get">
4202 <!-- <section class="operation-tags row"> -->
4203 <!-- <div class="doc-copy"> -->
4204 <div class=
"operation-tags">
4205 <a class=
"label" href=
"#tag-VideoAbuse">VideoAbuse
</a>
4210 <h2 class=
"operation-title">
4211 <span class=
"operation-name">
4212 <span class=
"operation-name">GET
</span>
4213 <span class=
"operation-path">/videos/abuse
</span>
4216 <div class=
"doc-row">
4217 <div class=
"doc-copy">
4218 <section class=
"swagger-request-params">
4219 <div class=
"prop-row prop-group">
4220 <div class=
"prop-name">
4221 <div class=
"prop-title">start:
4222 <span class=
"prop-type">
4223 <span class=
"json-property-type">number
</span>
4224 <span class=
"json-property-range" title=
"Value limits"></span>
4227 <div class=
"prop-subtitle"> in query
</div>
4229 <div class=
"prop-value">
4233 <div class=
"prop-row prop-group">
4234 <div class=
"prop-name">
4235 <div class=
"prop-title">count:
4236 <span class=
"prop-type">
4237 <span class=
"json-property-type">number
</span>
4238 <span class=
"json-property-range" title=
"Value limits"></span>
4241 <div class=
"prop-subtitle"> in query
</div>
4243 <div class=
"prop-value">
4244 <p>Number of items
</p>
4247 <div class=
"prop-row prop-group">
4248 <div class=
"prop-name">
4249 <div class=
"prop-title">sort:
4250 <span class=
"prop-type">
4251 <span class=
"json-property-type">string
</span>
4252 <span class=
"json-property-range" title=
"Value limits"></span>
4255 <div class=
"prop-subtitle"> in query
</div>
4257 <div class=
"prop-value">
4258 <p>Sort column (-createdAt for example)
</p>
4263 <div class=
"doc-examples"></div>
4265 <div class=
"doc-row">
4266 <div class=
"doc-copy">
4267 <section class=
"swagger-responses">
4268 <div class=
"prop-row prop-group">
4269 <div class=
"prop-name">
4270 <div class=
"prop-title">200 OK
</div>
4271 <div class=
"prop-ref">
4272 <span class=
"json-schema-ref-array">
4273 <a class=
"json-schema-ref" href=
"#/definitions/VideoAbuse">VideoAbuse
</a>
4276 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4278 <div class=
"prop-value">
4279 <p>successful operation
</p>
4282 <div class=
"prop-row prop-inner">
4283 <div class=
"prop-name">type
</div>
4284 <div class=
"prop-value">
4285 <span class=
"json-property-type">
4286 <span class=
"json-schema-ref-array">
4287 <a class=
"json-schema-ref" href=
"#/definitions/VideoAbuse">VideoAbuse
</a>
4290 <span class=
"json-property-range" title=
"Value limits"></span>
4295 <div class=
"doc-examples">
4296 <h5>Response Content-Types:
4297 <span>application/json
</span>
4300 <h5>Response Example
4301 <span>(
200 OK)
</span>
4303 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4305 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4306 <span class=
"hljs-attr">"reason
"</span>:
<span class=
"hljs-string">"string
"</span>,
4307 <span class=
"hljs-attr">"reporterAccount
"</span>: {
4308 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4309 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4310 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4311 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
4312 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4313 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
4314 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4315 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
4316 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4317 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4318 <span class=
"hljs-attr">"avatar
"</span>: {
4319 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
4320 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4321 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4324 <span class=
"hljs-attr">"video
"</span>: {
4325 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4326 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4327 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4328 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>
4330 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>
4338 <div class=
"doc-row">
4339 <div class=
"doc-copy">
4340 <section class=
"swagger-request-security">
4341 <table class=
"table">
4344 <th class=
"swagger-request-security-schema"></th>
4345 <th class=
"swagger-request-security-scopes"></th>
4351 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4361 <div id=
"operation--videos--id--abuse-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--abuse-post">
4362 <!-- <section class="operation-tags row"> -->
4363 <!-- <div class="doc-copy"> -->
4364 <div class=
"operation-tags">
4365 <a class=
"label" href=
"#tag-VideoAbuse">VideoAbuse
</a>
4370 <h2 class=
"operation-title">
4371 <span class=
"operation-name">
4372 <span class=
"operation-name">POST
</span>
4373 <span class=
"operation-path">/videos/{id}/abuse
</span>
4376 <div class=
"doc-row">
4377 <div class=
"doc-copy">
4378 <section class=
"swagger-request-params">
4379 <div class=
"prop-row prop-group">
4380 <div class=
"prop-name">
4381 <div class=
"prop-title">id:
4382 <span class=
"prop-type">
4383 <span class=
"json-property-type">string
</span>
4384 <span class=
"json-property-range" title=
"Value limits"></span>
4387 <span class=
"json-property-required"></span>
4388 <div class=
"prop-subtitle"> in path
</div>
4390 <div class=
"prop-value">
4391 <p>The video id or uuid
</p>
4396 <div class=
"doc-examples"></div>
4398 <div class=
"doc-row">
4399 <div class=
"doc-copy">
4400 <section class=
"swagger-responses">
4401 <div class=
"prop-row prop-group">
4402 <div class=
"prop-name">
4403 <div class=
"prop-title">204 No Content
</div>
4405 <div class=
"prop-value">
4406 <p>Successful operation
</p>
4411 <div class=
"doc-examples">
4412 <h5>Response Content-Types:
4413 <span>application/json
</span>
4417 <div class=
"doc-row">
4418 <div class=
"doc-copy">
4419 <section class=
"swagger-request-security">
4420 <table class=
"table">
4423 <th class=
"swagger-request-security-schema"></th>
4424 <th class=
"swagger-request-security-scopes"></th>
4430 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4440 <h1 id=
"tag-VideoBlacklist" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoBlacklist">VideoBlacklist
</h1>
4441 <div id=
"operation--videos--id--blacklist-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--blacklist-post">
4442 <!-- <section class="operation-tags row"> -->
4443 <!-- <div class="doc-copy"> -->
4444 <div class=
"operation-tags">
4445 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4450 <h2 class=
"operation-title">
4451 <span class=
"operation-name">
4452 <span class=
"operation-name">POST
</span>
4453 <span class=
"operation-path">/videos/{id}/blacklist
</span>
4456 <div class=
"doc-row">
4457 <div class=
"doc-copy">
4458 <section class=
"swagger-request-params">
4459 <div class=
"prop-row prop-group">
4460 <div class=
"prop-name">
4461 <div class=
"prop-title">id:
4462 <span class=
"prop-type">
4463 <span class=
"json-property-type">string
</span>
4464 <span class=
"json-property-range" title=
"Value limits"></span>
4467 <span class=
"json-property-required"></span>
4468 <div class=
"prop-subtitle"> in path
</div>
4470 <div class=
"prop-value">
4471 <p>The video id or uuid
</p>
4476 <div class=
"doc-examples"></div>
4478 <div class=
"doc-row">
4479 <div class=
"doc-copy">
4480 <section class=
"swagger-responses">
4481 <div class=
"prop-row prop-group">
4482 <div class=
"prop-name">
4483 <div class=
"prop-title">204 No Content
</div>
4485 <div class=
"prop-value">
4486 <p>Successful operation
</p>
4491 <div class=
"doc-examples">
4492 <h5>Response Content-Types:
4493 <span>application/json
</span>
4497 <div class=
"doc-row">
4498 <div class=
"doc-copy">
4499 <section class=
"swagger-request-security">
4500 <table class=
"table">
4503 <th class=
"swagger-request-security-schema"></th>
4504 <th class=
"swagger-request-security-scopes"></th>
4510 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4520 <div id=
"operation--videos--id--blacklist-delete" class=
"operation panel" data-traverse-target=
"operation--videos--id--blacklist-delete">
4521 <!-- <section class="operation-tags row"> -->
4522 <!-- <div class="doc-copy"> -->
4523 <div class=
"operation-tags">
4524 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4529 <h2 class=
"operation-title">
4530 <span class=
"operation-name">
4531 <span class=
"operation-name">DELETE
</span>
4532 <span class=
"operation-path">/videos/{id}/blacklist
</span>
4535 <div class=
"doc-row">
4536 <div class=
"doc-copy">
4537 <section class=
"swagger-request-params">
4538 <div class=
"prop-row prop-group">
4539 <div class=
"prop-name">
4540 <div class=
"prop-title">id:
4541 <span class=
"prop-type">
4542 <span class=
"json-property-type">string
</span>
4543 <span class=
"json-property-range" title=
"Value limits"></span>
4546 <span class=
"json-property-required"></span>
4547 <div class=
"prop-subtitle"> in path
</div>
4549 <div class=
"prop-value">
4550 <p>The video id or uuid
</p>
4555 <div class=
"doc-examples"></div>
4557 <div class=
"doc-row">
4558 <div class=
"doc-copy">
4559 <section class=
"swagger-responses">
4560 <div class=
"prop-row prop-group">
4561 <div class=
"prop-name">
4562 <div class=
"prop-title">204 No Content
</div>
4564 <div class=
"prop-value">
4565 <p>Successful operation
</p>
4570 <div class=
"doc-examples">
4571 <h5>Response Content-Types:
4572 <span>application/json
</span>
4576 <div class=
"doc-row">
4577 <div class=
"doc-copy">
4578 <section class=
"swagger-request-security">
4579 <table class=
"table">
4582 <th class=
"swagger-request-security-schema"></th>
4583 <th class=
"swagger-request-security-scopes"></th>
4589 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4599 <div id=
"operation--videos-blacklist-get" class=
"operation panel" data-traverse-target=
"operation--videos-blacklist-get">
4600 <!-- <section class="operation-tags row"> -->
4601 <!-- <div class="doc-copy"> -->
4602 <div class=
"operation-tags">
4603 <a class=
"label" href=
"#tag-VideoBlacklist">VideoBlacklist
</a>
4608 <h2 class=
"operation-title">
4609 <span class=
"operation-name">
4610 <span class=
"operation-name">GET
</span>
4611 <span class=
"operation-path">/videos/blacklist
</span>
4614 <div class=
"doc-row">
4615 <div class=
"doc-copy">
4616 <section class=
"swagger-request-params">
4617 <div class=
"prop-row prop-group">
4618 <div class=
"prop-name">
4619 <div class=
"prop-title">start:
4620 <span class=
"prop-type">
4621 <span class=
"json-property-type">number
</span>
4622 <span class=
"json-property-range" title=
"Value limits"></span>
4625 <div class=
"prop-subtitle"> in query
</div>
4627 <div class=
"prop-value">
4631 <div class=
"prop-row prop-group">
4632 <div class=
"prop-name">
4633 <div class=
"prop-title">count:
4634 <span class=
"prop-type">
4635 <span class=
"json-property-type">number
</span>
4636 <span class=
"json-property-range" title=
"Value limits"></span>
4639 <div class=
"prop-subtitle"> in query
</div>
4641 <div class=
"prop-value">
4642 <p>Number of items
</p>
4645 <div class=
"prop-row prop-group">
4646 <div class=
"prop-name">
4647 <div class=
"prop-title">sort:
4648 <span class=
"prop-type">
4649 <span class=
"json-property-type">string
</span>
4650 <span class=
"json-property-range" title=
"Value limits"></span>
4653 <div class=
"prop-subtitle"> in query
</div>
4655 <div class=
"prop-value">
4656 <p>Sort column (-createdAt for example)
</p>
4661 <div class=
"doc-examples"></div>
4663 <div class=
"doc-row">
4664 <div class=
"doc-copy">
4665 <section class=
"swagger-responses">
4666 <div class=
"prop-row prop-group">
4667 <div class=
"prop-name">
4668 <div class=
"prop-title">200 OK
</div>
4669 <div class=
"prop-ref">
4670 <span class=
"json-schema-ref-array">
4671 <a class=
"json-schema-ref" href=
"#/definitions/VideoBlacklist">VideoBlacklist
</a>
4674 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4676 <div class=
"prop-value">
4677 <p>successful operation
</p>
4680 <div class=
"prop-row prop-inner">
4681 <div class=
"prop-name">type
</div>
4682 <div class=
"prop-value">
4683 <span class=
"json-property-type">
4684 <span class=
"json-schema-ref-array">
4685 <a class=
"json-schema-ref" href=
"#/definitions/VideoBlacklist">VideoBlacklist
</a>
4688 <span class=
"json-property-range" title=
"Value limits"></span>
4693 <div class=
"doc-examples">
4694 <h5>Response Content-Types:
4695 <span>application/json
</span>
4698 <h5>Response Example
4699 <span>(
200 OK)
</span>
4701 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4703 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4704 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
4705 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4706 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
4707 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4708 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
4709 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4710 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
4711 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
4712 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4713 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
4714 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
4722 <div class=
"doc-row">
4723 <div class=
"doc-copy">
4724 <section class=
"swagger-request-security">
4725 <table class=
"table">
4728 <th class=
"swagger-request-security-schema"></th>
4729 <th class=
"swagger-request-security-scopes"></th>
4735 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4745 <h1 id=
"tag-VideoChannel" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoChannel">VideoChannel
</h1>
4746 <div id=
"operation--video-channels-get" class=
"operation panel" data-traverse-target=
"operation--video-channels-get">
4747 <!-- <section class="operation-tags row"> -->
4748 <!-- <div class="doc-copy"> -->
4749 <div class=
"operation-tags">
4750 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4755 <h2 class=
"operation-title">
4756 <span class=
"operation-name">
4757 <span class=
"operation-name">GET
</span>
4758 <span class=
"operation-path">/video-channels
</span>
4761 <div class=
"doc-row">
4762 <div class=
"doc-copy">
4763 <section class=
"swagger-request-params">
4764 <div class=
"prop-row prop-group">
4765 <div class=
"prop-name">
4766 <div class=
"prop-title">start:
4767 <span class=
"prop-type">
4768 <span class=
"json-property-type">number
</span>
4769 <span class=
"json-property-range" title=
"Value limits"></span>
4772 <div class=
"prop-subtitle"> in query
</div>
4774 <div class=
"prop-value">
4778 <div class=
"prop-row prop-group">
4779 <div class=
"prop-name">
4780 <div class=
"prop-title">count:
4781 <span class=
"prop-type">
4782 <span class=
"json-property-type">number
</span>
4783 <span class=
"json-property-range" title=
"Value limits"></span>
4786 <div class=
"prop-subtitle"> in query
</div>
4788 <div class=
"prop-value">
4789 <p>Number of items
</p>
4792 <div class=
"prop-row prop-group">
4793 <div class=
"prop-name">
4794 <div class=
"prop-title">sort:
4795 <span class=
"prop-type">
4796 <span class=
"json-property-type">string
</span>
4797 <span class=
"json-property-range" title=
"Value limits"></span>
4800 <div class=
"prop-subtitle"> in query
</div>
4802 <div class=
"prop-value">
4803 <p>Sort column (-createdAt for example)
</p>
4808 <div class=
"doc-examples"></div>
4810 <div class=
"doc-row">
4811 <div class=
"doc-copy">
4812 <section class=
"swagger-responses">
4813 <div class=
"prop-row prop-group">
4814 <div class=
"prop-name">
4815 <div class=
"prop-title">200 OK
</div>
4816 <div class=
"prop-ref">
4817 <span class=
"json-schema-ref-array">
4818 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4821 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4823 <div class=
"prop-value">
4824 <p>successful operation
</p>
4827 <div class=
"prop-row prop-inner">
4828 <div class=
"prop-name">type
</div>
4829 <div class=
"prop-value">
4830 <span class=
"json-property-type">
4831 <span class=
"json-schema-ref-array">
4832 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
4835 <span class=
"json-property-range" title=
"Value limits"></span>
4840 <div class=
"doc-examples">
4841 <h5>Response Content-Types:
4842 <span>application/json
</span>
4845 <h5>Response Example
4846 <span>(
200 OK)
</span>
4848 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
4850 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
4851 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
4852 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
4853 <span class=
"hljs-attr">"ownerAccount
"</span>: {
4854 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
4855 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
4865 <div id=
"operation--video-channels-post" class=
"operation panel" data-traverse-target=
"operation--video-channels-post">
4866 <!-- <section class="operation-tags row"> -->
4867 <!-- <div class="doc-copy"> -->
4868 <div class=
"operation-tags">
4869 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4874 <h2 class=
"operation-title">
4875 <span class=
"operation-name">
4876 <span class=
"operation-name">POST
</span>
4877 <span class=
"operation-path">/video-channels
</span>
4880 <div class=
"doc-row">
4881 <div class=
"doc-copy">
4882 <section class=
"swagger-request-body">
4883 <div class=
"prop-row">
4884 <div class=
"prop-name">
4885 <div class=
"swagger-request-model">
4887 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannelInput">VideoChannelInput
</a>
4891 <div class=
"prop-value columns small-6">
4892 <!-- <div class="swagger-request-description"> -->
4899 <div class=
"doc-examples">
4901 <h5>Request Content-Types:
4902 <span>application/json
</span>
4904 <h5>Request Example
</h5>
4905 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
4906 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
4907 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
4914 <div class=
"doc-row">
4915 <div class=
"doc-copy">
4916 <section class=
"swagger-responses">
4917 <div class=
"prop-row prop-group">
4918 <div class=
"prop-name">
4919 <div class=
"prop-title">204 No Content
</div>
4921 <div class=
"prop-value">
4922 <p>Successful operation
</p>
4927 <div class=
"doc-examples">
4928 <h5>Response Content-Types:
4929 <span>application/json
</span>
4933 <div class=
"doc-row">
4934 <div class=
"doc-copy">
4935 <section class=
"swagger-request-security">
4936 <table class=
"table">
4939 <th class=
"swagger-request-security-schema"></th>
4940 <th class=
"swagger-request-security-scopes"></th>
4946 <a href=
"#security-definition-OAuth2">OAuth2
</a>
4956 <div id=
"operation--video-channels--id--get" class=
"operation panel" data-traverse-target=
"operation--video-channels--id--get">
4957 <!-- <section class="operation-tags row"> -->
4958 <!-- <div class="doc-copy"> -->
4959 <div class=
"operation-tags">
4960 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
4965 <h2 class=
"operation-title">
4966 <span class=
"operation-name">
4967 <span class=
"operation-name">GET
</span>
4968 <span class=
"operation-path">/video-channels/{id}
</span>
4971 <div class=
"doc-row">
4972 <div class=
"doc-copy">
4973 <section class=
"swagger-request-params">
4974 <div class=
"prop-row prop-group">
4975 <div class=
"prop-name">
4976 <div class=
"prop-title">id:
4977 <span class=
"prop-type">
4978 <span class=
"json-property-type">string
</span>
4979 <span class=
"json-property-range" title=
"Value limits"></span>
4982 <span class=
"json-property-required"></span>
4983 <div class=
"prop-subtitle"> in path
</div>
4985 <div class=
"prop-value">
4986 <p>The video channel id or uuid
</p>
4991 <div class=
"doc-examples"></div>
4993 <div class=
"doc-row">
4994 <div class=
"doc-copy">
4995 <section class=
"swagger-responses">
4996 <div class=
"prop-row prop-group">
4997 <div class=
"prop-name">
4998 <div class=
"prop-title">200 OK
</div>
4999 <div class=
"prop-ref">
5001 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
5004 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5006 <div class=
"prop-value">
5007 <p>successful operation
</p>
5012 <div class=
"doc-examples">
5013 <h5>Response Content-Types:
5014 <span>application/json
</span>
5017 <h5>Response Example
5018 <span>(
200 OK)
</span>
5020 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5021 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5022 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5023 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5024 <span class=
"hljs-attr">"ownerAccount
"</span>: {
5025 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5026 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
5035 <div id=
"operation--video-channels--id--put" class=
"operation panel" data-traverse-target=
"operation--video-channels--id--put">
5036 <!-- <section class="operation-tags row"> -->
5037 <!-- <div class="doc-copy"> -->
5038 <div class=
"operation-tags">
5039 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5044 <h2 class=
"operation-title">
5045 <span class=
"operation-name">
5046 <span class=
"operation-name">PUT
</span>
5047 <span class=
"operation-path">/video-channels/{id}
</span>
5050 <div class=
"doc-row">
5051 <div class=
"doc-copy">
5052 <section class=
"swagger-request-body">
5053 <div class=
"prop-row">
5054 <div class=
"prop-name">
5055 <div class=
"swagger-request-model">
5057 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannelInput">VideoChannelInput
</a>
5061 <div class=
"prop-value columns small-6">
5062 <!-- <div class="swagger-request-description"> -->
5068 <section class=
"swagger-request-params">
5069 <div class=
"prop-row prop-group">
5070 <div class=
"prop-name">
5071 <div class=
"prop-title">id:
5072 <span class=
"prop-type">
5073 <span class=
"json-property-type">string
</span>
5074 <span class=
"json-property-range" title=
"Value limits"></span>
5077 <span class=
"json-property-required"></span>
5078 <div class=
"prop-subtitle"> in path
</div>
5080 <div class=
"prop-value">
5081 <p>The video channel id or uuid
</p>
5086 <div class=
"doc-examples">
5088 <h5>Request Content-Types:
5089 <span>application/json
</span>
5091 <h5>Request Example
</h5>
5092 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5093 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5094 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
5101 <div class=
"doc-row">
5102 <div class=
"doc-copy">
5103 <section class=
"swagger-responses">
5104 <div class=
"prop-row prop-group">
5105 <div class=
"prop-name">
5106 <div class=
"prop-title">204 No Content
</div>
5108 <div class=
"prop-value">
5109 <p>Successful operation
</p>
5114 <div class=
"doc-examples">
5115 <h5>Response Content-Types:
5116 <span>application/json
</span>
5120 <div class=
"doc-row">
5121 <div class=
"doc-copy">
5122 <section class=
"swagger-request-security">
5123 <table class=
"table">
5126 <th class=
"swagger-request-security-schema"></th>
5127 <th class=
"swagger-request-security-scopes"></th>
5133 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5143 <div id=
"operation--video-channels--id--delete" class=
"operation panel" data-traverse-target=
"operation--video-channels--id--delete">
5144 <!-- <section class="operation-tags row"> -->
5145 <!-- <div class="doc-copy"> -->
5146 <div class=
"operation-tags">
5147 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5152 <h2 class=
"operation-title">
5153 <span class=
"operation-name">
5154 <span class=
"operation-name">DELETE
</span>
5155 <span class=
"operation-path">/video-channels/{id}
</span>
5158 <div class=
"doc-row">
5159 <div class=
"doc-copy">
5160 <section class=
"swagger-request-params">
5161 <div class=
"prop-row prop-group">
5162 <div class=
"prop-name">
5163 <div class=
"prop-title">id:
5164 <span class=
"prop-type">
5165 <span class=
"json-property-type">string
</span>
5166 <span class=
"json-property-range" title=
"Value limits"></span>
5169 <span class=
"json-property-required"></span>
5170 <div class=
"prop-subtitle"> in path
</div>
5172 <div class=
"prop-value">
5173 <p>The video channel id or uuid
</p>
5178 <div class=
"doc-examples"></div>
5180 <div class=
"doc-row">
5181 <div class=
"doc-copy">
5182 <section class=
"swagger-responses">
5183 <div class=
"prop-row prop-group">
5184 <div class=
"prop-name">
5185 <div class=
"prop-title">204 No Content
</div>
5187 <div class=
"prop-value">
5188 <p>Successful operation
</p>
5193 <div class=
"doc-examples">
5194 <h5>Response Content-Types:
5195 <span>application/json
</span>
5199 <div class=
"doc-row">
5200 <div class=
"doc-copy">
5201 <section class=
"swagger-request-security">
5202 <table class=
"table">
5205 <th class=
"swagger-request-security-schema"></th>
5206 <th class=
"swagger-request-security-scopes"></th>
5212 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5222 <div id=
"operation--video-channels--id--videos-get" class=
"operation panel" data-traverse-target=
"operation--video-channels--id--videos-get">
5223 <!-- <section class="operation-tags row"> -->
5224 <!-- <div class="doc-copy"> -->
5225 <div class=
"operation-tags">
5226 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5231 <h2 class=
"operation-title">
5232 <span class=
"operation-name">
5233 <span class=
"operation-name">GET
</span>
5234 <span class=
"operation-path">/video-channels/{id}/videos
</span>
5237 <div class=
"doc-row">
5238 <div class=
"doc-copy">
5239 <section class=
"swagger-request-params">
5240 <div class=
"prop-row prop-group">
5241 <div class=
"prop-name">
5242 <div class=
"prop-title">id:
5243 <span class=
"prop-type">
5244 <span class=
"json-property-type">string
</span>
5245 <span class=
"json-property-range" title=
"Value limits"></span>
5248 <span class=
"json-property-required"></span>
5249 <div class=
"prop-subtitle"> in path
</div>
5251 <div class=
"prop-value">
5252 <p>The video channel id or uuid
</p>
5257 <div class=
"doc-examples"></div>
5259 <div class=
"doc-row">
5260 <div class=
"doc-copy">
5261 <section class=
"swagger-responses">
5262 <div class=
"prop-row prop-group">
5263 <div class=
"prop-name">
5264 <div class=
"prop-title">200 OK
</div>
5265 <div class=
"prop-ref">
5267 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
5270 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5272 <div class=
"prop-value">
5273 <p>successful operation
</p>
5278 <div class=
"doc-examples">
5279 <h5>Response Content-Types:
5280 <span>application/json
</span>
5283 <h5>Response Example
5284 <span>(
200 OK)
</span>
5286 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5287 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5288 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5289 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5290 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5291 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5292 <span class=
"hljs-attr">"category
"</span>: {
5293 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5294 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5296 <span class=
"hljs-attr">"licence
"</span>: {
5297 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5298 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5300 <span class=
"hljs-attr">"language
"</span>: {
5301 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
5302 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
5304 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
5305 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5306 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
5307 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5308 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5309 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5310 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5311 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
5312 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
5313 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5314 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
5315 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5316 <span class=
"hljs-attr">"account
"</span>: {
5317 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5318 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5319 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5320 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5321 <span class=
"hljs-attr">"avatar
"</span>: {
5322 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5323 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5324 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5334 <div id=
"operation--accounts--name--video-channels-get" class=
"operation panel" data-traverse-target=
"operation--accounts--name--video-channels-get">
5335 <!-- <section class="operation-tags row"> -->
5336 <!-- <div class="doc-copy"> -->
5337 <div class=
"operation-tags">
5338 <a class=
"label" href=
"#tag-VideoChannel">VideoChannel
</a>
5343 <h2 class=
"operation-title">
5344 <span class=
"operation-name">
5345 <span class=
"operation-name">GET
</span>
5346 <span class=
"operation-path">/accounts/{name}/video-channels
</span>
5349 <div class=
"doc-row">
5350 <div class=
"doc-copy">
5351 <section class=
"swagger-request-params">
5352 <div class=
"prop-row prop-group">
5353 <div class=
"prop-name">
5354 <div class=
"prop-title">name:
5355 <span class=
"prop-type">
5356 <span class=
"json-property-type">string
</span>
5357 <span class=
"json-property-range" title=
"Value limits"></span>
5360 <span class=
"json-property-required"></span>
5361 <div class=
"prop-subtitle"> in path
</div>
5363 <div class=
"prop-value">
5364 <p>The name of the account (chocobozzz or
5365 <a href=
"mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re
</a> for example)
</p>
5370 <div class=
"doc-examples"></div>
5372 <div class=
"doc-row">
5373 <div class=
"doc-copy">
5374 <section class=
"swagger-responses">
5375 <div class=
"prop-row prop-group">
5376 <div class=
"prop-name">
5377 <div class=
"prop-title">200 OK
</div>
5378 <div class=
"prop-ref">
5379 <span class=
"json-schema-ref-array">
5380 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
5383 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5385 <div class=
"prop-value">
5386 <p>successful operation
</p>
5389 <div class=
"prop-row prop-inner">
5390 <div class=
"prop-name">type
</div>
5391 <div class=
"prop-value">
5392 <span class=
"json-property-type">
5393 <span class=
"json-schema-ref-array">
5394 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
5397 <span class=
"json-property-range" title=
"Value limits"></span>
5402 <div class=
"doc-examples">
5403 <h5>Response Content-Types:
5404 <span>application/json
</span>
5407 <h5>Response Example
5408 <span>(
200 OK)
</span>
5410 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
5412 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5413 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
5414 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
5415 <span class=
"hljs-attr">"ownerAccount
"</span>: {
5416 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5417 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
5427 <h1 id=
"tag-VideoComment" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoComment">VideoComment
</h1>
5428 <div id=
"operation--videos--id--comment-threads-get" class=
"operation panel" data-traverse-target=
"operation--videos--id--comment-threads-get">
5429 <!-- <section class="operation-tags row"> -->
5430 <!-- <div class="doc-copy"> -->
5431 <div class=
"operation-tags">
5432 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5437 <h2 class=
"operation-title">
5438 <span class=
"operation-name">
5439 <span class=
"operation-name">GET
</span>
5440 <span class=
"operation-path">/videos/{id}/comment-threads
</span>
5443 <div class=
"doc-row">
5444 <div class=
"doc-copy">
5445 <section class=
"swagger-request-params">
5446 <div class=
"prop-row prop-group">
5447 <div class=
"prop-name">
5448 <div class=
"prop-title">id:
5449 <span class=
"prop-type">
5450 <span class=
"json-property-type">string
</span>
5451 <span class=
"json-property-range" title=
"Value limits"></span>
5454 <span class=
"json-property-required"></span>
5455 <div class=
"prop-subtitle"> in path
</div>
5457 <div class=
"prop-value">
5458 <p>The video id or uuid
</p>
5461 <div class=
"prop-row prop-group">
5462 <div class=
"prop-name">
5463 <div class=
"prop-title">start:
5464 <span class=
"prop-type">
5465 <span class=
"json-property-type">number
</span>
5466 <span class=
"json-property-range" title=
"Value limits"></span>
5469 <div class=
"prop-subtitle"> in query
</div>
5471 <div class=
"prop-value">
5475 <div class=
"prop-row prop-group">
5476 <div class=
"prop-name">
5477 <div class=
"prop-title">count:
5478 <span class=
"prop-type">
5479 <span class=
"json-property-type">number
</span>
5480 <span class=
"json-property-range" title=
"Value limits"></span>
5483 <div class=
"prop-subtitle"> in query
</div>
5485 <div class=
"prop-value">
5486 <p>Number of items
</p>
5489 <div class=
"prop-row prop-group">
5490 <div class=
"prop-name">
5491 <div class=
"prop-title">sort:
5492 <span class=
"prop-type">
5493 <span class=
"json-property-type">string
</span>
5494 <span class=
"json-property-range" title=
"Value limits"></span>
5497 <div class=
"prop-subtitle"> in query
</div>
5499 <div class=
"prop-value">
5500 <p>Sort column (-createdAt for example)
</p>
5505 <div class=
"doc-examples"></div>
5507 <div class=
"doc-row">
5508 <div class=
"doc-copy">
5509 <section class=
"swagger-responses">
5510 <div class=
"prop-row prop-group">
5511 <div class=
"prop-name">
5512 <div class=
"prop-title">200 OK
</div>
5513 <div class=
"prop-ref">
5515 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadResponse">CommentThreadResponse
</a>
5518 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5520 <div class=
"prop-value">
5521 <p>successful operation
</p>
5526 <div class=
"doc-examples">
5527 <h5>Response Content-Types:
5528 <span>application/json
</span>
5531 <h5>Response Example
5532 <span>(
200 OK)
</span>
5534 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5535 <span class=
"hljs-attr">"total
"</span>:
<span class=
"hljs-string">"number
"</span>,
5536 <span class=
"hljs-attr">"data
"</span>: [
5538 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5539 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5540 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5541 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5542 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5543 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5544 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5545 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5546 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5547 <span class=
"hljs-attr">"account
"</span>: {
5548 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5549 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5550 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5551 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5552 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5553 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5554 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5555 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5556 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5557 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5558 <span class=
"hljs-attr">"avatar
"</span>: {
5559 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5560 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5561 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5573 <div id=
"operation--videos--id--comment-threads-post" class=
"operation panel" data-traverse-target=
"operation--videos--id--comment-threads-post">
5574 <!-- <section class="operation-tags row"> -->
5575 <!-- <div class="doc-copy"> -->
5576 <div class=
"operation-tags">
5577 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5582 <h2 class=
"operation-title">
5583 <span class=
"operation-name">
5584 <span class=
"operation-name">POST
</span>
5585 <span class=
"operation-path">/videos/{id}/comment-threads
</span>
5588 <div class=
"doc-row">
5589 <div class=
"doc-copy">
5590 <section class=
"swagger-request-params">
5591 <div class=
"prop-row prop-group">
5592 <div class=
"prop-name">
5593 <div class=
"prop-title">id:
5594 <span class=
"prop-type">
5595 <span class=
"json-property-type">string
</span>
5596 <span class=
"json-property-range" title=
"Value limits"></span>
5599 <span class=
"json-property-required"></span>
5600 <div class=
"prop-subtitle"> in path
</div>
5602 <div class=
"prop-value">
5603 <p>The video id or uuid
</p>
5608 <div class=
"doc-examples"></div>
5610 <div class=
"doc-row">
5611 <div class=
"doc-copy">
5612 <section class=
"swagger-responses">
5613 <div class=
"prop-row prop-group">
5614 <div class=
"prop-name">
5615 <div class=
"prop-title">200 OK
</div>
5616 <div class=
"prop-ref">
5618 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadPostResponse">CommentThreadPostResponse
</a>
5621 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5623 <div class=
"prop-value">
5624 <p>successful operation
</p>
5629 <div class=
"doc-examples">
5630 <h5>Response Content-Types:
5631 <span>application/json
</span>
5634 <h5>Response Example
5635 <span>(
200 OK)
</span>
5637 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5638 <span class=
"hljs-attr">"comment
"</span>: {
5639 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5640 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5641 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5642 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5643 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5644 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5645 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5646 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5647 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5648 <span class=
"hljs-attr">"account
"</span>: {
5649 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5650 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5651 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5652 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5653 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5654 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5655 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5656 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5657 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5658 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5659 <span class=
"hljs-attr">"avatar
"</span>: {
5660 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5661 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5662 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5672 <div class=
"doc-row">
5673 <div class=
"doc-copy">
5674 <section class=
"swagger-request-security">
5675 <table class=
"table">
5678 <th class=
"swagger-request-security-schema"></th>
5679 <th class=
"swagger-request-security-scopes"></th>
5685 <a href=
"#security-definition-OAuth2">OAuth2
</a>
5695 <div id=
"operation--videos--id--comment-threads--threadId--get" class=
"operation panel" data-traverse-target=
"operation--videos--id--comment-threads--threadId--get">
5696 <!-- <section class="operation-tags row"> -->
5697 <!-- <div class="doc-copy"> -->
5698 <div class=
"operation-tags">
5699 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5704 <h2 class=
"operation-title">
5705 <span class=
"operation-name">
5706 <span class=
"operation-name">GET
</span>
5707 <span class=
"operation-path">/videos/{id}/comment-threads/{threadId}
</span>
5710 <div class=
"doc-row">
5711 <div class=
"doc-copy">
5712 <section class=
"swagger-request-params">
5713 <div class=
"prop-row prop-group">
5714 <div class=
"prop-name">
5715 <div class=
"prop-title">id:
5716 <span class=
"prop-type">
5717 <span class=
"json-property-type">string
</span>
5718 <span class=
"json-property-range" title=
"Value limits"></span>
5721 <span class=
"json-property-required"></span>
5722 <div class=
"prop-subtitle"> in path
</div>
5724 <div class=
"prop-value">
5725 <p>The video id or uuid
</p>
5728 <div class=
"prop-row prop-group">
5729 <div class=
"prop-name">
5730 <div class=
"prop-title">threadId:
5731 <span class=
"prop-type">
5732 <span class=
"json-property-type">number
</span>
5733 <span class=
"json-property-range" title=
"Value limits"></span>
5736 <span class=
"json-property-required"></span>
5737 <div class=
"prop-subtitle"> in path
</div>
5739 <div class=
"prop-value">
5740 <p>The thread id (root comment id)
</p>
5745 <div class=
"doc-examples"></div>
5747 <div class=
"doc-row">
5748 <div class=
"doc-copy">
5749 <section class=
"swagger-responses">
5750 <div class=
"prop-row prop-group">
5751 <div class=
"prop-name">
5752 <div class=
"prop-title">200 OK
</div>
5753 <div class=
"prop-ref">
5755 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
5758 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5760 <div class=
"prop-value">
5761 <p>successful operation
</p>
5766 <div class=
"doc-examples">
5767 <h5>Response Content-Types:
5768 <span>application/json
</span>
5771 <h5>Response Example
5772 <span>(
200 OK)
</span>
5774 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5775 <span class=
"hljs-attr">"comment
"</span>: {
5776 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5777 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5778 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5779 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5780 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5781 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5782 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5783 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5784 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5785 <span class=
"hljs-attr">"account
"</span>: {
5786 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5787 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5788 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5789 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5790 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5791 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5792 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5793 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5794 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5795 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5796 <span class=
"hljs-attr">"avatar
"</span>: {
5797 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5798 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5799 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5803 <span class=
"hljs-attr">"children
"</span>: [
5805 <span class=
"hljs-attr">"comment
"</span>: {
5806 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5807 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5808 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5809 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5810 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5811 <span class=
"hljs-attr">"videoId
"</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">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5815 <span class=
"hljs-attr">"account
"</span>: {
5816 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5817 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5818 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5819 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5820 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5821 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5822 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5823 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5824 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5825 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5826 <span class=
"hljs-attr">"avatar
"</span>: {
5827 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5828 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5829 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5833 <span class=
"hljs-attr">"children
"</span>: [
5835 <span class=
"hljs-attr">"comment
"</span>: {
5836 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5837 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5838 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5839 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5840 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5841 <span class=
"hljs-attr">"videoId
"</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">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5845 <span class=
"hljs-attr">"account
"</span>: {
5846 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5847 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5848 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5849 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5850 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5851 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5852 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5853 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5854 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5855 <span class=
"hljs-attr">"avatar
"</span>: {
5856 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
5857 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5858 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
5873 <div id=
"operation--videos--id--comments--commentId--post" class=
"operation panel" data-traverse-target=
"operation--videos--id--comments--commentId--post">
5874 <!-- <section class="operation-tags row"> -->
5875 <!-- <div class="doc-copy"> -->
5876 <div class=
"operation-tags">
5877 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
5882 <h2 class=
"operation-title">
5883 <span class=
"operation-name">
5884 <span class=
"operation-name">POST
</span>
5885 <span class=
"operation-path">/videos/{id}/comments/{commentId}
</span>
5888 <div class=
"doc-row">
5889 <div class=
"doc-copy">
5890 <section class=
"swagger-request-params">
5891 <div class=
"prop-row prop-group">
5892 <div class=
"prop-name">
5893 <div class=
"prop-title">id:
5894 <span class=
"prop-type">
5895 <span class=
"json-property-type">string
</span>
5896 <span class=
"json-property-range" title=
"Value limits"></span>
5899 <span class=
"json-property-required"></span>
5900 <div class=
"prop-subtitle"> in path
</div>
5902 <div class=
"prop-value">
5903 <p>The video id or uuid
</p>
5906 <div class=
"prop-row prop-group">
5907 <div class=
"prop-name">
5908 <div class=
"prop-title">threadId:
5909 <span class=
"prop-type">
5910 <span class=
"json-property-type">number
</span>
5911 <span class=
"json-property-range" title=
"Value limits"></span>
5914 <span class=
"json-property-required"></span>
5915 <div class=
"prop-subtitle"> in path
</div>
5917 <div class=
"prop-value">
5918 <p>The comment id
</p>
5923 <div class=
"doc-examples"></div>
5925 <div class=
"doc-row">
5926 <div class=
"doc-copy">
5927 <section class=
"swagger-responses">
5928 <div class=
"prop-row prop-group">
5929 <div class=
"prop-name">
5930 <div class=
"prop-title">200 OK
</div>
5931 <div class=
"prop-ref">
5933 <a class=
"json-schema-ref" href=
"#/definitions/CommentThreadPostResponse">CommentThreadPostResponse
</a>
5936 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5938 <div class=
"prop-value">
5939 <p>successful operation
</p>
5944 <div class=
"doc-examples">
5945 <h5>Response Content-Types:
5946 <span>application/json
</span>
5949 <h5>Response Example
5950 <span>(
200 OK)
</span>
5952 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
5953 <span class=
"hljs-attr">"comment
"</span>: {
5954 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5955 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5956 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
5957 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5958 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5959 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
5960 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5961 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5962 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
5963 <span class=
"hljs-attr">"account
"</span>: {
5964 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
5965 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
5966 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
5967 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
5968 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
5969 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
5970 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5971 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
5972 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5973 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
5974 <span class=
"hljs-attr">"avatar
"</span>: {
5975 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</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>
5987 <div class=
"doc-row">
5988 <div class=
"doc-copy">
5989 <section class=
"swagger-request-security">
5990 <table class=
"table">
5993 <th class=
"swagger-request-security-schema"></th>
5994 <th class=
"swagger-request-security-scopes"></th>
6000 <a href=
"#security-definition-OAuth2">OAuth2
</a>
6010 <div id=
"operation--videos--id--comments--commentId--delete" class=
"operation panel" data-traverse-target=
"operation--videos--id--comments--commentId--delete">
6011 <!-- <section class="operation-tags row"> -->
6012 <!-- <div class="doc-copy"> -->
6013 <div class=
"operation-tags">
6014 <a class=
"label" href=
"#tag-VideoComment">VideoComment
</a>
6019 <h2 class=
"operation-title">
6020 <span class=
"operation-name">
6021 <span class=
"operation-name">DELETE
</span>
6022 <span class=
"operation-path">/videos/{id}/comments/{commentId}
</span>
6025 <div class=
"doc-row">
6026 <div class=
"doc-copy">
6027 <section class=
"swagger-request-params">
6028 <div class=
"prop-row prop-group">
6029 <div class=
"prop-name">
6030 <div class=
"prop-title">id:
6031 <span class=
"prop-type">
6032 <span class=
"json-property-type">string
</span>
6033 <span class=
"json-property-range" title=
"Value limits"></span>
6036 <span class=
"json-property-required"></span>
6037 <div class=
"prop-subtitle"> in path
</div>
6039 <div class=
"prop-value">
6040 <p>The video id or uuid
</p>
6043 <div class=
"prop-row prop-group">
6044 <div class=
"prop-name">
6045 <div class=
"prop-title">threadId:
6046 <span class=
"prop-type">
6047 <span class=
"json-property-type">number
</span>
6048 <span class=
"json-property-range" title=
"Value limits"></span>
6051 <span class=
"json-property-required"></span>
6052 <div class=
"prop-subtitle"> in path
</div>
6054 <div class=
"prop-value">
6055 <p>The comment id
</p>
6060 <div class=
"doc-examples"></div>
6062 <div class=
"doc-row">
6063 <div class=
"doc-copy">
6064 <section class=
"swagger-responses">
6065 <div class=
"prop-row prop-group">
6066 <div class=
"prop-name">
6067 <div class=
"prop-title">204 No Content
</div>
6069 <div class=
"prop-value">
6070 <p>Successful operation
</p>
6075 <div class=
"doc-examples">
6076 <h5>Response Content-Types:
6077 <span>application/json
</span>
6081 <div class=
"doc-row">
6082 <div class=
"doc-copy">
6083 <section class=
"swagger-request-security">
6084 <table class=
"table">
6087 <th class=
"swagger-request-security-schema"></th>
6088 <th class=
"swagger-request-security-scopes"></th>
6094 <a href=
"#security-definition-OAuth2">OAuth2
</a>
6104 <h1 id=
"tag-VideoRate" class=
"swagger-summary-tag" data-traverse-target=
"tag-VideoRate">VideoRate
</h1>
6105 <div id=
"operation--videos--id--rate-put" class=
"operation panel" data-traverse-target=
"operation--videos--id--rate-put">
6106 <!-- <section class="operation-tags row"> -->
6107 <!-- <div class="doc-copy"> -->
6108 <div class=
"operation-tags">
6109 <a class=
"label" href=
"#tag-VideoRate">VideoRate
</a>
6114 <h2 class=
"operation-title">
6115 <span class=
"operation-name">
6116 <span class=
"operation-name">PUT
</span>
6117 <span class=
"operation-path">/videos/{id}/rate
</span>
6120 <div class=
"doc-row">
6121 <div class=
"doc-copy">
6122 <section class=
"swagger-request-params">
6123 <div class=
"prop-row prop-group">
6124 <div class=
"prop-name">
6125 <div class=
"prop-title">id:
6126 <span class=
"prop-type">
6127 <span class=
"json-property-type">string
</span>
6128 <span class=
"json-property-range" title=
"Value limits"></span>
6131 <span class=
"json-property-required"></span>
6132 <div class=
"prop-subtitle"> in path
</div>
6134 <div class=
"prop-value">
6135 <p>The video id or uuid
</p>
6140 <div class=
"doc-examples"></div>
6142 <div class=
"doc-row">
6143 <div class=
"doc-copy">
6144 <section class=
"swagger-responses">
6145 <div class=
"prop-row prop-group">
6146 <div class=
"prop-name">
6147 <div class=
"prop-title">204 No Content
</div>
6149 <div class=
"prop-value">
6150 <p>Successful operation
</p>
6155 <div class=
"doc-examples">
6156 <h5>Response Content-Types:
6157 <span>application/json
</span>
6161 <div class=
"doc-row">
6162 <div class=
"doc-copy">
6163 <section class=
"swagger-request-security">
6164 <table class=
"table">
6167 <th class=
"swagger-request-security-schema"></th>
6168 <th class=
"swagger-request-security-scopes"></th>
6174 <a href=
"#security-definition-OAuth2">OAuth2
</a>
6184 <h1 id=
"tag-Search" class=
"swagger-summary-tag" data-traverse-target=
"tag-Search">Search
</h1>
6185 <div id=
"operation--search-videos-get" class=
"operation panel" data-traverse-target=
"operation--search-videos-get">
6186 <!-- <section class="operation-tags row"> -->
6187 <!-- <div class="doc-copy"> -->
6188 <div class=
"operation-tags">
6189 <a class=
"label" href=
"#tag-Search">Search
</a>
6194 <h2 class=
"operation-title">
6195 <span class=
"operation-name">
6196 <span class=
"operation-name">GET
</span>
6197 <span class=
"operation-path">/search/videos
</span>
6200 <div class=
"doc-row">
6201 <div class=
"doc-copy">
6202 <section class=
"swagger-request-params">
6203 <div class=
"prop-row prop-group">
6204 <div class=
"prop-name">
6205 <div class=
"prop-title">start:
6206 <span class=
"prop-type">
6207 <span class=
"json-property-type">number
</span>
6208 <span class=
"json-property-range" title=
"Value limits"></span>
6211 <div class=
"prop-subtitle"> in query
</div>
6213 <div class=
"prop-value">
6217 <div class=
"prop-row prop-group">
6218 <div class=
"prop-name">
6219 <div class=
"prop-title">count:
6220 <span class=
"prop-type">
6221 <span class=
"json-property-type">number
</span>
6222 <span class=
"json-property-range" title=
"Value limits"></span>
6225 <div class=
"prop-subtitle"> in query
</div>
6227 <div class=
"prop-value">
6228 <p>Number of items
</p>
6231 <div class=
"prop-row prop-group">
6232 <div class=
"prop-name">
6233 <div class=
"prop-title">sort:
6234 <span class=
"prop-type">
6235 <span class=
"json-property-type">string
</span>
6236 <span class=
"json-property-range" title=
"Value limits"></span>
6239 <div class=
"prop-subtitle"> in query
</div>
6241 <div class=
"prop-value">
6242 <p>Sort column (-createdAt for example)
</p>
6245 <div class=
"prop-row prop-group">
6246 <div class=
"prop-name">
6247 <div class=
"prop-title">search:
6248 <span class=
"prop-type">
6249 <span class=
"json-property-type">string
</span>
6250 <span class=
"json-property-range" title=
"Value limits"></span>
6253 <span class=
"json-property-required"></span>
6254 <div class=
"prop-subtitle"> in query
</div>
6256 <div class=
"prop-value">
6257 <p>String to search
</p>
6262 <div class=
"doc-examples"></div>
6264 <div class=
"doc-row">
6265 <div class=
"doc-copy">
6266 <section class=
"swagger-responses">
6267 <div class=
"prop-row prop-group">
6268 <div class=
"prop-name">
6269 <div class=
"prop-title">200 OK
</div>
6270 <div class=
"prop-ref">
6271 <span class=
"json-schema-ref-array">
6272 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
6275 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
6277 <div class=
"prop-value">
6278 <p>successful operation
</p>
6281 <div class=
"prop-row prop-inner">
6282 <div class=
"prop-name">type
</div>
6283 <div class=
"prop-value">
6284 <span class=
"json-property-type">
6285 <span class=
"json-schema-ref-array">
6286 <a class=
"json-schema-ref" href=
"#/definitions/Video">Video
</a>
6289 <span class=
"json-property-range" title=
"Value limits"></span>
6294 <div class=
"doc-examples">
6295 <h5>Response Content-Types:
6296 <span>application/json
</span>
6299 <h5>Response Example
6300 <span>(
200 OK)
</span>
6302 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">[
6304 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6305 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6306 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6307 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6308 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6309 <span class=
"hljs-attr">"category
"</span>: {
6310 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6311 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6313 <span class=
"hljs-attr">"licence
"</span>: {
6314 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6315 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6317 <span class=
"hljs-attr">"language
"</span>: {
6318 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
6319 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6321 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
6322 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6323 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6324 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6325 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6326 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6327 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6328 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6329 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6330 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6331 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6332 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6333 <span class=
"hljs-attr">"account
"</span>: {
6334 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6335 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6336 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6337 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6338 <span class=
"hljs-attr">"avatar
"</span>: {
6339 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6340 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6341 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6352 <h1>Schema Definitions
</h1>
6353 <div id=
"definition-VideoConstantNumber" class=
"definition panel" data-traverse-target=
"definition-VideoConstantNumber">
6354 <h2 class=
"panel-title">
6355 <a name=
"/definitions/VideoConstantNumber"></a>VideoConstantNumber:
6356 <!-- <span class="json-property-type">
6357 <span class="json-property-type">object</span>
6358 <span class="json-property-range" title="Value limits"></span>
6363 <div class=
"doc-row">
6364 <div class=
"doc-copy">
6365 <section class=
"json-schema-properties">
6367 <dt data-property-name=
"id">
6368 <span class=
"json-property-name">id:
</span>
6369 <span class=
"json-property-type">number
</span>
6370 <span class=
"json-property-range" title=
"Value limits"></span>
6372 <dt data-property-name=
"label">
6373 <span class=
"json-property-name">label:
</span>
6374 <span class=
"json-property-type">string
</span>
6375 <span class=
"json-property-range" title=
"Value limits"></span>
6380 <div class=
"doc-examples">
6383 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6384 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6385 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6393 <div id=
"definition-VideoConstantString" class=
"definition panel" data-traverse-target=
"definition-VideoConstantString">
6394 <h2 class=
"panel-title">
6395 <a name=
"/definitions/VideoConstantString"></a>VideoConstantString:
6396 <!-- <span class="json-property-type">
6397 <span class="json-property-type">object</span>
6398 <span class="json-property-range" title="Value limits"></span>
6403 <div class=
"doc-row">
6404 <div class=
"doc-copy">
6405 <section class=
"json-schema-properties">
6407 <dt data-property-name=
"id">
6408 <span class=
"json-property-name">id:
</span>
6409 <span class=
"json-property-type">string
</span>
6410 <span class=
"json-property-range" title=
"Value limits"></span>
6412 <dt data-property-name=
"label">
6413 <span class=
"json-property-name">label:
</span>
6414 <span class=
"json-property-type">string
</span>
6415 <span class=
"json-property-range" title=
"Value limits"></span>
6420 <div class=
"doc-examples">
6423 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6424 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
6425 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6433 <div id=
"definition-VideoPrivacy" class=
"definition panel" data-traverse-target=
"definition-VideoPrivacy">
6434 <h2 class=
"panel-title">
6435 <a name=
"/definitions/VideoPrivacy"></a>VideoPrivacy: string
6436 <!-- <span class="json-property-type">
6437 <span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values">
6438 <span class="json-property-enum-item">Public</span>,
6439 <span class="json-property-enum-item">Unlisted</span>,
6440 <span class="json-property-enum-item">Private</span>
6442 <span class="json-property-range" title="Value limits"></span>
6447 <div class=
"doc-row">
6448 <div class=
"doc-copy">
6449 <span class=
"json-property-type">string
</span>
6450 <span class=
"json-property-enum" title=
"Possible values">
6451 <span class=
"json-property-enum-item">Public
</span>,
6452 <span class=
"json-property-enum-item">Unlisted
</span>,
6453 <span class=
"json-property-enum-item">Private
</span>
6455 <span class=
"json-property-range" title=
"Value limits"></span>
6459 <div id=
"definition-Video" class=
"definition panel" data-traverse-target=
"definition-Video">
6460 <h2 class=
"panel-title">
6461 <a name=
"/definitions/Video"></a>Video:
6462 <!-- <span class="json-property-type">
6463 <span class="json-property-type">object</span>
6464 <span class="json-property-range" title="Value limits"></span>
6469 <div class=
"doc-row">
6470 <div class=
"doc-copy">
6471 <section class=
"json-schema-properties">
6473 <dt data-property-name=
"id">
6474 <span class=
"json-property-name">id:
</span>
6475 <span class=
"json-property-type">number
</span>
6476 <span class=
"json-property-range" title=
"Value limits"></span>
6478 <dt data-property-name=
"uuid">
6479 <span class=
"json-property-name">uuid:
</span>
6480 <span class=
"json-property-type">string
</span>
6481 <span class=
"json-property-range" title=
"Value limits"></span>
6483 <dt data-property-name=
"createdAt">
6484 <span class=
"json-property-name">createdAt:
</span>
6485 <span class=
"json-property-type">string
</span>
6486 <span class=
"json-property-range" title=
"Value limits"></span>
6488 <dt data-property-name=
"publishedAt">
6489 <span class=
"json-property-name">publishedAt:
</span>
6490 <span class=
"json-property-type">string
</span>
6491 <span class=
"json-property-range" title=
"Value limits"></span>
6493 <dt data-property-name=
"updatedAt">
6494 <span class=
"json-property-name">updatedAt:
</span>
6495 <span class=
"json-property-type">string
</span>
6496 <span class=
"json-property-range" title=
"Value limits"></span>
6498 <dt data-property-name=
"category">
6499 <span class=
"json-property-name">category:
</span>
6500 <span class=
"json-property-type">
6502 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstantNumber">VideoConstantNumber
</a>
6505 <span class=
"json-property-range" title=
"Value limits"></span>
6507 <dt data-property-name=
"licence">
6508 <span class=
"json-property-name">licence:
</span>
6509 <span class=
"json-property-type">
6511 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstantNumber">VideoConstantNumber
</a>
6514 <span class=
"json-property-range" title=
"Value limits"></span>
6516 <dt data-property-name=
"language">
6517 <span class=
"json-property-name">language:
</span>
6518 <span class=
"json-property-type">
6520 <a class=
"json-schema-ref" href=
"#/definitions/VideoConstantString">VideoConstantString
</a>
6523 <span class=
"json-property-range" title=
"Value limits"></span>
6525 <dt data-property-name=
"privacy">
6526 <span class=
"json-property-name">privacy:
</span>
6527 <span class=
"json-property-type">
6529 <a class=
"json-schema-ref" href=
"#/definitions/VideoPrivacy">VideoPrivacy
</a>
6532 <span class=
"json-property-range" title=
"Value limits"></span>
6534 <dt data-property-name=
"description">
6535 <span class=
"json-property-name">description:
</span>
6536 <span class=
"json-property-type">string
</span>
6537 <span class=
"json-property-range" title=
"Value limits"></span>
6539 <dt data-property-name=
"duration">
6540 <span class=
"json-property-name">duration:
</span>
6541 <span class=
"json-property-type">number
</span>
6542 <span class=
"json-property-range" title=
"Value limits"></span>
6544 <dt data-property-name=
"isLocal">
6545 <span class=
"json-property-name">isLocal:
</span>
6546 <span class=
"json-property-type">boolean
</span>
6547 <span class=
"json-property-range" title=
"Value limits"></span>
6549 <dt data-property-name=
"name">
6550 <span class=
"json-property-name">name:
</span>
6551 <span class=
"json-property-type">string
</span>
6552 <span class=
"json-property-range" title=
"Value limits"></span>
6554 <dt data-property-name=
"thumbnailPath">
6555 <span class=
"json-property-name">thumbnailPath:
</span>
6556 <span class=
"json-property-type">string
</span>
6557 <span class=
"json-property-range" title=
"Value limits"></span>
6559 <dt data-property-name=
"previewPath">
6560 <span class=
"json-property-name">previewPath:
</span>
6561 <span class=
"json-property-type">string
</span>
6562 <span class=
"json-property-range" title=
"Value limits"></span>
6564 <dt data-property-name=
"embedPath">
6565 <span class=
"json-property-name">embedPath:
</span>
6566 <span class=
"json-property-type">string
</span>
6567 <span class=
"json-property-range" title=
"Value limits"></span>
6569 <dt data-property-name=
"views">
6570 <span class=
"json-property-name">views:
</span>
6571 <span class=
"json-property-type">number
</span>
6572 <span class=
"json-property-range" title=
"Value limits"></span>
6574 <dt data-property-name=
"likes">
6575 <span class=
"json-property-name">likes:
</span>
6576 <span class=
"json-property-type">number
</span>
6577 <span class=
"json-property-range" title=
"Value limits"></span>
6579 <dt data-property-name=
"dislikes">
6580 <span class=
"json-property-name">dislikes:
</span>
6581 <span class=
"json-property-type">number
</span>
6582 <span class=
"json-property-range" title=
"Value limits"></span>
6584 <dt data-property-name=
"nsfw">
6585 <span class=
"json-property-name">nsfw:
</span>
6586 <span class=
"json-property-type">boolean
</span>
6587 <span class=
"json-property-range" title=
"Value limits"></span>
6589 <dt data-property-name=
"account">
6590 <span class=
"json-property-name">account:
</span>
6591 <span class=
"json-property-type">object
</span>
6592 <span class=
"json-property-range" title=
"Value limits"></span>
6594 <dt class=
"json-inner-schema">
6595 <section class=
"json-schema-properties">
6597 <dt data-property-name=
"name">
6598 <span class=
"json-property-name">name:
</span>
6599 <span class=
"json-property-type">string
</span>
6600 <span class=
"json-property-range" title=
"Value limits"></span>
6602 <dt data-property-name=
"displayName">
6603 <span class=
"json-property-name">displayName:
</span>
6604 <span class=
"json-property-type">string
</span>
6605 <span class=
"json-property-range" title=
"Value limits"></span>
6607 <dt data-property-name=
"url">
6608 <span class=
"json-property-name">url:
</span>
6609 <span class=
"json-property-type">string
</span>
6610 <span class=
"json-property-range" title=
"Value limits"></span>
6612 <dt data-property-name=
"host">
6613 <span class=
"json-property-name">host:
</span>
6614 <span class=
"json-property-type">string
</span>
6615 <span class=
"json-property-range" title=
"Value limits"></span>
6617 <dt data-property-name=
"avatar">
6618 <span class=
"json-property-name">avatar:
</span>
6619 <span class=
"json-property-type">
6621 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
6624 <span class=
"json-property-range" title=
"Value limits"></span>
6632 <div class=
"doc-examples">
6635 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6636 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6637 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6638 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6639 <span class=
"hljs-attr">"publishedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6640 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6641 <span class=
"hljs-attr">"category
"</span>: {
6642 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6643 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6645 <span class=
"hljs-attr">"licence
"</span>: {
6646 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6647 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6649 <span class=
"hljs-attr">"language
"</span>: {
6650 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
6651 <span class=
"hljs-attr">"label
"</span>:
<span class=
"hljs-string">"string
"</span>
6653 <span class=
"hljs-attr">"privacy
"</span>:
<span class=
"hljs-string">"string
"</span>,
6654 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6655 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6656 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6657 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6658 <span class=
"hljs-attr">"thumbnailPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6659 <span class=
"hljs-attr">"previewPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6660 <span class=
"hljs-attr">"embedPath
"</span>:
<span class=
"hljs-string">"string
"</span>,
6661 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6662 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6663 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6664 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6665 <span class=
"hljs-attr">"account
"</span>: {
6666 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6667 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6668 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6669 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6670 <span class=
"hljs-attr">"avatar
"</span>: {
6671 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6672 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6673 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6683 <div id=
"definition-VideoAbuse" class=
"definition panel" data-traverse-target=
"definition-VideoAbuse">
6684 <h2 class=
"panel-title">
6685 <a name=
"/definitions/VideoAbuse"></a>VideoAbuse:
6686 <!-- <span class="json-property-type">
6687 <span class="json-property-type">object</span>
6688 <span class="json-property-range" title="Value limits"></span>
6693 <div class=
"doc-row">
6694 <div class=
"doc-copy">
6695 <section class=
"json-schema-properties">
6697 <dt data-property-name=
"id">
6698 <span class=
"json-property-name">id:
</span>
6699 <span class=
"json-property-type">number
</span>
6700 <span class=
"json-property-range" title=
"Value limits"></span>
6702 <dt data-property-name=
"reason">
6703 <span class=
"json-property-name">reason:
</span>
6704 <span class=
"json-property-type">string
</span>
6705 <span class=
"json-property-range" title=
"Value limits"></span>
6707 <dt data-property-name=
"reporterAccount">
6708 <span class=
"json-property-name">reporterAccount:
</span>
6709 <span class=
"json-property-type">
6711 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
6714 <span class=
"json-property-range" title=
"Value limits"></span>
6716 <dt data-property-name=
"video">
6717 <span class=
"json-property-name">video:
</span>
6718 <span class=
"json-property-type">object
</span>
6719 <span class=
"json-property-range" title=
"Value limits"></span>
6721 <dt class=
"json-inner-schema">
6722 <section class=
"json-schema-properties">
6724 <dt data-property-name=
"id">
6725 <span class=
"json-property-name">id:
</span>
6726 <span class=
"json-property-type">number
</span>
6727 <span class=
"json-property-range" title=
"Value limits"></span>
6729 <dt data-property-name=
"name">
6730 <span class=
"json-property-name">name:
</span>
6731 <span class=
"json-property-type">string
</span>
6732 <span class=
"json-property-range" title=
"Value limits"></span>
6734 <dt data-property-name=
"uuid">
6735 <span class=
"json-property-name">uuid:
</span>
6736 <span class=
"json-property-type">string
</span>
6737 <span class=
"json-property-range" title=
"Value limits"></span>
6739 <dt data-property-name=
"url">
6740 <span class=
"json-property-name">url:
</span>
6741 <span class=
"json-property-type">string
</span>
6742 <span class=
"json-property-range" title=
"Value limits"></span>
6747 <dt data-property-name=
"createdAt">
6748 <span class=
"json-property-name">createdAt:
</span>
6749 <span class=
"json-property-type">string
</span>
6750 <span class=
"json-property-range" title=
"Value limits"></span>
6755 <div class=
"doc-examples">
6758 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6759 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6760 <span class=
"hljs-attr">"reason
"</span>:
<span class=
"hljs-string">"string
"</span>,
6761 <span class=
"hljs-attr">"reporterAccount
"</span>: {
6762 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6763 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6764 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6765 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
6766 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6767 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
6768 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6769 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
6770 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6771 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6772 <span class=
"hljs-attr">"avatar
"</span>: {
6773 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
6774 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6775 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6778 <span class=
"hljs-attr">"video
"</span>: {
6779 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6780 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6781 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6782 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>
6784 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>
6792 <div id=
"definition-VideoBlacklist" class=
"definition panel" data-traverse-target=
"definition-VideoBlacklist">
6793 <h2 class=
"panel-title">
6794 <a name=
"/definitions/VideoBlacklist"></a>VideoBlacklist:
6795 <!-- <span class="json-property-type">
6796 <span class="json-property-type">object</span>
6797 <span class="json-property-range" title="Value limits"></span>
6802 <div class=
"doc-row">
6803 <div class=
"doc-copy">
6804 <section class=
"json-schema-properties">
6806 <dt data-property-name=
"id">
6807 <span class=
"json-property-name">id:
</span>
6808 <span class=
"json-property-type">number
</span>
6809 <span class=
"json-property-range" title=
"Value limits"></span>
6811 <dt data-property-name=
"videoId">
6812 <span class=
"json-property-name">videoId:
</span>
6813 <span class=
"json-property-type">number
</span>
6814 <span class=
"json-property-range" title=
"Value limits"></span>
6816 <dt data-property-name=
"createdAt">
6817 <span class=
"json-property-name">createdAt:
</span>
6818 <span class=
"json-property-type">string
</span>
6819 <span class=
"json-property-range" title=
"Value limits"></span>
6821 <dt data-property-name=
"updatedAt">
6822 <span class=
"json-property-name">updatedAt:
</span>
6823 <span class=
"json-property-type">string
</span>
6824 <span class=
"json-property-range" title=
"Value limits"></span>
6826 <dt data-property-name=
"name">
6827 <span class=
"json-property-name">name:
</span>
6828 <span class=
"json-property-type">string
</span>
6829 <span class=
"json-property-range" title=
"Value limits"></span>
6831 <dt data-property-name=
"uuid">
6832 <span class=
"json-property-name">uuid:
</span>
6833 <span class=
"json-property-type">string
</span>
6834 <span class=
"json-property-range" title=
"Value limits"></span>
6836 <dt data-property-name=
"description">
6837 <span class=
"json-property-name">description:
</span>
6838 <span class=
"json-property-type">string
</span>
6839 <span class=
"json-property-range" title=
"Value limits"></span>
6841 <dt data-property-name=
"duration">
6842 <span class=
"json-property-name">duration:
</span>
6843 <span class=
"json-property-type">number
</span>
6844 <span class=
"json-property-range" title=
"Value limits"></span>
6846 <dt data-property-name=
"views">
6847 <span class=
"json-property-name">views:
</span>
6848 <span class=
"json-property-type">number
</span>
6849 <span class=
"json-property-range" title=
"Value limits"></span>
6851 <dt data-property-name=
"likes">
6852 <span class=
"json-property-name">likes:
</span>
6853 <span class=
"json-property-type">number
</span>
6854 <span class=
"json-property-range" title=
"Value limits"></span>
6856 <dt data-property-name=
"dislikes">
6857 <span class=
"json-property-name">dislikes:
</span>
6858 <span class=
"json-property-type">number
</span>
6859 <span class=
"json-property-range" title=
"Value limits"></span>
6861 <dt data-property-name=
"nsfw">
6862 <span class=
"json-property-name">nsfw:
</span>
6863 <span class=
"json-property-type">boolean
</span>
6864 <span class=
"json-property-range" title=
"Value limits"></span>
6869 <div class=
"doc-examples">
6872 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6873 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6874 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
6875 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6876 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
6877 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
6878 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
6879 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6880 <span class=
"hljs-attr">"duration
"</span>:
<span class=
"hljs-string">"number
"</span>,
6881 <span class=
"hljs-attr">"views
"</span>:
<span class=
"hljs-string">"number
"</span>,
6882 <span class=
"hljs-attr">"likes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6883 <span class=
"hljs-attr">"dislikes
"</span>:
<span class=
"hljs-string">"number
"</span>,
6884 <span class=
"hljs-attr">"nsfw
"</span>:
<span class=
"hljs-string">"boolean
"</span>
6892 <div id=
"definition-VideoChannel" class=
"definition panel" data-traverse-target=
"definition-VideoChannel">
6893 <h2 class=
"panel-title">
6894 <a name=
"/definitions/VideoChannel"></a>VideoChannel:
6895 <!-- <span class="json-property-type">
6896 <span class="json-property-type">object</span>
6897 <span class="json-property-range" title="Value limits"></span>
6902 <div class=
"doc-row">
6903 <div class=
"doc-copy">
6904 <section class=
"json-schema-properties">
6906 <dt data-property-name=
"displayName">
6907 <span class=
"json-property-name">displayName:
</span>
6908 <span class=
"json-property-type">string
</span>
6909 <span class=
"json-property-range" title=
"Value limits"></span>
6911 <dt data-property-name=
"description">
6912 <span class=
"json-property-name">description:
</span>
6913 <span class=
"json-property-type">string
</span>
6914 <span class=
"json-property-range" title=
"Value limits"></span>
6916 <dt data-property-name=
"isLocal">
6917 <span class=
"json-property-name">isLocal:
</span>
6918 <span class=
"json-property-type">boolean
</span>
6919 <span class=
"json-property-range" title=
"Value limits"></span>
6921 <dt data-property-name=
"ownerAccount">
6922 <span class=
"json-property-name">ownerAccount:
</span>
6923 <span class=
"json-property-type">object
</span>
6924 <span class=
"json-property-range" title=
"Value limits"></span>
6926 <dt class=
"json-inner-schema">
6927 <section class=
"json-schema-properties">
6929 <dt data-property-name=
"id">
6930 <span class=
"json-property-name">id:
</span>
6931 <span class=
"json-property-type">number
</span>
6932 <span class=
"json-property-range" title=
"Value limits"></span>
6934 <dt data-property-name=
"uuid">
6935 <span class=
"json-property-name">uuid:
</span>
6936 <span class=
"json-property-type">string
</span>
6937 <span class=
"json-property-range" title=
"Value limits"></span>
6945 <div class=
"doc-examples">
6948 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
6949 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
6950 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
6951 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
6952 <span class=
"hljs-attr">"ownerAccount
"</span>: {
6953 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
6954 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
6963 <div id=
"definition-VideoComment" class=
"definition panel" data-traverse-target=
"definition-VideoComment">
6964 <h2 class=
"panel-title">
6965 <a name=
"/definitions/VideoComment"></a>VideoComment:
6966 <!-- <span class="json-property-type">
6967 <span class="json-property-type">object</span>
6968 <span class="json-property-range" title="Value limits"></span>
6973 <div class=
"doc-row">
6974 <div class=
"doc-copy">
6975 <section class=
"json-schema-properties">
6977 <dt data-property-name=
"id">
6978 <span class=
"json-property-name">id:
</span>
6979 <span class=
"json-property-type">number
</span>
6980 <span class=
"json-property-range" title=
"Value limits"></span>
6982 <dt data-property-name=
"url">
6983 <span class=
"json-property-name">url:
</span>
6984 <span class=
"json-property-type">string
</span>
6985 <span class=
"json-property-range" title=
"Value limits"></span>
6987 <dt data-property-name=
"text">
6988 <span class=
"json-property-name">text:
</span>
6989 <span class=
"json-property-type">string
</span>
6990 <span class=
"json-property-range" title=
"Value limits"></span>
6992 <dt data-property-name=
"threadId">
6993 <span class=
"json-property-name">threadId:
</span>
6994 <span class=
"json-property-type">number
</span>
6995 <span class=
"json-property-range" title=
"Value limits"></span>
6997 <dt data-property-name=
"inReplyToCommentId">
6998 <span class=
"json-property-name">inReplyToCommentId:
</span>
6999 <span class=
"json-property-type">number
</span>
7000 <span class=
"json-property-range" title=
"Value limits"></span>
7002 <dt data-property-name=
"videoId">
7003 <span class=
"json-property-name">videoId:
</span>
7004 <span class=
"json-property-type">number
</span>
7005 <span class=
"json-property-range" title=
"Value limits"></span>
7007 <dt data-property-name=
"createdAt">
7008 <span class=
"json-property-name">createdAt:
</span>
7009 <span class=
"json-property-type">string
</span>
7010 <span class=
"json-property-range" title=
"Value limits"></span>
7012 <dt data-property-name=
"updatedAt">
7013 <span class=
"json-property-name">updatedAt:
</span>
7014 <span class=
"json-property-type">string
</span>
7015 <span class=
"json-property-range" title=
"Value limits"></span>
7017 <dt data-property-name=
"totalReplies">
7018 <span class=
"json-property-name">totalReplies:
</span>
7019 <span class=
"json-property-type">number
</span>
7020 <span class=
"json-property-range" title=
"Value limits"></span>
7022 <dt data-property-name=
"account">
7023 <span class=
"json-property-name">account:
</span>
7024 <span class=
"json-property-type">
7026 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
7029 <span class=
"json-property-range" title=
"Value limits"></span>
7034 <div class=
"doc-examples">
7037 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7038 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7039 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7040 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7041 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7042 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7043 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7044 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7045 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7046 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7047 <span class=
"hljs-attr">"account
"</span>: {
7048 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7049 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7050 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7051 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7052 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7053 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7054 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7055 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7056 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7057 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7058 <span class=
"hljs-attr">"avatar
"</span>: {
7059 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7060 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7061 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7071 <div id=
"definition-VideoCommentThreadTree" class=
"definition panel" data-traverse-target=
"definition-VideoCommentThreadTree">
7072 <h2 class=
"panel-title">
7073 <a name=
"/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree:
7074 <!-- <span class="json-property-type">
7075 <span class="json-property-type">object</span>
7076 <span class="json-property-range" title="Value limits"></span>
7081 <div class=
"doc-row">
7082 <div class=
"doc-copy">
7083 <section class=
"json-schema-properties">
7085 <dt data-property-name=
"comment">
7086 <span class=
"json-property-name">comment:
</span>
7087 <span class=
"json-property-type">
7089 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
7092 <span class=
"json-property-range" title=
"Value limits"></span>
7094 <dt data-property-name=
"children">
7095 <span class=
"json-property-name">children:
</span>
7096 <span class=
"json-property-type">
7097 <span class=
"json-schema-ref-array">
7098 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
7101 <span class=
"json-property-range" title=
"Value limits"></span>
7103 <dt class=
"json-inner-schema">
7104 <section class=
"json-schema-array-items">
7105 <span class=
"json-property-type">
7107 <a class=
"json-schema-ref" href=
"#/definitions/VideoCommentThreadTree">VideoCommentThreadTree
</a>
7110 <span class=
"json-property-range" title=
"Value limits"></span>
7111 <div class=
"json-inner-schema"> </div>
7117 <div class=
"doc-examples">
7120 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7121 <span class=
"hljs-attr">"comment
"</span>: {
7122 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7123 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7124 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7125 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7126 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7127 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7128 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7129 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7130 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7131 <span class=
"hljs-attr">"account
"</span>: {
7132 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7133 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7134 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7135 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7136 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7137 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7138 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7139 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7140 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7141 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7142 <span class=
"hljs-attr">"avatar
"</span>: {
7143 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7144 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7145 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7149 <span class=
"hljs-attr">"children
"</span>: [
7151 <span class=
"hljs-attr">"comment
"</span>: {
7152 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7153 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7154 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7155 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7156 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7157 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7158 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7159 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7160 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7161 <span class=
"hljs-attr">"account
"</span>: {
7162 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7163 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7164 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7165 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7166 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7167 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7168 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7169 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7170 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7171 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7172 <span class=
"hljs-attr">"avatar
"</span>: {
7173 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7174 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7175 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7179 <span class=
"hljs-attr">"children
"</span>: [
7181 <span class=
"hljs-attr">"comment
"</span>: {
7182 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7183 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7184 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
7185 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7186 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7187 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
7188 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7189 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7190 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
7191 <span class=
"hljs-attr">"account
"</span>: {
7192 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7193 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7194 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7195 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7196 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7197 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7198 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7199 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7200 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7201 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7202 <span class=
"hljs-attr">"avatar
"</span>: {
7203 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7204 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7205 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7220 <div id=
"definition-Avatar" class=
"definition panel" data-traverse-target=
"definition-Avatar">
7221 <h2 class=
"panel-title">
7222 <a name=
"/definitions/Avatar"></a>Avatar:
7223 <!-- <span class="json-property-type">
7224 <span class="json-property-type">object</span>
7225 <span class="json-property-range" title="Value limits"></span>
7230 <div class=
"doc-row">
7231 <div class=
"doc-copy">
7232 <section class=
"json-schema-properties">
7234 <dt data-property-name=
"path">
7235 <span class=
"json-property-name">path:
</span>
7236 <span class=
"json-property-type">string
</span>
7237 <span class=
"json-property-range" title=
"Value limits"></span>
7239 <dt data-property-name=
"createdAt">
7240 <span class=
"json-property-name">createdAt:
</span>
7241 <span class=
"json-property-type">string
</span>
7242 <span class=
"json-property-range" title=
"Value limits"></span>
7244 <dt data-property-name=
"updatedAt">
7245 <span class=
"json-property-name">updatedAt:
</span>
7246 <span class=
"json-property-type">string
</span>
7247 <span class=
"json-property-range" title=
"Value limits"></span>
7252 <div class=
"doc-examples">
7255 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7256 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7257 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7258 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7266 <div id=
"definition-Actor" class=
"definition panel" data-traverse-target=
"definition-Actor">
7267 <h2 class=
"panel-title">
7268 <a name=
"/definitions/Actor"></a>Actor:
7269 <!-- <span class="json-property-type">
7270 <span class="json-property-type">object</span>
7271 <span class="json-property-range" title="Value limits"></span>
7276 <div class=
"doc-row">
7277 <div class=
"doc-copy">
7278 <section class=
"json-schema-properties">
7280 <dt data-property-name=
"id">
7281 <span class=
"json-property-name">id:
</span>
7282 <span class=
"json-property-type">number
</span>
7283 <span class=
"json-property-range" title=
"Value limits"></span>
7285 <dt data-property-name=
"uuid">
7286 <span class=
"json-property-name">uuid:
</span>
7287 <span class=
"json-property-type">string
</span>
7288 <span class=
"json-property-range" title=
"Value limits"></span>
7290 <dt data-property-name=
"url">
7291 <span class=
"json-property-name">url:
</span>
7292 <span class=
"json-property-type">string
</span>
7293 <span class=
"json-property-range" title=
"Value limits"></span>
7295 <dt data-property-name=
"name">
7296 <span class=
"json-property-name">name:
</span>
7297 <span class=
"json-property-type">string
</span>
7298 <span class=
"json-property-range" title=
"Value limits"></span>
7300 <dt data-property-name=
"host">
7301 <span class=
"json-property-name">host:
</span>
7302 <span class=
"json-property-type">string
</span>
7303 <span class=
"json-property-range" title=
"Value limits"></span>
7305 <dt data-property-name=
"followingCount">
7306 <span class=
"json-property-name">followingCount:
</span>
7307 <span class=
"json-property-type">number
</span>
7308 <span class=
"json-property-range" title=
"Value limits"></span>
7310 <dt data-property-name=
"followersCount">
7311 <span class=
"json-property-name">followersCount:
</span>
7312 <span class=
"json-property-type">number
</span>
7313 <span class=
"json-property-range" title=
"Value limits"></span>
7315 <dt data-property-name=
"createdAt">
7316 <span class=
"json-property-name">createdAt:
</span>
7317 <span class=
"json-property-type">string
</span>
7318 <span class=
"json-property-range" title=
"Value limits"></span>
7320 <dt data-property-name=
"updatedAt">
7321 <span class=
"json-property-name">updatedAt:
</span>
7322 <span class=
"json-property-type">string
</span>
7323 <span class=
"json-property-range" title=
"Value limits"></span>
7325 <dt data-property-name=
"avatar">
7326 <span class=
"json-property-name">avatar:
</span>
7327 <span class=
"json-property-type">
7329 <a class=
"json-schema-ref" href=
"#/definitions/Avatar">Avatar
</a>
7332 <span class=
"json-property-range" title=
"Value limits"></span>
7337 <div class=
"doc-examples">
7340 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7341 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7342 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7343 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7344 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7345 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7346 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7347 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7348 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7349 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7350 <span class=
"hljs-attr">"avatar
"</span>: {
7351 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7352 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7353 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7362 <div id=
"definition-Account" class=
"definition panel" data-traverse-target=
"definition-Account">
7363 <h2 class=
"panel-title">
7364 <a name=
"/definitions/Account"></a>Account:
7365 <!-- <span class="json-property-type">
7366 <span class="json-property-type"></span>
7367 <span class="json-property-range" title="Value limits"></span>
7372 <div class=
"doc-row">
7373 <div class=
"doc-copy">
7374 <section class=
"json-schema-allOf">
7375 <section class=
"json-schema-allOf-inherited">
7378 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7382 <section class=
"json-schema-allOf-additional">
7383 <section class=
"json-schema-properties">
7385 <dt data-property-name=
"displayName">
7386 <span class=
"json-property-name">displayName:
</span>
7387 <span class=
"json-property-type">string
</span>
7388 <span class=
"json-property-range" title=
"Value limits"></span>
7395 <div class=
"doc-examples">
7398 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7399 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7400 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7401 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7402 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7403 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7404 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7405 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7406 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7407 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7408 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7409 <span class=
"hljs-attr">"avatar
"</span>: {
7410 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7411 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7412 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7421 <div id=
"definition-User" class=
"definition panel" data-traverse-target=
"definition-User">
7422 <h2 class=
"panel-title">
7423 <a name=
"/definitions/User"></a>User:
7424 <!-- <span class="json-property-type">
7425 <span class="json-property-type">object</span>
7426 <span class="json-property-range" title="Value limits"></span>
7431 <div class=
"doc-row">
7432 <div class=
"doc-copy">
7433 <section class=
"json-schema-properties">
7435 <dt data-property-name=
"id">
7436 <span class=
"json-property-name">id:
</span>
7437 <span class=
"json-property-type">number
</span>
7438 <span class=
"json-property-range" title=
"Value limits"></span>
7440 <dt data-property-name=
"username">
7441 <span class=
"json-property-name">username:
</span>
7442 <span class=
"json-property-type">string
</span>
7443 <span class=
"json-property-range" title=
"Value limits"></span>
7445 <dt data-property-name=
"email">
7446 <span class=
"json-property-name">email:
</span>
7447 <span class=
"json-property-type">string
</span>
7448 <span class=
"json-property-range" title=
"Value limits"></span>
7450 <dt data-property-name=
"displayNSFW">
7451 <span class=
"json-property-name">displayNSFW:
</span>
7452 <span class=
"json-property-type">boolean
</span>
7453 <span class=
"json-property-range" title=
"Value limits"></span>
7455 <dt data-property-name=
"autoPlayVideo">
7456 <span class=
"json-property-name">autoPlayVideo:
</span>
7457 <span class=
"json-property-type">boolean
</span>
7458 <span class=
"json-property-range" title=
"Value limits"></span>
7460 <dt data-property-name=
"role">
7461 <span class=
"json-property-name">role:
</span>
7462 <span class=
"json-property-type">string
</span>
7463 <span class=
"json-property-enum" title=
"Possible values">
7464 <span class=
"json-property-enum-item">User
</span>,
7465 <span class=
"json-property-enum-item">Moderator
</span>,
7466 <span class=
"json-property-enum-item">Administrator
</span>
7468 <span class=
"json-property-range" title=
"Value limits"></span>
7470 <dt data-property-name=
"videoQuota">
7471 <span class=
"json-property-name">videoQuota:
</span>
7472 <span class=
"json-property-type">number
</span>
7473 <span class=
"json-property-range" title=
"Value limits"></span>
7475 <dt data-property-name=
"createdAt">
7476 <span class=
"json-property-name">createdAt:
</span>
7477 <span class=
"json-property-type">string
</span>
7478 <span class=
"json-property-range" title=
"Value limits"></span>
7480 <dt data-property-name=
"account">
7481 <span class=
"json-property-name">account:
</span>
7482 <span class=
"json-property-type">
7484 <a class=
"json-schema-ref" href=
"#/definitions/Account">Account
</a>
7487 <span class=
"json-property-range" title=
"Value limits"></span>
7489 <dt data-property-name=
"videoChannels">
7490 <span class=
"json-property-name">videoChannels:
</span>
7491 <span class=
"json-property-type">
7492 <span class=
"json-schema-ref-array">
7493 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
7496 <span class=
"json-property-range" title=
"Value limits"></span>
7498 <dt class=
"json-inner-schema">
7499 <section class=
"json-schema-array-items">
7500 <span class=
"json-property-type">
7502 <a class=
"json-schema-ref" href=
"#/definitions/VideoChannel">VideoChannel
</a>
7505 <span class=
"json-property-range" title=
"Value limits"></span>
7506 <div class=
"json-inner-schema"> </div>
7512 <div class=
"doc-examples">
7515 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7516 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7517 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
7518 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
7519 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7520 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7521 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>,
7522 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"number
"</span>,
7523 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7524 <span class=
"hljs-attr">"account
"</span>: {
7525 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7526 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7527 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7528 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7529 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7530 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7531 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7532 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7533 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7534 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7535 <span class=
"hljs-attr">"avatar
"</span>: {
7536 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7537 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7538 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7541 <span class=
"hljs-attr">"videoChannels
"</span>: [
7543 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7544 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>,
7545 <span class=
"hljs-attr">"isLocal
"</span>:
<span class=
"hljs-string">"boolean
"</span>,
7546 <span class=
"hljs-attr">"ownerAccount
"</span>: {
7547 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7548 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
7559 <div id=
"definition-ServerConfig" class=
"definition panel" data-traverse-target=
"definition-ServerConfig">
7560 <h2 class=
"panel-title">
7561 <a name=
"/definitions/ServerConfig"></a>ServerConfig:
7562 <!-- <span class="json-property-type">
7563 <span class="json-property-type">object</span>
7564 <span class="json-property-range" title="Value limits"></span>
7569 <div class=
"doc-row">
7570 <div class=
"doc-copy">
7571 <section class=
"json-schema-properties">
7573 <dt data-property-name=
"signup">
7574 <span class=
"json-property-name">signup:
</span>
7575 <span class=
"json-property-type">object
</span>
7576 <span class=
"json-property-range" title=
"Value limits"></span>
7578 <dt class=
"json-inner-schema">
7579 <section class=
"json-schema-properties">
7581 <dt data-property-name=
"allowed">
7582 <span class=
"json-property-name">allowed:
</span>
7583 <span class=
"json-property-type">boolean
</span>
7584 <span class=
"json-property-range" title=
"Value limits"></span>
7589 <dt data-property-name=
"transcoding">
7590 <span class=
"json-property-name">transcoding:
</span>
7591 <span class=
"json-property-type">object
</span>
7592 <span class=
"json-property-range" title=
"Value limits"></span>
7594 <dt class=
"json-inner-schema">
7595 <section class=
"json-schema-properties">
7597 <dt data-property-name=
"enabledResolutions">
7598 <span class=
"json-property-name">enabledResolutions:
</span>
7599 <span class=
"json-property-type">number[]
</span>
7600 <span class=
"json-property-range" title=
"Value limits"></span>
7602 <dt class=
"json-inner-schema">
7603 <section class=
"json-schema-array-items">
7604 <span class=
"json-property-type">number
</span>
7605 <span class=
"json-property-range" title=
"Value limits"></span>
7606 <div class=
"json-inner-schema"> </div>
7612 <dt data-property-name=
"avatar">
7613 <span class=
"json-property-name">avatar:
</span>
7614 <span class=
"json-property-type">object
</span>
7615 <span class=
"json-property-range" title=
"Value limits"></span>
7617 <dt class=
"json-inner-schema">
7618 <section class=
"json-schema-properties">
7620 <dt data-property-name=
"file">
7621 <span class=
"json-property-name">file:
</span>
7622 <span class=
"json-property-type">object
</span>
7623 <span class=
"json-property-range" title=
"Value limits"></span>
7625 <dt class=
"json-inner-schema">
7626 <section class=
"json-schema-properties">
7628 <dt data-property-name=
"size">
7629 <span class=
"json-property-name">size:
</span>
7630 <span class=
"json-property-type">object
</span>
7631 <span class=
"json-property-range" title=
"Value limits"></span>
7633 <dt class=
"json-inner-schema">
7634 <section class=
"json-schema-properties">
7636 <dt data-property-name=
"max">
7637 <span class=
"json-property-name">max:
</span>
7638 <span class=
"json-property-type">number
</span>
7639 <span class=
"json-property-range" title=
"Value limits"></span>
7647 <dt data-property-name=
"extensions">
7648 <span class=
"json-property-name">extensions:
</span>
7649 <span class=
"json-property-type">string[]
</span>
7650 <span class=
"json-property-range" title=
"Value limits"></span>
7652 <dt class=
"json-inner-schema">
7653 <section class=
"json-schema-array-items">
7654 <span class=
"json-property-type">string
</span>
7655 <span class=
"json-property-range" title=
"Value limits"></span>
7656 <div class=
"json-inner-schema"> </div>
7662 <dt data-property-name=
"video">
7663 <span class=
"json-property-name">video:
</span>
7664 <span class=
"json-property-type">object
</span>
7665 <span class=
"json-property-range" title=
"Value limits"></span>
7667 <dt class=
"json-inner-schema">
7668 <section class=
"json-schema-properties">
7670 <dt data-property-name=
"file">
7671 <span class=
"json-property-name">file:
</span>
7672 <span class=
"json-property-type">object
</span>
7673 <span class=
"json-property-range" title=
"Value limits"></span>
7675 <dt class=
"json-inner-schema">
7676 <section class=
"json-schema-properties">
7678 <dt data-property-name=
"extensions">
7679 <span class=
"json-property-name">extensions:
</span>
7680 <span class=
"json-property-type">string[]
</span>
7681 <span class=
"json-property-range" title=
"Value limits"></span>
7683 <dt class=
"json-inner-schema">
7684 <section class=
"json-schema-array-items">
7685 <span class=
"json-property-type">string
</span>
7686 <span class=
"json-property-range" title=
"Value limits"></span>
7687 <div class=
"json-inner-schema"> </div>
7699 <div class=
"doc-examples">
7702 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7703 <span class=
"hljs-attr">"signup
"</span>: {
7704 <span class=
"hljs-attr">"allowed
"</span>:
<span class=
"hljs-string">"boolean
"</span>
7706 <span class=
"hljs-attr">"transcoding
"</span>: {
7707 <span class=
"hljs-attr">"enabledResolutions
"</span>: [
7708 <span class=
"hljs-string">"number
"</span>
7711 <span class=
"hljs-attr">"avatar
"</span>: {
7712 <span class=
"hljs-attr">"file
"</span>: {
7713 <span class=
"hljs-attr">"size
"</span>: {
7714 <span class=
"hljs-attr">"max
"</span>:
<span class=
"hljs-string">"number
"</span>
7717 <span class=
"hljs-attr">"extensions
"</span>: [
7718 <span class=
"hljs-string">"string
"</span>
7721 <span class=
"hljs-attr">"video
"</span>: {
7722 <span class=
"hljs-attr">"file
"</span>: {
7723 <span class=
"hljs-attr">"extensions
"</span>: [
7724 <span class=
"hljs-string">"string
"</span>
7735 <div id=
"definition-Follow" class=
"definition panel" data-traverse-target=
"definition-Follow">
7736 <h2 class=
"panel-title">
7737 <a name=
"/definitions/Follow"></a>Follow:
7738 <!-- <span class="json-property-type">
7739 <span class="json-property-type">object</span>
7740 <span class="json-property-range" title="Value limits"></span>
7745 <div class=
"doc-row">
7746 <div class=
"doc-copy">
7747 <section class=
"json-schema-properties">
7749 <dt data-property-name=
"id">
7750 <span class=
"json-property-name">id:
</span>
7751 <span class=
"json-property-type">number
</span>
7752 <span class=
"json-property-range" title=
"Value limits"></span>
7754 <dt data-property-name=
"follower">
7755 <span class=
"json-property-name">follower:
</span>
7756 <span class=
"json-property-type">
7758 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7761 <span class=
"json-property-range" title=
"Value limits"></span>
7763 <dt data-property-name=
"following">
7764 <span class=
"json-property-name">following:
</span>
7765 <span class=
"json-property-type">
7767 <a class=
"json-schema-ref" href=
"#/definitions/Actor">Actor
</a>
7770 <span class=
"json-property-range" title=
"Value limits"></span>
7772 <dt data-property-name=
"score">
7773 <span class=
"json-property-name">score:
</span>
7774 <span class=
"json-property-type">number
</span>
7775 <span class=
"json-property-range" title=
"Value limits"></span>
7777 <dt data-property-name=
"state">
7778 <span class=
"json-property-name">state:
</span>
7779 <span class=
"json-property-type">string
</span>
7780 <span class=
"json-property-enum" title=
"Possible values">
7781 <span class=
"json-property-enum-item">pending
</span>,
7782 <span class=
"json-property-enum-item">accepted
</span>
7784 <span class=
"json-property-range" title=
"Value limits"></span>
7786 <dt data-property-name=
"createdAt">
7787 <span class=
"json-property-name">createdAt:
</span>
7788 <span class=
"json-property-type">string
</span>
7789 <span class=
"json-property-range" title=
"Value limits"></span>
7791 <dt data-property-name=
"updatedAt">
7792 <span class=
"json-property-name">updatedAt:
</span>
7793 <span class=
"json-property-type">string
</span>
7794 <span class=
"json-property-range" title=
"Value limits"></span>
7799 <div class=
"doc-examples">
7802 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7803 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7804 <span class=
"hljs-attr">"follower
"</span>: {
7805 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7806 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7807 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7808 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7809 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7810 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7811 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7812 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7813 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7814 <span class=
"hljs-attr">"avatar
"</span>: {
7815 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7816 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7817 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7820 <span class=
"hljs-attr">"following
"</span>: {
7821 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7822 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
7823 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
7824 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
7825 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
7826 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7827 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
7828 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7829 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7830 <span class=
"hljs-attr">"avatar
"</span>: {
7831 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
7832 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7833 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7836 <span class=
"hljs-attr">"score
"</span>:
<span class=
"hljs-string">"number
"</span>,
7837 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
7838 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7839 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7847 <div id=
"definition-Job" class=
"definition panel" data-traverse-target=
"definition-Job">
7848 <h2 class=
"panel-title">
7849 <a name=
"/definitions/Job"></a>Job:
7850 <!-- <span class="json-property-type">
7851 <span class="json-property-type">object</span>
7852 <span class="json-property-range" title="Value limits"></span>
7857 <div class=
"doc-row">
7858 <div class=
"doc-copy">
7859 <section class=
"json-schema-properties">
7861 <dt data-property-name=
"id">
7862 <span class=
"json-property-name">id:
</span>
7863 <span class=
"json-property-type">number
</span>
7864 <span class=
"json-property-range" title=
"Value limits"></span>
7866 <dt data-property-name=
"state">
7867 <span class=
"json-property-name">state:
</span>
7868 <span class=
"json-property-type">string
</span>
7869 <span class=
"json-property-enum" title=
"Possible values">
7870 <span class=
"json-property-enum-item">pending
</span>,
7871 <span class=
"json-property-enum-item">processing
</span>,
7872 <span class=
"json-property-enum-item">error
</span>,
7873 <span class=
"json-property-enum-item">success
</span>
7875 <span class=
"json-property-range" title=
"Value limits"></span>
7877 <dt data-property-name=
"category">
7878 <span class=
"json-property-name">category:
</span>
7879 <span class=
"json-property-type">string
</span>
7880 <span class=
"json-property-enum" title=
"Possible values">
7881 <span class=
"json-property-enum-item">transcoding
</span>,
7882 <span class=
"json-property-enum-item">activitypub-http
</span>
7884 <span class=
"json-property-range" title=
"Value limits"></span>
7886 <dt data-property-name=
"handlerName">
7887 <span class=
"json-property-name">handlerName:
</span>
7888 <span class=
"json-property-type">string
</span>
7889 <span class=
"json-property-range" title=
"Value limits"></span>
7891 <dt data-property-name=
"handlerInputData">
7892 <span class=
"json-property-name">handlerInputData:
</span>
7893 <span class=
"json-property-type">string
</span>
7894 <span class=
"json-property-range" title=
"Value limits"></span>
7896 <dt data-property-name=
"createdAt">
7897 <span class=
"json-property-name">createdAt:
</span>
7898 <span class=
"json-property-type">string
</span>
7899 <span class=
"json-property-range" title=
"Value limits"></span>
7901 <dt data-property-name=
"updatedAt">
7902 <span class=
"json-property-name">updatedAt:
</span>
7903 <span class=
"json-property-type">string
</span>
7904 <span class=
"json-property-range" title=
"Value limits"></span>
7909 <div class=
"doc-examples">
7912 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7913 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7914 <span class=
"hljs-attr">"state
"</span>:
<span class=
"hljs-string">"string
"</span>,
7915 <span class=
"hljs-attr">"category
"</span>:
<span class=
"hljs-string">"string
"</span>,
7916 <span class=
"hljs-attr">"handlerName
"</span>:
<span class=
"hljs-string">"string
"</span>,
7917 <span class=
"hljs-attr">"handlerInputData
"</span>:
<span class=
"hljs-string">"string
"</span>,
7918 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
7919 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
7927 <div id=
"definition-AddUserResponse" class=
"definition panel" data-traverse-target=
"definition-AddUserResponse">
7928 <h2 class=
"panel-title">
7929 <a name=
"/definitions/AddUserResponse"></a>AddUserResponse:
7930 <!-- <span class="json-property-type">
7931 <span class="json-property-type">object</span>
7932 <span class="json-property-range" title="Value limits"></span>
7937 <div class=
"doc-row">
7938 <div class=
"doc-copy">
7939 <section class=
"json-schema-properties">
7941 <dt data-property-name=
"id">
7942 <span class=
"json-property-name">id:
</span>
7943 <span class=
"json-property-type">number
</span>
7944 <span class=
"json-property-range" title=
"Value limits"></span>
7946 <dt data-property-name=
"uuid">
7947 <span class=
"json-property-name">uuid:
</span>
7948 <span class=
"json-property-type">string
</span>
7949 <span class=
"json-property-range" title=
"Value limits"></span>
7954 <div class=
"doc-examples">
7957 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
7958 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
7959 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
7967 <div id=
"definition-VideoUploadResponse" class=
"definition panel" data-traverse-target=
"definition-VideoUploadResponse">
7968 <h2 class=
"panel-title">
7969 <a name=
"/definitions/VideoUploadResponse"></a>VideoUploadResponse:
7970 <!-- <span class="json-property-type">
7971 <span class="json-property-type">object</span>
7972 <span class="json-property-range" title="Value limits"></span>
7977 <div class=
"doc-row">
7978 <div class=
"doc-copy">
7979 <section class=
"json-schema-properties">
7981 <dt data-property-name=
"video">
7982 <span class=
"json-property-name">video:
</span>
7983 <span class=
"json-property-type">object
</span>
7984 <span class=
"json-property-range" title=
"Value limits"></span>
7986 <dt class=
"json-inner-schema">
7987 <section class=
"json-schema-properties">
7989 <dt data-property-name=
"id">
7990 <span class=
"json-property-name">id:
</span>
7991 <span class=
"json-property-type">number
</span>
7992 <span class=
"json-property-range" title=
"Value limits"></span>
7994 <dt data-property-name=
"uuid">
7995 <span class=
"json-property-name">uuid:
</span>
7996 <span class=
"json-property-type">string
</span>
7997 <span class=
"json-property-range" title=
"Value limits"></span>
8005 <div class=
"doc-examples">
8008 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8009 <span class=
"hljs-attr">"video
"</span>: {
8010 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
8011 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>
8020 <div id=
"definition-CommentThreadResponse" class=
"definition panel" data-traverse-target=
"definition-CommentThreadResponse">
8021 <h2 class=
"panel-title">
8022 <a name=
"/definitions/CommentThreadResponse"></a>CommentThreadResponse:
8023 <!-- <span class="json-property-type">
8024 <span class="json-property-type">object</span>
8025 <span class="json-property-range" title="Value limits"></span>
8030 <div class=
"doc-row">
8031 <div class=
"doc-copy">
8032 <section class=
"json-schema-properties">
8034 <dt data-property-name=
"total">
8035 <span class=
"json-property-name">total:
</span>
8036 <span class=
"json-property-type">number
</span>
8037 <span class=
"json-property-range" title=
"Value limits"></span>
8039 <dt data-property-name=
"data">
8040 <span class=
"json-property-name">data:
</span>
8041 <span class=
"json-property-type">
8042 <span class=
"json-schema-ref-array">
8043 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
8046 <span class=
"json-property-range" title=
"Value limits"></span>
8048 <dt class=
"json-inner-schema">
8049 <section class=
"json-schema-array-items">
8050 <span class=
"json-property-type">
8052 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
8055 <span class=
"json-property-range" title=
"Value limits"></span>
8056 <div class=
"json-inner-schema"> </div>
8062 <div class=
"doc-examples">
8065 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8066 <span class=
"hljs-attr">"total
"</span>:
<span class=
"hljs-string">"number
"</span>,
8067 <span class=
"hljs-attr">"data
"</span>: [
8069 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
8070 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
8071 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
8072 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
8073 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
8074 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
8075 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8076 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8077 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
8078 <span class=
"hljs-attr">"account
"</span>: {
8079 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
8080 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
8081 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
8082 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
8083 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
8084 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
8085 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
8086 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
8087 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8088 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8089 <span class=
"hljs-attr">"avatar
"</span>: {
8090 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
8091 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8092 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
8104 <div id=
"definition-CommentThreadPostResponse" class=
"definition panel" data-traverse-target=
"definition-CommentThreadPostResponse">
8105 <h2 class=
"panel-title">
8106 <a name=
"/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse:
8107 <!-- <span class="json-property-type">
8108 <span class="json-property-type">object</span>
8109 <span class="json-property-range" title="Value limits"></span>
8114 <div class=
"doc-row">
8115 <div class=
"doc-copy">
8116 <section class=
"json-schema-properties">
8118 <dt data-property-name=
"comment">
8119 <span class=
"json-property-name">comment:
</span>
8120 <span class=
"json-property-type">
8122 <a class=
"json-schema-ref" href=
"#/definitions/VideoComment">VideoComment
</a>
8125 <span class=
"json-property-range" title=
"Value limits"></span>
8130 <div class=
"doc-examples">
8133 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8134 <span class=
"hljs-attr">"comment
"</span>: {
8135 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
8136 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
8137 <span class=
"hljs-attr">"text
"</span>:
<span class=
"hljs-string">"string
"</span>,
8138 <span class=
"hljs-attr">"threadId
"</span>:
<span class=
"hljs-string">"number
"</span>,
8139 <span class=
"hljs-attr">"inReplyToCommentId
"</span>:
<span class=
"hljs-string">"number
"</span>,
8140 <span class=
"hljs-attr">"videoId
"</span>:
<span class=
"hljs-string">"number
"</span>,
8141 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8142 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8143 <span class=
"hljs-attr">"totalReplies
"</span>:
<span class=
"hljs-string">"number
"</span>,
8144 <span class=
"hljs-attr">"account
"</span>: {
8145 <span class=
"hljs-attr">"displayName
"</span>:
<span class=
"hljs-string">"string
"</span>,
8146 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"number
"</span>,
8147 <span class=
"hljs-attr">"uuid
"</span>:
<span class=
"hljs-string">"string
"</span>,
8148 <span class=
"hljs-attr">"url
"</span>:
<span class=
"hljs-string">"string
"</span>,
8149 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
8150 <span class=
"hljs-attr">"host
"</span>:
<span class=
"hljs-string">"string
"</span>,
8151 <span class=
"hljs-attr">"followingCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
8152 <span class=
"hljs-attr">"followersCount
"</span>:
<span class=
"hljs-string">"number
"</span>,
8153 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8154 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8155 <span class=
"hljs-attr">"avatar
"</span>: {
8156 <span class=
"hljs-attr">"path
"</span>:
<span class=
"hljs-string">"string
"</span>,
8157 <span class=
"hljs-attr">"createdAt
"</span>:
<span class=
"hljs-string">"string
"</span>,
8158 <span class=
"hljs-attr">"updatedAt
"</span>:
<span class=
"hljs-string">"string
"</span>
8169 <div id=
"definition-AddUser" class=
"definition panel" data-traverse-target=
"definition-AddUser">
8170 <h2 class=
"panel-title">
8171 <a name=
"/definitions/AddUser"></a>AddUser:
8172 <!-- <span class="json-property-type">
8173 <span class="json-property-type">object</span>
8174 <span class="json-property-range" title="Value limits"></span>
8179 <div class=
"doc-row">
8180 <div class=
"doc-copy">
8181 <section class=
"json-schema-properties">
8183 <dt data-property-name=
"username" class=
"has-description">
8184 <span class=
"json-property-name">username:
</span>
8185 <span class=
"json-property-type">string
</span>
8186 <span class=
"json-property-range" title=
"Value limits"></span>
8187 <span class=
"json-property-required"></span>
8190 <p>The user username
</p>
8192 <dt data-property-name=
"password" class=
"has-description">
8193 <span class=
"json-property-name">password:
</span>
8194 <span class=
"json-property-type">string
</span>
8195 <span class=
"json-property-range" title=
"Value limits"></span>
8196 <span class=
"json-property-required"></span>
8199 <p>The user password
</p>
8201 <dt data-property-name=
"email" class=
"has-description">
8202 <span class=
"json-property-name">email:
</span>
8203 <span class=
"json-property-type">string
</span>
8204 <span class=
"json-property-range" title=
"Value limits"></span>
8205 <span class=
"json-property-required"></span>
8208 <p>The user email
</p>
8210 <dt data-property-name=
"videoQuota" class=
"has-description">
8211 <span class=
"json-property-name">videoQuota:
</span>
8212 <span class=
"json-property-type">string
</span>
8213 <span class=
"json-property-range" title=
"Value limits"></span>
8214 <span class=
"json-property-required"></span>
8217 <p>The user videoQuota
</p>
8219 <dt data-property-name=
"role" class=
"has-description">
8220 <span class=
"json-property-name">role:
</span>
8221 <span class=
"json-property-type">string
</span>
8222 <span class=
"json-property-range" title=
"Value limits"></span>
8223 <span class=
"json-property-required"></span>
8226 <p>The user role
</p>
8231 <div class=
"doc-examples">
8234 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8235 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
8236 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
8237 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
8238 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
8239 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
8247 <div id=
"definition-UpdateUser" class=
"definition panel" data-traverse-target=
"definition-UpdateUser">
8248 <h2 class=
"panel-title">
8249 <a name=
"/definitions/UpdateUser"></a>UpdateUser:
8250 <!-- <span class="json-property-type">
8251 <span class="json-property-type">object</span>
8252 <span class="json-property-range" title="Value limits"></span>
8257 <div class=
"doc-row">
8258 <div class=
"doc-copy">
8259 <section class=
"json-schema-properties">
8261 <dt data-property-name=
"id" class=
"has-description">
8262 <span class=
"json-property-name">id:
</span>
8263 <span class=
"json-property-type">string
</span>
8264 <span class=
"json-property-range" title=
"Value limits"></span>
8265 <span class=
"json-property-required"></span>
8270 <dt data-property-name=
"email" class=
"has-description">
8271 <span class=
"json-property-name">email:
</span>
8272 <span class=
"json-property-type">string
</span>
8273 <span class=
"json-property-range" title=
"Value limits"></span>
8274 <span class=
"json-property-required"></span>
8277 <p>The updated email of the user
</p>
8279 <dt data-property-name=
"videoQuota" class=
"has-description">
8280 <span class=
"json-property-name">videoQuota:
</span>
8281 <span class=
"json-property-type">string
</span>
8282 <span class=
"json-property-range" title=
"Value limits"></span>
8283 <span class=
"json-property-required"></span>
8286 <p>The updated videoQuota of the user
</p>
8288 <dt data-property-name=
"role" class=
"has-description">
8289 <span class=
"json-property-name">role:
</span>
8290 <span class=
"json-property-type">string
</span>
8291 <span class=
"json-property-range" title=
"Value limits"></span>
8292 <span class=
"json-property-required"></span>
8295 <p>The updated role of the user
</p>
8300 <div class=
"doc-examples">
8303 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8304 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
8305 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
8306 <span class=
"hljs-attr">"videoQuota
"</span>:
<span class=
"hljs-string">"string
"</span>,
8307 <span class=
"hljs-attr">"role
"</span>:
<span class=
"hljs-string">"string
"</span>
8315 <div id=
"definition-UpdateMe" class=
"definition panel" data-traverse-target=
"definition-UpdateMe">
8316 <h2 class=
"panel-title">
8317 <a name=
"/definitions/UpdateMe"></a>UpdateMe:
8318 <!-- <span class="json-property-type">
8319 <span class="json-property-type">object</span>
8320 <span class="json-property-range" title="Value limits"></span>
8325 <div class=
"doc-row">
8326 <div class=
"doc-copy">
8327 <section class=
"json-schema-properties">
8329 <dt data-property-name=
"password" class=
"has-description">
8330 <span class=
"json-property-name">password:
</span>
8331 <span class=
"json-property-type">string
</span>
8332 <span class=
"json-property-range" title=
"Value limits"></span>
8333 <span class=
"json-property-required"></span>
8336 <p>Your new password
</p>
8338 <dt data-property-name=
"email" class=
"has-description">
8339 <span class=
"json-property-name">email:
</span>
8340 <span class=
"json-property-type">string
</span>
8341 <span class=
"json-property-range" title=
"Value limits"></span>
8342 <span class=
"json-property-required"></span>
8345 <p>Your new email
</p>
8347 <dt data-property-name=
"displayNSFW" class=
"has-description">
8348 <span class=
"json-property-name">displayNSFW:
</span>
8349 <span class=
"json-property-type">string
</span>
8350 <span class=
"json-property-range" title=
"Value limits"></span>
8351 <span class=
"json-property-required"></span>
8354 <p>Your new displayNSFW
</p>
8356 <dt data-property-name=
"autoPlayVideo" class=
"has-description">
8357 <span class=
"json-property-name">autoPlayVideo:
</span>
8358 <span class=
"json-property-type">string
</span>
8359 <span class=
"json-property-range" title=
"Value limits"></span>
8360 <span class=
"json-property-required"></span>
8363 <p>Your new autoPlayVideo
</p>
8368 <div class=
"doc-examples">
8371 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8372 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
8373 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>,
8374 <span class=
"hljs-attr">"displayNSFW
"</span>:
<span class=
"hljs-string">"string
"</span>,
8375 <span class=
"hljs-attr">"autoPlayVideo
"</span>:
<span class=
"hljs-string">"string
"</span>
8383 <div id=
"definition-GetMeVideoRating" class=
"definition panel" data-traverse-target=
"definition-GetMeVideoRating">
8384 <h2 class=
"panel-title">
8385 <a name=
"/definitions/GetMeVideoRating"></a>GetMeVideoRating:
8386 <!-- <span class="json-property-type">
8387 <span class="json-property-type">object</span>
8388 <span class="json-property-range" title="Value limits"></span>
8393 <div class=
"doc-row">
8394 <div class=
"doc-copy">
8395 <section class=
"json-schema-properties">
8397 <dt data-property-name=
"id" class=
"has-description">
8398 <span class=
"json-property-name">id:
</span>
8399 <span class=
"json-property-type">string
</span>
8400 <span class=
"json-property-range" title=
"Value limits"></span>
8401 <span class=
"json-property-required"></span>
8404 <p>Id of the video
</p>
8406 <dt data-property-name=
"rating" class=
"has-description">
8407 <span class=
"json-property-name">rating:
</span>
8408 <span class=
"json-property-type">number
</span>
8409 <span class=
"json-property-range" title=
"Value limits"></span>
8410 <span class=
"json-property-required"></span>
8413 <p>Rating of the video
</p>
8418 <div class=
"doc-examples">
8421 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8422 <span class=
"hljs-attr">"id
"</span>:
<span class=
"hljs-string">"string
"</span>,
8423 <span class=
"hljs-attr">"rating
"</span>:
<span class=
"hljs-string">"number
"</span>
8431 <div id=
"definition-RegisterUser" class=
"definition panel" data-traverse-target=
"definition-RegisterUser">
8432 <h2 class=
"panel-title">
8433 <a name=
"/definitions/RegisterUser"></a>RegisterUser:
8434 <!-- <span class="json-property-type">
8435 <span class="json-property-type">object</span>
8436 <span class="json-property-range" title="Value limits"></span>
8441 <div class=
"doc-row">
8442 <div class=
"doc-copy">
8443 <section class=
"json-schema-properties">
8445 <dt data-property-name=
"username" class=
"has-description">
8446 <span class=
"json-property-name">username:
</span>
8447 <span class=
"json-property-type">string
</span>
8448 <span class=
"json-property-range" title=
"Value limits"></span>
8449 <span class=
"json-property-required"></span>
8452 <p>The username of the user
</p>
8454 <dt data-property-name=
"password" class=
"has-description">
8455 <span class=
"json-property-name">password:
</span>
8456 <span class=
"json-property-type">string
</span>
8457 <span class=
"json-property-range" title=
"Value limits"></span>
8458 <span class=
"json-property-required"></span>
8461 <p>The password of the user
</p>
8463 <dt data-property-name=
"email" class=
"has-description">
8464 <span class=
"json-property-name">email:
</span>
8465 <span class=
"json-property-type">string
</span>
8466 <span class=
"json-property-range" title=
"Value limits"></span>
8467 <span class=
"json-property-required"></span>
8470 <p>The email of the user
</p>
8475 <div class=
"doc-examples">
8478 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8479 <span class=
"hljs-attr">"username
"</span>:
<span class=
"hljs-string">"string
"</span>,
8480 <span class=
"hljs-attr">"password
"</span>:
<span class=
"hljs-string">"string
"</span>,
8481 <span class=
"hljs-attr">"email
"</span>:
<span class=
"hljs-string">"string
"</span>
8489 <div id=
"definition-VideoChannelInput" class=
"definition panel" data-traverse-target=
"definition-VideoChannelInput">
8490 <h2 class=
"panel-title">
8491 <a name=
"/definitions/VideoChannelInput"></a>VideoChannelInput:
8492 <!-- <span class="json-property-type">
8493 <span class="json-property-type">object</span>
8494 <span class="json-property-range" title="Value limits"></span>
8499 <div class=
"doc-row">
8500 <div class=
"doc-copy">
8501 <section class=
"json-schema-properties">
8503 <dt data-property-name=
"name">
8504 <span class=
"json-property-name">name:
</span>
8505 <span class=
"json-property-type">string
</span>
8506 <span class=
"json-property-range" title=
"Value limits"></span>
8508 <dt data-property-name=
"description">
8509 <span class=
"json-property-name">description:
</span>
8510 <span class=
"json-property-type">string
</span>
8511 <span class=
"json-property-range" title=
"Value limits"></span>
8516 <div class=
"doc-examples">
8519 <!-- <div class="hljs"> --><pre><code class=
"hljs lang-json">{
8520 <span class=
"hljs-attr">"name
"</span>:
<span class=
"hljs-string">"string
"</span>,
8521 <span class=
"hljs-attr">"description
"</span>:
<span class=
"hljs-string">"string
"</span>
8529 <div class=
"doc-row no-margin">
8530 <div class=
"doc-copy doc-separator">
8531 <a class=
"powered-by" href=
"https://sourcey.com/spectacle">Documentation by
8532 <span>Spectacle
</span>