diff options
author | Chocobozzz <me@florianbigard.com> | 2018-04-24 17:05:32 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2018-04-24 17:12:57 +0200 |
commit | 48dce1c90dff4e90a4bcffefaecf157336cf904b (patch) | |
tree | 478de23812d0bfd93f47e9ad6ad8888c9edcc235 /support/doc/api | |
parent | 82e392f8a42a19815e932dd386e96e61ebe6d191 (diff) | |
download | PeerTube-48dce1c90dff4e90a4bcffefaecf157336cf904b.tar.gz PeerTube-48dce1c90dff4e90a4bcffefaecf157336cf904b.tar.zst PeerTube-48dce1c90dff4e90a4bcffefaecf157336cf904b.zip |
Update video channel routes
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/html/index.html | 543 | ||||
-rw-r--r-- | support/doc/api/openapi.yaml | 72 |
2 files changed, 415 insertions, 200 deletions
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 | |||
@@ -41,6 +41,14 @@ | |||
41 | </ul> | 41 | </ul> |
42 | </section> | 42 | </section> |
43 | <section> | 43 | <section> |
44 | <a href="#tag-Feeds">Feeds</a> | ||
45 | <ul> | ||
46 | <li> | ||
47 | <a href="#operation--feeds-videos.-format--get"> GET /feeds/videos.{format} </a> | ||
48 | </li> | ||
49 | </ul> | ||
50 | </section> | ||
51 | <section> | ||
44 | <a href="#tag-Job">Job</a> | 52 | <a href="#tag-Job">Job</a> |
45 | <ul> | 53 | <ul> |
46 | <li> | 54 | <li> |
@@ -176,22 +184,22 @@ | |||
176 | <a href="#tag-VideoChannel">VideoChannel</a> | 184 | <a href="#tag-VideoChannel">VideoChannel</a> |
177 | <ul> | 185 | <ul> |
178 | <li> | 186 | <li> |
179 | <a href="#operation--videos-channels-get"> GET /videos/channels </a> | 187 | <a href="#operation--video-channels-get"> GET /video-channels </a> |
180 | </li> | 188 | </li> |
181 | <li> | 189 | <li> |
182 | <a href="#operation--videos-channels-post"> POST /videos/channels </a> | 190 | <a href="#operation--accounts--accountId--video-channels-get"> GET /accounts/{accountId}/video-channels </a> |
183 | </li> | 191 | </li> |
184 | <li> | 192 | <li> |
185 | <a href="#operation--videos-channels--id--get"> GET /videos/channels/{id} </a> | 193 | <a href="#operation--accounts--accountId--video-channels-post"> POST /accounts/{accountId}/video-channels </a> |
186 | </li> | 194 | </li> |
187 | <li> | 195 | <li> |
188 | <a href="#operation--videos-channels--id--put"> PUT /videos/channels/{id} </a> | 196 | <a href="#operation--account--accountId--video-channels--id--get"> GET /account/{accountId}/video-channels/{id} </a> |
189 | </li> | 197 | </li> |
190 | <li> | 198 | <li> |
191 | <a href="#operation--videos-channels--id--delete"> DELETE /videos/channels/{id} </a> | 199 | <a href="#operation--account--accountId--video-channels--id--put"> PUT /account/{accountId}/video-channels/{id} </a> |
192 | </li> | 200 | </li> |
193 | <li> | 201 | <li> |
194 | <a href="#operation--videos-accounts--accountId--channels-get"> GET /videos/accounts/{accountId}/channels </a> | 202 | <a href="#operation--account--accountId--video-channels--id--delete"> DELETE /account/{accountId}/video-channels/{id} </a> |
195 | </li> | 203 | </li> |
196 | </ul> | 204 | </ul> |
197 | </section> | 205 | </section> |
@@ -224,7 +232,8 @@ | |||
224 | </ul> | 232 | </ul> |
225 | </section> | 233 | </section> |
226 | <h5>Schema Definitions</h5> | 234 | <h5>Schema Definitions</h5> |
227 | <a href="#definition-VideoConstant"> VideoConstant </a> | 235 | <a href="#definition-VideoConstantNumber"> VideoConstantNumber </a> |
236 | <a href="#definition-VideoConstantString"> VideoConstantString </a> | ||
228 | <a href="#definition-VideoPrivacy"> VideoPrivacy </a> | 237 | <a href="#definition-VideoPrivacy"> VideoPrivacy </a> |
229 | <a href="#definition-Video"> Video </a> | 238 | <a href="#definition-Video"> Video </a> |
230 | <a href="#definition-VideoAbuse"> VideoAbuse </a> | 239 | <a href="#definition-VideoAbuse"> VideoAbuse </a> |
@@ -605,6 +614,95 @@ | |||
605 | </div> | 614 | </div> |
606 | </div> | 615 | </div> |
607 | </div> | 616 | </div> |
617 | <h1 id="tag-Feeds" class="swagger-summary-tag" data-traverse-target="tag-Feeds">Feeds</h1> | ||
618 | <div id="operation--feeds-videos.-format--get" class="operation panel" data-traverse-target="operation--feeds-videos.-format--get"> | ||
619 | <!-- <section class="operation-tags row"> --> | ||
620 | <!-- <div class="doc-copy"> --> | ||
621 | <div class="operation-tags"> | ||
622 | <a class="label" href="#tag-Feeds">Feeds</a> | ||
623 | <!----> | ||
624 | </div> | ||
625 | <!-- </div> --> | ||
626 | <!-- </section> --> | ||
627 | <h2 class="operation-title"> | ||
628 | <span class="operation-name"> | ||
629 | <span class="operation-name">GET</span> | ||
630 | <span class="operation-path">/feeds/videos.{format}</span> | ||
631 | </span> | ||
632 | </h2> | ||
633 | <div class="doc-row"> | ||
634 | <div class="doc-copy"> | ||
635 | <section class="swagger-request-params"> | ||
636 | <div class="prop-row prop-group"> | ||
637 | <div class="prop-name"> | ||
638 | <div class="prop-title">format</div> | ||
639 | <span class="json-property-required"></span> | ||
640 | <div class="prop-subtitle"> in path </div> | ||
641 | <div class="prop-subtitle"> | ||
642 | <span class="json-property-type">string</span> | ||
643 | <span class="json-property-enum" title="Possible values"> | ||
644 | <span class="json-property-enum-item json-property-enum-default-value">xml</span>, | ||
645 | <span class="json-property-enum-item">atom</span>, | ||
646 | <span class="json-property-enum-item">json</span> | ||
647 | </span> | ||
648 | <span class="json-property-range" title="Value limits"></span> | ||
649 | <span class="json-property-default-value" title="Default value">xml</span> | ||
650 | </div> | ||
651 | </div> | ||
652 | <div class="prop-value"> | ||
653 | <p>The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0</p> | ||
654 | </div> | ||
655 | </div> | ||
656 | <div class="prop-row prop-group"> | ||
657 | <div class="prop-name"> | ||
658 | <div class="prop-title">accountId</div> | ||
659 | <div class="prop-subtitle"> in query </div> | ||
660 | <div class="prop-subtitle"> | ||
661 | <span class="json-property-type">number</span> | ||
662 | <span class="json-property-range" title="Value limits"></span> | ||
663 | </div> | ||
664 | </div> | ||
665 | <div class="prop-value"> | ||
666 | <p>The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds</p> | ||
667 | </div> | ||
668 | </div> | ||
669 | <div class="prop-row prop-group"> | ||
670 | <div class="prop-name"> | ||
671 | <div class="prop-title">accountName</div> | ||
672 | <div class="prop-subtitle"> in query </div> | ||
673 | <div class="prop-subtitle"> | ||
674 | <span class="json-property-type">string</span> | ||
675 | <span class="json-property-range" title="Value limits"></span> | ||
676 | </div> | ||
677 | </div> | ||
678 | <div class="prop-value"> | ||
679 | <p>The name of the local account to filter to</p> | ||
680 | </div> | ||
681 | </div> | ||
682 | </section> | ||
683 | </div> | ||
684 | <div class="doc-examples"></div> | ||
685 | </div> | ||
686 | <div class="doc-row"> | ||
687 | <div class="doc-copy"> | ||
688 | <section class="swagger-responses"> | ||
689 | <div class="prop-row prop-group"> | ||
690 | <div class="prop-name"> | ||
691 | <div class="prop-title">200 OK</div> | ||
692 | </div> | ||
693 | <div class="prop-value"> | ||
694 | <p>successful operation</p> | ||
695 | </div> | ||
696 | </div> | ||
697 | </section> | ||
698 | </div> | ||
699 | <div class="doc-examples"> | ||
700 | <h5>Response Content-Types: | ||
701 | <span>application/atom+xml, application/rss+xml, application/json</span> | ||
702 | </h5> | ||
703 | </div> | ||
704 | </div> | ||
705 | </div> | ||
608 | <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1> | 706 | <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1> |
609 | <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get"> | 707 | <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get"> |
610 | <!-- <section class="operation-tags row"> --> | 708 | <!-- <section class="operation-tags row"> --> |
@@ -1518,7 +1616,7 @@ | |||
1518 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 1616 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
1519 | }, | 1617 | }, |
1520 | <span class="hljs-attr">"language"</span>: { | 1618 | <span class="hljs-attr">"language"</span>: { |
1521 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 1619 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
1522 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 1620 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
1523 | }, | 1621 | }, |
1524 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 1622 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
@@ -1770,7 +1868,7 @@ | |||
1770 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 1868 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
1771 | }, | 1869 | }, |
1772 | <span class="hljs-attr">"language"</span>: { | 1870 | <span class="hljs-attr">"language"</span>: { |
1773 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 1871 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
1774 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 1872 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
1775 | }, | 1873 | }, |
1776 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 1874 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
@@ -2047,7 +2145,7 @@ | |||
2047 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 2145 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
2048 | }, | 2146 | }, |
2049 | <span class="hljs-attr">"language"</span>: { | 2147 | <span class="hljs-attr">"language"</span>: { |
2050 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 2148 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
2051 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 2149 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
2052 | }, | 2150 | }, |
2053 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 2151 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
@@ -2488,7 +2586,7 @@ | |||
2488 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 2586 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
2489 | }, | 2587 | }, |
2490 | <span class="hljs-attr">"language"</span>: { | 2588 | <span class="hljs-attr">"language"</span>: { |
2491 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 2589 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
2492 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 2590 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
2493 | }, | 2591 | }, |
2494 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 2592 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
@@ -2825,7 +2923,7 @@ | |||
2825 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 2923 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
2826 | }, | 2924 | }, |
2827 | <span class="hljs-attr">"language"</span>: { | 2925 | <span class="hljs-attr">"language"</span>: { |
2828 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 2926 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
2829 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 2927 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
2830 | }, | 2928 | }, |
2831 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 2929 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
@@ -3206,7 +3304,7 @@ | |||
3206 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 3304 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
3207 | }, | 3305 | }, |
3208 | <span class="hljs-attr">"language"</span>: { | 3306 | <span class="hljs-attr">"language"</span>: { |
3209 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 3307 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
3210 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 3308 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
3211 | }, | 3309 | }, |
3212 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 3310 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
@@ -3329,7 +3427,7 @@ | |||
3329 | <div class="prop-title">language</div> | 3427 | <div class="prop-title">language</div> |
3330 | <div class="prop-subtitle"> in formData </div> | 3428 | <div class="prop-subtitle"> in formData </div> |
3331 | <div class="prop-subtitle"> | 3429 | <div class="prop-subtitle"> |
3332 | <span class="json-property-type">number</span> | 3430 | <span class="json-property-type">string</span> |
3333 | <span class="json-property-range" title="Value limits"></span> | 3431 | <span class="json-property-range" title="Value limits"></span> |
3334 | </div> | 3432 | </div> |
3335 | </div> | 3433 | </div> |
@@ -3478,7 +3576,7 @@ | |||
3478 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 3576 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
3479 | }, | 3577 | }, |
3480 | <span class="hljs-attr">"language"</span>: { | 3578 | <span class="hljs-attr">"language"</span>: { |
3481 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 3579 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
3482 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 3580 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
3483 | }, | 3581 | }, |
3484 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 3582 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
@@ -3611,7 +3709,7 @@ | |||
3611 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 3709 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
3612 | }, | 3710 | }, |
3613 | <span class="hljs-attr">"language"</span>: { | 3711 | <span class="hljs-attr">"language"</span>: { |
3614 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 3712 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
3615 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 3713 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
3616 | }, | 3714 | }, |
3617 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 3715 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
@@ -3942,7 +4040,7 @@ | |||
3942 | <div class="prop-title">language</div> | 4040 | <div class="prop-title">language</div> |
3943 | <div class="prop-subtitle"> in formData </div> | 4041 | <div class="prop-subtitle"> in formData </div> |
3944 | <div class="prop-subtitle"> | 4042 | <div class="prop-subtitle"> |
3945 | <span class="json-property-type">number</span> | 4043 | <span class="json-property-type">string</span> |
3946 | <span class="json-property-range" title="Value limits"></span> | 4044 | <span class="json-property-range" title="Value limits"></span> |
3947 | </div> | 4045 | </div> |
3948 | </div> | 4046 | </div> |
@@ -4665,7 +4763,7 @@ | |||
4665 | </div> | 4763 | </div> |
4666 | </div> | 4764 | </div> |
4667 | <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1> | 4765 | <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1> |
4668 | <div id="operation--videos-channels-get" class="operation panel" data-traverse-target="operation--videos-channels-get"> | 4766 | <div id="operation--video-channels-get" class="operation panel" data-traverse-target="operation--video-channels-get"> |
4669 | <!-- <section class="operation-tags row"> --> | 4767 | <!-- <section class="operation-tags row"> --> |
4670 | <!-- <div class="doc-copy"> --> | 4768 | <!-- <div class="doc-copy"> --> |
4671 | <div class="operation-tags"> | 4769 | <div class="operation-tags"> |
@@ -4677,7 +4775,7 @@ | |||
4677 | <h2 class="operation-title"> | 4775 | <h2 class="operation-title"> |
4678 | <span class="operation-name"> | 4776 | <span class="operation-name"> |
4679 | <span class="operation-name">GET</span> | 4777 | <span class="operation-name">GET</span> |
4680 | <span class="operation-path">/videos/channels</span> | 4778 | <span class="operation-path">/video-channels</span> |
4681 | </span> | 4779 | </span> |
4682 | </h2> | 4780 | </h2> |
4683 | <div class="doc-row"> | 4781 | <div class="doc-row"> |
@@ -4789,9 +4887,144 @@ | |||
4789 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 4887 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
4790 | }, | 4888 | }, |
4791 | <span class="hljs-attr">"language"</span>: { | 4889 | <span class="hljs-attr">"language"</span>: { |
4890 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
4891 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
4892 | }, | ||
4893 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | ||
4894 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
4895 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | ||
4896 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
4897 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
4898 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | ||
4899 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | ||
4900 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | ||
4901 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | ||
4902 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | ||
4903 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | ||
4904 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | ||
4905 | <span class="hljs-attr">"account"</span>: { | ||
4906 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
4907 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
4908 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
4909 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
4910 | <span class="hljs-attr">"avatar"</span>: { | ||
4911 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
4912 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
4913 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
4914 | } | ||
4915 | } | ||
4916 | } | ||
4917 | ] | ||
4918 | } | ||
4919 | ] | ||
4920 | </code></pre> | ||
4921 | <!-- </div> --> | ||
4922 | </section> | ||
4923 | </div> | ||
4924 | </div> | ||
4925 | </div> | ||
4926 | <div id="operation--accounts--accountId--video-channels-get" class="operation panel" data-traverse-target="operation--accounts--accountId--video-channels-get"> | ||
4927 | <!-- <section class="operation-tags row"> --> | ||
4928 | <!-- <div class="doc-copy"> --> | ||
4929 | <div class="operation-tags"> | ||
4930 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | ||
4931 | <!----> | ||
4932 | </div> | ||
4933 | <!-- </div> --> | ||
4934 | <!-- </section> --> | ||
4935 | <h2 class="operation-title"> | ||
4936 | <span class="operation-name"> | ||
4937 | <span class="operation-name">GET</span> | ||
4938 | <span class="operation-path">/accounts/{accountId}/video-channels</span> | ||
4939 | </span> | ||
4940 | </h2> | ||
4941 | <div class="doc-row"> | ||
4942 | <div class="doc-copy"> | ||
4943 | <section class="swagger-request-params"> | ||
4944 | <div class="prop-row prop-group"> | ||
4945 | <div class="prop-name"> | ||
4946 | <div class="prop-title">accountId</div> | ||
4947 | <span class="json-property-required"></span> | ||
4948 | <div class="prop-subtitle"> in path </div> | ||
4949 | <div class="prop-subtitle"> | ||
4950 | <span class="json-property-type">string</span> | ||
4951 | <span class="json-property-range" title="Value limits"></span> | ||
4952 | </div> | ||
4953 | </div> | ||
4954 | <div class="prop-value"> | ||
4955 | <p>The account id </p> | ||
4956 | </div> | ||
4957 | </div> | ||
4958 | </section> | ||
4959 | </div> | ||
4960 | <div class="doc-examples"></div> | ||
4961 | </div> | ||
4962 | <div class="doc-row"> | ||
4963 | <div class="doc-copy"> | ||
4964 | <section class="swagger-responses"> | ||
4965 | <div class="prop-row prop-group"> | ||
4966 | <div class="prop-name"> | ||
4967 | <div class="prop-title">200 OK</div> | ||
4968 | <div class="prop-ref"> | ||
4969 | <span class="json-schema-ref-array"> | ||
4970 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | ||
4971 | </span> | ||
4972 | </div> | ||
4973 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
4974 | </div> | ||
4975 | <div class="prop-value"> | ||
4976 | <p>successful operation</p> | ||
4977 | </div> | ||
4978 | </div> | ||
4979 | <div class="prop-row prop-inner"> | ||
4980 | <div class="prop-name">type</div> | ||
4981 | <div class="prop-value"> | ||
4982 | <span class="json-property-type"> | ||
4983 | <span class="json-schema-ref-array"> | ||
4984 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | ||
4985 | </span> | ||
4986 | </span> | ||
4987 | <span class="json-property-range" title="Value limits"></span> | ||
4988 | </div> | ||
4989 | </div> | ||
4990 | </section> | ||
4991 | </div> | ||
4992 | <div class="doc-examples"> | ||
4993 | <h5>Response Content-Types: | ||
4994 | <span>application/json</span> | ||
4995 | </h5> | ||
4996 | <section> | ||
4997 | <h5>Response Example | ||
4998 | <span>(200 OK)</span> | ||
4999 | </h5> | ||
5000 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
5001 | { | ||
5002 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
5003 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
5004 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
5005 | <span class="hljs-attr">"owner"</span>: { | ||
5006 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5007 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | ||
5008 | }, | ||
5009 | <span class="hljs-attr">"videos"</span>: [ | ||
5010 | { | ||
5011 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5012 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
5013 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5014 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5015 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5016 | <span class="hljs-attr">"category"</span>: { | ||
4792 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 5017 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, |
4793 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 5018 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
4794 | }, | 5019 | }, |
5020 | <span class="hljs-attr">"licence"</span>: { | ||
5021 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5022 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
5023 | }, | ||
5024 | <span class="hljs-attr">"language"</span>: { | ||
5025 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
5026 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
5027 | }, | ||
4795 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 5028 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
4796 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | 5029 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
4797 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | 5030 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, |
@@ -4825,7 +5058,7 @@ | |||
4825 | </div> | 5058 | </div> |
4826 | </div> | 5059 | </div> |
4827 | </div> | 5060 | </div> |
4828 | <div id="operation--videos-channels-post" class="operation panel" data-traverse-target="operation--videos-channels-post"> | 5061 | <div id="operation--accounts--accountId--video-channels-post" class="operation panel" data-traverse-target="operation--accounts--accountId--video-channels-post"> |
4829 | <!-- <section class="operation-tags row"> --> | 5062 | <!-- <section class="operation-tags row"> --> |
4830 | <!-- <div class="doc-copy"> --> | 5063 | <!-- <div class="doc-copy"> --> |
4831 | <div class="operation-tags"> | 5064 | <div class="operation-tags"> |
@@ -4837,7 +5070,7 @@ | |||
4837 | <h2 class="operation-title"> | 5070 | <h2 class="operation-title"> |
4838 | <span class="operation-name"> | 5071 | <span class="operation-name"> |
4839 | <span class="operation-name">POST</span> | 5072 | <span class="operation-name">POST</span> |
4840 | <span class="operation-path">/videos/channels</span> | 5073 | <span class="operation-path">/accounts/{accountId}/video-channels</span> |
4841 | </span> | 5074 | </span> |
4842 | </h2> | 5075 | </h2> |
4843 | <div class="doc-row"> | 5076 | <div class="doc-row"> |
@@ -4858,6 +5091,22 @@ | |||
4858 | </div> | 5091 | </div> |
4859 | </div> | 5092 | </div> |
4860 | </section> | 5093 | </section> |
5094 | <section class="swagger-request-params"> | ||
5095 | <div class="prop-row prop-group"> | ||
5096 | <div class="prop-name"> | ||
5097 | <div class="prop-title">accountId</div> | ||
5098 | <span class="json-property-required"></span> | ||
5099 | <div class="prop-subtitle"> in path </div> | ||
5100 | <div class="prop-subtitle"> | ||
5101 | <span class="json-property-type">string</span> | ||
5102 | <span class="json-property-range" title="Value limits"></span> | ||
5103 | </div> | ||
5104 | </div> | ||
5105 | <div class="prop-value"> | ||
5106 | <p>The account id </p> | ||
5107 | </div> | ||
5108 | </div> | ||
5109 | </section> | ||
4861 | </div> | 5110 | </div> |
4862 | <div class="doc-examples"> | 5111 | <div class="doc-examples"> |
4863 | <section> | 5112 | <section> |
@@ -4916,7 +5165,7 @@ | |||
4916 | </div> | 5165 | </div> |
4917 | </div> | 5166 | </div> |
4918 | </div> | 5167 | </div> |
4919 | <div id="operation--videos-channels--id--get" class="operation panel" data-traverse-target="operation--videos-channels--id--get"> | 5168 | <div id="operation--account--accountId--video-channels--id--get" class="operation panel" data-traverse-target="operation--account--accountId--video-channels--id--get"> |
4920 | <!-- <section class="operation-tags row"> --> | 5169 | <!-- <section class="operation-tags row"> --> |
4921 | <!-- <div class="doc-copy"> --> | 5170 | <!-- <div class="doc-copy"> --> |
4922 | <div class="operation-tags"> | 5171 | <div class="operation-tags"> |
@@ -4928,7 +5177,7 @@ | |||
4928 | <h2 class="operation-title"> | 5177 | <h2 class="operation-title"> |
4929 | <span class="operation-name"> | 5178 | <span class="operation-name"> |
4930 | <span class="operation-name">GET</span> | 5179 | <span class="operation-name">GET</span> |
4931 | <span class="operation-path">/videos/channels/{id}</span> | 5180 | <span class="operation-path">/account/{accountId}/video-channels/{id}</span> |
4932 | </span> | 5181 | </span> |
4933 | </h2> | 5182 | </h2> |
4934 | <div class="doc-row"> | 5183 | <div class="doc-row"> |
@@ -4936,6 +5185,20 @@ | |||
4936 | <section class="swagger-request-params"> | 5185 | <section class="swagger-request-params"> |
4937 | <div class="prop-row prop-group"> | 5186 | <div class="prop-row prop-group"> |
4938 | <div class="prop-name"> | 5187 | <div class="prop-name"> |
5188 | <div class="prop-title">accountId</div> | ||
5189 | <span class="json-property-required"></span> | ||
5190 | <div class="prop-subtitle"> in path </div> | ||
5191 | <div class="prop-subtitle"> | ||
5192 | <span class="json-property-type">string</span> | ||
5193 | <span class="json-property-range" title="Value limits"></span> | ||
5194 | </div> | ||
5195 | </div> | ||
5196 | <div class="prop-value"> | ||
5197 | <p>The account id </p> | ||
5198 | </div> | ||
5199 | </div> | ||
5200 | <div class="prop-row prop-group"> | ||
5201 | <div class="prop-name"> | ||
4939 | <div class="prop-title">id</div> | 5202 | <div class="prop-title">id</div> |
4940 | <span class="json-property-required"></span> | 5203 | <span class="json-property-required"></span> |
4941 | <div class="prop-subtitle"> in path </div> | 5204 | <div class="prop-subtitle"> in path </div> |
@@ -4945,7 +5208,7 @@ | |||
4945 | </div> | 5208 | </div> |
4946 | </div> | 5209 | </div> |
4947 | <div class="prop-value"> | 5210 | <div class="prop-value"> |
4948 | <p>The video id </p> | 5211 | <p>The video channel id </p> |
4949 | </div> | 5212 | </div> |
4950 | </div> | 5213 | </div> |
4951 | </section> | 5214 | </section> |
@@ -5003,7 +5266,7 @@ | |||
5003 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 5266 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
5004 | }, | 5267 | }, |
5005 | <span class="hljs-attr">"language"</span>: { | 5268 | <span class="hljs-attr">"language"</span>: { |
5006 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 5269 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
5007 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 5270 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
5008 | }, | 5271 | }, |
5009 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 5272 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
@@ -5038,7 +5301,7 @@ | |||
5038 | </div> | 5301 | </div> |
5039 | </div> | 5302 | </div> |
5040 | </div> | 5303 | </div> |
5041 | <div id="operation--videos-channels--id--put" class="operation panel" data-traverse-target="operation--videos-channels--id--put"> | 5304 | <div id="operation--account--accountId--video-channels--id--put" class="operation panel" data-traverse-target="operation--account--accountId--video-channels--id--put"> |
5042 | <!-- <section class="operation-tags row"> --> | 5305 | <!-- <section class="operation-tags row"> --> |
5043 | <!-- <div class="doc-copy"> --> | 5306 | <!-- <div class="doc-copy"> --> |
5044 | <div class="operation-tags"> | 5307 | <div class="operation-tags"> |
@@ -5050,7 +5313,7 @@ | |||
5050 | <h2 class="operation-title"> | 5313 | <h2 class="operation-title"> |
5051 | <span class="operation-name"> | 5314 | <span class="operation-name"> |
5052 | <span class="operation-name">PUT</span> | 5315 | <span class="operation-name">PUT</span> |
5053 | <span class="operation-path">/videos/channels/{id}</span> | 5316 | <span class="operation-path">/account/{accountId}/video-channels/{id}</span> |
5054 | </span> | 5317 | </span> |
5055 | </h2> | 5318 | </h2> |
5056 | <div class="doc-row"> | 5319 | <div class="doc-row"> |
@@ -5074,6 +5337,20 @@ | |||
5074 | <section class="swagger-request-params"> | 5337 | <section class="swagger-request-params"> |
5075 | <div class="prop-row prop-group"> | 5338 | <div class="prop-row prop-group"> |
5076 | <div class="prop-name"> | 5339 | <div class="prop-name"> |
5340 | <div class="prop-title">accountId</div> | ||
5341 | <span class="json-property-required"></span> | ||
5342 | <div class="prop-subtitle"> in path </div> | ||
5343 | <div class="prop-subtitle"> | ||
5344 | <span class="json-property-type">string</span> | ||
5345 | <span class="json-property-range" title="Value limits"></span> | ||
5346 | </div> | ||
5347 | </div> | ||
5348 | <div class="prop-value"> | ||
5349 | <p>The account id </p> | ||
5350 | </div> | ||
5351 | </div> | ||
5352 | <div class="prop-row prop-group"> | ||
5353 | <div class="prop-name"> | ||
5077 | <div class="prop-title">id</div> | 5354 | <div class="prop-title">id</div> |
5078 | <span class="json-property-required"></span> | 5355 | <span class="json-property-required"></span> |
5079 | <div class="prop-subtitle"> in path </div> | 5356 | <div class="prop-subtitle"> in path </div> |
@@ -5083,7 +5360,7 @@ | |||
5083 | </div> | 5360 | </div> |
5084 | </div> | 5361 | </div> |
5085 | <div class="prop-value"> | 5362 | <div class="prop-value"> |
5086 | <p>The video id </p> | 5363 | <p>The video channel id </p> |
5087 | </div> | 5364 | </div> |
5088 | </div> | 5365 | </div> |
5089 | </section> | 5366 | </section> |
@@ -5145,7 +5422,7 @@ | |||
5145 | </div> | 5422 | </div> |
5146 | </div> | 5423 | </div> |
5147 | </div> | 5424 | </div> |
5148 | <div id="operation--videos-channels--id--delete" class="operation panel" data-traverse-target="operation--videos-channels--id--delete"> | 5425 | <div id="operation--account--accountId--video-channels--id--delete" class="operation panel" data-traverse-target="operation--account--accountId--video-channels--id--delete"> |
5149 | <!-- <section class="operation-tags row"> --> | 5426 | <!-- <section class="operation-tags row"> --> |
5150 | <!-- <div class="doc-copy"> --> | 5427 | <!-- <div class="doc-copy"> --> |
5151 | <div class="operation-tags"> | 5428 | <div class="operation-tags"> |
@@ -5157,7 +5434,7 @@ | |||
5157 | <h2 class="operation-title"> | 5434 | <h2 class="operation-title"> |
5158 | <span class="operation-name"> | 5435 | <span class="operation-name"> |
5159 | <span class="operation-name">DELETE</span> | 5436 | <span class="operation-name">DELETE</span> |
5160 | <span class="operation-path">/videos/channels/{id}</span> | 5437 | <span class="operation-path">/account/{accountId}/video-channels/{id}</span> |
5161 | </span> | 5438 | </span> |
5162 | </h2> | 5439 | </h2> |
5163 | <div class="doc-row"> | 5440 | <div class="doc-row"> |
@@ -5165,6 +5442,20 @@ | |||
5165 | <section class="swagger-request-params"> | 5442 | <section class="swagger-request-params"> |
5166 | <div class="prop-row prop-group"> | 5443 | <div class="prop-row prop-group"> |
5167 | <div class="prop-name"> | 5444 | <div class="prop-name"> |
5445 | <div class="prop-title">accountId</div> | ||
5446 | <span class="json-property-required"></span> | ||
5447 | <div class="prop-subtitle"> in path </div> | ||
5448 | <div class="prop-subtitle"> | ||
5449 | <span class="json-property-type">string</span> | ||
5450 | <span class="json-property-range" title="Value limits"></span> | ||
5451 | </div> | ||
5452 | </div> | ||
5453 | <div class="prop-value"> | ||
5454 | <p>The account id </p> | ||
5455 | </div> | ||
5456 | </div> | ||
5457 | <div class="prop-row prop-group"> | ||
5458 | <div class="prop-name"> | ||
5168 | <div class="prop-title">id</div> | 5459 | <div class="prop-title">id</div> |
5169 | <span class="json-property-required"></span> | 5460 | <span class="json-property-required"></span> |
5170 | <div class="prop-subtitle"> in path </div> | 5461 | <div class="prop-subtitle"> in path </div> |
@@ -5174,7 +5465,7 @@ | |||
5174 | </div> | 5465 | </div> |
5175 | </div> | 5466 | </div> |
5176 | <div class="prop-value"> | 5467 | <div class="prop-value"> |
5177 | <p>The video id </p> | 5468 | <p>The video channel id </p> |
5178 | </div> | 5469 | </div> |
5179 | </div> | 5470 | </div> |
5180 | </section> | 5471 | </section> |
@@ -5223,141 +5514,6 @@ | |||
5223 | </div> | 5514 | </div> |
5224 | </div> | 5515 | </div> |
5225 | </div> | 5516 | </div> |
5226 | <div id="operation--videos-accounts--accountId--channels-get" class="operation panel" data-traverse-target="operation--videos-accounts--accountId--channels-get"> | ||
5227 | <!-- <section class="operation-tags row"> --> | ||
5228 | <!-- <div class="doc-copy"> --> | ||
5229 | <div class="operation-tags"> | ||
5230 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | ||
5231 | <!----> | ||
5232 | </div> | ||
5233 | <!-- </div> --> | ||
5234 | <!-- </section> --> | ||
5235 | <h2 class="operation-title"> | ||
5236 | <span class="operation-name"> | ||
5237 | <span class="operation-name">GET</span> | ||
5238 | <span class="operation-path">/videos/accounts/{accountId}/channels</span> | ||
5239 | </span> | ||
5240 | </h2> | ||
5241 | <div class="doc-row"> | ||
5242 | <div class="doc-copy"> | ||
5243 | <section class="swagger-request-params"> | ||
5244 | <div class="prop-row prop-group"> | ||
5245 | <div class="prop-name"> | ||
5246 | <div class="prop-title">accountId</div> | ||
5247 | <span class="json-property-required"></span> | ||
5248 | <div class="prop-subtitle"> in path </div> | ||
5249 | <div class="prop-subtitle"> | ||
5250 | <span class="json-property-type">string</span> | ||
5251 | <span class="json-property-range" title="Value limits"></span> | ||
5252 | </div> | ||
5253 | </div> | ||
5254 | <div class="prop-value"> | ||
5255 | <p>The account id </p> | ||
5256 | </div> | ||
5257 | </div> | ||
5258 | </section> | ||
5259 | </div> | ||
5260 | <div class="doc-examples"></div> | ||
5261 | </div> | ||
5262 | <div class="doc-row"> | ||
5263 | <div class="doc-copy"> | ||
5264 | <section class="swagger-responses"> | ||
5265 | <div class="prop-row prop-group"> | ||
5266 | <div class="prop-name"> | ||
5267 | <div class="prop-title">200 OK</div> | ||
5268 | <div class="prop-ref"> | ||
5269 | <span class="json-schema-ref-array"> | ||
5270 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | ||
5271 | </span> | ||
5272 | </div> | ||
5273 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
5274 | </div> | ||
5275 | <div class="prop-value"> | ||
5276 | <p>successful operation</p> | ||
5277 | </div> | ||
5278 | </div> | ||
5279 | <div class="prop-row prop-inner"> | ||
5280 | <div class="prop-name">type</div> | ||
5281 | <div class="prop-value"> | ||
5282 | <span class="json-property-type"> | ||
5283 | <span class="json-schema-ref-array"> | ||
5284 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | ||
5285 | </span> | ||
5286 | </span> | ||
5287 | <span class="json-property-range" title="Value limits"></span> | ||
5288 | </div> | ||
5289 | </div> | ||
5290 | </section> | ||
5291 | </div> | ||
5292 | <div class="doc-examples"> | ||
5293 | <h5>Response Content-Types: | ||
5294 | <span>application/json</span> | ||
5295 | </h5> | ||
5296 | <section> | ||
5297 | <h5>Response Example | ||
5298 | <span>(200 OK)</span> | ||
5299 | </h5> | ||
5300 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
5301 | { | ||
5302 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
5303 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
5304 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
5305 | <span class="hljs-attr">"owner"</span>: { | ||
5306 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5307 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | ||
5308 | }, | ||
5309 | <span class="hljs-attr">"videos"</span>: [ | ||
5310 | { | ||
5311 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5312 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
5313 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5314 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5315 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5316 | <span class="hljs-attr">"category"</span>: { | ||
5317 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5318 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
5319 | }, | ||
5320 | <span class="hljs-attr">"licence"</span>: { | ||
5321 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5322 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
5323 | }, | ||
5324 | <span class="hljs-attr">"language"</span>: { | ||
5325 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5326 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
5327 | }, | ||
5328 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | ||
5329 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
5330 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | ||
5331 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
5332 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5333 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | ||
5334 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | ||
5335 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | ||
5336 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | ||
5337 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | ||
5338 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | ||
5339 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | ||
5340 | <span class="hljs-attr">"account"</span>: { | ||
5341 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5342 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
5343 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5344 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
5345 | <span class="hljs-attr">"avatar"</span>: { | ||
5346 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
5347 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5348 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
5349 | } | ||
5350 | } | ||
5351 | } | ||
5352 | ] | ||
5353 | } | ||
5354 | ] | ||
5355 | </code></pre> | ||
5356 | <!-- </div> --> | ||
5357 | </section> | ||
5358 | </div> | ||
5359 | </div> | ||
5360 | </div> | ||
5361 | <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1> | 5517 | <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1> |
5362 | <div id="operation--videos--videoId--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-get"> | 5518 | <div id="operation--videos--videoId--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-get"> |
5363 | <!-- <section class="operation-tags row"> --> | 5519 | <!-- <section class="operation-tags row"> --> |
@@ -6104,9 +6260,9 @@ | |||
6104 | </div> | 6260 | </div> |
6105 | </div> | 6261 | </div> |
6106 | <h1>Schema Definitions</h1> | 6262 | <h1>Schema Definitions</h1> |
6107 | <div id="definition-VideoConstant" class="definition panel" data-traverse-target="definition-VideoConstant"> | 6263 | <div id="definition-VideoConstantNumber" class="definition panel" data-traverse-target="definition-VideoConstantNumber"> |
6108 | <h2 class="panel-title"> | 6264 | <h2 class="panel-title"> |
6109 | <a name="/definitions/VideoConstant"></a>VideoConstant: | 6265 | <a name="/definitions/VideoConstantNumber"></a>VideoConstantNumber: |
6110 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | 6266 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
6111 | <span class="json-property-range" title="Value limits"></span> | 6267 | <span class="json-property-range" title="Value limits"></span> |
6112 | 6268 | ||
@@ -6143,6 +6299,45 @@ | |||
6143 | </div> | 6299 | </div> |
6144 | </div> | 6300 | </div> |
6145 | </div> | 6301 | </div> |
6302 | <div id="definition-VideoConstantString" class="definition panel" data-traverse-target="definition-VideoConstantString"> | ||
6303 | <h2 class="panel-title"> | ||
6304 | <a name="/definitions/VideoConstantString"></a>VideoConstantString: | ||
6305 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | ||
6306 | <span class="json-property-range" title="Value limits"></span> | ||
6307 | |||
6308 | |||
6309 | </span> --> | ||
6310 | </h2> | ||
6311 | <div class="doc-row"> | ||
6312 | <div class="doc-copy"> | ||
6313 | <section class="json-schema-properties"> | ||
6314 | <dl> | ||
6315 | <dt data-property-name="id"> | ||
6316 | <span class="json-property-name">id:</span> | ||
6317 | <span class="json-property-type">string</span> | ||
6318 | <span class="json-property-range" title="Value limits"></span> | ||
6319 | </dt> | ||
6320 | <dt data-property-name="label"> | ||
6321 | <span class="json-property-name">label:</span> | ||
6322 | <span class="json-property-type">string</span> | ||
6323 | <span class="json-property-range" title="Value limits"></span> | ||
6324 | </dt> | ||
6325 | </dl> | ||
6326 | </section> | ||
6327 | </div> | ||
6328 | <div class="doc-examples"> | ||
6329 | <section> | ||
6330 | <h5>Example</h5> | ||
6331 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
6332 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
6333 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
6334 | } | ||
6335 | </code></pre> | ||
6336 | <!-- </div> --> | ||
6337 | </section> | ||
6338 | </div> | ||
6339 | </div> | ||
6340 | </div> | ||
6146 | <div id="definition-VideoPrivacy" class="definition panel" data-traverse-target="definition-VideoPrivacy"> | 6341 | <div id="definition-VideoPrivacy" class="definition panel" data-traverse-target="definition-VideoPrivacy"> |
6147 | <h2 class="panel-title"> | 6342 | <h2 class="panel-title"> |
6148 | <a name="/definitions/VideoPrivacy"></a>VideoPrivacy: string | 6343 | <a name="/definitions/VideoPrivacy"></a>VideoPrivacy: string |
@@ -6210,7 +6405,7 @@ | |||
6210 | <span class="json-property-name">category:</span> | 6405 | <span class="json-property-name">category:</span> |
6211 | <span class="json-property-type"> | 6406 | <span class="json-property-type"> |
6212 | <span class=""> | 6407 | <span class=""> |
6213 | <a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a> | 6408 | <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a> |
6214 | </span> | 6409 | </span> |
6215 | </span> | 6410 | </span> |
6216 | <span class="json-property-range" title="Value limits"></span> | 6411 | <span class="json-property-range" title="Value limits"></span> |
@@ -6219,7 +6414,7 @@ | |||
6219 | <span class="json-property-name">licence:</span> | 6414 | <span class="json-property-name">licence:</span> |
6220 | <span class="json-property-type"> | 6415 | <span class="json-property-type"> |
6221 | <span class=""> | 6416 | <span class=""> |
6222 | <a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a> | 6417 | <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a> |
6223 | </span> | 6418 | </span> |
6224 | </span> | 6419 | </span> |
6225 | <span class="json-property-range" title="Value limits"></span> | 6420 | <span class="json-property-range" title="Value limits"></span> |
@@ -6228,7 +6423,7 @@ | |||
6228 | <span class="json-property-name">language:</span> | 6423 | <span class="json-property-name">language:</span> |
6229 | <span class="json-property-type"> | 6424 | <span class="json-property-type"> |
6230 | <span class=""> | 6425 | <span class=""> |
6231 | <a class="json-schema-ref" href="#/definitions/VideoConstant">VideoConstant</a> | 6426 | <a class="json-schema-ref" href="#/definitions/VideoConstantString">VideoConstantString</a> |
6232 | </span> | 6427 | </span> |
6233 | </span> | 6428 | </span> |
6234 | <span class="json-property-range" title="Value limits"></span> | 6429 | <span class="json-property-range" title="Value limits"></span> |
@@ -6323,7 +6518,7 @@ | |||
6323 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 6518 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
6324 | }, | 6519 | }, |
6325 | <span class="hljs-attr">"language"</span>: { | 6520 | <span class="hljs-attr">"language"</span>: { |
6326 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 6521 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
6327 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 6522 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
6328 | }, | 6523 | }, |
6329 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 6524 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
@@ -6609,7 +6804,7 @@ | |||
6609 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 6804 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
6610 | }, | 6805 | }, |
6611 | <span class="hljs-attr">"language"</span>: { | 6806 | <span class="hljs-attr">"language"</span>: { |
6612 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 6807 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
6613 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 6808 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
6614 | }, | 6809 | }, |
6615 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 6810 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
@@ -7219,7 +7414,7 @@ | |||
7219 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 7414 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
7220 | }, | 7415 | }, |
7221 | <span class="hljs-attr">"language"</span>: { | 7416 | <span class="hljs-attr">"language"</span>: { |
7222 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | 7417 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
7223 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | 7418 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
7224 | }, | 7419 | }, |
7225 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | 7420 | <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: | |||
91 | in: path | 91 | in: path |
92 | required: true | 92 | required: true |
93 | type: string | 93 | type: string |
94 | enum: ['xml', 'atom' 'json'] | 94 | enum: [ 'xml', 'atom', 'json'] |
95 | default: 'xml' | 95 | default: 'xml' |
96 | description: 'The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0' | 96 | description: 'The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0' |
97 | - name: accountId | 97 | - name: accountId |
@@ -967,7 +967,7 @@ paths: | |||
967 | type: array | 967 | type: array |
968 | items: | 968 | items: |
969 | $ref: '#/definitions/VideoBlacklist' | 969 | $ref: '#/definitions/VideoBlacklist' |
970 | /videos/channels: | 970 | /video-channels: |
971 | get: | 971 | get: |
972 | tags: | 972 | tags: |
973 | - VideoChannel | 973 | - VideoChannel |
@@ -998,6 +998,27 @@ paths: | |||
998 | type: array | 998 | type: array |
999 | items: | 999 | items: |
1000 | $ref: '#/definitions/VideoChannel' | 1000 | $ref: '#/definitions/VideoChannel' |
1001 | /accounts/{accountId}/video-channels: | ||
1002 | get: | ||
1003 | tags: | ||
1004 | - VideoChannel | ||
1005 | consumes: | ||
1006 | - application/json | ||
1007 | produces: | ||
1008 | - application/json | ||
1009 | parameters: | ||
1010 | - name: accountId | ||
1011 | in: path | ||
1012 | required: true | ||
1013 | type: string | ||
1014 | description: 'The account id ' | ||
1015 | responses: | ||
1016 | '200': | ||
1017 | description: successful operation | ||
1018 | schema: | ||
1019 | type: array | ||
1020 | items: | ||
1021 | $ref: '#/definitions/VideoChannel' | ||
1001 | post: | 1022 | post: |
1002 | security: | 1023 | security: |
1003 | - OAuth2: [ ] | 1024 | - OAuth2: [ ] |
@@ -1008,6 +1029,11 @@ paths: | |||
1008 | produces: | 1029 | produces: |
1009 | - application/json | 1030 | - application/json |
1010 | parameters: | 1031 | parameters: |
1032 | - name: accountId | ||
1033 | in: path | ||
1034 | required: true | ||
1035 | type: string | ||
1036 | description: 'The account id ' | ||
1011 | - in: body | 1037 | - in: body |
1012 | name: body | 1038 | name: body |
1013 | schema: | 1039 | schema: |
@@ -1015,7 +1041,7 @@ paths: | |||
1015 | responses: | 1041 | responses: |
1016 | '204': | 1042 | '204': |
1017 | description: successful operation | 1043 | description: successful operation |
1018 | "/videos/channels/{id}": | 1044 | "/account/{accountId}/video-channels/{id}": |
1019 | get: | 1045 | get: |
1020 | tags: | 1046 | tags: |
1021 | - VideoChannel | 1047 | - VideoChannel |
@@ -1024,11 +1050,16 @@ paths: | |||
1024 | produces: | 1050 | produces: |
1025 | - application/json | 1051 | - application/json |
1026 | parameters: | 1052 | parameters: |
1053 | - name: accountId | ||
1054 | in: path | ||
1055 | required: true | ||
1056 | type: string | ||
1057 | description: 'The account id ' | ||
1027 | - name: id | 1058 | - name: id |
1028 | in: path | 1059 | in: path |
1029 | required: true | 1060 | required: true |
1030 | type: string | 1061 | type: string |
1031 | description: 'The video id ' | 1062 | description: 'The video channel id ' |
1032 | responses: | 1063 | responses: |
1033 | '200': | 1064 | '200': |
1034 | description: successful operation | 1065 | description: successful operation |
@@ -1044,11 +1075,16 @@ paths: | |||
1044 | produces: | 1075 | produces: |
1045 | - application/json | 1076 | - application/json |
1046 | parameters: | 1077 | parameters: |
1078 | - name: accountId | ||
1079 | in: path | ||
1080 | required: true | ||
1081 | type: string | ||
1082 | description: 'The account id ' | ||
1047 | - name: id | 1083 | - name: id |
1048 | in: path | 1084 | in: path |
1049 | required: true | 1085 | required: true |
1050 | type: string | 1086 | type: string |
1051 | description: 'The video id ' | 1087 | description: 'The video channel id ' |
1052 | - in: body | 1088 | - in: body |
1053 | name: body | 1089 | name: body |
1054 | schema: | 1090 | schema: |
@@ -1066,35 +1102,19 @@ paths: | |||
1066 | produces: | 1102 | produces: |
1067 | - application/json | 1103 | - application/json |
1068 | parameters: | 1104 | parameters: |
1069 | - name: id | 1105 | - name: accountId |
1070 | in: path | 1106 | in: path |
1071 | required: true | 1107 | required: true |
1072 | type: string | 1108 | type: string |
1073 | description: 'The video id ' | 1109 | description: 'The account id ' |
1074 | responses: | 1110 | - name: id |
1075 | '204': | ||
1076 | description: successful operation | ||
1077 | /videos/accounts/{accountId}/channels: | ||
1078 | get: | ||
1079 | tags: | ||
1080 | - VideoChannel | ||
1081 | consumes: | ||
1082 | - application/json | ||
1083 | produces: | ||
1084 | - application/json | ||
1085 | parameters: | ||
1086 | - name: accountId | ||
1087 | in: path | 1111 | in: path |
1088 | required: true | 1112 | required: true |
1089 | type: string | 1113 | type: string |
1090 | description: 'The account id ' | 1114 | description: 'The video channel id ' |
1091 | responses: | 1115 | responses: |
1092 | '200': | 1116 | '204': |
1093 | description: successful operation | 1117 | description: successful operation |
1094 | schema: | ||
1095 | type: array | ||
1096 | items: | ||
1097 | $ref: '#/definitions/VideoChannel' | ||
1098 | "/videos/{videoId}/comment-threads": | 1118 | "/videos/{videoId}/comment-threads": |
1099 | get: | 1119 | get: |
1100 | tags: | 1120 | tags: |