From 48dce1c90dff4e90a4bcffefaecf157336cf904b Mon Sep 17 00:00:00 2001
From: Chocobozzz <me@florianbigard.com>
Date: Tue, 24 Apr 2018 17:05:32 +0200
Subject: Update video channel routes
---
support/doc/api/html/index.html | 543 +++++++++++++++++++++++++++-------------
support/doc/api/openapi.yaml | 72 ++++--
2 files changed, 415 insertions(+), 200 deletions(-)
(limited to 'support/doc/api')
diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html
index bf9430e79..23162c307 100644
--- a/support/doc/api/html/index.html
+++ b/support/doc/api/html/index.html
@@ -40,6 +40,14 @@
</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>
@@ -176,22 +184,22 @@
<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--accounts--accountId--video-channels-get"> GET /accounts/{accountId}/video-channels </a>
</li>
<li>
- <a href="#operation--videos-channels--id--get"> GET /videos/channels/{id} </a>
+ <a href="#operation--accounts--accountId--video-channels-post"> POST /accounts/{accountId}/video-channels </a>
</li>
<li>
- <a href="#operation--videos-channels--id--put"> PUT /videos/channels/{id} </a>
+ <a href="#operation--account--accountId--video-channels--id--get"> GET /account/{accountId}/video-channels/{id} </a>
</li>
<li>
- <a href="#operation--videos-channels--id--delete"> DELETE /videos/channels/{id} </a>
+ <a href="#operation--account--accountId--video-channels--id--put"> PUT /account/{accountId}/video-channels/{id} </a>
</li>
<li>
- <a href="#operation--videos-accounts--accountId--channels-get"> GET /videos/accounts/{accountId}/channels </a>
+ <a href="#operation--account--accountId--video-channels--id--delete"> DELETE /account/{accountId}/video-channels/{id} </a>
</li>
</ul>
</section>
@@ -224,7 +232,8 @@
</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>
@@ -605,6 +614,95 @@
</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"> -->
@@ -1518,7 +1616,7 @@
<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>,
@@ -1770,7 +1868,7 @@
<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>,
@@ -2047,7 +2145,7 @@
<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>,
@@ -2488,7 +2586,7 @@
<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>,
@@ -2825,7 +2923,7 @@
<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>,
@@ -3206,7 +3304,7 @@
<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>,
@@ -3329,7 +3427,7 @@
<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>
@@ -3478,7 +3576,7 @@
<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>,
@@ -3611,7 +3709,7 @@
<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>,
@@ -3942,7 +4040,7 @@
<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>
@@ -4665,7 +4763,7 @@
</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">
@@ -4677,7 +4775,7 @@
<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">
@@ -4789,9 +4887,144 @@
<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--accountId--video-channels-get" class="operation panel" data-traverse-target="operation--accounts--accountId--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/{accountId}/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">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">"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>,
@@ -4825,7 +5058,7 @@
</div>
</div>
</div>
- <div id="operation--videos-channels-post" class="operation panel" data-traverse-target="operation--videos-channels-post">
+ <div id="operation--accounts--accountId--video-channels-post" class="operation panel" data-traverse-target="operation--accounts--accountId--video-channels-post">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
@@ -4837,7 +5070,7 @@
<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">/accounts/{accountId}/video-channels</span>
</span>
</h2>
<div class="doc-row">
@@ -4858,6 +5091,22 @@
</div>
</div>
</section>
+ <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">
<section>
@@ -4916,7 +5165,7 @@
</div>
</div>
</div>
- <div id="operation--videos-channels--id--get" class="operation panel" data-traverse-target="operation--videos-channels--id--get">
+ <div id="operation--account--accountId--video-channels--id--get" class="operation panel" data-traverse-target="operation--account--accountId--video-channels--id--get">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
@@ -4928,12 +5177,26 @@
<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">/account/{accountId}/video-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">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>
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">id</div>
@@ -4945,7 +5208,7 @@
</div>
</div>
<div class="prop-value">
- <p>The video id </p>
+ <p>The video channel id </p>
</div>
</div>
</section>
@@ -5003,7 +5266,7 @@
<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>,
@@ -5038,7 +5301,7 @@
</div>
</div>
</div>
- <div id="operation--videos-channels--id--put" class="operation panel" data-traverse-target="operation--videos-channels--id--put">
+ <div id="operation--account--accountId--video-channels--id--put" class="operation panel" data-traverse-target="operation--account--accountId--video-channels--id--put">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
@@ -5050,7 +5313,7 @@
<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">/account/{accountId}/video-channels/{id}</span>
</span>
</h2>
<div class="doc-row">
@@ -5072,6 +5335,20 @@
</div>
</section>
<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>
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">id</div>
@@ -5083,7 +5360,7 @@
</div>
</div>
<div class="prop-value">
- <p>The video id </p>
+ <p>The video channel id </p>
</div>
</div>
</section>
@@ -5145,7 +5422,7 @@
</div>
</div>
</div>
- <div id="operation--videos-channels--id--delete" class="operation panel" data-traverse-target="operation--videos-channels--id--delete">
+ <div id="operation--account--accountId--video-channels--id--delete" class="operation panel" data-traverse-target="operation--account--accountId--video-channels--id--delete">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
@@ -5157,12 +5434,26 @@
<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">/account/{accountId}/video-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">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>
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">id</div>
@@ -5174,7 +5465,7 @@
</div>
</div>
<div class="prop-value">
- <p>The video id </p>
+ <p>The video channel id </p>
</div>
</div>
</section>
@@ -5223,141 +5514,6 @@
</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"> -->
@@ -6104,9 +6260,9 @@
</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>
@@ -6137,6 +6293,45 @@
<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>
@@ -6210,7 +6405,7 @@
<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>
@@ -6219,7 +6414,7 @@
<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>
@@ -6228,7 +6423,7 @@
<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>
@@ -6323,7 +6518,7 @@
<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>,
@@ -6609,7 +6804,7 @@
<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>,
@@ -7219,7 +7414,7 @@
<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>,
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 10f60175d..4a1f06d00 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -91,7 +91,7 @@ paths:
in: path
required: true
type: string
- enum: ['xml', 'atom' 'json']
+ enum: [ 'xml', 'atom', 'json']
default: 'xml'
description: 'The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0'
- name: accountId
@@ -967,7 +967,7 @@ paths:
type: array
items:
$ref: '#/definitions/VideoBlacklist'
- /videos/channels:
+ /video-channels:
get:
tags:
- VideoChannel
@@ -998,6 +998,27 @@ paths:
type: array
items:
$ref: '#/definitions/VideoChannel'
+ /accounts/{accountId}/video-channels:
+ get:
+ tags:
+ - VideoChannel
+ consumes:
+ - application/json
+ produces:
+ - application/json
+ parameters:
+ - name: accountId
+ in: path
+ required: true
+ type: string
+ description: 'The account id '
+ responses:
+ '200':
+ description: successful operation
+ schema:
+ type: array
+ items:
+ $ref: '#/definitions/VideoChannel'
post:
security:
- OAuth2: [ ]
@@ -1008,6 +1029,11 @@ paths:
produces:
- application/json
parameters:
+ - name: accountId
+ in: path
+ required: true
+ type: string
+ description: 'The account id '
- in: body
name: body
schema:
@@ -1015,7 +1041,7 @@ paths:
responses:
'204':
description: successful operation
- "/videos/channels/{id}":
+ "/account/{accountId}/video-channels/{id}":
get:
tags:
- VideoChannel
@@ -1024,11 +1050,16 @@ paths:
produces:
- application/json
parameters:
+ - name: accountId
+ in: path
+ required: true
+ type: string
+ description: 'The account id '
- name: id
in: path
required: true
type: string
- description: 'The video id '
+ description: 'The video channel id '
responses:
'200':
description: successful operation
@@ -1044,11 +1075,16 @@ paths:
produces:
- application/json
parameters:
+ - name: accountId
+ in: path
+ required: true
+ type: string
+ description: 'The account id '
- name: id
in: path
required: true
type: string
- description: 'The video id '
+ description: 'The video channel id '
- in: body
name: body
schema:
@@ -1066,35 +1102,19 @@ paths:
produces:
- application/json
parameters:
- - name: id
+ - name: accountId
in: path
required: true
type: string
- description: 'The video id '
- responses:
- '204':
- description: successful operation
- /videos/accounts/{accountId}/channels:
- get:
- tags:
- - VideoChannel
- consumes:
- - application/json
- produces:
- - application/json
- parameters:
- - name: accountId
+ description: 'The account id '
+ - name: id
in: path
required: true
type: string
- description: 'The account id '
+ description: 'The video channel id '
responses:
- '200':
+ '204':
description: successful operation
- schema:
- type: array
- items:
- $ref: '#/definitions/VideoChannel'
"/videos/{videoId}/comment-threads":
get:
tags:
--
cgit v1.2.3