<a href="#tag-Accounts">Accounts</a>
<ul>
<li>
- <a href="#operation--accounts--id--get"> GET /accounts/{id} </a>
+ <a href="#operation--accounts--name--get"> GET /accounts/{name} </a>
+ </li>
+ <li>
+ <a href="#operation--accounts--name--videos-get"> GET /accounts/{name}/videos </a>
</li>
<li>
<a href="#operation--accounts-get"> GET /accounts </a>
</li>
</ul>
</section>
+ <section>
+ <a href="#tag-Feeds">Feeds</a>
+ <ul>
+ <li>
+ <a href="#operation--feeds-videos.-format--get"> GET /feeds/videos.{format} </a>
+ </li>
+ </ul>
+ </section>
<section>
<a href="#tag-Job">Job</a>
<ul>
<a href="#tag-VideoChannel">VideoChannel</a>
<ul>
<li>
- <a href="#operation--videos-channels-get"> GET /videos/channels </a>
+ <a href="#operation--video-channels-get"> GET /video-channels </a>
</li>
<li>
- <a href="#operation--videos-channels-post"> POST /videos/channels </a>
+ <a href="#operation--video-channels-post"> POST /video-channels </a>
</li>
<li>
- <a href="#operation--videos-channels--id--get"> GET /videos/channels/{id} </a>
+ <a href="#operation--video-channels--id--get"> GET /video-channels/{id} </a>
</li>
<li>
- <a href="#operation--videos-channels--id--put"> PUT /videos/channels/{id} </a>
+ <a href="#operation--video-channels--id--put"> PUT /video-channels/{id} </a>
</li>
<li>
- <a href="#operation--videos-channels--id--delete"> DELETE /videos/channels/{id} </a>
+ <a href="#operation--video-channels--id--delete"> DELETE /video-channels/{id} </a>
</li>
<li>
- <a href="#operation--videos-accounts--accountId--channels-get"> GET /videos/accounts/{accountId}/channels </a>
+ <a href="#operation--video-channels--id--videos-get"> GET /video-channels/{id}/videos </a>
+ </li>
+ <li>
+ <a href="#operation--accounts--name--video-channels-get"> GET /accounts/{name}/video-channels </a>
</li>
</ul>
</section>
</ul>
</section>
<h5>Schema Definitions</h5>
- <a href="#definition-VideoConstant"> VideoConstant </a>
+ <a href="#definition-VideoConstantNumber"> VideoConstantNumber </a>
+ <a href="#definition-VideoConstantString"> VideoConstantString </a>
<a href="#definition-VideoPrivacy"> VideoPrivacy </a>
<a href="#definition-Video"> Video </a>
<a href="#definition-VideoAbuse"> VideoAbuse </a>
</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">
+ <div id="operation--accounts--name--get" class="operation panel" data-traverse-target="operation--accounts--name--get">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
<h2 class="operation-title">
<span class="operation-name">
<span class="operation-name">GET</span>
- <span class="operation-path">/accounts/{id}</span>
+ <span class="operation-path">/accounts/{name}</span>
</span>
</h2>
<div class="doc-row">
<section class="swagger-request-params">
<div class="prop-row prop-group">
<div class="prop-name">
- <div class="prop-title">id</div>
+ <div class="prop-title">name</div>
<span class="json-property-required"></span>
<div class="prop-subtitle"> in path </div>
<div class="prop-subtitle">
</div>
</div>
<div class="prop-value">
- <p>The id of the account</p>
+ <p>The name of the account (chocobozzz or
+ <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p>
</div>
</div>
<div class="prop-row prop-group">
<span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>
}
}
+</code></pre>
+ <!-- </div> -->
+ </section>
+ </div>
+ </div>
+ </div>
+ <div id="operation--accounts--name--videos-get" class="operation panel" data-traverse-target="operation--accounts--name--videos-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/{name}/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">name</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 name of the account (chocobozzz or
+ <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</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">"string"</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-Feeds" class="swagger-summary-tag" data-traverse-target="tag-Feeds">Feeds</h1>
+ <div id="operation--feeds-videos.-format--get" class="operation panel" data-traverse-target="operation--feeds-videos.-format--get">
+ <!-- <section class="operation-tags row"> -->
+ <!-- <div class="doc-copy"> -->
+ <div class="operation-tags">
+ <a class="label" href="#tag-Feeds">Feeds</a>
+ <!---->
+ </div>
+ <!-- </div> -->
+ <!-- </section> -->
+ <h2 class="operation-title">
+ <span class="operation-name">
+ <span class="operation-name">GET</span>
+ <span class="operation-path">/feeds/videos.{format}</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">format</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-enum" title="Possible values">
+ <span class="json-property-enum-item json-property-enum-default-value">xml</span>,
+ <span class="json-property-enum-item">atom</span>,
+ <span class="json-property-enum-item">json</span>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+ <span class="json-property-default-value" title="Default value">xml</span>
+ </div>
+ </div>
+ <div class="prop-value">
+ <p>The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0</p>
+ </div>
+ </div>
+ <div class="prop-row prop-group">
+ <div class="prop-name">
+ <div class="prop-title">accountId</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>The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds</p>
+ </div>
+ </div>
+ <div class="prop-row prop-group">
+ <div class="prop-name">
+ <div class="prop-title">accountName</div>
+ <div class="prop-subtitle"> in query </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 name of the local account to filter to</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>
+ <div class="prop-value">
+ <p>successful operation</p>
+ </div>
+ </div>
+ </section>
+ </div>
+ <div class="doc-examples">
+ <h5>Response Content-Types:
+ <span>application/atom+xml, application/rss+xml, application/json</span>
+ </h5>
+ </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"> -->
<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">"ownerAccount"</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">"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>
- }
- }
- }
- ]
+ }
}
]
}
<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">"ownerAccount"</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">"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>
- }
- }
- }
- ]
+ }
}
]
}
<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">"ownerAccount"</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">"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>
- }
- }
- }
- ]
+ }
}
]
}
<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">"id"</span>: <span class="hljs-string">"string"</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">"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">"id"</span>: <span class="hljs-string">"string"</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">"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">"id"</span>: <span class="hljs-string">"string"</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>,
<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-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</div>
</div>
<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">"id"</span>: <span class="hljs-string">"string"</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">"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">"id"</span>: <span class="hljs-string">"string"</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>,
<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-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</div>
</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">
+ <div id="operation--video-channels-get" class="operation panel" data-traverse-target="operation--video-channels-get">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
<h2 class="operation-title">
<span class="operation-name">
<span class="operation-name">GET</span>
- <span class="operation-path">/videos/channels</span>
+ <span class="operation-path">/video-channels</span>
</span>
</h2>
<div class="doc-row">
<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">"ownerAccount"</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">"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>
</div>
</div>
- <div id="operation--videos-channels-post" class="operation panel" data-traverse-target="operation--videos-channels-post">
+ <div id="operation--video-channels-post" class="operation panel" data-traverse-target="operation--video-channels-post">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
<h2 class="operation-title">
<span class="operation-name">
<span class="operation-name">POST</span>
- <span class="operation-path">/videos/channels</span>
+ <span class="operation-path">/video-channels</span>
</span>
</h2>
<div class="doc-row">
</div>
</div>
</div>
- <div id="operation--videos-channels--id--get" class="operation panel" data-traverse-target="operation--videos-channels--id--get">
+ <div id="operation--video-channels--id--get" class="operation panel" data-traverse-target="operation--video-channels--id--get">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
<h2 class="operation-title">
<span class="operation-name">
<span class="operation-name">GET</span>
- <span class="operation-path">/videos/channels/{id}</span>
+ <span class="operation-path">/video-channels/{id}</span>
</span>
</h2>
<div class="doc-row">
</div>
</div>
<div class="prop-value">
- <p>The video id </p>
+ <p>The video channel id </p>
</div>
</div>
</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>
- }
- }
- }
- ]
+ <!-- <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">"ownerAccount"</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> -->
</div>
</div>
</div>
- <div id="operation--videos-channels--id--put" class="operation panel" data-traverse-target="operation--videos-channels--id--put">
+ <div id="operation--video-channels--id--put" class="operation panel" data-traverse-target="operation--video-channels--id--put">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
<h2 class="operation-title">
<span class="operation-name">
<span class="operation-name">PUT</span>
- <span class="operation-path">/videos/channels/{id}</span>
+ <span class="operation-path">/video-channels/{id}</span>
</span>
</h2>
<div class="doc-row">
</div>
</div>
<div class="prop-value">
- <p>The video id </p>
+ <p>The video channel id </p>
</div>
</div>
</section>
</div>
</div>
</div>
- <div id="operation--videos-channels--id--delete" class="operation panel" data-traverse-target="operation--videos-channels--id--delete">
+ <div id="operation--video-channels--id--delete" class="operation panel" data-traverse-target="operation--video-channels--id--delete">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
<h2 class="operation-title">
<span class="operation-name">
<span class="operation-name">DELETE</span>
- <span class="operation-path">/videos/channels/{id}</span>
+ <span class="operation-path">/video-channels/{id}</span>
</span>
</h2>
<div class="doc-row">
</div>
</div>
<div class="prop-value">
- <p>The video id </p>
+ <p>The video channel id </p>
</div>
</div>
</section>
</div>
</div>
</div>
- <div id="operation--videos-accounts--accountId--channels-get" class="operation panel" data-traverse-target="operation--videos-accounts--accountId--channels-get">
+ <div id="operation--video-channels--id--videos-get" class="operation panel" data-traverse-target="operation--video-channels--id--videos-get">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
<h2 class="operation-title">
<span class="operation-name">
<span class="operation-name">GET</span>
- <span class="operation-path">/videos/accounts/{accountId}/channels</span>
+ <span class="operation-path">/video-channels/{id}/videos</span>
</span>
</h2>
<div class="doc-row">
<section class="swagger-request-params">
<div class="prop-row prop-group">
<div class="prop-name">
- <div class="prop-title">accountId</div>
+ <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 channel 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">"string"</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--accounts--name--video-channels-get" class="operation panel" data-traverse-target="operation--accounts--name--video-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">/accounts/{name}/video-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">name</div>
<span class="json-property-required"></span>
<div class="prop-subtitle"> in path </div>
<div class="prop-subtitle">
</div>
</div>
<div class="prop-value">
- <p>The account id </p>
+ <p>The name of the account (chocobozzz or
+ <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p>
</div>
</div>
</section>
<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">"ownerAccount"</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">"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>
</div>
<h1>Schema Definitions</h1>
- <div id="definition-VideoConstant" class="definition panel" data-traverse-target="definition-VideoConstant">
+ <div id="definition-VideoConstantNumber" class="definition panel" data-traverse-target="definition-VideoConstantNumber">
<h2 class="panel-title">
- <a name="/definitions/VideoConstant"></a>VideoConstant:
+ <a name="/definitions/VideoConstantNumber"></a>VideoConstantNumber:
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
<span class="json-property-range" title="Value limits"></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>
}
+</code></pre>
+ <!-- </div> -->
+ </section>
+ </div>
+ </div>
+ </div>
+ <div id="definition-VideoConstantString" class="definition panel" data-traverse-target="definition-VideoConstantString">
+ <h2 class="panel-title">
+ <a name="/definitions/VideoConstantString"></a>VideoConstantString:
+ <!-- <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">string</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">"string"</span>,
+ <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>
+}
</code></pre>
<!-- </div> -->
</section>
<span class="json-property-name">category:</span>
<span class="json-property-type">
<span class="">
- <a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a>
+ <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a>
</span>
</span>
<span class="json-property-range" title="Value limits"></span>
<span class="json-property-name">licence:</span>
<span class="json-property-type">
<span class="">
- <a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a>
+ <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a>
</span>
</span>
<span class="json-property-range" title="Value limits"></span>
<span class="json-property-name">language:</span>
<span class="json-property-type">
<span class="">
- <a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a>
+ <a class="json-schema-ref" href="#/definitions/VideoConstantString">VideoConstantString</a>
</span>
</span>
<span class="json-property-range" title="Value limits"></span>
<span class="json-property-type">object</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
+ <dt class="json-inner-schema">
+ <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="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="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="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="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>
+ </dt>
</dl>
</section>
</div>
<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">"id"</span>: <span class="hljs-string">"string"</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="json-property-type">object</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
+ <dt class="json-inner-schema">
+ <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="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="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>
+ </dl>
+ </section>
+ </dt>
<dt data-property-name="createdAt">
<span class="json-property-name">createdAt:</span>
<span class="json-property-type">string</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>
+ <dt data-property-name="ownerAccount">
+ <span class="json-property-name">ownerAccount:</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 class="json-inner-schema">
+ <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>
</dt>
</dl>
</section>
<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">"ownerAccount"</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">"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> -->
</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
+ <dt class="json-inner-schema">
+ <section class="json-schema-array-items">
+ <span class="json-property-type">
+ <span class="">
+ <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
+ </span>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+ <div class="json-inner-schema"> </div>
+ </section>
+ </dt>
</dl>
</section>
</div>
</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
+ <dt class="json-inner-schema">
+ <section class="json-schema-array-items">
+ <span class="json-property-type">
+ <span class="">
+ <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
+ </span>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+ <div class="json-inner-schema"> </div>
+ </section>
+ </dt>
</dl>
</section>
</div>
<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">"ownerAccount"</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">"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>
- }
- }
- }
- ]
+ }
}
]
}
<span class="json-property-type">object</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
+ <dt class="json-inner-schema">
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="allowed">
+ <span class="json-property-name">allowed:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </dt>
+ </dl>
+ </section>
+ </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 class="json-inner-schema">
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="enabledResolutions">
+ <span class="json-property-name">enabledResolutions:</span>
+ <span class="json-property-type">number[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </dt>
+ <dt class="json-inner-schema">
+ <section class="json-schema-array-items">
+ <span class="json-property-type">number</span>
+ <span class="json-property-range" title="Value limits"></span>
+ <div class="json-inner-schema"> </div>
+ </section>
+ </dt>
+ </dl>
+ </section>
+ </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 class="json-inner-schema">
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="file">
+ <span class="json-property-name">file:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </dt>
+ <dt class="json-inner-schema">
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="size">
+ <span class="json-property-name">size:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </dt>
+ <dt class="json-inner-schema">
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="max">
+ <span class="json-property-name">max:</span>
+ <span class="json-property-type">number</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </dt>
+ </dl>
+ </section>
+ </dt>
+ </dl>
+ </section>
+ </dt>
+ <dt data-property-name="extensions">
+ <span class="json-property-name">extensions:</span>
+ <span class="json-property-type">string[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </dt>
+ <dt class="json-inner-schema">
+ <section class="json-schema-array-items">
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ <div class="json-inner-schema"> </div>
+ </section>
+ </dt>
+ </dl>
+ </section>
+ </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 class="json-inner-schema">
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="file">
+ <span class="json-property-name">file:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </dt>
+ <dt class="json-inner-schema">
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="extensions">
+ <span class="json-property-name">extensions:</span>
+ <span class="json-property-type">string[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </dt>
+ <dt class="json-inner-schema">
+ <section class="json-schema-array-items">
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ <div class="json-inner-schema"> </div>
+ </section>
+ </dt>
+ </dl>
+ </section>
+ </dt>
+ </dl>
+ </section>
+ </dt>
</dl>
</section>
</div>
<span class="json-property-type">object</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
+ <dt class="json-inner-schema">
+ <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>
+ </dt>
</dl>
</section>
</div>
</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
+ <dt class="json-inner-schema">
+ <section class="json-schema-array-items">
+ <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>
+ <div class="json-inner-schema"> </div>
+ </section>
+ </dt>
</dl>
</section>
</div>