7421 lines
392 KiB
HTML
7421 lines
392 KiB
HTML
<!doctype html>
|
||
<html class="no-js" lang="en">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>PeerTube | API Reference</title>
|
||
<link rel="stylesheet" href="stylesheets/foundation.min.css" />
|
||
<link rel="stylesheet" href="stylesheets/spectacle.min.css" />
|
||
<script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
|
||
<!-- <script src="javascripts/foundation.js"></script> -->
|
||
<script src="javascripts/spectacle.min.js"></script>
|
||
</head>
|
||
<body id="spectacle">
|
||
<div id="page" class="drawer-layout drawer-slide-right-large">
|
||
<div id="sidebar">
|
||
<button class="close-button" aria-label="Close menu" type="button" data-drawer-close>
|
||
<span aria-hidden="true">×</span>
|
||
</button>
|
||
<nav id="nav" role="navigation">
|
||
<h5>Topics</h5>
|
||
<a href="#introduction">Introduction</a>
|
||
<h5>Operations</h5>
|
||
<section>
|
||
<a href="#tag-Accounts">Accounts</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--accounts--id--get"> GET /accounts/{id} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--accounts-get"> GET /accounts </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-Config">Config</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--config-get"> GET /config </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-Job">Job</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--jobs-get"> GET /jobs </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-ServerFollowing">ServerFollowing</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--server-following--host--delete"> DELETE /server/following/{host} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--server-followers-get"> GET /server/followers </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--server-following-get"> GET /server/following </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--server-following-post"> POST /server/following </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-User">User</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--users-post"> POST /users </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--users-get"> GET /users </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--users--id--delete"> DELETE /users/{id} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--users--id--get"> GET /users/{id} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--users--id--put"> PUT /users/{id} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--users-me-get"> GET /users/me </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--users-me-put"> PUT /users/me </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--users-me-videos-get"> GET /users/me/videos </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--users-register-post"> POST /users/register </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-Video">Video</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--videos-get"> GET /videos </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos-categories-get"> GET /videos/categories </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos-licences-get"> GET /videos/licences </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos-languages-get"> GET /videos/languages </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos-privacies-get"> GET /videos/privacies </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos-search-get"> GET /videos/search </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos--id--put"> PUT /videos/{id} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos--id--get"> GET /videos/{id} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos--id--delete"> DELETE /videos/{id} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos--id--description-get"> GET /videos/{id}/description </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos--id--views-post"> POST /videos/{id}/views </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos-upload-post"> POST /videos/upload </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-VideoAbuse">VideoAbuse</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--videos-abuse-get"> GET /videos/abuse </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos--id--abuse-post"> POST /videos/{id}/abuse </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-VideoBlacklist">VideoBlacklist</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--videos--videoId--blacklist-post"> POST /videos/{videoId}/blacklist </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos--videoId--blacklist-delete"> DELETE /videos/{videoId}/blacklist </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos-blacklist-get"> GET /videos/blacklist </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-VideoChannel">VideoChannel</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--videos-channels-get"> GET /videos/channels </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos-channels-post"> POST /videos/channels </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos-channels--id--get"> GET /videos/channels/{id} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos-channels--id--put"> PUT /videos/channels/{id} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos-channels--id--delete"> DELETE /videos/channels/{id} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos-accounts--accountId--channels-get"> GET /videos/accounts/{accountId}/channels </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-VideoComment">VideoComment</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--videos--videoId--comment-threads-get"> GET /videos/{videoId}/comment-threads </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos--videoId--comment-threads-post"> POST /videos/{videoId}/comment-threads </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos--videoId--comment-threads--threadId--get"> GET /videos/{videoId}/comment-threads/{threadId} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos--videoId--comments--commentId--post"> POST /videos/{videoId}/comments/{commentId} </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--videos--videoId--comments--commentId--delete"> DELETE /videos/{videoId}/comments/{commentId} </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-VideoRate">VideoRate</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--videos--id--rate-put"> PUT /videos/{id}/rate </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<h5>Schema Definitions</h5>
|
||
<a href="#definition-VideoConstant"> VideoConstant </a>
|
||
<a href="#definition-VideoPrivacy"> VideoPrivacy </a>
|
||
<a href="#definition-Video"> Video </a>
|
||
<a href="#definition-VideoAbuse"> VideoAbuse </a>
|
||
<a href="#definition-VideoBlacklist"> VideoBlacklist </a>
|
||
<a href="#definition-VideoChannel"> VideoChannel </a>
|
||
<a href="#definition-VideoComment"> VideoComment </a>
|
||
<a href="#definition-VideoCommentThreadTree"> VideoCommentThreadTree </a>
|
||
<a href="#definition-Avatar"> Avatar </a>
|
||
<a href="#definition-Actor"> Actor </a>
|
||
<a href="#definition-Account"> Account </a>
|
||
<a href="#definition-User"> User </a>
|
||
<a href="#definition-ServerConfig"> ServerConfig </a>
|
||
<a href="#definition-Follow"> Follow </a>
|
||
<a href="#definition-Job"> Job </a>
|
||
<a href="#definition-AddUserResponse"> AddUserResponse </a>
|
||
<a href="#definition-VideoUploadResponse"> VideoUploadResponse </a>
|
||
<a href="#definition-CommentThreadResponse"> CommentThreadResponse </a>
|
||
<a href="#definition-CommentThreadPostResponse"> CommentThreadPostResponse </a>
|
||
<a href="#definition-AddUser"> AddUser </a>
|
||
<a href="#definition-UpdateUser"> UpdateUser </a>
|
||
<a href="#definition-UpdateMe"> UpdateMe </a>
|
||
<a href="#definition-GetMeVideoRating"> GetMeVideoRating </a>
|
||
<a href="#definition-RegisterUser"> RegisterUser </a>
|
||
<a href="#definition-VideoChannelInput"> VideoChannelInput </a>
|
||
</nav>
|
||
</div>
|
||
<div id="docs" class="row collapse expanded drawer" data-drawer>
|
||
<button class="floating-menu-icon" type="button" data-drawer-slide="right">
|
||
<span class="hamburger"></span>
|
||
</button>
|
||
<div class="example-box doc-content"></div>
|
||
<article>
|
||
<h1 class="doc-title">PeerTube
|
||
<span>API Reference</span>
|
||
</h1>
|
||
<div id="introduction" data-traverse-target="introduction">
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.</p>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>API Endpoint</h5>
|
||
<!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre>
|
||
<!-- </div> -->
|
||
<h5>Schemes:
|
||
<span>https</span>
|
||
</h5>
|
||
<h5>Version:
|
||
<span>1.0.0-beta</span>
|
||
</h5>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1>
|
||
<div id="operation--accounts--id--get" class="operation panel" data-traverse-target="operation--accounts--id--get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Accounts">Accounts</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/accounts/{id}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The id of the account</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">start</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>starting page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">stop</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>stopping page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">sort</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>sorting</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Account">Account</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--accounts-get" class="operation panel" data-traverse-target="operation--accounts-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Accounts">Accounts</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/accounts</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy"> </div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Account">Account</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Account">Account</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-Config" class="swagger-summary-tag" data-traverse-target="tag-Config">Config</h1>
|
||
<div id="operation--config-get" class="operation panel" data-traverse-target="operation--config-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Config">Config</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/config</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy"> </div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/ServerConfig">ServerConfig</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"signup"</span>: {
|
||
<span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"transcoding"</span>: {
|
||
<span class="hljs-attr">"enabledResolutions"</span>: [
|
||
<span class="hljs-string">"number"</span>
|
||
]
|
||
},
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"file"</span>: {
|
||
<span class="hljs-attr">"size"</span>: {
|
||
<span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"extensions"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
},
|
||
<span class="hljs-attr">"video"</span>: {
|
||
<span class="hljs-attr">"file"</span>: {
|
||
<span class="hljs-attr">"extensions"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1>
|
||
<div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Job">Job</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/jobs</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">state</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The id of the account</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">start</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>starting page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">count</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">sort</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>sorting</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Job">Job</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Job">Job</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-ServerFollowing" class="swagger-summary-tag" data-traverse-target="tag-ServerFollowing">ServerFollowing</h1>
|
||
<div id="operation--server-following--host--delete" class="operation panel" data-traverse-target="operation--server-following--host--delete">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">DELETE</span>
|
||
<span class="operation-path">/server/following/{host}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">host</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The host to unfollow </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">201 Created</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--server-followers-get" class="operation panel" data-traverse-target="operation--server-followers-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/server/followers</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">start</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>starting page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">stop</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>stopping page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">sort</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>sorting</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"follower"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"following"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--server-following-get" class="operation panel" data-traverse-target="operation--server-following-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/server/following</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">start</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>starting page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">stop</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>stopping page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">sort</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>sorting</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"follower"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"following"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--server-following-post" class="operation panel" data-traverse-target="operation--server-following-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ServerFollowing">ServerFollowing</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">POST</span>
|
||
<span class="operation-path">/server/following</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<div class="prop-row">
|
||
<div class="prop-name">
|
||
<div class="swagger-request-model">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Follow">Follow</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value columns small-6">
|
||
<!-- <div class="swagger-request-description"> -->
|
||
<p>undefined</p>
|
||
<!-- </div> -->
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"follower"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"following"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-User" class="swagger-summary-tag" data-traverse-target="tag-User">User</h1>
|
||
<div id="operation--users-post" class="operation panel" data-traverse-target="operation--users-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User">User</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">POST</span>
|
||
<span class="operation-path">/users</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<div class="prop-row">
|
||
<div class="prop-name">
|
||
<div class="swagger-request-model">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/AddUser">AddUser</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value columns small-6">
|
||
<!-- <div class="swagger-request-description"> -->
|
||
<p>User to create</p>
|
||
<!-- </div> -->
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/AddUserResponse">AddUserResponse</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--users-get" class="operation panel" data-traverse-target="operation--users-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User">User</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/users</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">start</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>starting page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">stop</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>stopping page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">sort</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>sorting</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/User">User</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/User">User</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"videoChannels"</span>: [
|
||
{
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"owner"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"videos"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--users--id--delete" class="operation panel" data-traverse-target="operation--users--id--delete">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User">User</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">DELETE</span>
|
||
<span class="operation-path">/users/{id}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The user id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--users--id--get" class="operation panel" data-traverse-target="operation--users--id--get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User">User</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/users/{id}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The user id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/User">User</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"videoChannels"</span>: [
|
||
{
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"owner"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"videos"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--users--id--put" class="operation panel" data-traverse-target="operation--users--id--put">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User">User</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">PUT</span>
|
||
<span class="operation-path">/users/{id}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<div class="prop-row">
|
||
<div class="prop-name">
|
||
<div class="swagger-request-model">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/UpdateUser">UpdateUser</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value columns small-6">
|
||
<!-- <div class="swagger-request-description"> -->
|
||
<p>undefined</p>
|
||
<!-- </div> -->
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The user id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--users-me-get" class="operation panel" data-traverse-target="operation--users-me-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User">User</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/users/me</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy"> </div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/User">User</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/User">User</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"videoChannels"</span>: [
|
||
{
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"owner"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"videos"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--users-me-put" class="operation panel" data-traverse-target="operation--users-me-put">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User">User</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">PUT</span>
|
||
<span class="operation-path">/users/me</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<div class="prop-row">
|
||
<div class="prop-name">
|
||
<div class="swagger-request-model">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/UpdateMe">UpdateMe</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value columns small-6">
|
||
<!-- <div class="swagger-request-description"> -->
|
||
<p>undefined</p>
|
||
<!-- </div> -->
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--users-me-video-quota-used-get" class="operation panel" data-traverse-target="operation--users-me-video-quota-used-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User">User</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/users/me/video-quota-used</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy"> </div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref"></div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"number"</span>
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--users-me-videos--videoId--rating-get" class="operation panel" data-traverse-target="operation--users-me-videos--videoId--rating-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User">User</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/users/me/videos/{videoId}/rating</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">videoId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/GetMeVideoRating">GetMeVideoRating</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--users-me-videos-get" class="operation panel" data-traverse-target="operation--users-me-videos-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User">User</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/users/me/videos</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">start</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>starting page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">stop</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>stopping page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">sort</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>sorting</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Video">Video</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Video">Video</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--users-register-post" class="operation panel" data-traverse-target="operation--users-register-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User">User</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">POST</span>
|
||
<span class="operation-path">/users/register</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<div class="prop-row">
|
||
<div class="prop-name">
|
||
<div class="swagger-request-model">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/RegisterUser">RegisterUser</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value columns small-6">
|
||
<!-- <div class="swagger-request-description"> -->
|
||
<p>undefined</p>
|
||
<!-- </div> -->
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--users-me-avatar-pick-post" class="operation panel" data-traverse-target="operation--users-me-avatar-pick-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User">User</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">POST</span>
|
||
<span class="operation-path">/users/me/avatar/pick</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">avatarfile</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">file</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The file to upload.</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-Video" class="swagger-summary-tag" data-traverse-target="tag-Video">Video</h1>
|
||
<div id="operation--videos-get" class="operation panel" data-traverse-target="operation--videos-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Video">Video</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">start</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>starting page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">stop</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>stopping page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">sort</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>sorting</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Video">Video</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Video">Video</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos-categories-get" class="operation panel" data-traverse-target="operation--videos-categories-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Video">Video</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/categories</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy"> </div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref"></div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">string[]</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos-licences-get" class="operation panel" data-traverse-target="operation--videos-licences-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Video">Video</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/licences</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy"> </div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref"></div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">string[]</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos-languages-get" class="operation panel" data-traverse-target="operation--videos-languages-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Video">Video</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/languages</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy"> </div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref"></div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">string[]</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos-privacies-get" class="operation panel" data-traverse-target="operation--videos-privacies-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Video">Video</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/privacies</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy"> </div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref"></div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">string[]</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos-search-get" class="operation panel" data-traverse-target="operation--videos-search-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Video">Video</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/search</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">start</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>starting page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">stop</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>stopping page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">sort</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>sorting</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Video">Video</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Video">Video</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos--id--put" class="operation panel" data-traverse-target="operation--videos--id--put">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Video">Video</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">PUT</span>
|
||
<span class="operation-path">/videos/{id}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">thumbnailfile</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">file</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video thumbnail file</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">previewfile</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">file</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video preview file</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">category</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video category</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">licence</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video licence</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">language</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video language</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">description</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video description</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">support</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Text describing how to support the video uploader</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">nsfw</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">boolean</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Whether or not this video contains sensitive content</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">name</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video name</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">tags</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string[]</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video tags</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">commentsEnabled</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">boolean</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Enable or disable comments for this video</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">privacy</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">Public</span>,
|
||
<span class="json-property-enum-item">Unlisted</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video privacy</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Video">Video</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos--id--get" class="operation panel" data-traverse-target="operation--videos--id--get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Video">Video</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/{id}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Video">Video</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos--id--delete" class="operation panel" data-traverse-target="operation--videos--id--delete">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Video">Video</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">DELETE</span>
|
||
<span class="operation-path">/videos/{id}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos--id--description-get" class="operation panel" data-traverse-target="operation--videos--id--description-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Video">Video</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/{id}/description</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref"></div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"string"</span>
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos--id--views-post" class="operation panel" data-traverse-target="operation--videos--id--views-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Video">Video</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">POST</span>
|
||
<span class="operation-path">/videos/{id}/views</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos-upload-post" class="operation panel" data-traverse-target="operation--videos-upload-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Video">Video</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">POST</span>
|
||
<span class="operation-path">/videos/upload</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">videofile</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">file</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video file</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">thumbnailfile</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">file</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video thumbnail file</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">previewfile</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">file</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video preview file</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">category</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video category</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">licence</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video licence</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">language</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video language</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">description</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video description</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">support</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Text describing how to support the video uploader</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">channelId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Channel id that will contain this video</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">nsfw</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">boolean</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Whether or not this video contains sensitive content</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">name</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video name</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">tags</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string[]</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video tags</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">commentsEnabled</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">boolean</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Enable or disable comments for this video</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">privacy</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">Public</span>,
|
||
<span class="json-property-enum-item">Unlisted</span>,
|
||
<span class="json-property-enum-item">Private</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Video privacy</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/VideoUploadResponse">VideoUploadResponse</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"video"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-VideoAbuse" class="swagger-summary-tag" data-traverse-target="tag-VideoAbuse">VideoAbuse</h1>
|
||
<div id="operation--videos-abuse-get" class="operation panel" data-traverse-target="operation--videos-abuse-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoAbuse">VideoAbuse</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/abuse</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">start</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>starting page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">stop</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>stopping page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">sort</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>sorting</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"reporterAccount"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"video"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos--id--abuse-post" class="operation panel" data-traverse-target="operation--videos--id--abuse-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoAbuse">VideoAbuse</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">POST</span>
|
||
<span class="operation-path">/videos/{id}/abuse</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-VideoBlacklist" class="swagger-summary-tag" data-traverse-target="tag-VideoBlacklist">VideoBlacklist</h1>
|
||
<div id="operation--videos--videoId--blacklist-post" class="operation panel" data-traverse-target="operation--videos--videoId--blacklist-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">POST</span>
|
||
<span class="operation-path">/videos/{videoId}/blacklist</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">videoId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos--videoId--blacklist-delete" class="operation panel" data-traverse-target="operation--videos--videoId--blacklist-delete">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">DELETE</span>
|
||
<span class="operation-path">/videos/{videoId}/blacklist</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">videoId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos-blacklist-get" class="operation panel" data-traverse-target="operation--videos-blacklist-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/blacklist</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">start</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>starting page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">stop</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>stopping page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">sort</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>sorting</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1>
|
||
<div id="operation--videos-channels-get" class="operation panel" data-traverse-target="operation--videos-channels-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoChannel">VideoChannel</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/channels</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">start</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>starting page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">stop</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>stopping page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">sort</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>sorting</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"owner"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"videos"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos-channels-post" class="operation panel" data-traverse-target="operation--videos-channels-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoChannel">VideoChannel</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">POST</span>
|
||
<span class="operation-path">/videos/channels</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<div class="prop-row">
|
||
<div class="prop-name">
|
||
<div class="swagger-request-model">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value columns small-6">
|
||
<!-- <div class="swagger-request-description"> -->
|
||
<p>undefined</p>
|
||
<!-- </div> -->
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos-channels--id--get" class="operation panel" data-traverse-target="operation--videos-channels--id--get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoChannel">VideoChannel</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/channels/{id}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"owner"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"videos"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos-channels--id--put" class="operation panel" data-traverse-target="operation--videos-channels--id--put">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoChannel">VideoChannel</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">PUT</span>
|
||
<span class="operation-path">/videos/channels/{id}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<div class="prop-row">
|
||
<div class="prop-name">
|
||
<div class="swagger-request-model">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value columns small-6">
|
||
<!-- <div class="swagger-request-description"> -->
|
||
<p>undefined</p>
|
||
<!-- </div> -->
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos-channels--id--delete" class="operation panel" data-traverse-target="operation--videos-channels--id--delete">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoChannel">VideoChannel</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">DELETE</span>
|
||
<span class="operation-path">/videos/channels/{id}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos-accounts--accountId--channels-get" class="operation panel" data-traverse-target="operation--videos-accounts--accountId--channels-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoChannel">VideoChannel</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/accounts/{accountId}/channels</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">accountId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The account id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"owner"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"videos"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1>
|
||
<div id="operation--videos--videoId--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoComment">VideoComment</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/{videoId}/comment-threads</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">videoId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">start</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>starting page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">stop</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>stopping page</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">sort</div>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>sorting</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/CommentThreadResponse">CommentThreadResponse</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"data"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos--videoId--comment-threads-post" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoComment">VideoComment</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">POST</span>
|
||
<span class="operation-path">/videos/{videoId}/comment-threads</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">videoId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"comment"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos--videoId--comment-threads--threadId--get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads--threadId--get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoComment">VideoComment</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">GET</span>
|
||
<span class="operation-path">/videos/{videoId}/comment-threads/{threadId}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">videoId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">threadId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The thread id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"comment"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
},
|
||
<span class="hljs-attr">"children"</span>: [
|
||
{
|
||
<span class="hljs-attr">"comment"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
},
|
||
<span class="hljs-attr">"children"</span>: [
|
||
{
|
||
<span class="hljs-attr">"comment"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos--videoId--comments--commentId--post" class="operation panel" data-traverse-target="operation--videos--videoId--comments--commentId--post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoComment">VideoComment</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">POST</span>
|
||
<span class="operation-path">/videos/{videoId}/comments/{commentId}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">videoId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">commentId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The comment id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"comment"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--videos--videoId--comments--commentId--delete" class="operation panel" data-traverse-target="operation--videos--videoId--comments--commentId--delete">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoComment">VideoComment</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">DELETE</span>
|
||
<span class="operation-path">/videos/{videoId}/comments/{commentId}</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">videoId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">commentId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The comment id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-VideoRate" class="swagger-summary-tag" data-traverse-target="tag-VideoRate">VideoRate</h1>
|
||
<div id="operation--videos--id--rate-put" class="operation panel" data-traverse-target="operation--videos--id--rate-put">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-VideoRate">VideoRate</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-name">
|
||
<span class="operation-name">PUT</span>
|
||
<span class="operation-path">/videos/{id}/rate</span>
|
||
</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">id</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The video id </p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">204 No Content</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1>Schema Definitions</h1>
|
||
<div id="definition-VideoConstant" class="definition panel" data-traverse-target="definition-VideoConstant">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/VideoConstant"></a>VideoConstant:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="label">
|
||
<span class="json-property-name">label:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-VideoPrivacy" class="definition panel" data-traverse-target="definition-VideoPrivacy">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/VideoPrivacy"></a>VideoPrivacy: string
|
||
<!-- <span class="json-property-type"><span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">Public</span>,
|
||
<span class="json-property-enum-item">Unlisted</span>,
|
||
<span class="json-property-enum-item">Private</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">Public</span>,
|
||
<span class="json-property-enum-item">Unlisted</span>,
|
||
<span class="json-property-enum-item">Private</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Video" class="definition panel" data-traverse-target="definition-Video">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Video"></a>Video:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="uuid">
|
||
<span class="json-property-name">uuid:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="createdAt">
|
||
<span class="json-property-name">createdAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="publishedAt">
|
||
<span class="json-property-name">publishedAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="updatedAt">
|
||
<span class="json-property-name">updatedAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="category">
|
||
<span class="json-property-name">category:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="licence">
|
||
<span class="json-property-name">licence:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="language">
|
||
<span class="json-property-name">language:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="privacy">
|
||
<span class="json-property-name">privacy:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/VideoPrivacy">VideoPrivacy</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="description">
|
||
<span class="json-property-name">description:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="duration">
|
||
<span class="json-property-name">duration:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="isLocal">
|
||
<span class="json-property-name">isLocal:</span>
|
||
<span class="json-property-type">boolean</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="name">
|
||
<span class="json-property-name">name:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="thumbnailPath">
|
||
<span class="json-property-name">thumbnailPath:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="previewPath">
|
||
<span class="json-property-name">previewPath:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="embedPath">
|
||
<span class="json-property-name">embedPath:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="views">
|
||
<span class="json-property-name">views:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="likes">
|
||
<span class="json-property-name">likes:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="dislikes">
|
||
<span class="json-property-name">dislikes:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="nsfw">
|
||
<span class="json-property-name">nsfw:</span>
|
||
<span class="json-property-type">boolean</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="account">
|
||
<span class="json-property-name">account:</span>
|
||
<span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-VideoAbuse" class="definition panel" data-traverse-target="definition-VideoAbuse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/VideoAbuse"></a>VideoAbuse:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="reason">
|
||
<span class="json-property-name">reason:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="reporterAccount">
|
||
<span class="json-property-name">reporterAccount:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Account">Account</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="video">
|
||
<span class="json-property-name">video:</span>
|
||
<span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="createdAt">
|
||
<span class="json-property-name">createdAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"reporterAccount"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"video"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-VideoBlacklist" class="definition panel" data-traverse-target="definition-VideoBlacklist">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/VideoBlacklist"></a>VideoBlacklist:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="videoId">
|
||
<span class="json-property-name">videoId:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="createdAt">
|
||
<span class="json-property-name">createdAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="updatedAt">
|
||
<span class="json-property-name">updatedAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="name">
|
||
<span class="json-property-name">name:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="uuid">
|
||
<span class="json-property-name">uuid:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="description">
|
||
<span class="json-property-name">description:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="duration">
|
||
<span class="json-property-name">duration:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="views">
|
||
<span class="json-property-name">views:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="likes">
|
||
<span class="json-property-name">likes:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="dislikes">
|
||
<span class="json-property-name">dislikes:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="nsfw">
|
||
<span class="json-property-name">nsfw:</span>
|
||
<span class="json-property-type">boolean</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-VideoChannel" class="definition panel" data-traverse-target="definition-VideoChannel">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/VideoChannel"></a>VideoChannel:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="displayName">
|
||
<span class="json-property-name">displayName:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="description">
|
||
<span class="json-property-name">description:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="isLocal">
|
||
<span class="json-property-name">isLocal:</span>
|
||
<span class="json-property-type">boolean</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="owner">
|
||
<span class="json-property-name">owner:</span>
|
||
<span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="videos">
|
||
<span class="json-property-name">videos:</span>
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Video">Video</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"owner"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"videos"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-VideoComment" class="definition panel" data-traverse-target="definition-VideoComment">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/VideoComment"></a>VideoComment:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="url">
|
||
<span class="json-property-name">url:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="text">
|
||
<span class="json-property-name">text:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="threadId">
|
||
<span class="json-property-name">threadId:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="inReplyToCommentId">
|
||
<span class="json-property-name">inReplyToCommentId:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="videoId">
|
||
<span class="json-property-name">videoId:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="createdAt">
|
||
<span class="json-property-name">createdAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="updatedAt">
|
||
<span class="json-property-name">updatedAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="totalReplies">
|
||
<span class="json-property-name">totalReplies:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="account">
|
||
<span class="json-property-name">account:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Account">Account</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-VideoCommentThreadTree" class="definition panel" data-traverse-target="definition-VideoCommentThreadTree">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="comment">
|
||
<span class="json-property-name">comment:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="children">
|
||
<span class="json-property-name">children:</span>
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"comment"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
},
|
||
<span class="hljs-attr">"children"</span>: [
|
||
{
|
||
<span class="hljs-attr">"comment"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
},
|
||
<span class="hljs-attr">"children"</span>: [
|
||
{
|
||
<span class="hljs-attr">"comment"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Avatar" class="definition panel" data-traverse-target="definition-Avatar">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Avatar"></a>Avatar:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="path">
|
||
<span class="json-property-name">path:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="createdAt">
|
||
<span class="json-property-name">createdAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="updatedAt">
|
||
<span class="json-property-name">updatedAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Actor" class="definition panel" data-traverse-target="definition-Actor">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Actor"></a>Actor:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="uuid">
|
||
<span class="json-property-name">uuid:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="url">
|
||
<span class="json-property-name">url:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="name">
|
||
<span class="json-property-name">name:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="host">
|
||
<span class="json-property-name">host:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="followingCount">
|
||
<span class="json-property-name">followingCount:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="followersCount">
|
||
<span class="json-property-name">followersCount:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="createdAt">
|
||
<span class="json-property-name">createdAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="updatedAt">
|
||
<span class="json-property-name">updatedAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="avatar">
|
||
<span class="json-property-name">avatar:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Account" class="definition panel" data-traverse-target="definition-Account">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Account"></a>Account:
|
||
<!-- <span class="json-property-type"><span class="json-property-type"></span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-allOf">
|
||
<section class="json-schema-allOf-inherited">
|
||
<ul>
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Actor">Actor</a>
|
||
</span>
|
||
</ul>
|
||
</section>
|
||
<section class="json-schema-allOf-additional">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="displayName">
|
||
<span class="json-property-name">displayName:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-User" class="definition panel" data-traverse-target="definition-User">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/User"></a>User:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="username">
|
||
<span class="json-property-name">username:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="email">
|
||
<span class="json-property-name">email:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="displayNSFW">
|
||
<span class="json-property-name">displayNSFW:</span>
|
||
<span class="json-property-type">boolean</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="autoPlayVideo">
|
||
<span class="json-property-name">autoPlayVideo:</span>
|
||
<span class="json-property-type">boolean</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="role">
|
||
<span class="json-property-name">role:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">User</span>,
|
||
<span class="json-property-enum-item">Moderator</span>,
|
||
<span class="json-property-enum-item">Administrator</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="videoQuota">
|
||
<span class="json-property-name">videoQuota:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="createdAt">
|
||
<span class="json-property-name">createdAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="account">
|
||
<span class="json-property-name">account:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Account">Account</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="videoChannels">
|
||
<span class="json-property-name">videoChannels:</span>
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"videoChannels"</span>: [
|
||
{
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"owner"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"videos"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"licence"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"language"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ServerConfig" class="definition panel" data-traverse-target="definition-ServerConfig">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ServerConfig"></a>ServerConfig:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="signup">
|
||
<span class="json-property-name">signup:</span>
|
||
<span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="transcoding">
|
||
<span class="json-property-name">transcoding:</span>
|
||
<span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="avatar">
|
||
<span class="json-property-name">avatar:</span>
|
||
<span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="video">
|
||
<span class="json-property-name">video:</span>
|
||
<span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"signup"</span>: {
|
||
<span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"transcoding"</span>: {
|
||
<span class="hljs-attr">"enabledResolutions"</span>: [
|
||
<span class="hljs-string">"number"</span>
|
||
]
|
||
},
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"file"</span>: {
|
||
<span class="hljs-attr">"size"</span>: {
|
||
<span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"extensions"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
},
|
||
<span class="hljs-attr">"video"</span>: {
|
||
<span class="hljs-attr">"file"</span>: {
|
||
<span class="hljs-attr">"extensions"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Follow" class="definition panel" data-traverse-target="definition-Follow">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Follow"></a>Follow:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="follower">
|
||
<span class="json-property-name">follower:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Actor">Actor</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="following">
|
||
<span class="json-property-name">following:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Actor">Actor</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="score">
|
||
<span class="json-property-name">score:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="state">
|
||
<span class="json-property-name">state:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">pending</span>,
|
||
<span class="json-property-enum-item">accepted</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="createdAt">
|
||
<span class="json-property-name">createdAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="updatedAt">
|
||
<span class="json-property-name">updatedAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"follower"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"following"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Job" class="definition panel" data-traverse-target="definition-Job">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Job"></a>Job:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="state">
|
||
<span class="json-property-name">state:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">pending</span>,
|
||
<span class="json-property-enum-item">processing</span>,
|
||
<span class="json-property-enum-item">error</span>,
|
||
<span class="json-property-enum-item">success</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="category">
|
||
<span class="json-property-name">category:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">transcoding</span>,
|
||
<span class="json-property-enum-item">activitypub-http</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="handlerName">
|
||
<span class="json-property-name">handlerName:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="handlerInputData">
|
||
<span class="json-property-name">handlerInputData:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="createdAt">
|
||
<span class="json-property-name">createdAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="updatedAt">
|
||
<span class="json-property-name">updatedAt:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-AddUserResponse" class="definition panel" data-traverse-target="definition-AddUserResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/AddUserResponse"></a>AddUserResponse:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="uuid">
|
||
<span class="json-property-name">uuid:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-VideoUploadResponse" class="definition panel" data-traverse-target="definition-VideoUploadResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/VideoUploadResponse"></a>VideoUploadResponse:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="video">
|
||
<span class="json-property-name">video:</span>
|
||
<span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"video"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-CommentThreadResponse" class="definition panel" data-traverse-target="definition-CommentThreadResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/CommentThreadResponse"></a>CommentThreadResponse:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="total">
|
||
<span class="json-property-name">total:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="data">
|
||
<span class="json-property-name">data:</span>
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"data"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-CommentThreadPostResponse" class="definition panel" data-traverse-target="definition-CommentThreadPostResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="comment">
|
||
<span class="json-property-name">comment:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"comment"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"account"</span>: {
|
||
<span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"avatar"</span>: {
|
||
<span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-AddUser" class="definition panel" data-traverse-target="definition-AddUser">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/AddUser"></a>AddUser:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="username" class="has-description">
|
||
<span class="json-property-name">username:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>The user username </p>
|
||
</dd>
|
||
<dt data-property-name="password" class="has-description">
|
||
<span class="json-property-name">password:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>The user password </p>
|
||
</dd>
|
||
<dt data-property-name="email" class="has-description">
|
||
<span class="json-property-name">email:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>The user email </p>
|
||
</dd>
|
||
<dt data-property-name="videoQuota" class="has-description">
|
||
<span class="json-property-name">videoQuota:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>The user videoQuota </p>
|
||
</dd>
|
||
<dt data-property-name="role" class="has-description">
|
||
<span class="json-property-name">role:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>The user role </p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-UpdateUser" class="definition panel" data-traverse-target="definition-UpdateUser">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/UpdateUser"></a>UpdateUser:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id" class="has-description">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>The user id </p>
|
||
</dd>
|
||
<dt data-property-name="email" class="has-description">
|
||
<span class="json-property-name">email:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>The updated email of the user </p>
|
||
</dd>
|
||
<dt data-property-name="videoQuota" class="has-description">
|
||
<span class="json-property-name">videoQuota:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>The updated videoQuota of the user </p>
|
||
</dd>
|
||
<dt data-property-name="role" class="has-description">
|
||
<span class="json-property-name">role:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>The updated role of the user </p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-UpdateMe" class="definition panel" data-traverse-target="definition-UpdateMe">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/UpdateMe"></a>UpdateMe:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="password" class="has-description">
|
||
<span class="json-property-name">password:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>Your new password </p>
|
||
</dd>
|
||
<dt data-property-name="email" class="has-description">
|
||
<span class="json-property-name">email:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>Your new email </p>
|
||
</dd>
|
||
<dt data-property-name="displayNSFW" class="has-description">
|
||
<span class="json-property-name">displayNSFW:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>Your new displayNSFW </p>
|
||
</dd>
|
||
<dt data-property-name="autoPlayVideo" class="has-description">
|
||
<span class="json-property-name">autoPlayVideo:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>Your new autoPlayVideo </p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-GetMeVideoRating" class="definition panel" data-traverse-target="definition-GetMeVideoRating">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/GetMeVideoRating"></a>GetMeVideoRating:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id" class="has-description">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>Id of the video </p>
|
||
</dd>
|
||
<dt data-property-name="rating" class="has-description">
|
||
<span class="json-property-name">rating:</span>
|
||
<span class="json-property-type">number</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>Rating of the video </p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-RegisterUser" class="definition panel" data-traverse-target="definition-RegisterUser">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/RegisterUser"></a>RegisterUser:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="username" class="has-description">
|
||
<span class="json-property-name">username:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>The username of the user </p>
|
||
</dd>
|
||
<dt data-property-name="password" class="has-description">
|
||
<span class="json-property-name">password:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>The password of the user </p>
|
||
</dd>
|
||
<dt data-property-name="email" class="has-description">
|
||
<span class="json-property-name">email:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>The email of the user </p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-VideoChannelInput" class="definition panel" data-traverse-target="definition-VideoChannelInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/VideoChannelInput"></a>VideoChannelInput:
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="name">
|
||
<span class="json-property-name">name:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="description">
|
||
<span class="json-property-name">description:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row no-margin">
|
||
<div class="doc-copy doc-separator">
|
||
<a class="powered-by" href="https://sourcey.com/spectacle">Documentation by
|
||
<span>Spectacle</span>
|
||
</a>
|
||
</div>
|
||
</div>
|
||
</article>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html> |