aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorRigel Kent <sendmemail@rigelk.eu>2018-11-13 23:27:58 +0100
committerRigel Kent <sendmemail@rigelk.eu>2018-11-13 23:32:55 +0100
commit2963c3432f3967675530162b1bf87b549cc124f5 (patch)
tree9740118cc83f43ed8e3f153fab6d2e430081e32f /support/doc/api
parentbe0f59b4eec3c2c4dcd151e2b174be39dff1568e (diff)
downloadPeerTube-2963c3432f3967675530162b1bf87b549cc124f5.tar.gz
PeerTube-2963c3432f3967675530162b1bf87b549cc124f5.tar.zst
PeerTube-2963c3432f3967675530162b1bf87b549cc124f5.zip
updated REST API documentation
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/html/index.html3892
-rw-r--r--support/doc/api/openapi.yaml168
2 files changed, 2330 insertions, 1730 deletions
diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html
index 0efc24f02..7e53ce675 100644
--- a/support/doc/api/html/index.html
+++ b/support/doc/api/html/index.html
@@ -25,13 +25,13 @@
25 <a href="#tag-Accounts">Accounts</a> 25 <a href="#tag-Accounts">Accounts</a>
26 <ul> 26 <ul>
27 <li> 27 <li>
28 <a href="#operation--accounts--name--get"> GET /accounts/{name} </a> 28 <a href="#operation--accounts--name--get"> Get the account by name </a>
29 </li> 29 </li>
30 <li> 30 <li>
31 <a href="#operation--accounts--name--videos-get"> GET /accounts/{name}/videos </a> 31 <a href="#operation--accounts--name--videos-get"> Get videos for an account, provided the name of that account </a>
32 </li> 32 </li>
33 <li> 33 <li>
34 <a href="#operation--accounts-get"> GET /accounts </a> 34 <a href="#operation--accounts-get"> Get all accounts </a>
35 </li> 35 </li>
36 </ul> 36 </ul>
37 </section> 37 </section>
@@ -39,7 +39,7 @@
39 <a href="#tag-Config">Config</a> 39 <a href="#tag-Config">Config</a>
40 <ul> 40 <ul>
41 <li> 41 <li>
42 <a href="#operation--config-get"> GET /config </a> 42 <a href="#operation--config-get"> Get the configuration of the server </a>
43 </li> 43 </li>
44 </ul> 44 </ul>
45 </section> 45 </section>
@@ -47,7 +47,7 @@
47 <a href="#tag-Feeds">Feeds</a> 47 <a href="#tag-Feeds">Feeds</a>
48 <ul> 48 <ul>
49 <li> 49 <li>
50 <a href="#operation--feeds-videos.-format--get"> GET /feeds/videos.{format} </a> 50 <a href="#operation--feeds-videos.-format--get"> Get the feed of videos for the server, with optional filter by account name or id </a>
51 </li> 51 </li>
52 </ul> 52 </ul>
53 </section> 53 </section>
@@ -55,7 +55,7 @@
55 <a href="#tag-Job">Job</a> 55 <a href="#tag-Job">Job</a>
56 <ul> 56 <ul>
57 <li> 57 <li>
58 <a href="#operation--jobs-get"> GET /jobs </a> 58 <a href="#operation--jobs-get"> Get list of jobs </a>
59 </li> 59 </li>
60 </ul> 60 </ul>
61 </section> 61 </section>
@@ -63,166 +63,177 @@
63 <a href="#tag-ServerFollowing">ServerFollowing</a> 63 <a href="#tag-ServerFollowing">ServerFollowing</a>
64 <ul> 64 <ul>
65 <li> 65 <li>
66 <a href="#operation--server-following--host--delete"> DELETE /server/following/{host} </a> 66 <a href="#operation--server-following--host--delete"> Unfollow a server by hostname </a>
67 </li> 67 </li>
68 <li> 68 <li>
69 <a href="#operation--server-followers-get"> GET /server/followers </a> 69 <a href="#operation--server-followers-get"> Get followers of the server </a>
70 </li> 70 </li>
71 <li> 71 <li>
72 <a href="#operation--server-following-get"> GET /server/following </a> 72 <a href="#operation--server-following-get"> Get servers followed by the server </a>
73 </li> 73 </li>
74 <li> 74 <li>
75 <a href="#operation--server-following-post"> POST /server/following </a> 75 <a href="#operation--server-following-post"> Follow a server </a>
76 </li> 76 </li>
77 </ul> 77 </ul>
78 </section> 78 </section>
79 <section> 79 <section>
80 <a href="#tag-User">User</a> 80 <a href="#tag-VideoAbuse">VideoAbuse</a>
81 <ul> 81 <ul>
82 <li> 82 <li>
83 <a href="#operation--users-post"> POST /users </a> 83 <a href="#operation--videos-abuse-get"> Get list of reported video abuses </a>
84 </li> 84 </li>
85 <li> 85 <li>
86 <a href="#operation--users-get"> GET /users </a> 86 <a href="#operation--videos--id--abuse-post"> Report an abuse, on a video by its id </a>
87 </li> 87 </li>
88 </ul>
89 </section>
90 <section>
91 <a href="#tag-Video">Video</a>
92 <ul>
88 <li> 93 <li>
89 <a href="#operation--users--id--delete"> DELETE /users/{id} </a> 94 <a href="#operation--accounts--name--videos-get"> Get videos for an account, provided the name of that account </a>
90 </li> 95 </li>
91 <li> 96 <li>
92 <a href="#operation--users--id--get"> GET /users/{id} </a> 97 <a href="#operation--videos-get"> Get list of videos </a>
93 </li> 98 </li>
94 <li> 99 <li>
95 <a href="#operation--users--id--put"> PUT /users/{id} </a> 100 <a href="#operation--videos-categories-get"> Get list of video licences known by the server </a>
96 </li> 101 </li>
97 <li> 102 <li>
98 <a href="#operation--users-me-get"> GET /users/me </a> 103 <a href="#operation--videos-licences-get"> Get list of video licences known by the server </a>
99 </li> 104 </li>
100 <li> 105 <li>
101 <a href="#operation--users-me-put"> PUT /users/me </a> 106 <a href="#operation--videos-languages-get"> Get list of languages known by the server </a>
102 </li> 107 </li>
103 <li> 108 <li>
104 <a href="#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used </a> 109 <a href="#operation--videos-privacies-get"> Get list of privacy policies supported by the server </a>
105 </li> 110 </li>
106 <li> 111 <li>
107 <a href="#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating </a> 112 <a href="#operation--videos--id--put"> Update metadata for a video by its id </a>
108 </li> 113 </li>
109 <li> 114 <li>
110 <a href="#operation--users-me-videos-get"> GET /users/me/videos </a> 115 <a href="#operation--videos--id--get"> Get a video by its id </a>
111 </li> 116 </li>
112 <li> 117 <li>
113 <a href="#operation--users-register-post"> POST /users/register </a> 118 <a href="#operation--videos--id--delete"> Delete a video by its id </a>
114 </li> 119 </li>
115 <li> 120 <li>
116 <a href="#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick </a> 121 <a href="#operation--videos--id--description-get"> Get a video description by its id </a>
122 </li>
123 <li>
124 <a href="#operation--videos--id--views-post"> Add a view to the video by its id </a>
125 </li>
126 <li>
127 <a href="#operation--videos-upload-post"> Upload a video file with its metadata </a>
117 </li> 128 </li>
118 </ul> 129 </ul>
119 </section> 130 </section>
120 <section> 131 <section>
121 <a href="#tag-Video">Video</a> 132 <a href="#tag-Search">Search</a>
122 <ul> 133 <ul>
123 <li> 134 <li>
124 <a href="#operation--videos-get"> GET /videos </a> 135 <a href="#operation--search-videos-get"> Get the videos corresponding to a given query </a>
125 </li> 136 </li>
137 </ul>
138 </section>
139 <section>
140 <a href="#tag-VideoComment">VideoComment</a>
141 <ul>
126 <li> 142 <li>
127 <a href="#operation--videos-categories-get"> GET /videos/categories </a> 143 <a href="#operation--videos--id--comment-threads-get"> Get the comment threads of a video by its id </a>
128 </li> 144 </li>
129 <li> 145 <li>
130 <a href="#operation--videos-licences-get"> GET /videos/licences </a> 146 <a href="#operation--videos--id--comment-threads-post"> Creates a comment thread, on a video by its id </a>
131 </li> 147 </li>
132 <li> 148 <li>
133 <a href="#operation--videos-languages-get"> GET /videos/languages </a> 149 <a href="#operation--videos--id--comment-threads--threadId--get"> Get the comment thread by its id, of a video by its id </a>
134 </li> 150 </li>
135 <li> 151 <li>
136 <a href="#operation--videos-privacies-get"> GET /videos/privacies </a> 152 <a href="#operation--videos--id--comments--commentId--post"> Creates a comment in a comment thread by its id, of a video by its id </a>
137 </li> 153 </li>
138 <li> 154 <li>
139 <a href="#operation--videos--id--put"> PUT /videos/{id} </a> 155 <a href="#operation--videos--id--comments--commentId--delete"> Delete a comment in a comment therad by its id, of a video by its id </a>
140 </li> 156 </li>
157 </ul>
158 </section>
159 <section>
160 <a href="#tag-VideoChannel">VideoChannel</a>
161 <ul>
141 <li> 162 <li>
142 <a href="#operation--videos--id--get"> GET /videos/{id} </a> 163 <a href="#operation--video-channels-get"> Get list of video channels </a>
143 </li> 164 </li>
144 <li> 165 <li>
145 <a href="#operation--videos--id--delete"> DELETE /videos/{id} </a> 166 <a href="#operation--video-channels-post"> Creates a video channel for the current user </a>
146 </li> 167 </li>
147 <li> 168 <li>
148 <a href="#operation--videos--id--description-get"> GET /videos/{id}/description </a> 169 <a href="#operation--video-channels--id--get"> Get a video channel by its id </a>
149 </li> 170 </li>
150 <li> 171 <li>
151 <a href="#operation--videos--id--views-post"> POST /videos/{id}/views </a> 172 <a href="#operation--video-channels--id--put"> Update a video channel by its id </a>
152 </li> 173 </li>
153 <li> 174 <li>
154 <a href="#operation--videos-upload-post"> POST /videos/upload </a> 175 <a href="#operation--video-channels--id--delete"> Delete a video channel by its id </a>
155 </li> 176 </li>
156 </ul>
157 </section>
158 <section>
159 <a href="#tag-VideoAbuse">VideoAbuse</a>
160 <ul>
161 <li> 177 <li>
162 <a href="#operation--videos-abuse-get"> GET /videos/abuse </a> 178 <a href="#operation--video-channels--id--videos-get"> Get videos of a video channel by its id </a>
163 </li> 179 </li>
164 <li> 180 <li>
165 <a href="#operation--videos--id--abuse-post"> POST /videos/{id}/abuse </a> 181 <a href="#operation--accounts--name--video-channels-get"> Get video channels of an account by its name </a>
166 </li> 182 </li>
167 </ul> 183 </ul>
168 </section> 184 </section>
169 <section> 185 <section>
170 <a href="#tag-VideoBlacklist">VideoBlacklist</a> 186 <a href="#tag-User">User</a>
171 <ul> 187 <ul>
172 <li> 188 <li>
173 <a href="#operation--videos--id--blacklist-post"> POST /videos/{id}/blacklist </a> 189 <a href="#operation--users-post"> Creates user </a>
174 </li> 190 </li>
175 <li> 191 <li>
176 <a href="#operation--videos--id--blacklist-delete"> DELETE /videos/{id}/blacklist </a> 192 <a href="#operation--users-get"> Get a list of users </a>
177 </li> 193 </li>
178 <li> 194 <li>
179 <a href="#operation--videos-blacklist-get"> GET /videos/blacklist </a> 195 <a href="#operation--users--id--delete"> Delete a user by its id </a>
180 </li> 196 </li>
181 </ul>
182 </section>
183 <section>
184 <a href="#tag-VideoChannel">VideoChannel</a>
185 <ul>
186 <li> 197 <li>
187 <a href="#operation--video-channels-get"> GET /video-channels </a> 198 <a href="#operation--users--id--get"> Get user by its id </a>
188 </li> 199 </li>
189 <li> 200 <li>
190 <a href="#operation--video-channels-post"> POST /video-channels </a> 201 <a href="#operation--users--id--put"> Update user profile by its id </a>
191 </li> 202 </li>
192 <li> 203 <li>
193 <a href="#operation--video-channels--id--get"> GET /video-channels/{id} </a> 204 <a href="#operation--users-me-get"> Get current user information </a>
194 </li> 205 </li>
195 <li> 206 <li>
196 <a href="#operation--video-channels--id--put"> PUT /video-channels/{id} </a> 207 <a href="#operation--users-me-put"> Update current user information </a>
197 </li> 208 </li>
198 <li> 209 <li>
199 <a href="#operation--video-channels--id--delete"> DELETE /video-channels/{id} </a> 210 <a href="#operation--users-me-video-quota-used-get"> Get current user used quota </a>
200 </li> 211 </li>
201 <li> 212 <li>
202 <a href="#operation--video-channels--id--videos-get"> GET /video-channels/{id}/videos </a> 213 <a href="#operation--users-me-videos--videoId--rating-get"> Get rating of video by its id, among those of the current user </a>
203 </li> 214 </li>
204 <li> 215 <li>
205 <a href="#operation--accounts--name--video-channels-get"> GET /accounts/{name}/video-channels </a> 216 <a href="#operation--users-me-videos-get"> Get videos of the current user </a>
206 </li> 217 </li>
207 </ul>
208 </section>
209 <section>
210 <a href="#tag-VideoComment">VideoComment</a>
211 <ul>
212 <li> 218 <li>
213 <a href="#operation--videos--id--comment-threads-get"> GET /videos/{id}/comment-threads </a> 219 <a href="#operation--users-register-post"> Register a user </a>
214 </li> 220 </li>
215 <li> 221 <li>
216 <a href="#operation--videos--id--comment-threads-post"> POST /videos/{id}/comment-threads </a> 222 <a href="#operation--users-me-avatar-pick-post"> Update current user avatar </a>
217 </li> 223 </li>
224 </ul>
225 </section>
226 <section>
227 <a href="#tag-VideoBlacklist">VideoBlacklist</a>
228 <ul>
218 <li> 229 <li>
219 <a href="#operation--videos--id--comment-threads--threadId--get"> GET /videos/{id}/comment-threads/{threadId} </a> 230 <a href="#operation--videos--id--blacklist-post"> Put on blacklist a video by its id </a>
220 </li> 231 </li>
221 <li> 232 <li>
222 <a href="#operation--videos--id--comments--commentId--post"> POST /videos/{id}/comments/{commentId} </a> 233 <a href="#operation--videos--id--blacklist-delete"> Delete an entry of the blacklist of a video by its id </a>
223 </li> 234 </li>
224 <li> 235 <li>
225 <a href="#operation--videos--id--comments--commentId--delete"> DELETE /videos/{id}/comments/{commentId} </a> 236 <a href="#operation--videos-blacklist-get"> Get list of videos on blacklist </a>
226 </li> 237 </li>
227 </ul> 238 </ul>
228 </section> 239 </section>
@@ -230,15 +241,7 @@
230 <a href="#tag-VideoRate">VideoRate</a> 241 <a href="#tag-VideoRate">VideoRate</a>
231 <ul> 242 <ul>
232 <li> 243 <li>
233 <a href="#operation--videos--id--rate-put"> PUT /videos/{id}/rate </a> 244 <a href="#operation--videos--id--rate-put"> Vote for a video by its id </a>
234 </li>
235 </ul>
236 </section>
237 <section>
238 <a href="#tag-Search">Search</a>
239 <ul>
240 <li>
241 <a href="#operation--search-videos-get"> GET /search/videos </a>
242 </li> 245 </li>
243 </ul> 246 </ul>
244 </section> 247 </section>
@@ -283,18 +286,27 @@
283 <div id="introduction" data-traverse-target="introduction"> 286 <div id="introduction" data-traverse-target="introduction">
284 <div class="doc-row"> 287 <div class="doc-row">
285 <div class="doc-copy"> 288 <div class="doc-copy">
286 <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.</p> 289 <h1 id="introduction">Introduction</h1>
290 <p>The PeerTube API is built on HTTP(S). Our API is RESTful. It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. You can use your favorite HTTP/REST library for your programming language to use PeerTube. No official SDK is currently provided.</p>
291 <h1 id="authentication">Authentication</h1>
292 <p>When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time.</p>
287 </div> 293 </div>
288 <div class="doc-examples"> 294 <div class="doc-examples">
289 <section> 295 <section>
290 <h5>API Endpoint</h5> 296 <h5>API Endpoint</h5>
291 <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre> 297 <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre>
292 <!-- </div> --> 298 <!-- </div> -->
299 <h5>Request Content-Types:
300 <span>application/json</span>
301 </h5>
302 <h5>Response Content-Types:
303 <span>application/json; charset&#x3D;utf-8</span>
304 </h5>
293 <h5>Schemes: 305 <h5>Schemes:
294 <span>https</span> 306 <span>https</span>
295 </h5> 307 </h5>
296 <h5>Version: 308 <h5>Version:
297 <span>1.0.0-beta</span> 309 <span>1.1.0-alpha.2</span>
298 </h5> 310 </h5>
299 </section> 311 </section>
300 </div> 312 </div>
@@ -311,8 +323,15 @@
311 </h3> 323 </h3>
312 <section class="security-definition-description"> 324 <section class="security-definition-description">
313 <p>In the header: 325 <p>In the header:
314 <em>Authorization: Bearer mytoken</em> 326 <em>Authorization: Bearer &lt;token></em>
315 </p> 327 </p>
328 <p>Authenticating via OAuth requires the following steps:</p>
329 <ul>
330 <li>Have an account with sufficient authorization levels</li>
331 <li>
332 <a href="https://docs.joinpeertube.org/lang/en/devdocs/rest.html">Generate</a> a Bearer Token</li>
333 <li>Make Authenticated Requests</li>
334 </ul>
316 </section> 335 </section>
317 <section class="swagger-security-definition-properties"> 336 <section class="swagger-security-definition-properties">
318 <div class="prop-row security-definition-property"> 337 <div class="prop-row security-definition-property">
@@ -333,11 +352,29 @@
333 </div> 352 </div>
334 <div class="prop-value security-definition-property-type"> https://peertube.example.com/api/v1/users/token </div> 353 <div class="prop-value security-definition-property-type"> https://peertube.example.com/api/v1/users/token </div>
335 </div> 354 </div>
355 <div class="prop-row security-definition-property">
356 <div class="prop-name">
357 <div class="prop-title security-definition-property-name">scopes</div>
358 </div>
359 <div class="prop-value security-definition-property-type">
360 <span id="security-definition-scope-admin">admin</span>
361 <p class="security-definition-scope-description">Admin scope</p>
362 <span id="security-definition-scope-moderator">moderator</span>
363 <p class="security-definition-scope-description">Moderator scope</p>
364 <span id="security-definition-scope-user">user</span>
365 <p class="security-definition-scope-description">User scope</p>
366 </div>
367 </div>
336 </section> 368 </section>
337 </div> 369 </div>
338 </div> 370 </div>
339 </div> 371 </div>
340 <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1> 372 <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1>
373 <div class="tag-description doc-row">
374 <div class="doc-copy">
375 <p>Using some features of PeerTube require authentication, for which Accounts provide different levels of permission as well as associated user information. Accounts also encompass remote accounts discovered across the federation.</p>
376 </div>
377 </div>
341 <div id="operation--accounts--name--get" class="operation panel" data-traverse-target="operation--accounts--name--get"> 378 <div id="operation--accounts--name--get" class="operation panel" data-traverse-target="operation--accounts--name--get">
342 <!-- <section class="operation-tags row"> --> 379 <!-- <section class="operation-tags row"> -->
343 <!-- <div class="doc-copy"> --> 380 <!-- <div class="doc-copy"> -->
@@ -348,13 +385,18 @@
348 <!-- </div> --> 385 <!-- </div> -->
349 <!-- </section> --> 386 <!-- </section> -->
350 <h2 class="operation-title"> 387 <h2 class="operation-title">
351 <span class="operation-name"> 388 <span class="operation-summary">Get the account by name</span>
352 <span class="operation-name">GET</span>
353 <span class="operation-path">/accounts/{name}</span>
354 </span>
355 </h2> 389 </h2>
356 <div class="doc-row"> 390 <div class="doc-row">
357 <div class="doc-copy"> 391 <div class="doc-copy">
392 <section class="swagger-operation-path">
393 <span class="operation-method">GET</span>
394 <span class="operation-path">/accounts/{name}</span>
395 </section>
396 </div>
397 </div>
398 <div class="doc-row">
399 <div class="doc-copy">
358 <section class="swagger-request-params"> 400 <section class="swagger-request-params">
359 <div class="prop-row prop-group"> 401 <div class="prop-row prop-group">
360 <div class="prop-name"> 402 <div class="prop-name">
@@ -473,18 +515,25 @@
473 <!-- <div class="doc-copy"> --> 515 <!-- <div class="doc-copy"> -->
474 <div class="operation-tags"> 516 <div class="operation-tags">
475 <a class="label" href="#tag-Accounts">Accounts</a> 517 <a class="label" href="#tag-Accounts">Accounts</a>
518 <!--, -->
519 <a class="label" href="#tag-Video">Video</a>
476 <!----> 520 <!---->
477 </div> 521 </div>
478 <!-- </div> --> 522 <!-- </div> -->
479 <!-- </section> --> 523 <!-- </section> -->
480 <h2 class="operation-title"> 524 <h2 class="operation-title">
481 <span class="operation-name"> 525 <span class="operation-summary">Get videos for an account, provided the name of that account</span>
482 <span class="operation-name">GET</span>
483 <span class="operation-path">/accounts/{name}/videos</span>
484 </span>
485 </h2> 526 </h2>
486 <div class="doc-row"> 527 <div class="doc-row">
487 <div class="doc-copy"> 528 <div class="doc-copy">
529 <section class="swagger-operation-path">
530 <span class="operation-method">GET</span>
531 <span class="operation-path">/accounts/{name}/videos</span>
532 </section>
533 </div>
534 </div>
535 <div class="doc-row">
536 <div class="doc-copy">
488 <section class="swagger-request-params"> 537 <section class="swagger-request-params">
489 <div class="prop-row prop-group"> 538 <div class="prop-row prop-group">
490 <div class="prop-name"> 539 <div class="prop-name">
@@ -591,12 +640,17 @@
591 <!-- </div> --> 640 <!-- </div> -->
592 <!-- </section> --> 641 <!-- </section> -->
593 <h2 class="operation-title"> 642 <h2 class="operation-title">
594 <span class="operation-name"> 643 <span class="operation-summary">Get all accounts</span>
595 <span class="operation-name">GET</span>
596 <span class="operation-path">/accounts</span>
597 </span>
598 </h2> 644 </h2>
599 <div class="doc-row"> 645 <div class="doc-row">
646 <div class="doc-copy">
647 <section class="swagger-operation-path">
648 <span class="operation-method">GET</span>
649 <span class="operation-path">/accounts</span>
650 </section>
651 </div>
652 </div>
653 <div class="doc-row">
600 <div class="doc-copy"> </div> 654 <div class="doc-copy"> </div>
601 <div class="doc-examples"></div> 655 <div class="doc-examples"></div>
602 </div> 656 </div>
@@ -632,7 +686,7 @@
632 </div> 686 </div>
633 <div class="doc-examples"> 687 <div class="doc-examples">
634 <h5>Response Content-Types: 688 <h5>Response Content-Types:
635 <span>application/json</span> 689 <span>application/jsonhttps://peertube.cpy.re/api/v1</span>
636 </h5> 690 </h5>
637 <section> 691 <section>
638 <h5>Response Example 692 <h5>Response Example
@@ -664,6 +718,11 @@
664 </div> 718 </div>
665 </div> 719 </div>
666 <h1 id="tag-Config" class="swagger-summary-tag" data-traverse-target="tag-Config">Config</h1> 720 <h1 id="tag-Config" class="swagger-summary-tag" data-traverse-target="tag-Config">Config</h1>
721 <div class="tag-description doc-row">
722 <div class="doc-copy">
723 <p>Each server exposes public information regarding supported videos and options.</p>
724 </div>
725 </div>
667 <div id="operation--config-get" class="operation panel" data-traverse-target="operation--config-get"> 726 <div id="operation--config-get" class="operation panel" data-traverse-target="operation--config-get">
668 <!-- <section class="operation-tags row"> --> 727 <!-- <section class="operation-tags row"> -->
669 <!-- <div class="doc-copy"> --> 728 <!-- <div class="doc-copy"> -->
@@ -674,12 +733,17 @@
674 <!-- </div> --> 733 <!-- </div> -->
675 <!-- </section> --> 734 <!-- </section> -->
676 <h2 class="operation-title"> 735 <h2 class="operation-title">
677 <span class="operation-name"> 736 <span class="operation-summary">Get the configuration of the server</span>
678 <span class="operation-name">GET</span>
679 <span class="operation-path">/config</span>
680 </span>
681 </h2> 737 </h2>
682 <div class="doc-row"> 738 <div class="doc-row">
739 <div class="doc-copy">
740 <section class="swagger-operation-path">
741 <span class="operation-method">GET</span>
742 <span class="operation-path">/config</span>
743 </section>
744 </div>
745 </div>
746 <div class="doc-row">
683 <div class="doc-copy"> </div> 747 <div class="doc-copy"> </div>
684 <div class="doc-examples"></div> 748 <div class="doc-examples"></div>
685 </div> 749 </div>
@@ -744,6 +808,11 @@
744 </div> 808 </div>
745 </div> 809 </div>
746 <h1 id="tag-Feeds" class="swagger-summary-tag" data-traverse-target="tag-Feeds">Feeds</h1> 810 <h1 id="tag-Feeds" class="swagger-summary-tag" data-traverse-target="tag-Feeds">Feeds</h1>
811 <div class="tag-description doc-row">
812 <div class="doc-copy">
813 <p>Feeds of videos and feeds of comments allow to see updates and get them in an aggregator or script of your choice.</p>
814 </div>
815 </div>
747 <div id="operation--feeds-videos.-format--get" class="operation panel" data-traverse-target="operation--feeds-videos.-format--get"> 816 <div id="operation--feeds-videos.-format--get" class="operation panel" data-traverse-target="operation--feeds-videos.-format--get">
748 <!-- <section class="operation-tags row"> --> 817 <!-- <section class="operation-tags row"> -->
749 <!-- <div class="doc-copy"> --> 818 <!-- <div class="doc-copy"> -->
@@ -754,13 +823,18 @@
754 <!-- </div> --> 823 <!-- </div> -->
755 <!-- </section> --> 824 <!-- </section> -->
756 <h2 class="operation-title"> 825 <h2 class="operation-title">
757 <span class="operation-name"> 826 <span class="operation-summary">Get the feed of videos for the server, with optional filter by account name or id</span>
758 <span class="operation-name">GET</span>
759 <span class="operation-path">/feeds/videos.{format}</span>
760 </span>
761 </h2> 827 </h2>
762 <div class="doc-row"> 828 <div class="doc-row">
763 <div class="doc-copy"> 829 <div class="doc-copy">
830 <section class="swagger-operation-path">
831 <span class="operation-method">GET</span>
832 <span class="operation-path">/feeds/videos.{format}</span>
833 </section>
834 </div>
835 </div>
836 <div class="doc-row">
837 <div class="doc-copy">
764 <section class="swagger-request-params"> 838 <section class="swagger-request-params">
765 <div class="prop-row prop-group"> 839 <div class="prop-row prop-group">
766 <div class="prop-name"> 840 <div class="prop-name">
@@ -836,6 +910,11 @@
836 </div> 910 </div>
837 </div> 911 </div>
838 <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1> 912 <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1>
913 <div class="tag-description doc-row">
914 <div class="doc-copy">
915 <p>Jobs are long-running tasks enqueued and processed by the instance itself. No additional worker registration is currently available.</p>
916 </div>
917 </div>
839 <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get"> 918 <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get">
840 <!-- <section class="operation-tags row"> --> 919 <!-- <section class="operation-tags row"> -->
841 <!-- <div class="doc-copy"> --> 920 <!-- <div class="doc-copy"> -->
@@ -846,13 +925,18 @@
846 <!-- </div> --> 925 <!-- </div> -->
847 <!-- </section> --> 926 <!-- </section> -->
848 <h2 class="operation-title"> 927 <h2 class="operation-title">
849 <span class="operation-name"> 928 <span class="operation-summary">Get list of jobs</span>
850 <span class="operation-name">GET</span>
851 <span class="operation-path">/jobs</span>
852 </span>
853 </h2> 929 </h2>
854 <div class="doc-row"> 930 <div class="doc-row">
855 <div class="doc-copy"> 931 <div class="doc-copy">
932 <section class="swagger-operation-path">
933 <span class="operation-method">GET</span>
934 <span class="operation-path">/jobs</span>
935 </section>
936 </div>
937 </div>
938 <div class="doc-row">
939 <div class="doc-copy">
856 <section class="swagger-request-params"> 940 <section class="swagger-request-params">
857 <div class="prop-row prop-group"> 941 <div class="prop-row prop-group">
858 <div class="prop-name"> 942 <div class="prop-name">
@@ -984,7 +1068,9 @@
984 <td> 1068 <td>
985 <a href="#security-definition-OAuth2">OAuth2</a> 1069 <a href="#security-definition-OAuth2">OAuth2</a>
986 </td> 1070 </td>
987 <td> </td> 1071 <td>
1072 <a href="#security-definition-scope-admin">admin</a>
1073 </td>
988 </tr> 1074 </tr>
989 </tbody> 1075 </tbody>
990 </table> 1076 </table>
@@ -993,6 +1079,11 @@
993 </div> 1079 </div>
994 </div> 1080 </div>
995 <h1 id="tag-ServerFollowing" class="swagger-summary-tag" data-traverse-target="tag-ServerFollowing">ServerFollowing</h1> 1081 <h1 id="tag-ServerFollowing" class="swagger-summary-tag" data-traverse-target="tag-ServerFollowing">ServerFollowing</h1>
1082 <div class="tag-description doc-row">
1083 <div class="doc-copy">
1084 <p>Managing servers which the instance interacts with is crucial to the concept of federation in PeerTube and external video indexation. The PeerTube server then deals with inter-server ActivityPub operations and propagates information across its social graph by posting activities to actors&#39; inbox endpoints.</p>
1085 </div>
1086 </div>
996 <div id="operation--server-following--host--delete" class="operation panel" data-traverse-target="operation--server-following--host--delete"> 1087 <div id="operation--server-following--host--delete" class="operation panel" data-traverse-target="operation--server-following--host--delete">
997 <!-- <section class="operation-tags row"> --> 1088 <!-- <section class="operation-tags row"> -->
998 <!-- <div class="doc-copy"> --> 1089 <!-- <div class="doc-copy"> -->
@@ -1003,13 +1094,18 @@
1003 <!-- </div> --> 1094 <!-- </div> -->
1004 <!-- </section> --> 1095 <!-- </section> -->
1005 <h2 class="operation-title"> 1096 <h2 class="operation-title">
1006 <span class="operation-name"> 1097 <span class="operation-summary">Unfollow a server by hostname</span>
1007 <span class="operation-name">DELETE</span>
1008 <span class="operation-path">/server/following/{host}</span>
1009 </span>
1010 </h2> 1098 </h2>
1011 <div class="doc-row"> 1099 <div class="doc-row">
1012 <div class="doc-copy"> 1100 <div class="doc-copy">
1101 <section class="swagger-operation-path">
1102 <span class="operation-method">DELETE</span>
1103 <span class="operation-path">/server/following/{host}</span>
1104 </section>
1105 </div>
1106 </div>
1107 <div class="doc-row">
1108 <div class="doc-copy">
1013 <section class="swagger-request-params"> 1109 <section class="swagger-request-params">
1014 <div class="prop-row prop-group"> 1110 <div class="prop-row prop-group">
1015 <div class="prop-name"> 1111 <div class="prop-name">
@@ -1064,7 +1160,9 @@
1064 <td> 1160 <td>
1065 <a href="#security-definition-OAuth2">OAuth2</a> 1161 <a href="#security-definition-OAuth2">OAuth2</a>
1066 </td> 1162 </td>
1067 <td> </td> 1163 <td>
1164 <a href="#security-definition-scope-admin">admin</a>
1165 </td>
1068 </tr> 1166 </tr>
1069 </tbody> 1167 </tbody>
1070 </table> 1168 </table>
@@ -1082,13 +1180,18 @@
1082 <!-- </div> --> 1180 <!-- </div> -->
1083 <!-- </section> --> 1181 <!-- </section> -->
1084 <h2 class="operation-title"> 1182 <h2 class="operation-title">
1085 <span class="operation-name"> 1183 <span class="operation-summary">Get followers of the server</span>
1086 <span class="operation-name">GET</span>
1087 <span class="operation-path">/server/followers</span>
1088 </span>
1089 </h2> 1184 </h2>
1090 <div class="doc-row"> 1185 <div class="doc-row">
1091 <div class="doc-copy"> 1186 <div class="doc-copy">
1187 <section class="swagger-operation-path">
1188 <span class="operation-method">GET</span>
1189 <span class="operation-path">/server/followers</span>
1190 </section>
1191 </div>
1192 </div>
1193 <div class="doc-row">
1194 <div class="doc-copy">
1092 <section class="swagger-request-params"> 1195 <section class="swagger-request-params">
1093 <div class="prop-row prop-group"> 1196 <div class="prop-row prop-group">
1094 <div class="prop-name"> 1197 <div class="prop-name">
@@ -1231,13 +1334,18 @@
1231 <!-- </div> --> 1334 <!-- </div> -->
1232 <!-- </section> --> 1335 <!-- </section> -->
1233 <h2 class="operation-title"> 1336 <h2 class="operation-title">
1234 <span class="operation-name"> 1337 <span class="operation-summary">Get servers followed by the server</span>
1235 <span class="operation-name">GET</span>
1236 <span class="operation-path">/server/following</span>
1237 </span>
1238 </h2> 1338 </h2>
1239 <div class="doc-row"> 1339 <div class="doc-row">
1240 <div class="doc-copy"> 1340 <div class="doc-copy">
1341 <section class="swagger-operation-path">
1342 <span class="operation-method">GET</span>
1343 <span class="operation-path">/server/following</span>
1344 </section>
1345 </div>
1346 </div>
1347 <div class="doc-row">
1348 <div class="doc-copy">
1241 <section class="swagger-request-params"> 1349 <section class="swagger-request-params">
1242 <div class="prop-row prop-group"> 1350 <div class="prop-row prop-group">
1243 <div class="prop-name"> 1351 <div class="prop-name">
@@ -1380,13 +1488,18 @@
1380 <!-- </div> --> 1488 <!-- </div> -->
1381 <!-- </section> --> 1489 <!-- </section> -->
1382 <h2 class="operation-title"> 1490 <h2 class="operation-title">
1383 <span class="operation-name"> 1491 <span class="operation-summary">Follow a server</span>
1384 <span class="operation-name">POST</span>
1385 <span class="operation-path">/server/following</span>
1386 </span>
1387 </h2> 1492 </h2>
1388 <div class="doc-row"> 1493 <div class="doc-row">
1389 <div class="doc-copy"> 1494 <div class="doc-copy">
1495 <section class="swagger-operation-path">
1496 <span class="operation-method">POST</span>
1497 <span class="operation-path">/server/following</span>
1498 </section>
1499 </div>
1500 </div>
1501 <div class="doc-row">
1502 <div class="doc-copy">
1390 <section class="swagger-request-body"> 1503 <section class="swagger-request-body">
1391 <div class="prop-row"> 1504 <div class="prop-row">
1392 <div class="prop-name"> 1505 <div class="prop-name">
@@ -1488,7 +1601,9 @@
1488 <td> 1601 <td>
1489 <a href="#security-definition-OAuth2">OAuth2</a> 1602 <a href="#security-definition-OAuth2">OAuth2</a>
1490 </td> 1603 </td>
1491 <td> </td> 1604 <td>
1605 <a href="#security-definition-scope-admin">admin</a>
1606 </td>
1492 </tr> 1607 </tr>
1493 </tbody> 1608 </tbody>
1494 </table> 1609 </table>
@@ -1496,135 +1611,34 @@
1496 </div> 1611 </div>
1497 </div> 1612 </div>
1498 </div> 1613 </div>
1499 <h1 id="tag-User" class="swagger-summary-tag" data-traverse-target="tag-User">User</h1> 1614 <h1 id="tag-VideoAbuse" class="swagger-summary-tag" data-traverse-target="tag-VideoAbuse">VideoAbuse</h1>
1500 <div id="operation--users-post" class="operation panel" data-traverse-target="operation--users-post"> 1615 <div class="tag-description doc-row">
1616 <div class="doc-copy">
1617 <p>Video abuses deal with reports of local or remote videos alike.</p>
1618 </div>
1619 </div>
1620 <div id="operation--videos-abuse-get" class="operation panel" data-traverse-target="operation--videos-abuse-get">
1501 <!-- <section class="operation-tags row"> --> 1621 <!-- <section class="operation-tags row"> -->
1502 <!-- <div class="doc-copy"> --> 1622 <!-- <div class="doc-copy"> -->
1503 <div class="operation-tags"> 1623 <div class="operation-tags">
1504 <a class="label" href="#tag-User">User</a> 1624 <a class="label" href="#tag-VideoAbuse">VideoAbuse</a>
1505 <!----> 1625 <!---->
1506 </div> 1626 </div>
1507 <!-- </div> --> 1627 <!-- </div> -->
1508 <!-- </section> --> 1628 <!-- </section> -->
1509 <h2 class="operation-title"> 1629 <h2 class="operation-title">
1510 <span class="operation-name"> 1630 <span class="operation-summary">Get list of reported video abuses</span>
1511 <span class="operation-name">POST</span>
1512 <span class="operation-path">/users</span>
1513 </span>
1514 </h2> 1631 </h2>
1515 <div class="doc-row"> 1632 <div class="doc-row">
1516 <div class="doc-copy"> 1633 <div class="doc-copy">
1517 <section class="swagger-request-body"> 1634 <section class="swagger-operation-path">
1518 <div class="prop-row"> 1635 <span class="operation-method">GET</span>
1519 <div class="prop-name"> 1636 <span class="operation-path">/videos/abuse</span>
1520 <div class="swagger-request-model">
1521 <span class="">
1522 <a class="json-schema-ref" href="#/definitions/AddUser">AddUser</a>
1523 </span>
1524 </div>
1525 </div>
1526 <div class="prop-value columns small-6">
1527 <!-- <div class="swagger-request-description"> -->
1528 <p>User to create</p>
1529 <!-- </div> -->
1530 </div>
1531 </div>
1532 </section>
1533 </div>
1534 <div class="doc-examples">
1535 <section>
1536 <h5>Request Content-Types:
1537 <span>application/json</span>
1538 </h5>
1539 <h5>Request Example</h5>
1540 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1541 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1542 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1543 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1544 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1545 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1546}
1547</code></pre>
1548 <!-- </div> -->
1549 </section> 1637 </section>
1550 </div> 1638 </div>
1551 </div> 1639 </div>
1552 <div class="doc-row"> 1640 <div class="doc-row">
1553 <div class="doc-copy"> 1641 <div class="doc-copy">
1554 <section class="swagger-responses">
1555 <div class="prop-row prop-group">
1556 <div class="prop-name">
1557 <div class="prop-title">200 OK</div>
1558 <div class="prop-ref">
1559 <span class="">
1560 <a class="json-schema-ref" href="#/definitions/AddUserResponse">AddUserResponse</a>
1561 </span>
1562 </div>
1563 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1564 </div>
1565 <div class="prop-value">
1566 <p>successful operation</p>
1567 </div>
1568 </div>
1569 </section>
1570 </div>
1571 <div class="doc-examples">
1572 <h5>Response Content-Types:
1573 <span>application/json</span>
1574 </h5>
1575 <section>
1576 <h5>Response Example
1577 <span>(200 OK)</span>
1578 </h5>
1579 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1580 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1581 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1582}
1583</code></pre>
1584 <!-- </div> -->
1585 </section>
1586 </div>
1587 </div>
1588 <div class="doc-row">
1589 <div class="doc-copy">
1590 <section class="swagger-request-security">
1591 <table class="table">
1592 <thead>
1593 <tr>
1594 <th class="swagger-request-security-schema"></th>
1595 <th class="swagger-request-security-scopes"></th>
1596 </tr>
1597 </thead>
1598 <tbody>
1599 <tr>
1600 <td>
1601 <a href="#security-definition-OAuth2">OAuth2</a>
1602 </td>
1603 <td> </td>
1604 </tr>
1605 </tbody>
1606 </table>
1607 </section>
1608 </div>
1609 </div>
1610 </div>
1611 <div id="operation--users-get" class="operation panel" data-traverse-target="operation--users-get">
1612 <!-- <section class="operation-tags row"> -->
1613 <!-- <div class="doc-copy"> -->
1614 <div class="operation-tags">
1615 <a class="label" href="#tag-User">User</a>
1616 <!---->
1617 </div>
1618 <!-- </div> -->
1619 <!-- </section> -->
1620 <h2 class="operation-title">
1621 <span class="operation-name">
1622 <span class="operation-name">GET</span>
1623 <span class="operation-path">/users</span>
1624 </span>
1625 </h2>
1626 <div class="doc-row">
1627 <div class="doc-copy">
1628 <section class="swagger-request-params"> 1642 <section class="swagger-request-params">
1629 <div class="prop-row prop-group"> 1643 <div class="prop-row prop-group">
1630 <div class="prop-name"> 1644 <div class="prop-name">
@@ -1680,7 +1694,7 @@
1680 <div class="prop-title">200 OK</div> 1694 <div class="prop-title">200 OK</div>
1681 <div class="prop-ref"> 1695 <div class="prop-ref">
1682 <span class="json-schema-ref-array"> 1696 <span class="json-schema-ref-array">
1683 <a class="json-schema-ref" href="#/definitions/User">User</a> 1697 <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a>
1684 </span> 1698 </span>
1685 </div> 1699 </div>
1686 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> 1700 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
@@ -1694,7 +1708,7 @@
1694 <div class="prop-value"> 1708 <div class="prop-value">
1695 <span class="json-property-type"> 1709 <span class="json-property-type">
1696 <span class="json-schema-ref-array"> 1710 <span class="json-schema-ref-array">
1697 <a class="json-schema-ref" href="#/definitions/User">User</a> 1711 <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a>
1698 </span> 1712 </span>
1699 </span> 1713 </span>
1700 <span class="json-property-range" title="Value limits"></span> 1714 <span class="json-property-range" title="Value limits"></span>
@@ -1713,14 +1727,8 @@
1713 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ 1727 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
1714 { 1728 {
1715 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 1729 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1716 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1730 <span class="hljs-attr">&quot;reason&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1717 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1731 <span class="hljs-attr">&quot;reporterAccount&quot;</span>: {
1718 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1719 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1720 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1721 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1722 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1723 <span class="hljs-attr">&quot;account&quot;</span>: {
1724 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1732 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1725 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 1733 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1726 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1734 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
@@ -1737,17 +1745,13 @@
1737 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span> 1745 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1738 } 1746 }
1739 }, 1747 },
1740 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [ 1748 <span class="hljs-attr">&quot;video&quot;</span>: {
1741 { 1749 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1742 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1750 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1743 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1751 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1744 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>, 1752 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1745 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: { 1753 },
1746 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 1754 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1747 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1748 }
1749 }
1750 ]
1751 } 1755 }
1752] 1756]
1753</code></pre> 1757</code></pre>
@@ -1778,100 +1782,26 @@
1778 </div> 1782 </div>
1779 </div> 1783 </div>
1780 </div> 1784 </div>
1781 <div id="operation--users--id--delete" class="operation panel" data-traverse-target="operation--users--id--delete"> 1785 <div id="operation--videos--id--abuse-post" class="operation panel" data-traverse-target="operation--videos--id--abuse-post">
1782 <!-- <section class="operation-tags row"> --> 1786 <!-- <section class="operation-tags row"> -->
1783 <!-- <div class="doc-copy"> --> 1787 <!-- <div class="doc-copy"> -->
1784 <div class="operation-tags"> 1788 <div class="operation-tags">
1785 <a class="label" href="#tag-User">User</a> 1789 <a class="label" href="#tag-VideoAbuse">VideoAbuse</a>
1786 <!----> 1790 <!---->
1787 </div> 1791 </div>
1788 <!-- </div> --> 1792 <!-- </div> -->
1789 <!-- </section> --> 1793 <!-- </section> -->
1790 <h2 class="operation-title"> 1794 <h2 class="operation-title">
1791 <span class="operation-name"> 1795 <span class="operation-summary">Report an abuse, on a video by its id</span>
1792 <span class="operation-name">DELETE</span>
1793 <span class="operation-path">/users/{id}</span>
1794 </span>
1795 </h2> 1796 </h2>
1796 <div class="doc-row"> 1797 <div class="doc-row">
1797 <div class="doc-copy"> 1798 <div class="doc-copy">
1798 <section class="swagger-request-params"> 1799 <section class="swagger-operation-path">
1799 <div class="prop-row prop-group"> 1800 <span class="operation-method">POST</span>
1800 <div class="prop-name"> 1801 <span class="operation-path">/videos/{id}/abuse</span>
1801 <div class="prop-title">id:
1802 <span class="prop-type">
1803 <span class="json-property-type">number</span>
1804 <span class="json-property-range" title="Value limits"></span>
1805 </span>
1806 </div>
1807 <span class="json-property-required"></span>
1808 <div class="prop-subtitle"> in path </div>
1809 </div>
1810 <div class="prop-value">
1811 <p>The user id</p>
1812 </div>
1813 </div>
1814 </section>
1815 </div>
1816 <div class="doc-examples"></div>
1817 </div>
1818 <div class="doc-row">
1819 <div class="doc-copy">
1820 <section class="swagger-responses">
1821 <div class="prop-row prop-group">
1822 <div class="prop-name">
1823 <div class="prop-title">204 No Content</div>
1824 </div>
1825 <div class="prop-value">
1826 <p>Successful operation</p>
1827 </div>
1828 </div>
1829 </section>
1830 </div>
1831 <div class="doc-examples">
1832 <h5>Response Content-Types:
1833 <span>application/json</span>
1834 </h5>
1835 </div>
1836 </div>
1837 <div class="doc-row">
1838 <div class="doc-copy">
1839 <section class="swagger-request-security">
1840 <table class="table">
1841 <thead>
1842 <tr>
1843 <th class="swagger-request-security-schema"></th>
1844 <th class="swagger-request-security-scopes"></th>
1845 </tr>
1846 </thead>
1847 <tbody>
1848 <tr>
1849 <td>
1850 <a href="#security-definition-OAuth2">OAuth2</a>
1851 </td>
1852 <td> </td>
1853 </tr>
1854 </tbody>
1855 </table>
1856 </section> 1802 </section>
1857 </div> 1803 </div>
1858 </div> 1804 </div>
1859 </div>
1860 <div id="operation--users--id--get" class="operation panel" data-traverse-target="operation--users--id--get">
1861 <!-- <section class="operation-tags row"> -->
1862 <!-- <div class="doc-copy"> -->
1863 <div class="operation-tags">
1864 <a class="label" href="#tag-User">User</a>
1865 <!---->
1866 </div>
1867 <!-- </div> -->
1868 <!-- </section> -->
1869 <h2 class="operation-title">
1870 <span class="operation-name">
1871 <span class="operation-name">GET</span>
1872 <span class="operation-path">/users/{id}</span>
1873 </span>
1874 </h2>
1875 <div class="doc-row"> 1805 <div class="doc-row">
1876 <div class="doc-copy"> 1806 <div class="doc-copy">
1877 <section class="swagger-request-params"> 1807 <section class="swagger-request-params">
@@ -1879,7 +1809,7 @@
1879 <div class="prop-name"> 1809 <div class="prop-name">
1880 <div class="prop-title">id: 1810 <div class="prop-title">id:
1881 <span class="prop-type"> 1811 <span class="prop-type">
1882 <span class="json-property-type">number</span> 1812 <span class="json-property-type">string</span>
1883 <span class="json-property-range" title="Value limits"></span> 1813 <span class="json-property-range" title="Value limits"></span>
1884 </span> 1814 </span>
1885 </div> 1815 </div>
@@ -1887,7 +1817,7 @@
1887 <div class="prop-subtitle"> in path </div> 1817 <div class="prop-subtitle"> in path </div>
1888 </div> 1818 </div>
1889 <div class="prop-value"> 1819 <div class="prop-value">
1890 <p>The user id</p> 1820 <p>The video id or uuid</p>
1891 </div> 1821 </div>
1892 </div> 1822 </div>
1893 </section> 1823 </section>
@@ -1899,167 +1829,6 @@
1899 <section class="swagger-responses"> 1829 <section class="swagger-responses">
1900 <div class="prop-row prop-group"> 1830 <div class="prop-row prop-group">
1901 <div class="prop-name"> 1831 <div class="prop-name">
1902 <div class="prop-title">200 OK</div>
1903 <div class="prop-ref">
1904 <span class="">
1905 <a class="json-schema-ref" href="#/definitions/User">User</a>
1906 </span>
1907 </div>
1908 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
1909 </div>
1910 <div class="prop-value">
1911 <p>successful operation</p>
1912 </div>
1913 </div>
1914 </section>
1915 </div>
1916 <div class="doc-examples">
1917 <h5>Response Content-Types:
1918 <span>application/json</span>
1919 </h5>
1920 <section>
1921 <h5>Response Example
1922 <span>(200 OK)</span>
1923 </h5>
1924 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
1925 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1926 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1927 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1928 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1929 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1930 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1931 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1932 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1933 <span class="hljs-attr">&quot;account&quot;</span>: {
1934 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1935 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1936 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1937 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1938 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1939 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1940 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1941 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1942 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1943 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1944 <span class="hljs-attr">&quot;avatar&quot;</span>: {
1945 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1946 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1947 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1948 }
1949 },
1950 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
1951 {
1952 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1953 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1954 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1955 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
1956 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1957 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
1958 }
1959 }
1960 ]
1961}
1962</code></pre>
1963 <!-- </div> -->
1964 </section>
1965 </div>
1966 </div>
1967 <div class="doc-row">
1968 <div class="doc-copy">
1969 <section class="swagger-request-security">
1970 <table class="table">
1971 <thead>
1972 <tr>
1973 <th class="swagger-request-security-schema"></th>
1974 <th class="swagger-request-security-scopes"></th>
1975 </tr>
1976 </thead>
1977 <tbody>
1978 <tr>
1979 <td>
1980 <a href="#security-definition-OAuth2">OAuth2</a>
1981 </td>
1982 <td> </td>
1983 </tr>
1984 </tbody>
1985 </table>
1986 </section>
1987 </div>
1988 </div>
1989 </div>
1990 <div id="operation--users--id--put" class="operation panel" data-traverse-target="operation--users--id--put">
1991 <!-- <section class="operation-tags row"> -->
1992 <!-- <div class="doc-copy"> -->
1993 <div class="operation-tags">
1994 <a class="label" href="#tag-User">User</a>
1995 <!---->
1996 </div>
1997 <!-- </div> -->
1998 <!-- </section> -->
1999 <h2 class="operation-title">
2000 <span class="operation-name">
2001 <span class="operation-name">PUT</span>
2002 <span class="operation-path">/users/{id}</span>
2003 </span>
2004 </h2>
2005 <div class="doc-row">
2006 <div class="doc-copy">
2007 <section class="swagger-request-body">
2008 <div class="prop-row">
2009 <div class="prop-name">
2010 <div class="swagger-request-model">
2011 <span class="">
2012 <a class="json-schema-ref" href="#/definitions/UpdateUser">UpdateUser</a>
2013 </span>
2014 </div>
2015 </div>
2016 <div class="prop-value columns small-6">
2017 <!-- <div class="swagger-request-description"> -->
2018 <p>undefined</p>
2019 <!-- </div> -->
2020 </div>
2021 </div>
2022 </section>
2023 <section class="swagger-request-params">
2024 <div class="prop-row prop-group">
2025 <div class="prop-name">
2026 <div class="prop-title">id:
2027 <span class="prop-type">
2028 <span class="json-property-type">number</span>
2029 <span class="json-property-range" title="Value limits"></span>
2030 </span>
2031 </div>
2032 <span class="json-property-required"></span>
2033 <div class="prop-subtitle"> in path </div>
2034 </div>
2035 <div class="prop-value">
2036 <p>The user id</p>
2037 </div>
2038 </div>
2039 </section>
2040 </div>
2041 <div class="doc-examples">
2042 <section>
2043 <h5>Request Content-Types:
2044 <span>application/json</span>
2045 </h5>
2046 <h5>Request Example</h5>
2047 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2048 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2049 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2050 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2051 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2052}
2053</code></pre>
2054 <!-- </div> -->
2055 </section>
2056 </div>
2057 </div>
2058 <div class="doc-row">
2059 <div class="doc-copy">
2060 <section class="swagger-responses">
2061 <div class="prop-row prop-group">
2062 <div class="prop-name">
2063 <div class="prop-title">204 No Content</div> 1832 <div class="prop-title">204 No Content</div>
2064 </div> 1833 </div>
2065 <div class="prop-value"> 1834 <div class="prop-value">
@@ -2097,323 +1866,40 @@
2097 </div> 1866 </div>
2098 </div> 1867 </div>
2099 </div> 1868 </div>
2100 <div id="operation--users-me-get" class="operation panel" data-traverse-target="operation--users-me-get"> 1869 <h1 id="tag-Video" class="swagger-summary-tag" data-traverse-target="tag-Video">Video</h1>
2101 <!-- <section class="operation-tags row"> --> 1870 <div class="tag-description doc-row">
2102 <!-- <div class="doc-copy"> --> 1871 <div class="doc-copy">
2103 <div class="operation-tags"> 1872 <p>Operations dealing with listing, uploading, fetching or modifying videos.</p>
2104 <a class="label" href="#tag-User">User</a>
2105 <!---->
2106 </div>
2107 <!-- </div> -->
2108 <!-- </section> -->
2109 <h2 class="operation-title">
2110 <span class="operation-name">
2111 <span class="operation-name">GET</span>
2112 <span class="operation-path">/users/me</span>
2113 </span>
2114 </h2>
2115 <div class="doc-row">
2116 <div class="doc-copy"> </div>
2117 <div class="doc-examples"></div>
2118 </div>
2119 <div class="doc-row">
2120 <div class="doc-copy">
2121 <section class="swagger-responses">
2122 <div class="prop-row prop-group">
2123 <div class="prop-name">
2124 <div class="prop-title">200 OK</div>
2125 <div class="prop-ref">
2126 <span class="json-schema-ref-array">
2127 <a class="json-schema-ref" href="#/definitions/User">User</a>
2128 </span>
2129 </div>
2130 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2131 </div>
2132 <div class="prop-value">
2133 <p>successful operation</p>
2134 </div>
2135 </div>
2136 <div class="prop-row prop-inner">
2137 <div class="prop-name">type</div>
2138 <div class="prop-value">
2139 <span class="json-property-type">
2140 <span class="json-schema-ref-array">
2141 <a class="json-schema-ref" href="#/definitions/User">User</a>
2142 </span>
2143 </span>
2144 <span class="json-property-range" title="Value limits"></span>
2145 </div>
2146 </div>
2147 </section>
2148 </div>
2149 <div class="doc-examples">
2150 <h5>Response Content-Types:
2151 <span>application/json</span>
2152 </h5>
2153 <section>
2154 <h5>Response Example
2155 <span>(200 OK)</span>
2156 </h5>
2157 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
2158 {
2159 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2160 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2161 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2162 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2163 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2164 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2165 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2166 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2167 <span class="hljs-attr">&quot;account&quot;</span>: {
2168 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2169 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2170 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2171 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2172 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2173 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2174 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2175 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2176 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2177 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2178 <span class="hljs-attr">&quot;avatar&quot;</span>: {
2179 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2180 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2181 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2182 }
2183 },
2184 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
2185 {
2186 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2187 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2188 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2189 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
2190 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2191 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2192 }
2193 }
2194 ]
2195 }
2196]
2197</code></pre>
2198 <!-- </div> -->
2199 </section>
2200 </div>
2201 </div>
2202 <div class="doc-row">
2203 <div class="doc-copy">
2204 <section class="swagger-request-security">
2205 <table class="table">
2206 <thead>
2207 <tr>
2208 <th class="swagger-request-security-schema"></th>
2209 <th class="swagger-request-security-scopes"></th>
2210 </tr>
2211 </thead>
2212 <tbody>
2213 <tr>
2214 <td>
2215 <a href="#security-definition-OAuth2">OAuth2</a>
2216 </td>
2217 <td> </td>
2218 </tr>
2219 </tbody>
2220 </table>
2221 </section>
2222 </div>
2223 </div>
2224 </div>
2225 <div id="operation--users-me-put" class="operation panel" data-traverse-target="operation--users-me-put">
2226 <!-- <section class="operation-tags row"> -->
2227 <!-- <div class="doc-copy"> -->
2228 <div class="operation-tags">
2229 <a class="label" href="#tag-User">User</a>
2230 <!---->
2231 </div>
2232 <!-- </div> -->
2233 <!-- </section> -->
2234 <h2 class="operation-title">
2235 <span class="operation-name">
2236 <span class="operation-name">PUT</span>
2237 <span class="operation-path">/users/me</span>
2238 </span>
2239 </h2>
2240 <div class="doc-row">
2241 <div class="doc-copy">
2242 <section class="swagger-request-body">
2243 <div class="prop-row">
2244 <div class="prop-name">
2245 <div class="swagger-request-model">
2246 <span class="">
2247 <a class="json-schema-ref" href="#/definitions/UpdateMe">UpdateMe</a>
2248 </span>
2249 </div>
2250 </div>
2251 <div class="prop-value columns small-6">
2252 <!-- <div class="swagger-request-description"> -->
2253 <p>undefined</p>
2254 <!-- </div> -->
2255 </div>
2256 </div>
2257 </section>
2258 </div>
2259 <div class="doc-examples">
2260 <section>
2261 <h5>Request Content-Types:
2262 <span>application/json</span>
2263 </h5>
2264 <h5>Request Example</h5>
2265 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2266 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2267 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2268 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2269 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2270}
2271</code></pre>
2272 <!-- </div> -->
2273 </section>
2274 </div>
2275 </div>
2276 <div class="doc-row">
2277 <div class="doc-copy">
2278 <section class="swagger-responses">
2279 <div class="prop-row prop-group">
2280 <div class="prop-name">
2281 <div class="prop-title">204 No Content</div>
2282 </div>
2283 <div class="prop-value">
2284 <p>Successful operation</p>
2285 </div>
2286 </div>
2287 </section>
2288 </div>
2289 <div class="doc-examples">
2290 <h5>Response Content-Types:
2291 <span>application/json</span>
2292 </h5>
2293 </div>
2294 </div>
2295 <div class="doc-row">
2296 <div class="doc-copy">
2297 <section class="swagger-request-security">
2298 <table class="table">
2299 <thead>
2300 <tr>
2301 <th class="swagger-request-security-schema"></th>
2302 <th class="swagger-request-security-scopes"></th>
2303 </tr>
2304 </thead>
2305 <tbody>
2306 <tr>
2307 <td>
2308 <a href="#security-definition-OAuth2">OAuth2</a>
2309 </td>
2310 <td> </td>
2311 </tr>
2312 </tbody>
2313 </table>
2314 </section>
2315 </div>
2316 </div> 1873 </div>
2317 </div> 1874 </div>
2318 <div id="operation--users-me-video-quota-used-get" class="operation panel" data-traverse-target="operation--users-me-video-quota-used-get"> 1875 <div id="operation--accounts--name--videos-get" class="operation panel" data-traverse-target="operation--accounts--name--videos-get">
2319 <!-- <section class="operation-tags row"> --> 1876 <!-- <section class="operation-tags row"> -->
2320 <!-- <div class="doc-copy"> --> 1877 <!-- <div class="doc-copy"> -->
2321 <div class="operation-tags"> 1878 <div class="operation-tags">
2322 <a class="label" href="#tag-User">User</a> 1879 <a class="label" href="#tag-Accounts">Accounts</a>
1880 <!--, -->
1881 <a class="label" href="#tag-Video">Video</a>
2323 <!----> 1882 <!---->
2324 </div> 1883 </div>
2325 <!-- </div> --> 1884 <!-- </div> -->
2326 <!-- </section> --> 1885 <!-- </section> -->
2327 <h2 class="operation-title"> 1886 <h2 class="operation-title">
2328 <span class="operation-name"> 1887 <span class="operation-summary">Get videos for an account, provided the name of that account</span>
2329 <span class="operation-name">GET</span>
2330 <span class="operation-path">/users/me/video-quota-used</span>
2331 </span>
2332 </h2> 1888 </h2>
2333 <div class="doc-row"> 1889 <div class="doc-row">
2334 <div class="doc-copy"> </div>
2335 <div class="doc-examples"></div>
2336 </div>
2337 <div class="doc-row">
2338 <div class="doc-copy">
2339 <section class="swagger-responses">
2340 <div class="prop-row prop-group">
2341 <div class="prop-name">
2342 <div class="prop-title">200 OK</div>
2343 <div class="prop-ref"> </div>
2344 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2345 </div>
2346 <div class="prop-value">
2347 <p>successful operation</p>
2348 </div>
2349 </div>
2350 <div class="prop-row prop-inner">
2351 <div class="prop-name">type</div>
2352 <div class="prop-value">
2353 <span class="json-property-type">number</span>
2354 <span class="json-property-range" title="Value limits"></span>
2355 </div>
2356 </div>
2357 </section>
2358 </div>
2359 <div class="doc-examples">
2360 <h5>Response Content-Types:
2361 <span>application/json</span>
2362 </h5>
2363 <section>
2364 <h5>Response Example
2365 <span>(200 OK)</span>
2366 </h5>
2367 <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">&quot;number&quot;</span>
2368</code></pre>
2369 <!-- </div> -->
2370 </section>
2371 </div>
2372 </div>
2373 <div class="doc-row">
2374 <div class="doc-copy"> 1890 <div class="doc-copy">
2375 <section class="swagger-request-security"> 1891 <section class="swagger-operation-path">
2376 <table class="table"> 1892 <span class="operation-method">GET</span>
2377 <thead> 1893 <span class="operation-path">/accounts/{name}/videos</span>
2378 <tr>
2379 <th class="swagger-request-security-schema"></th>
2380 <th class="swagger-request-security-scopes"></th>
2381 </tr>
2382 </thead>
2383 <tbody>
2384 <tr>
2385 <td>
2386 <a href="#security-definition-OAuth2">OAuth2</a>
2387 </td>
2388 <td> </td>
2389 </tr>
2390 </tbody>
2391 </table>
2392 </section> 1894 </section>
2393 </div> 1895 </div>
2394 </div> 1896 </div>
2395 </div>
2396 <div id="operation--users-me-videos--videoId--rating-get" class="operation panel" data-traverse-target="operation--users-me-videos--videoId--rating-get">
2397 <!-- <section class="operation-tags row"> -->
2398 <!-- <div class="doc-copy"> -->
2399 <div class="operation-tags">
2400 <a class="label" href="#tag-User">User</a>
2401 <!---->
2402 </div>
2403 <!-- </div> -->
2404 <!-- </section> -->
2405 <h2 class="operation-title">
2406 <span class="operation-name">
2407 <span class="operation-name">GET</span>
2408 <span class="operation-path">/users/me/videos/{videoId}/rating</span>
2409 </span>
2410 </h2>
2411 <div class="doc-row"> 1897 <div class="doc-row">
2412 <div class="doc-copy"> 1898 <div class="doc-copy">
2413 <section class="swagger-request-params"> 1899 <section class="swagger-request-params">
2414 <div class="prop-row prop-group"> 1900 <div class="prop-row prop-group">
2415 <div class="prop-name"> 1901 <div class="prop-name">
2416 <div class="prop-title">videoId: 1902 <div class="prop-title">name:
2417 <span class="prop-type"> 1903 <span class="prop-type">
2418 <span class="json-property-type">string</span> 1904 <span class="json-property-type">string</span>
2419 <span class="json-property-range" title="Value limits"></span> 1905 <span class="json-property-range" title="Value limits"></span>
@@ -2423,7 +1909,8 @@
2423 <div class="prop-subtitle"> in path </div> 1909 <div class="prop-subtitle"> in path </div>
2424 </div> 1910 </div>
2425 <div class="prop-value"> 1911 <div class="prop-value">
2426 <p>The video id </p> 1912 <p>The name of the account (chocobozzz or
1913 <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p>
2427 </div> 1914 </div>
2428 </div> 1915 </div>
2429 </section> 1916 </section>
@@ -2438,129 +1925,6 @@
2438 <div class="prop-title">200 OK</div> 1925 <div class="prop-title">200 OK</div>
2439 <div class="prop-ref"> 1926 <div class="prop-ref">
2440 <span class=""> 1927 <span class="">
2441 <a class="json-schema-ref" href="#/definitions/GetMeVideoRating">GetMeVideoRating</a>
2442 </span>
2443 </div>
2444 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2445 </div>
2446 <div class="prop-value">
2447 <p>successful operation</p>
2448 </div>
2449 </div>
2450 </section>
2451 </div>
2452 <div class="doc-examples">
2453 <h5>Response Content-Types:
2454 <span>application/json</span>
2455 </h5>
2456 <section>
2457 <h5>Response Example
2458 <span>(200 OK)</span>
2459 </h5>
2460 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2461 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2462 <span class="hljs-attr">&quot;rating&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>
2463}
2464</code></pre>
2465 <!-- </div> -->
2466 </section>
2467 </div>
2468 </div>
2469 <div class="doc-row">
2470 <div class="doc-copy">
2471 <section class="swagger-request-security">
2472 <table class="table">
2473 <thead>
2474 <tr>
2475 <th class="swagger-request-security-schema"></th>
2476 <th class="swagger-request-security-scopes"></th>
2477 </tr>
2478 </thead>
2479 <tbody>
2480 <tr>
2481 <td>
2482 <a href="#security-definition-OAuth2">OAuth2</a>
2483 </td>
2484 <td> </td>
2485 </tr>
2486 </tbody>
2487 </table>
2488 </section>
2489 </div>
2490 </div>
2491 </div>
2492 <div id="operation--users-me-videos-get" class="operation panel" data-traverse-target="operation--users-me-videos-get">
2493 <!-- <section class="operation-tags row"> -->
2494 <!-- <div class="doc-copy"> -->
2495 <div class="operation-tags">
2496 <a class="label" href="#tag-User">User</a>
2497 <!---->
2498 </div>
2499 <!-- </div> -->
2500 <!-- </section> -->
2501 <h2 class="operation-title">
2502 <span class="operation-name">
2503 <span class="operation-name">GET</span>
2504 <span class="operation-path">/users/me/videos</span>
2505 </span>
2506 </h2>
2507 <div class="doc-row">
2508 <div class="doc-copy">
2509 <section class="swagger-request-params">
2510 <div class="prop-row prop-group">
2511 <div class="prop-name">
2512 <div class="prop-title">start:
2513 <span class="prop-type">
2514 <span class="json-property-type">number</span>
2515 <span class="json-property-range" title="Value limits"></span>
2516 </span>
2517 </div>
2518 <div class="prop-subtitle"> in query </div>
2519 </div>
2520 <div class="prop-value">
2521 <p>Offset</p>
2522 </div>
2523 </div>
2524 <div class="prop-row prop-group">
2525 <div class="prop-name">
2526 <div class="prop-title">count:
2527 <span class="prop-type">
2528 <span class="json-property-type">number</span>
2529 <span class="json-property-range" title="Value limits"></span>
2530 </span>
2531 </div>
2532 <div class="prop-subtitle"> in query </div>
2533 </div>
2534 <div class="prop-value">
2535 <p>Number of items</p>
2536 </div>
2537 </div>
2538 <div class="prop-row prop-group">
2539 <div class="prop-name">
2540 <div class="prop-title">sort:
2541 <span class="prop-type">
2542 <span class="json-property-type">string</span>
2543 <span class="json-property-range" title="Value limits"></span>
2544 </span>
2545 </div>
2546 <div class="prop-subtitle"> in query </div>
2547 </div>
2548 <div class="prop-value">
2549 <p>Sort column (-createdAt for example)</p>
2550 </div>
2551 </div>
2552 </section>
2553 </div>
2554 <div class="doc-examples"></div>
2555 </div>
2556 <div class="doc-row">
2557 <div class="doc-copy">
2558 <section class="swagger-responses">
2559 <div class="prop-row prop-group">
2560 <div class="prop-name">
2561 <div class="prop-title">200 OK</div>
2562 <div class="prop-ref">
2563 <span class="json-schema-ref-array">
2564 <a class="json-schema-ref" href="#/definitions/Video">Video</a> 1928 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2565 </span> 1929 </span>
2566 </div> 1930 </div>
@@ -2570,17 +1934,6 @@
2570 <p>successful operation</p> 1934 <p>successful operation</p>
2571 </div> 1935 </div>
2572 </div> 1936 </div>
2573 <div class="prop-row prop-inner">
2574 <div class="prop-name">type</div>
2575 <div class="prop-value">
2576 <span class="json-property-type">
2577 <span class="json-schema-ref-array">
2578 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
2579 </span>
2580 </span>
2581 <span class="json-property-range" title="Value limits"></span>
2582 </div>
2583 </div>
2584 </section> 1937 </section>
2585 </div> 1938 </div>
2586 <div class="doc-examples"> 1939 <div class="doc-examples">
@@ -2591,260 +1944,74 @@
2591 <h5>Response Example 1944 <h5>Response Example
2592 <span>(200 OK)</span> 1945 <span>(200 OK)</span>
2593 </h5> 1946 </h5>
2594 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ 1947 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2595 { 1948 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1949 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1950 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1951 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1952 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
1953 <span class="hljs-attr">&quot;category&quot;</span>: {
2596 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 1954 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2597 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1955 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2598 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1956 },
2599 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1957 <span class="hljs-attr">&quot;licence&quot;</span>: {
2600 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1958 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2601 <span class="hljs-attr">&quot;category&quot;</span>: { 1959 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2602 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 1960 },
2603 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span> 1961 <span class="hljs-attr">&quot;language&quot;</span>: {
2604 }, 1962 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2605 <span class="hljs-attr">&quot;licence&quot;</span>: { 1963 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2606 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 1964 },
2607 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span> 1965 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2608 }, 1966 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2609 <span class="hljs-attr">&quot;language&quot;</span>: { 1967 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2610 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1968 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
2611 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span> 1969 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2612 }, 1970 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2613 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1971 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2614 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1972 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2615 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 1973 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
2616 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>, 1974 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1975 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
1976 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
1977 <span class="hljs-attr">&quot;account&quot;</span>: {
2617 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1978 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2618 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1979 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2619 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1980 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2620 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 1981 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2621 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 1982 <span class="hljs-attr">&quot;avatar&quot;</span>: {
2622 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 1983 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2623 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 1984 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2624 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>, 1985 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2625 <span class="hljs-attr">&quot;account&quot;</span>: {
2626 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2627 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2628 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2629 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2630 <span class="hljs-attr">&quot;avatar&quot;</span>: {
2631 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2632 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2633 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2634 }
2635 } 1986 }
2636 } 1987 }
2637]
2638</code></pre>
2639 <!-- </div> -->
2640 </section>
2641 </div>
2642 </div>
2643 <div class="doc-row">
2644 <div class="doc-copy">
2645 <section class="swagger-request-security">
2646 <table class="table">
2647 <thead>
2648 <tr>
2649 <th class="swagger-request-security-schema"></th>
2650 <th class="swagger-request-security-scopes"></th>
2651 </tr>
2652 </thead>
2653 <tbody>
2654 <tr>
2655 <td>
2656 <a href="#security-definition-OAuth2">OAuth2</a>
2657 </td>
2658 <td> </td>
2659 </tr>
2660 </tbody>
2661 </table>
2662 </section>
2663 </div>
2664 </div>
2665 </div>
2666 <div id="operation--users-register-post" class="operation panel" data-traverse-target="operation--users-register-post">
2667 <!-- <section class="operation-tags row"> -->
2668 <!-- <div class="doc-copy"> -->
2669 <div class="operation-tags">
2670 <a class="label" href="#tag-User">User</a>
2671 <!---->
2672 </div>
2673 <!-- </div> -->
2674 <!-- </section> -->
2675 <h2 class="operation-title">
2676 <span class="operation-name">
2677 <span class="operation-name">POST</span>
2678 <span class="operation-path">/users/register</span>
2679 </span>
2680 </h2>
2681 <div class="doc-row">
2682 <div class="doc-copy">
2683 <section class="swagger-request-body">
2684 <div class="prop-row">
2685 <div class="prop-name">
2686 <div class="swagger-request-model">
2687 <span class="">
2688 <a class="json-schema-ref" href="#/definitions/RegisterUser">RegisterUser</a>
2689 </span>
2690 </div>
2691 </div>
2692 <div class="prop-value columns small-6">
2693 <!-- <div class="swagger-request-description"> -->
2694 <p>undefined</p>
2695 <!-- </div> -->
2696 </div>
2697 </div>
2698 </section>
2699 </div>
2700 <div class="doc-examples">
2701 <section>
2702 <h5>Request Content-Types:
2703 <span>application/json</span>
2704 </h5>
2705 <h5>Request Example</h5>
2706 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2707 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2708 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2709 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2710} 1988}
2711</code></pre> 1989</code></pre>
2712 <!-- </div> --> 1990 <!-- </div> -->
2713 </section> 1991 </section>
2714 </div> 1992 </div>
2715 </div> 1993 </div>
2716 <div class="doc-row">
2717 <div class="doc-copy">
2718 <section class="swagger-responses">
2719 <div class="prop-row prop-group">
2720 <div class="prop-name">
2721 <div class="prop-title">204 No Content</div>
2722 </div>
2723 <div class="prop-value">
2724 <p>Successful operation</p>
2725 </div>
2726 </div>
2727 </section>
2728 </div>
2729 <div class="doc-examples">
2730 <h5>Response Content-Types:
2731 <span>application/json</span>
2732 </h5>
2733 </div>
2734 </div>
2735 </div> 1994 </div>
2736 <div id="operation--users-me-avatar-pick-post" class="operation panel" data-traverse-target="operation--users-me-avatar-pick-post"> 1995 <div id="operation--videos-get" class="operation panel" data-traverse-target="operation--videos-get">
2737 <!-- <section class="operation-tags row"> --> 1996 <!-- <section class="operation-tags row"> -->
2738 <!-- <div class="doc-copy"> --> 1997 <!-- <div class="doc-copy"> -->
2739 <div class="operation-tags"> 1998 <div class="operation-tags">
2740 <a class="label" href="#tag-User">User</a> 1999 <a class="label" href="#tag-Video">Video</a>
2741 <!----> 2000 <!---->
2742 </div> 2001 </div>
2743 <!-- </div> --> 2002 <!-- </div> -->
2744 <!-- </section> --> 2003 <!-- </section> -->
2745 <h2 class="operation-title"> 2004 <h2 class="operation-title">
2746 <span class="operation-name"> 2005 <span class="operation-summary">Get list of videos</span>
2747 <span class="operation-name">POST</span>
2748 <span class="operation-path">/users/me/avatar/pick</span>
2749 </span>
2750 </h2> 2006 </h2>
2751 <div class="doc-row"> 2007 <div class="doc-row">
2752 <div class="doc-copy"> 2008 <div class="doc-copy">
2753 <section class="swagger-request-params"> 2009 <section class="swagger-operation-path">
2754 <div class="prop-row prop-group"> 2010 <span class="operation-method">GET</span>
2755 <div class="prop-name"> 2011 <span class="operation-path">/videos</span>
2756 <div class="prop-title">avatarfile:
2757 <span class="prop-type">
2758 <span class="json-property-type">file</span>
2759 <span class="json-property-range" title="Value limits"></span>
2760 </span>
2761 </div>
2762 <div class="prop-subtitle"> in formData </div>
2763 </div>
2764 <div class="prop-value">
2765 <p>The file to upload.</p>
2766 </div>
2767 </div>
2768 </section>
2769 </div>
2770 <div class="doc-examples"></div>
2771 </div>
2772 <div class="doc-row">
2773 <div class="doc-copy">
2774 <section class="swagger-responses">
2775 <div class="prop-row prop-group">
2776 <div class="prop-name">
2777 <div class="prop-title">200 OK</div>
2778 <div class="prop-ref">
2779 <span class="">
2780 <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
2781 </span>
2782 </div>
2783 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
2784 </div>
2785 <div class="prop-value">
2786 <p>successful operation</p>
2787 </div>
2788 </div>
2789 </section>
2790 </div>
2791 <div class="doc-examples">
2792 <h5>Response Content-Types:
2793 <span>application/json</span>
2794 </h5>
2795 <section>
2796 <h5>Response Example
2797 <span>(200 OK)</span>
2798 </h5>
2799 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
2800 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2801 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
2802 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
2803}
2804</code></pre>
2805 <!-- </div> -->
2806 </section>
2807 </div>
2808 </div>
2809 <div class="doc-row">
2810 <div class="doc-copy">
2811 <section class="swagger-request-security">
2812 <table class="table">
2813 <thead>
2814 <tr>
2815 <th class="swagger-request-security-schema"></th>
2816 <th class="swagger-request-security-scopes"></th>
2817 </tr>
2818 </thead>
2819 <tbody>
2820 <tr>
2821 <td>
2822 <a href="#security-definition-OAuth2">OAuth2</a>
2823 </td>
2824 <td> </td>
2825 </tr>
2826 </tbody>
2827 </table>
2828 </section> 2012 </section>
2829 </div> 2013 </div>
2830 </div> 2014 </div>
2831 </div>
2832 <h1 id="tag-Video" class="swagger-summary-tag" data-traverse-target="tag-Video">Video</h1>
2833 <div id="operation--videos-get" class="operation panel" data-traverse-target="operation--videos-get">
2834 <!-- <section class="operation-tags row"> -->
2835 <!-- <div class="doc-copy"> -->
2836 <div class="operation-tags">
2837 <a class="label" href="#tag-Video">Video</a>
2838 <!---->
2839 </div>
2840 <!-- </div> -->
2841 <!-- </section> -->
2842 <h2 class="operation-title">
2843 <span class="operation-name">
2844 <span class="operation-name">GET</span>
2845 <span class="operation-path">/videos</span>
2846 </span>
2847 </h2>
2848 <div class="doc-row"> 2015 <div class="doc-row">
2849 <div class="doc-copy"> 2016 <div class="doc-copy">
2850 <section class="swagger-request-params"> 2017 <section class="swagger-request-params">
@@ -3006,12 +2173,17 @@
3006 <!-- </div> --> 2173 <!-- </div> -->
3007 <!-- </section> --> 2174 <!-- </section> -->
3008 <h2 class="operation-title"> 2175 <h2 class="operation-title">
3009 <span class="operation-name"> 2176 <span class="operation-summary">Get list of video licences known by the server</span>
3010 <span class="operation-name">GET</span>
3011 <span class="operation-path">/videos/categories</span>
3012 </span>
3013 </h2> 2177 </h2>
3014 <div class="doc-row"> 2178 <div class="doc-row">
2179 <div class="doc-copy">
2180 <section class="swagger-operation-path">
2181 <span class="operation-method">GET</span>
2182 <span class="operation-path">/videos/categories</span>
2183 </section>
2184 </div>
2185 </div>
2186 <div class="doc-row">
3015 <div class="doc-copy"> </div> 2187 <div class="doc-copy"> </div>
3016 <div class="doc-examples"></div> 2188 <div class="doc-examples"></div>
3017 </div> 2189 </div>
@@ -3021,7 +2193,7 @@
3021 <div class="prop-row prop-group"> 2193 <div class="prop-row prop-group">
3022 <div class="prop-name"> 2194 <div class="prop-name">
3023 <div class="prop-title">200 OK</div> 2195 <div class="prop-title">200 OK</div>
3024 <div class="prop-ref"> </div> 2196 <div class="prop-ref"></div>
3025 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> 2197 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3026 </div> 2198 </div>
3027 <div class="prop-value"> 2199 <div class="prop-value">
@@ -3064,12 +2236,17 @@
3064 <!-- </div> --> 2236 <!-- </div> -->
3065 <!-- </section> --> 2237 <!-- </section> -->
3066 <h2 class="operation-title"> 2238 <h2 class="operation-title">
3067 <span class="operation-name"> 2239 <span class="operation-summary">Get list of video licences known by the server</span>
3068 <span class="operation-name">GET</span>
3069 <span class="operation-path">/videos/licences</span>
3070 </span>
3071 </h2> 2240 </h2>
3072 <div class="doc-row"> 2241 <div class="doc-row">
2242 <div class="doc-copy">
2243 <section class="swagger-operation-path">
2244 <span class="operation-method">GET</span>
2245 <span class="operation-path">/videos/licences</span>
2246 </section>
2247 </div>
2248 </div>
2249 <div class="doc-row">
3073 <div class="doc-copy"> </div> 2250 <div class="doc-copy"> </div>
3074 <div class="doc-examples"></div> 2251 <div class="doc-examples"></div>
3075 </div> 2252 </div>
@@ -3079,7 +2256,7 @@
3079 <div class="prop-row prop-group"> 2256 <div class="prop-row prop-group">
3080 <div class="prop-name"> 2257 <div class="prop-name">
3081 <div class="prop-title">200 OK</div> 2258 <div class="prop-title">200 OK</div>
3082 <div class="prop-ref"> </div> 2259 <div class="prop-ref"></div>
3083 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> 2260 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3084 </div> 2261 </div>
3085 <div class="prop-value"> 2262 <div class="prop-value">
@@ -3122,12 +2299,17 @@
3122 <!-- </div> --> 2299 <!-- </div> -->
3123 <!-- </section> --> 2300 <!-- </section> -->
3124 <h2 class="operation-title"> 2301 <h2 class="operation-title">
3125 <span class="operation-name"> 2302 <span class="operation-summary">Get list of languages known by the server</span>
3126 <span class="operation-name">GET</span>
3127 <span class="operation-path">/videos/languages</span>
3128 </span>
3129 </h2> 2303 </h2>
3130 <div class="doc-row"> 2304 <div class="doc-row">
2305 <div class="doc-copy">
2306 <section class="swagger-operation-path">
2307 <span class="operation-method">GET</span>
2308 <span class="operation-path">/videos/languages</span>
2309 </section>
2310 </div>
2311 </div>
2312 <div class="doc-row">
3131 <div class="doc-copy"> </div> 2313 <div class="doc-copy"> </div>
3132 <div class="doc-examples"></div> 2314 <div class="doc-examples"></div>
3133 </div> 2315 </div>
@@ -3137,7 +2319,7 @@
3137 <div class="prop-row prop-group"> 2319 <div class="prop-row prop-group">
3138 <div class="prop-name"> 2320 <div class="prop-name">
3139 <div class="prop-title">200 OK</div> 2321 <div class="prop-title">200 OK</div>
3140 <div class="prop-ref"> </div> 2322 <div class="prop-ref"></div>
3141 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> 2323 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3142 </div> 2324 </div>
3143 <div class="prop-value"> 2325 <div class="prop-value">
@@ -3180,12 +2362,17 @@
3180 <!-- </div> --> 2362 <!-- </div> -->
3181 <!-- </section> --> 2363 <!-- </section> -->
3182 <h2 class="operation-title"> 2364 <h2 class="operation-title">
3183 <span class="operation-name"> 2365 <span class="operation-summary">Get list of privacy policies supported by the server</span>
3184 <span class="operation-name">GET</span>
3185 <span class="operation-path">/videos/privacies</span>
3186 </span>
3187 </h2> 2366 </h2>
3188 <div class="doc-row"> 2367 <div class="doc-row">
2368 <div class="doc-copy">
2369 <section class="swagger-operation-path">
2370 <span class="operation-method">GET</span>
2371 <span class="operation-path">/videos/privacies</span>
2372 </section>
2373 </div>
2374 </div>
2375 <div class="doc-row">
3189 <div class="doc-copy"> </div> 2376 <div class="doc-copy"> </div>
3190 <div class="doc-examples"></div> 2377 <div class="doc-examples"></div>
3191 </div> 2378 </div>
@@ -3195,7 +2382,7 @@
3195 <div class="prop-row prop-group"> 2382 <div class="prop-row prop-group">
3196 <div class="prop-name"> 2383 <div class="prop-name">
3197 <div class="prop-title">200 OK</div> 2384 <div class="prop-title">200 OK</div>
3198 <div class="prop-ref"> </div> 2385 <div class="prop-ref"></div>
3199 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> 2386 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3200 </div> 2387 </div>
3201 <div class="prop-value"> 2388 <div class="prop-value">
@@ -3238,13 +2425,18 @@
3238 <!-- </div> --> 2425 <!-- </div> -->
3239 <!-- </section> --> 2426 <!-- </section> -->
3240 <h2 class="operation-title"> 2427 <h2 class="operation-title">
3241 <span class="operation-name"> 2428 <span class="operation-summary">Update metadata for a video by its id</span>
3242 <span class="operation-name">PUT</span>
3243 <span class="operation-path">/videos/{id}</span>
3244 </span>
3245 </h2> 2429 </h2>
3246 <div class="doc-row"> 2430 <div class="doc-row">
3247 <div class="doc-copy"> 2431 <div class="doc-copy">
2432 <section class="swagger-operation-path">
2433 <span class="operation-method">PUT</span>
2434 <span class="operation-path">/videos/{id}</span>
2435 </section>
2436 </div>
2437 </div>
2438 <div class="doc-row">
2439 <div class="doc-copy">
3248 <section class="swagger-request-params"> 2440 <section class="swagger-request-params">
3249 <div class="prop-row prop-group"> 2441 <div class="prop-row prop-group">
3250 <div class="prop-name"> 2442 <div class="prop-name">
@@ -3572,13 +2764,18 @@
3572 <!-- </div> --> 2764 <!-- </div> -->
3573 <!-- </section> --> 2765 <!-- </section> -->
3574 <h2 class="operation-title"> 2766 <h2 class="operation-title">
3575 <span class="operation-name"> 2767 <span class="operation-summary">Get a video by its id</span>
3576 <span class="operation-name">GET</span>
3577 <span class="operation-path">/videos/{id}</span>
3578 </span>
3579 </h2> 2768 </h2>
3580 <div class="doc-row"> 2769 <div class="doc-row">
3581 <div class="doc-copy"> 2770 <div class="doc-copy">
2771 <section class="swagger-operation-path">
2772 <span class="operation-method">GET</span>
2773 <span class="operation-path">/videos/{id}</span>
2774 </section>
2775 </div>
2776 </div>
2777 <div class="doc-row">
2778 <div class="doc-copy">
3582 <section class="swagger-request-params"> 2779 <section class="swagger-request-params">
3583 <div class="prop-row prop-group"> 2780 <div class="prop-row prop-group">
3584 <div class="prop-name"> 2781 <div class="prop-name">
@@ -3684,13 +2881,18 @@
3684 <!-- </div> --> 2881 <!-- </div> -->
3685 <!-- </section> --> 2882 <!-- </section> -->
3686 <h2 class="operation-title"> 2883 <h2 class="operation-title">
3687 <span class="operation-name"> 2884 <span class="operation-summary">Delete a video by its id</span>
3688 <span class="operation-name">DELETE</span>
3689 <span class="operation-path">/videos/{id}</span>
3690 </span>
3691 </h2> 2885 </h2>
3692 <div class="doc-row"> 2886 <div class="doc-row">
3693 <div class="doc-copy"> 2887 <div class="doc-copy">
2888 <section class="swagger-operation-path">
2889 <span class="operation-method">DELETE</span>
2890 <span class="operation-path">/videos/{id}</span>
2891 </section>
2892 </div>
2893 </div>
2894 <div class="doc-row">
2895 <div class="doc-copy">
3694 <section class="swagger-request-params"> 2896 <section class="swagger-request-params">
3695 <div class="prop-row prop-group"> 2897 <div class="prop-row prop-group">
3696 <div class="prop-name"> 2898 <div class="prop-name">
@@ -3763,13 +2965,18 @@
3763 <!-- </div> --> 2965 <!-- </div> -->
3764 <!-- </section> --> 2966 <!-- </section> -->
3765 <h2 class="operation-title"> 2967 <h2 class="operation-title">
3766 <span class="operation-name"> 2968 <span class="operation-summary">Get a video description by its id</span>
3767 <span class="operation-name">GET</span>
3768 <span class="operation-path">/videos/{id}/description</span>
3769 </span>
3770 </h2> 2969 </h2>
3771 <div class="doc-row"> 2970 <div class="doc-row">
3772 <div class="doc-copy"> 2971 <div class="doc-copy">
2972 <section class="swagger-operation-path">
2973 <span class="operation-method">GET</span>
2974 <span class="operation-path">/videos/{id}/description</span>
2975 </section>
2976 </div>
2977 </div>
2978 <div class="doc-row">
2979 <div class="doc-copy">
3773 <section class="swagger-request-params"> 2980 <section class="swagger-request-params">
3774 <div class="prop-row prop-group"> 2981 <div class="prop-row prop-group">
3775 <div class="prop-name"> 2982 <div class="prop-name">
@@ -3796,7 +3003,7 @@
3796 <div class="prop-row prop-group"> 3003 <div class="prop-row prop-group">
3797 <div class="prop-name"> 3004 <div class="prop-name">
3798 <div class="prop-title">200 OK</div> 3005 <div class="prop-title">200 OK</div>
3799 <div class="prop-ref"> </div> 3006 <div class="prop-ref"></div>
3800 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> 3007 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3801 </div> 3008 </div>
3802 <div class="prop-value"> 3009 <div class="prop-value">
@@ -3837,13 +3044,18 @@
3837 <!-- </div> --> 3044 <!-- </div> -->
3838 <!-- </section> --> 3045 <!-- </section> -->
3839 <h2 class="operation-title"> 3046 <h2 class="operation-title">
3840 <span class="operation-name"> 3047 <span class="operation-summary">Add a view to the video by its id</span>
3841 <span class="operation-name">POST</span>
3842 <span class="operation-path">/videos/{id}/views</span>
3843 </span>
3844 </h2> 3048 </h2>
3845 <div class="doc-row"> 3049 <div class="doc-row">
3846 <div class="doc-copy"> 3050 <div class="doc-copy">
3051 <section class="swagger-operation-path">
3052 <span class="operation-method">POST</span>
3053 <span class="operation-path">/videos/{id}/views</span>
3054 </section>
3055 </div>
3056 </div>
3057 <div class="doc-row">
3058 <div class="doc-copy">
3847 <section class="swagger-request-params"> 3059 <section class="swagger-request-params">
3848 <div class="prop-row prop-group"> 3060 <div class="prop-row prop-group">
3849 <div class="prop-name"> 3061 <div class="prop-name">
@@ -3894,13 +3106,18 @@
3894 <!-- </div> --> 3106 <!-- </div> -->
3895 <!-- </section> --> 3107 <!-- </section> -->
3896 <h2 class="operation-title"> 3108 <h2 class="operation-title">
3897 <span class="operation-name"> 3109 <span class="operation-summary">Upload a video file with its metadata</span>
3898 <span class="operation-name">POST</span>
3899 <span class="operation-path">/videos/upload</span>
3900 </span>
3901 </h2> 3110 </h2>
3902 <div class="doc-row"> 3111 <div class="doc-row">
3903 <div class="doc-copy"> 3112 <div class="doc-copy">
3113 <section class="swagger-operation-path">
3114 <span class="operation-method">POST</span>
3115 <span class="operation-path">/videos/upload</span>
3116 </section>
3117 </div>
3118 </div>
3119 <div class="doc-row">
3120 <div class="doc-copy">
3904 <section class="swagger-request-params"> 3121 <section class="swagger-request-params">
3905 <div class="prop-row prop-group"> 3122 <div class="prop-row prop-group">
3906 <div class="prop-name"> 3123 <div class="prop-name">
@@ -4197,24 +3414,35 @@
4197 </div> 3414 </div>
4198 </div> 3415 </div>
4199 </div> 3416 </div>
4200 <h1 id="tag-VideoAbuse" class="swagger-summary-tag" data-traverse-target="tag-VideoAbuse">VideoAbuse</h1> 3417 <h1 id="tag-Search" class="swagger-summary-tag" data-traverse-target="tag-Search">Search</h1>
4201 <div id="operation--videos-abuse-get" class="operation panel" data-traverse-target="operation--videos-abuse-get"> 3418 <div class="tag-description doc-row">
3419 <div class="doc-copy">
3420 <p>The search helps to find
3421 <em>videos</em> from within the instance and beyond. Videos from other instances federated by the instance (that is, instances followed by the instance) can be found via keywords and other criteria of the advanced search.</p>
3422 </div>
3423 </div>
3424 <div id="operation--search-videos-get" class="operation panel" data-traverse-target="operation--search-videos-get">
4202 <!-- <section class="operation-tags row"> --> 3425 <!-- <section class="operation-tags row"> -->
4203 <!-- <div class="doc-copy"> --> 3426 <!-- <div class="doc-copy"> -->
4204 <div class="operation-tags"> 3427 <div class="operation-tags">
4205 <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> 3428 <a class="label" href="#tag-Search">Search</a>
4206 <!----> 3429 <!---->
4207 </div> 3430 </div>
4208 <!-- </div> --> 3431 <!-- </div> -->
4209 <!-- </section> --> 3432 <!-- </section> -->
4210 <h2 class="operation-title"> 3433 <h2 class="operation-title">
4211 <span class="operation-name"> 3434 <span class="operation-summary">Get the videos corresponding to a given query</span>
4212 <span class="operation-name">GET</span>
4213 <span class="operation-path">/videos/abuse</span>
4214 </span>
4215 </h2> 3435 </h2>
4216 <div class="doc-row"> 3436 <div class="doc-row">
4217 <div class="doc-copy"> 3437 <div class="doc-copy">
3438 <section class="swagger-operation-path">
3439 <span class="operation-method">GET</span>
3440 <span class="operation-path">/search/videos</span>
3441 </section>
3442 </div>
3443 </div>
3444 <div class="doc-row">
3445 <div class="doc-copy">
4218 <section class="swagger-request-params"> 3446 <section class="swagger-request-params">
4219 <div class="prop-row prop-group"> 3447 <div class="prop-row prop-group">
4220 <div class="prop-name"> 3448 <div class="prop-name">
@@ -4258,6 +3486,21 @@
4258 <p>Sort column (-createdAt for example)</p> 3486 <p>Sort column (-createdAt for example)</p>
4259 </div> 3487 </div>
4260 </div> 3488 </div>
3489 <div class="prop-row prop-group">
3490 <div class="prop-name">
3491 <div class="prop-title">search:
3492 <span class="prop-type">
3493 <span class="json-property-type">string</span>
3494 <span class="json-property-range" title="Value limits"></span>
3495 </span>
3496 </div>
3497 <span class="json-property-required"></span>
3498 <div class="prop-subtitle"> in query </div>
3499 </div>
3500 <div class="prop-value">
3501 <p>String to search</p>
3502 </div>
3503 </div>
4261 </section> 3504 </section>
4262 </div> 3505 </div>
4263 <div class="doc-examples"></div> 3506 <div class="doc-examples"></div>
@@ -4270,7 +3513,7 @@
4270 <div class="prop-title">200 OK</div> 3513 <div class="prop-title">200 OK</div>
4271 <div class="prop-ref"> 3514 <div class="prop-ref">
4272 <span class="json-schema-ref-array"> 3515 <span class="json-schema-ref-array">
4273 <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a> 3516 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
4274 </span> 3517 </span>
4275 </div> 3518 </div>
4276 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> 3519 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
@@ -4284,7 +3527,7 @@
4284 <div class="prop-value"> 3527 <div class="prop-value">
4285 <span class="json-property-type"> 3528 <span class="json-property-type">
4286 <span class="json-schema-ref-array"> 3529 <span class="json-schema-ref-array">
4287 <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a> 3530 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
4288 </span> 3531 </span>
4289 </span> 3532 </span>
4290 <span class="json-property-range" title="Value limits"></span> 3533 <span class="json-property-range" title="Value limits"></span>
@@ -4303,31 +3546,45 @@
4303 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ 3546 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
4304 { 3547 {
4305 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 3548 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4306 <span class="hljs-attr">&quot;reason&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 3549 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4307 <span class="hljs-attr">&quot;reporterAccount&quot;</span>: { 3550 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4308 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 3551 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3552 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3553 <span class="hljs-attr">&quot;category&quot;</span>: {
4309 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 3554 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4310 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 3555 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4311 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 3556 },
3557 <span class="hljs-attr">&quot;licence&quot;</span>: {
3558 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3559 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3560 },
3561 <span class="hljs-attr">&quot;language&quot;</span>: {
3562 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3563 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3564 },
3565 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3566 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3567 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3568 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3569 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3570 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3571 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3572 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3573 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3574 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3575 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3576 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
3577 <span class="hljs-attr">&quot;account&quot;</span>: {
4312 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 3578 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3579 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3580 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4313 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 3581 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4314 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4315 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4316 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4317 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4318 <span class="hljs-attr">&quot;avatar&quot;</span>: { 3582 <span class="hljs-attr">&quot;avatar&quot;</span>: {
4319 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 3583 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4320 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 3584 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4321 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span> 3585 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4322 } 3586 }
4323 }, 3587 }
4324 <span class="hljs-attr">&quot;video&quot;</span>: {
4325 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4326 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4327 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4328 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4329 },
4330 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4331 } 3588 }
4332] 3589]
4333</code></pre> 3590</code></pre>
@@ -4335,46 +3592,185 @@
4335 </section> 3592 </section>
4336 </div> 3593 </div>
4337 </div> 3594 </div>
3595 </div>
3596 <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1>
3597 <div class="tag-description doc-row">
3598 <div class="doc-copy">
3599 <p>Operations dealing with comments to a video. Comments are organized in threads.</p>
3600 </div>
3601 </div>
3602 <div id="operation--videos--id--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--id--comment-threads-get">
3603 <!-- <section class="operation-tags row"> -->
3604 <!-- <div class="doc-copy"> -->
3605 <div class="operation-tags">
3606 <a class="label" href="#tag-VideoComment">VideoComment</a>
3607 <!---->
3608 </div>
3609 <!-- </div> -->
3610 <!-- </section> -->
3611 <h2 class="operation-title">
3612 <span class="operation-summary">Get the comment threads of a video by its id</span>
3613 </h2>
4338 <div class="doc-row"> 3614 <div class="doc-row">
4339 <div class="doc-copy"> 3615 <div class="doc-copy">
4340 <section class="swagger-request-security"> 3616 <section class="swagger-operation-path">
4341 <table class="table"> 3617 <span class="operation-method">GET</span>
4342 <thead> 3618 <span class="operation-path">/videos/{id}/comment-threads</span>
4343 <tr> 3619 </section>
4344 <th class="swagger-request-security-schema"></th> 3620 </div>
4345 <th class="swagger-request-security-scopes"></th> 3621 </div>
4346 </tr> 3622 <div class="doc-row">
4347 </thead> 3623 <div class="doc-copy">
4348 <tbody> 3624 <section class="swagger-request-params">
4349 <tr> 3625 <div class="prop-row prop-group">
4350 <td> 3626 <div class="prop-name">
4351 <a href="#security-definition-OAuth2">OAuth2</a> 3627 <div class="prop-title">id:
4352 </td> 3628 <span class="prop-type">
4353 <td> </td> 3629 <span class="json-property-type">string</span>
4354 </tr> 3630 <span class="json-property-range" title="Value limits"></span>
4355 </tbody> 3631 </span>
4356 </table> 3632 </div>
3633 <span class="json-property-required"></span>
3634 <div class="prop-subtitle"> in path </div>
3635 </div>
3636 <div class="prop-value">
3637 <p>The video id or uuid</p>
3638 </div>
3639 </div>
3640 <div class="prop-row prop-group">
3641 <div class="prop-name">
3642 <div class="prop-title">start:
3643 <span class="prop-type">
3644 <span class="json-property-type">number</span>
3645 <span class="json-property-range" title="Value limits"></span>
3646 </span>
3647 </div>
3648 <div class="prop-subtitle"> in query </div>
3649 </div>
3650 <div class="prop-value">
3651 <p>Offset</p>
3652 </div>
3653 </div>
3654 <div class="prop-row prop-group">
3655 <div class="prop-name">
3656 <div class="prop-title">count:
3657 <span class="prop-type">
3658 <span class="json-property-type">number</span>
3659 <span class="json-property-range" title="Value limits"></span>
3660 </span>
3661 </div>
3662 <div class="prop-subtitle"> in query </div>
3663 </div>
3664 <div class="prop-value">
3665 <p>Number of items</p>
3666 </div>
3667 </div>
3668 <div class="prop-row prop-group">
3669 <div class="prop-name">
3670 <div class="prop-title">sort:
3671 <span class="prop-type">
3672 <span class="json-property-type">string</span>
3673 <span class="json-property-range" title="Value limits"></span>
3674 </span>
3675 </div>
3676 <div class="prop-subtitle"> in query </div>
3677 </div>
3678 <div class="prop-value">
3679 <p>Sort column (-createdAt for example)</p>
3680 </div>
3681 </div>
3682 </section>
3683 </div>
3684 <div class="doc-examples"></div>
3685 </div>
3686 <div class="doc-row">
3687 <div class="doc-copy">
3688 <section class="swagger-responses">
3689 <div class="prop-row prop-group">
3690 <div class="prop-name">
3691 <div class="prop-title">200 OK</div>
3692 <div class="prop-ref">
3693 <span class="">
3694 <a class="json-schema-ref" href="#/definitions/CommentThreadResponse">CommentThreadResponse</a>
3695 </span>
3696 </div>
3697 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
3698 </div>
3699 <div class="prop-value">
3700 <p>successful operation</p>
3701 </div>
3702 </div>
3703 </section>
3704 </div>
3705 <div class="doc-examples">
3706 <h5>Response Content-Types:
3707 <span>application/json</span>
3708 </h5>
3709 <section>
3710 <h5>Response Example
3711 <span>(200 OK)</span>
3712 </h5>
3713 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
3714 <span class="hljs-attr">&quot;total&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3715 <span class="hljs-attr">&quot;data&quot;</span>: [
3716 {
3717 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3718 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3719 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3720 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3721 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3722 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3723 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3724 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3725 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3726 <span class="hljs-attr">&quot;account&quot;</span>: {
3727 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3728 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3729 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3730 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3731 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3732 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3733 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3734 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3735 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3736 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3737 <span class="hljs-attr">&quot;avatar&quot;</span>: {
3738 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3739 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3740 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3741 }
3742 }
3743 }
3744 ]
3745}
3746</code></pre>
3747 <!-- </div> -->
4357 </section> 3748 </section>
4358 </div> 3749 </div>
4359 </div> 3750 </div>
4360 </div> 3751 </div>
4361 <div id="operation--videos--id--abuse-post" class="operation panel" data-traverse-target="operation--videos--id--abuse-post"> 3752 <div id="operation--videos--id--comment-threads-post" class="operation panel" data-traverse-target="operation--videos--id--comment-threads-post">
4362 <!-- <section class="operation-tags row"> --> 3753 <!-- <section class="operation-tags row"> -->
4363 <!-- <div class="doc-copy"> --> 3754 <!-- <div class="doc-copy"> -->
4364 <div class="operation-tags"> 3755 <div class="operation-tags">
4365 <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> 3756 <a class="label" href="#tag-VideoComment">VideoComment</a>
4366 <!----> 3757 <!---->
4367 </div> 3758 </div>
4368 <!-- </div> --> 3759 <!-- </div> -->
4369 <!-- </section> --> 3760 <!-- </section> -->
4370 <h2 class="operation-title"> 3761 <h2 class="operation-title">
4371 <span class="operation-name"> 3762 <span class="operation-summary">Creates a comment thread, on a video by its id</span>
4372 <span class="operation-name">POST</span>
4373 <span class="operation-path">/videos/{id}/abuse</span>
4374 </span>
4375 </h2> 3763 </h2>
4376 <div class="doc-row"> 3764 <div class="doc-row">
4377 <div class="doc-copy"> 3765 <div class="doc-copy">
3766 <section class="swagger-operation-path">
3767 <span class="operation-method">POST</span>
3768 <span class="operation-path">/videos/{id}/comment-threads</span>
3769 </section>
3770 </div>
3771 </div>
3772 <div class="doc-row">
3773 <div class="doc-copy">
4378 <section class="swagger-request-params"> 3774 <section class="swagger-request-params">
4379 <div class="prop-row prop-group"> 3775 <div class="prop-row prop-group">
4380 <div class="prop-name"> 3776 <div class="prop-name">
@@ -4400,10 +3796,16 @@
4400 <section class="swagger-responses"> 3796 <section class="swagger-responses">
4401 <div class="prop-row prop-group"> 3797 <div class="prop-row prop-group">
4402 <div class="prop-name"> 3798 <div class="prop-name">
4403 <div class="prop-title">204 No Content</div> 3799 <div class="prop-title">200 OK</div>
3800 <div class="prop-ref">
3801 <span class="">
3802 <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a>
3803 </span>
3804 </div>
3805 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4404 </div> 3806 </div>
4405 <div class="prop-value"> 3807 <div class="prop-value">
4406 <p>Successful operation</p> 3808 <p>successful operation</p>
4407 </div> 3809 </div>
4408 </div> 3810 </div>
4409 </section> 3811 </section>
@@ -4412,6 +3814,43 @@
4412 <h5>Response Content-Types: 3814 <h5>Response Content-Types:
4413 <span>application/json</span> 3815 <span>application/json</span>
4414 </h5> 3816 </h5>
3817 <section>
3818 <h5>Response Example
3819 <span>(200 OK)</span>
3820 </h5>
3821 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
3822 <span class="hljs-attr">&quot;comment&quot;</span>: {
3823 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3824 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3825 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3826 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3827 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3828 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3829 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3830 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3831 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3832 <span class="hljs-attr">&quot;account&quot;</span>: {
3833 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3834 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3835 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3836 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3837 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3838 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3839 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3840 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3841 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3842 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3843 <span class="hljs-attr">&quot;avatar&quot;</span>: {
3844 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3845 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3846 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3847 }
3848 }
3849 }
3850}
3851</code></pre>
3852 <!-- </div> -->
3853 </section>
4415 </div> 3854 </div>
4416 </div> 3855 </div>
4417 <div class="doc-row"> 3856 <div class="doc-row">
@@ -4437,24 +3876,28 @@
4437 </div> 3876 </div>
4438 </div> 3877 </div>
4439 </div> 3878 </div>
4440 <h1 id="tag-VideoBlacklist" class="swagger-summary-tag" data-traverse-target="tag-VideoBlacklist">VideoBlacklist</h1> 3879 <div id="operation--videos--id--comment-threads--threadId--get" class="operation panel" data-traverse-target="operation--videos--id--comment-threads--threadId--get">
4441 <div id="operation--videos--id--blacklist-post" class="operation panel" data-traverse-target="operation--videos--id--blacklist-post">
4442 <!-- <section class="operation-tags row"> --> 3880 <!-- <section class="operation-tags row"> -->
4443 <!-- <div class="doc-copy"> --> 3881 <!-- <div class="doc-copy"> -->
4444 <div class="operation-tags"> 3882 <div class="operation-tags">
4445 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> 3883 <a class="label" href="#tag-VideoComment">VideoComment</a>
4446 <!----> 3884 <!---->
4447 </div> 3885 </div>
4448 <!-- </div> --> 3886 <!-- </div> -->
4449 <!-- </section> --> 3887 <!-- </section> -->
4450 <h2 class="operation-title"> 3888 <h2 class="operation-title">
4451 <span class="operation-name"> 3889 <span class="operation-summary">Get the comment thread by its id, of a video by its id</span>
4452 <span class="operation-name">POST</span>
4453 <span class="operation-path">/videos/{id}/blacklist</span>
4454 </span>
4455 </h2> 3890 </h2>
4456 <div class="doc-row"> 3891 <div class="doc-row">
4457 <div class="doc-copy"> 3892 <div class="doc-copy">
3893 <section class="swagger-operation-path">
3894 <span class="operation-method">GET</span>
3895 <span class="operation-path">/videos/{id}/comment-threads/{threadId}</span>
3896 </section>
3897 </div>
3898 </div>
3899 <div class="doc-row">
3900 <div class="doc-copy">
4458 <section class="swagger-request-params"> 3901 <section class="swagger-request-params">
4459 <div class="prop-row prop-group"> 3902 <div class="prop-row prop-group">
4460 <div class="prop-name"> 3903 <div class="prop-name">
@@ -4471,6 +3914,21 @@
4471 <p>The video id or uuid</p> 3914 <p>The video id or uuid</p>
4472 </div> 3915 </div>
4473 </div> 3916 </div>
3917 <div class="prop-row prop-group">
3918 <div class="prop-name">
3919 <div class="prop-title">threadId:
3920 <span class="prop-type">
3921 <span class="json-property-type">number</span>
3922 <span class="json-property-range" title="Value limits"></span>
3923 </span>
3924 </div>
3925 <span class="json-property-required"></span>
3926 <div class="prop-subtitle"> in path </div>
3927 </div>
3928 <div class="prop-value">
3929 <p>The thread id (root comment id)</p>
3930 </div>
3931 </div>
4474 </section> 3932 </section>
4475 </div> 3933 </div>
4476 <div class="doc-examples"></div> 3934 <div class="doc-examples"></div>
@@ -4480,10 +3938,16 @@
4480 <section class="swagger-responses"> 3938 <section class="swagger-responses">
4481 <div class="prop-row prop-group"> 3939 <div class="prop-row prop-group">
4482 <div class="prop-name"> 3940 <div class="prop-name">
4483 <div class="prop-title">204 No Content</div> 3941 <div class="prop-title">200 OK</div>
3942 <div class="prop-ref">
3943 <span class="">
3944 <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
3945 </span>
3946 </div>
3947 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4484 </div> 3948 </div>
4485 <div class="prop-value"> 3949 <div class="prop-value">
4486 <p>Successful operation</p> 3950 <p>successful operation</p>
4487 </div> 3951 </div>
4488 </div> 3952 </div>
4489 </section> 3953 </section>
@@ -4492,48 +3956,131 @@
4492 <h5>Response Content-Types: 3956 <h5>Response Content-Types:
4493 <span>application/json</span> 3957 <span>application/json</span>
4494 </h5> 3958 </h5>
4495 </div> 3959 <section>
4496 </div> 3960 <h5>Response Example
4497 <div class="doc-row"> 3961 <span>(200 OK)</span>
4498 <div class="doc-copy"> 3962 </h5>
4499 <section class="swagger-request-security"> 3963 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
4500 <table class="table"> 3964 <span class="hljs-attr">&quot;comment&quot;</span>: {
4501 <thead> 3965 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4502 <tr> 3966 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4503 <th class="swagger-request-security-schema"></th> 3967 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4504 <th class="swagger-request-security-scopes"></th> 3968 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4505 </tr> 3969 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4506 </thead> 3970 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4507 <tbody> 3971 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4508 <tr> 3972 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4509 <td> 3973 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4510 <a href="#security-definition-OAuth2">OAuth2</a> 3974 <span class="hljs-attr">&quot;account&quot;</span>: {
4511 </td> 3975 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4512 <td> </td> 3976 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4513 </tr> 3977 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4514 </tbody> 3978 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4515 </table> 3979 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3980 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3981 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3982 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3983 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3984 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3985 <span class="hljs-attr">&quot;avatar&quot;</span>: {
3986 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3987 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3988 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
3989 }
3990 }
3991 },
3992 <span class="hljs-attr">&quot;children&quot;</span>: [
3993 {
3994 <span class="hljs-attr">&quot;comment&quot;</span>: {
3995 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3996 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3997 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
3998 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
3999 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4000 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4001 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4002 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4003 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4004 <span class="hljs-attr">&quot;account&quot;</span>: {
4005 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4006 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4007 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4008 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4009 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4010 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4011 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4012 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4013 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4014 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4015 <span class="hljs-attr">&quot;avatar&quot;</span>: {
4016 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4017 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4018 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4019 }
4020 }
4021 },
4022 <span class="hljs-attr">&quot;children&quot;</span>: [
4023 {
4024 <span class="hljs-attr">&quot;comment&quot;</span>: {
4025 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4026 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4027 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4028 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4029 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4030 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4031 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4032 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4033 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4034 <span class="hljs-attr">&quot;account&quot;</span>: {
4035 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4036 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4037 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4038 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4039 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4040 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4041 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4042 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4043 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4044 <span class="hljs-attr">&quot;avatar&quot;</span>: {
4045 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4046 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4047 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4048 }
4049 }
4050 }
4051 }
4052 ]
4053 }
4054 ]
4055}
4056</code></pre>
4057 <!-- </div> -->
4516 </section> 4058 </section>
4517 </div> 4059 </div>
4518 </div> 4060 </div>
4519 </div> 4061 </div>
4520 <div id="operation--videos--id--blacklist-delete" class="operation panel" data-traverse-target="operation--videos--id--blacklist-delete"> 4062 <div id="operation--videos--id--comments--commentId--post" class="operation panel" data-traverse-target="operation--videos--id--comments--commentId--post">
4521 <!-- <section class="operation-tags row"> --> 4063 <!-- <section class="operation-tags row"> -->
4522 <!-- <div class="doc-copy"> --> 4064 <!-- <div class="doc-copy"> -->
4523 <div class="operation-tags"> 4065 <div class="operation-tags">
4524 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> 4066 <a class="label" href="#tag-VideoComment">VideoComment</a>
4525 <!----> 4067 <!---->
4526 </div> 4068 </div>
4527 <!-- </div> --> 4069 <!-- </div> -->
4528 <!-- </section> --> 4070 <!-- </section> -->
4529 <h2 class="operation-title"> 4071 <h2 class="operation-title">
4530 <span class="operation-name"> 4072 <span class="operation-summary">Creates a comment in a comment thread by its id, of a video by its id</span>
4531 <span class="operation-name">DELETE</span>
4532 <span class="operation-path">/videos/{id}/blacklist</span>
4533 </span>
4534 </h2> 4073 </h2>
4535 <div class="doc-row"> 4074 <div class="doc-row">
4536 <div class="doc-copy"> 4075 <div class="doc-copy">
4076 <section class="swagger-operation-path">
4077 <span class="operation-method">POST</span>
4078 <span class="operation-path">/videos/{id}/comments/{commentId}</span>
4079 </section>
4080 </div>
4081 </div>
4082 <div class="doc-row">
4083 <div class="doc-copy">
4537 <section class="swagger-request-params"> 4084 <section class="swagger-request-params">
4538 <div class="prop-row prop-group"> 4085 <div class="prop-row prop-group">
4539 <div class="prop-name"> 4086 <div class="prop-name">
@@ -4550,6 +4097,21 @@
4550 <p>The video id or uuid</p> 4097 <p>The video id or uuid</p>
4551 </div> 4098 </div>
4552 </div> 4099 </div>
4100 <div class="prop-row prop-group">
4101 <div class="prop-name">
4102 <div class="prop-title">threadId:
4103 <span class="prop-type">
4104 <span class="json-property-type">number</span>
4105 <span class="json-property-range" title="Value limits"></span>
4106 </span>
4107 </div>
4108 <span class="json-property-required"></span>
4109 <div class="prop-subtitle"> in path </div>
4110 </div>
4111 <div class="prop-value">
4112 <p>The comment id</p>
4113 </div>
4114 </div>
4553 </section> 4115 </section>
4554 </div> 4116 </div>
4555 <div class="doc-examples"></div> 4117 <div class="doc-examples"></div>
@@ -4559,10 +4121,16 @@
4559 <section class="swagger-responses"> 4121 <section class="swagger-responses">
4560 <div class="prop-row prop-group"> 4122 <div class="prop-row prop-group">
4561 <div class="prop-name"> 4123 <div class="prop-name">
4562 <div class="prop-title">204 No Content</div> 4124 <div class="prop-title">200 OK</div>
4125 <div class="prop-ref">
4126 <span class="">
4127 <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a>
4128 </span>
4129 </div>
4130 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4563 </div> 4131 </div>
4564 <div class="prop-value"> 4132 <div class="prop-value">
4565 <p>Successful operation</p> 4133 <p>successful operation</p>
4566 </div> 4134 </div>
4567 </div> 4135 </div>
4568 </section> 4136 </section>
@@ -4571,6 +4139,43 @@
4571 <h5>Response Content-Types: 4139 <h5>Response Content-Types:
4572 <span>application/json</span> 4140 <span>application/json</span>
4573 </h5> 4141 </h5>
4142 <section>
4143 <h5>Response Example
4144 <span>(200 OK)</span>
4145 </h5>
4146 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
4147 <span class="hljs-attr">&quot;comment&quot;</span>: {
4148 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4149 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4150 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4151 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4152 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4153 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4154 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4155 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4156 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4157 <span class="hljs-attr">&quot;account&quot;</span>: {
4158 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4159 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4160 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4161 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4162 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4163 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4164 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4165 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4166 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4167 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4168 <span class="hljs-attr">&quot;avatar&quot;</span>: {
4169 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4170 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4171 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
4172 }
4173 }
4174 }
4175}
4176</code></pre>
4177 <!-- </div> -->
4178 </section>
4574 </div> 4179 </div>
4575 </div> 4180 </div>
4576 <div class="doc-row"> 4181 <div class="doc-row">
@@ -4596,64 +4201,57 @@
4596 </div> 4201 </div>
4597 </div> 4202 </div>
4598 </div> 4203 </div>
4599 <div id="operation--videos-blacklist-get" class="operation panel" data-traverse-target="operation--videos-blacklist-get"> 4204 <div id="operation--videos--id--comments--commentId--delete" class="operation panel" data-traverse-target="operation--videos--id--comments--commentId--delete">
4600 <!-- <section class="operation-tags row"> --> 4205 <!-- <section class="operation-tags row"> -->
4601 <!-- <div class="doc-copy"> --> 4206 <!-- <div class="doc-copy"> -->
4602 <div class="operation-tags"> 4207 <div class="operation-tags">
4603 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> 4208 <a class="label" href="#tag-VideoComment">VideoComment</a>
4604 <!----> 4209 <!---->
4605 </div> 4210 </div>
4606 <!-- </div> --> 4211 <!-- </div> -->
4607 <!-- </section> --> 4212 <!-- </section> -->
4608 <h2 class="operation-title"> 4213 <h2 class="operation-title">
4609 <span class="operation-name"> 4214 <span class="operation-summary">Delete a comment in a comment therad by its id, of a video by its id</span>
4610 <span class="operation-name">GET</span>
4611 <span class="operation-path">/videos/blacklist</span>
4612 </span>
4613 </h2> 4215 </h2>
4614 <div class="doc-row"> 4216 <div class="doc-row">
4615 <div class="doc-copy"> 4217 <div class="doc-copy">
4218 <section class="swagger-operation-path">
4219 <span class="operation-method">DELETE</span>
4220 <span class="operation-path">/videos/{id}/comments/{commentId}</span>
4221 </section>
4222 </div>
4223 </div>
4224 <div class="doc-row">
4225 <div class="doc-copy">
4616 <section class="swagger-request-params"> 4226 <section class="swagger-request-params">
4617 <div class="prop-row prop-group"> 4227 <div class="prop-row prop-group">
4618 <div class="prop-name"> 4228 <div class="prop-name">
4619 <div class="prop-title">start: 4229 <div class="prop-title">id:
4620 <span class="prop-type"> 4230 <span class="prop-type">
4621 <span class="json-property-type">number</span> 4231 <span class="json-property-type">string</span>
4622 <span class="json-property-range" title="Value limits"></span> 4232 <span class="json-property-range" title="Value limits"></span>
4623 </span> 4233 </span>
4624 </div> 4234 </div>
4625 <div class="prop-subtitle"> in query </div> 4235 <span class="json-property-required"></span>
4236 <div class="prop-subtitle"> in path </div>
4626 </div> 4237 </div>
4627 <div class="prop-value"> 4238 <div class="prop-value">
4628 <p>Offset</p> 4239 <p>The video id or uuid</p>
4629 </div> 4240 </div>
4630 </div> 4241 </div>
4631 <div class="prop-row prop-group"> 4242 <div class="prop-row prop-group">
4632 <div class="prop-name"> 4243 <div class="prop-name">
4633 <div class="prop-title">count: 4244 <div class="prop-title">threadId:
4634 <span class="prop-type"> 4245 <span class="prop-type">
4635 <span class="json-property-type">number</span> 4246 <span class="json-property-type">number</span>
4636 <span class="json-property-range" title="Value limits"></span> 4247 <span class="json-property-range" title="Value limits"></span>
4637 </span> 4248 </span>
4638 </div> 4249 </div>
4639 <div class="prop-subtitle"> in query </div> 4250 <span class="json-property-required"></span>
4640 </div> 4251 <div class="prop-subtitle"> in path </div>
4641 <div class="prop-value">
4642 <p>Number of items</p>
4643 </div>
4644 </div>
4645 <div class="prop-row prop-group">
4646 <div class="prop-name">
4647 <div class="prop-title">sort:
4648 <span class="prop-type">
4649 <span class="json-property-type">string</span>
4650 <span class="json-property-range" title="Value limits"></span>
4651 </span>
4652 </div>
4653 <div class="prop-subtitle"> in query </div>
4654 </div> 4252 </div>
4655 <div class="prop-value"> 4253 <div class="prop-value">
4656 <p>Sort column (-createdAt for example)</p> 4254 <p>The comment id</p>
4657 </div> 4255 </div>
4658 </div> 4256 </div>
4659 </section> 4257 </section>
@@ -4665,27 +4263,10 @@
4665 <section class="swagger-responses"> 4263 <section class="swagger-responses">
4666 <div class="prop-row prop-group"> 4264 <div class="prop-row prop-group">
4667 <div class="prop-name"> 4265 <div class="prop-name">
4668 <div class="prop-title">200 OK</div> 4266 <div class="prop-title">204 No Content</div>
4669 <div class="prop-ref">
4670 <span class="json-schema-ref-array">
4671 <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a>
4672 </span>
4673 </div>
4674 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
4675 </div>
4676 <div class="prop-value">
4677 <p>successful operation</p>
4678 </div> 4267 </div>
4679 </div>
4680 <div class="prop-row prop-inner">
4681 <div class="prop-name">type</div>
4682 <div class="prop-value"> 4268 <div class="prop-value">
4683 <span class="json-property-type"> 4269 <p>Successful operation</p>
4684 <span class="json-schema-ref-array">
4685 <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a>
4686 </span>
4687 </span>
4688 <span class="json-property-range" title="Value limits"></span>
4689 </div> 4270 </div>
4690 </div> 4271 </div>
4691 </section> 4272 </section>
@@ -4694,29 +4275,6 @@
4694 <h5>Response Content-Types: 4275 <h5>Response Content-Types:
4695 <span>application/json</span> 4276 <span>application/json</span>
4696 </h5> 4277 </h5>
4697 <section>
4698 <h5>Response Example
4699 <span>(200 OK)</span>
4700 </h5>
4701 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
4702 {
4703 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4704 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4705 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4706 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4707 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4708 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4709 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
4710 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4711 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4712 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4713 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
4714 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>
4715 }
4716]
4717</code></pre>
4718 <!-- </div> -->
4719 </section>
4720 </div> 4278 </div>
4721 </div> 4279 </div>
4722 <div class="doc-row"> 4280 <div class="doc-row">
@@ -4743,6 +4301,11 @@
4743 </div> 4301 </div>
4744 </div> 4302 </div>
4745 <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1> 4303 <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1>
4304 <div class="tag-description doc-row">
4305 <div class="doc-copy">
4306 <p>Operations dealing with creation, modification and video listing of a user&#39;s channels.</p>
4307 </div>
4308 </div>
4746 <div id="operation--video-channels-get" class="operation panel" data-traverse-target="operation--video-channels-get"> 4309 <div id="operation--video-channels-get" class="operation panel" data-traverse-target="operation--video-channels-get">
4747 <!-- <section class="operation-tags row"> --> 4310 <!-- <section class="operation-tags row"> -->
4748 <!-- <div class="doc-copy"> --> 4311 <!-- <div class="doc-copy"> -->
@@ -4753,13 +4316,18 @@
4753 <!-- </div> --> 4316 <!-- </div> -->
4754 <!-- </section> --> 4317 <!-- </section> -->
4755 <h2 class="operation-title"> 4318 <h2 class="operation-title">
4756 <span class="operation-name"> 4319 <span class="operation-summary">Get list of video channels</span>
4757 <span class="operation-name">GET</span>
4758 <span class="operation-path">/video-channels</span>
4759 </span>
4760 </h2> 4320 </h2>
4761 <div class="doc-row"> 4321 <div class="doc-row">
4762 <div class="doc-copy"> 4322 <div class="doc-copy">
4323 <section class="swagger-operation-path">
4324 <span class="operation-method">GET</span>
4325 <span class="operation-path">/video-channels</span>
4326 </section>
4327 </div>
4328 </div>
4329 <div class="doc-row">
4330 <div class="doc-copy">
4763 <section class="swagger-request-params"> 4331 <section class="swagger-request-params">
4764 <div class="prop-row prop-group"> 4332 <div class="prop-row prop-group">
4765 <div class="prop-name"> 4333 <div class="prop-name">
@@ -4872,13 +4440,18 @@
4872 <!-- </div> --> 4440 <!-- </div> -->
4873 <!-- </section> --> 4441 <!-- </section> -->
4874 <h2 class="operation-title"> 4442 <h2 class="operation-title">
4875 <span class="operation-name"> 4443 <span class="operation-summary">Creates a video channel for the current user</span>
4876 <span class="operation-name">POST</span>
4877 <span class="operation-path">/video-channels</span>
4878 </span>
4879 </h2> 4444 </h2>
4880 <div class="doc-row"> 4445 <div class="doc-row">
4881 <div class="doc-copy"> 4446 <div class="doc-copy">
4447 <section class="swagger-operation-path">
4448 <span class="operation-method">POST</span>
4449 <span class="operation-path">/video-channels</span>
4450 </section>
4451 </div>
4452 </div>
4453 <div class="doc-row">
4454 <div class="doc-copy">
4882 <section class="swagger-request-body"> 4455 <section class="swagger-request-body">
4883 <div class="prop-row"> 4456 <div class="prop-row">
4884 <div class="prop-name"> 4457 <div class="prop-name">
@@ -4963,13 +4536,18 @@
4963 <!-- </div> --> 4536 <!-- </div> -->
4964 <!-- </section> --> 4537 <!-- </section> -->
4965 <h2 class="operation-title"> 4538 <h2 class="operation-title">
4966 <span class="operation-name"> 4539 <span class="operation-summary">Get a video channel by its id</span>
4967 <span class="operation-name">GET</span>
4968 <span class="operation-path">/video-channels/{id}</span>
4969 </span>
4970 </h2> 4540 </h2>
4971 <div class="doc-row"> 4541 <div class="doc-row">
4972 <div class="doc-copy"> 4542 <div class="doc-copy">
4543 <section class="swagger-operation-path">
4544 <span class="operation-method">GET</span>
4545 <span class="operation-path">/video-channels/{id}</span>
4546 </section>
4547 </div>
4548 </div>
4549 <div class="doc-row">
4550 <div class="doc-copy">
4973 <section class="swagger-request-params"> 4551 <section class="swagger-request-params">
4974 <div class="prop-row prop-group"> 4552 <div class="prop-row prop-group">
4975 <div class="prop-name"> 4553 <div class="prop-name">
@@ -5042,13 +4620,18 @@
5042 <!-- </div> --> 4620 <!-- </div> -->
5043 <!-- </section> --> 4621 <!-- </section> -->
5044 <h2 class="operation-title"> 4622 <h2 class="operation-title">
5045 <span class="operation-name"> 4623 <span class="operation-summary">Update a video channel by its id</span>
5046 <span class="operation-name">PUT</span>
5047 <span class="operation-path">/video-channels/{id}</span>
5048 </span>
5049 </h2> 4624 </h2>
5050 <div class="doc-row"> 4625 <div class="doc-row">
5051 <div class="doc-copy"> 4626 <div class="doc-copy">
4627 <section class="swagger-operation-path">
4628 <span class="operation-method">PUT</span>
4629 <span class="operation-path">/video-channels/{id}</span>
4630 </section>
4631 </div>
4632 </div>
4633 <div class="doc-row">
4634 <div class="doc-copy">
5052 <section class="swagger-request-body"> 4635 <section class="swagger-request-body">
5053 <div class="prop-row"> 4636 <div class="prop-row">
5054 <div class="prop-name"> 4637 <div class="prop-name">
@@ -5150,13 +4733,18 @@
5150 <!-- </div> --> 4733 <!-- </div> -->
5151 <!-- </section> --> 4734 <!-- </section> -->
5152 <h2 class="operation-title"> 4735 <h2 class="operation-title">
5153 <span class="operation-name"> 4736 <span class="operation-summary">Delete a video channel by its id</span>
5154 <span class="operation-name">DELETE</span>
5155 <span class="operation-path">/video-channels/{id}</span>
5156 </span>
5157 </h2> 4737 </h2>
5158 <div class="doc-row"> 4738 <div class="doc-row">
5159 <div class="doc-copy"> 4739 <div class="doc-copy">
4740 <section class="swagger-operation-path">
4741 <span class="operation-method">DELETE</span>
4742 <span class="operation-path">/video-channels/{id}</span>
4743 </section>
4744 </div>
4745 </div>
4746 <div class="doc-row">
4747 <div class="doc-copy">
5160 <section class="swagger-request-params"> 4748 <section class="swagger-request-params">
5161 <div class="prop-row prop-group"> 4749 <div class="prop-row prop-group">
5162 <div class="prop-name"> 4750 <div class="prop-name">
@@ -5229,13 +4817,18 @@
5229 <!-- </div> --> 4817 <!-- </div> -->
5230 <!-- </section> --> 4818 <!-- </section> -->
5231 <h2 class="operation-title"> 4819 <h2 class="operation-title">
5232 <span class="operation-name"> 4820 <span class="operation-summary">Get videos of a video channel by its id</span>
5233 <span class="operation-name">GET</span>
5234 <span class="operation-path">/video-channels/{id}/videos</span>
5235 </span>
5236 </h2> 4821 </h2>
5237 <div class="doc-row"> 4822 <div class="doc-row">
5238 <div class="doc-copy"> 4823 <div class="doc-copy">
4824 <section class="swagger-operation-path">
4825 <span class="operation-method">GET</span>
4826 <span class="operation-path">/video-channels/{id}/videos</span>
4827 </section>
4828 </div>
4829 </div>
4830 <div class="doc-row">
4831 <div class="doc-copy">
5239 <section class="swagger-request-params"> 4832 <section class="swagger-request-params">
5240 <div class="prop-row prop-group"> 4833 <div class="prop-row prop-group">
5241 <div class="prop-name"> 4834 <div class="prop-name">
@@ -5341,13 +4934,18 @@
5341 <!-- </div> --> 4934 <!-- </div> -->
5342 <!-- </section> --> 4935 <!-- </section> -->
5343 <h2 class="operation-title"> 4936 <h2 class="operation-title">
5344 <span class="operation-name"> 4937 <span class="operation-summary">Get video channels of an account by its name</span>
5345 <span class="operation-name">GET</span>
5346 <span class="operation-path">/accounts/{name}/video-channels</span>
5347 </span>
5348 </h2> 4938 </h2>
5349 <div class="doc-row"> 4939 <div class="doc-row">
5350 <div class="doc-copy"> 4940 <div class="doc-copy">
4941 <section class="swagger-operation-path">
4942 <span class="operation-method">GET</span>
4943 <span class="operation-path">/accounts/{name}/video-channels</span>
4944 </section>
4945 </div>
4946 </div>
4947 <div class="doc-row">
4948 <div class="doc-copy">
5351 <section class="swagger-request-params"> 4949 <section class="swagger-request-params">
5352 <div class="prop-row prop-group"> 4950 <div class="prop-row prop-group">
5353 <div class="prop-name"> 4951 <div class="prop-name">
@@ -5424,40 +5022,148 @@
5424 </div> 5022 </div>
5425 </div> 5023 </div>
5426 </div> 5024 </div>
5427 <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1> 5025 <h1 id="tag-User" class="swagger-summary-tag" data-traverse-target="tag-User">User</h1>
5428 <div id="operation--videos--id--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--id--comment-threads-get"> 5026 <div id="operation--users-post" class="operation panel" data-traverse-target="operation--users-post">
5429 <!-- <section class="operation-tags row"> --> 5027 <!-- <section class="operation-tags row"> -->
5430 <!-- <div class="doc-copy"> --> 5028 <!-- <div class="doc-copy"> -->
5431 <div class="operation-tags"> 5029 <div class="operation-tags">
5432 <a class="label" href="#tag-VideoComment">VideoComment</a> 5030 <a class="label" href="#tag-User">User</a>
5433 <!----> 5031 <!---->
5434 </div> 5032 </div>
5435 <!-- </div> --> 5033 <!-- </div> -->
5436 <!-- </section> --> 5034 <!-- </section> -->
5437 <h2 class="operation-title"> 5035 <h2 class="operation-title">
5438 <span class="operation-name"> 5036 <span class="operation-summary">Creates user</span>
5439 <span class="operation-name">GET</span>
5440 <span class="operation-path">/videos/{id}/comment-threads</span>
5441 </span>
5442 </h2> 5037 </h2>
5443 <div class="doc-row"> 5038 <div class="doc-row">
5444 <div class="doc-copy"> 5039 <div class="doc-copy">
5445 <section class="swagger-request-params"> 5040 <section class="swagger-operation-path">
5041 <span class="operation-method">POST</span>
5042 <span class="operation-path">/users</span>
5043 </section>
5044 </div>
5045 </div>
5046 <div class="doc-row">
5047 <div class="doc-copy">
5048 <section class="swagger-request-body">
5049 <div class="prop-row">
5050 <div class="prop-name">
5051 <div class="swagger-request-model">
5052 <span class="">
5053 <a class="json-schema-ref" href="#/definitions/AddUser">AddUser</a>
5054 </span>
5055 </div>
5056 </div>
5057 <div class="prop-value columns small-6">
5058 <!-- <div class="swagger-request-description"> -->
5059 <p>User to create</p>
5060 <!-- </div> -->
5061 </div>
5062 </div>
5063 </section>
5064 </div>
5065 <div class="doc-examples">
5066 <section>
5067 <h5>Request Content-Types:
5068 <span>application/json</span>
5069 </h5>
5070 <h5>Request Example</h5>
5071 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5072 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5073 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5074 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5075 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5076 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5077}
5078</code></pre>
5079 <!-- </div> -->
5080 </section>
5081 </div>
5082 </div>
5083 <div class="doc-row">
5084 <div class="doc-copy">
5085 <section class="swagger-responses">
5446 <div class="prop-row prop-group"> 5086 <div class="prop-row prop-group">
5447 <div class="prop-name"> 5087 <div class="prop-name">
5448 <div class="prop-title">id: 5088 <div class="prop-title">200 OK</div>
5449 <span class="prop-type"> 5089 <div class="prop-ref">
5450 <span class="json-property-type">string</span> 5090 <span class="">
5451 <span class="json-property-range" title="Value limits"></span> 5091 <a class="json-schema-ref" href="#/definitions/AddUserResponse">AddUserResponse</a>
5452 </span> 5092 </span>
5453 </div> 5093 </div>
5454 <span class="json-property-required"></span> 5094 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5455 <div class="prop-subtitle"> in path </div>
5456 </div> 5095 </div>
5457 <div class="prop-value"> 5096 <div class="prop-value">
5458 <p>The video id or uuid</p> 5097 <p>successful operation</p>
5459 </div> 5098 </div>
5460 </div> 5099 </div>
5100 </section>
5101 </div>
5102 <div class="doc-examples">
5103 <h5>Response Content-Types:
5104 <span>application/json</span>
5105 </h5>
5106 <section>
5107 <h5>Response Example
5108 <span>(200 OK)</span>
5109 </h5>
5110 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5111 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5112 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5113}
5114</code></pre>
5115 <!-- </div> -->
5116 </section>
5117 </div>
5118 </div>
5119 <div class="doc-row">
5120 <div class="doc-copy">
5121 <section class="swagger-request-security">
5122 <table class="table">
5123 <thead>
5124 <tr>
5125 <th class="swagger-request-security-schema"></th>
5126 <th class="swagger-request-security-scopes"></th>
5127 </tr>
5128 </thead>
5129 <tbody>
5130 <tr>
5131 <td>
5132 <a href="#security-definition-OAuth2">OAuth2</a>
5133 </td>
5134 <td>
5135 <a href="#security-definition-scope-admin">admin</a>
5136 </td>
5137 </tr>
5138 </tbody>
5139 </table>
5140 </section>
5141 </div>
5142 </div>
5143 </div>
5144 <div id="operation--users-get" class="operation panel" data-traverse-target="operation--users-get">
5145 <!-- <section class="operation-tags row"> -->
5146 <!-- <div class="doc-copy"> -->
5147 <div class="operation-tags">
5148 <a class="label" href="#tag-User">User</a>
5149 <!---->
5150 </div>
5151 <!-- </div> -->
5152 <!-- </section> -->
5153 <h2 class="operation-title">
5154 <span class="operation-summary">Get a list of users</span>
5155 </h2>
5156 <div class="doc-row">
5157 <div class="doc-copy">
5158 <section class="swagger-operation-path">
5159 <span class="operation-method">GET</span>
5160 <span class="operation-path">/users</span>
5161 </section>
5162 </div>
5163 </div>
5164 <div class="doc-row">
5165 <div class="doc-copy">
5166 <section class="swagger-request-params">
5461 <div class="prop-row prop-group"> 5167 <div class="prop-row prop-group">
5462 <div class="prop-name"> 5168 <div class="prop-name">
5463 <div class="prop-title">start: 5169 <div class="prop-title">start:
@@ -5511,8 +5217,8 @@
5511 <div class="prop-name"> 5217 <div class="prop-name">
5512 <div class="prop-title">200 OK</div> 5218 <div class="prop-title">200 OK</div>
5513 <div class="prop-ref"> 5219 <div class="prop-ref">
5514 <span class=""> 5220 <span class="json-schema-ref-array">
5515 <a class="json-schema-ref" href="#/definitions/CommentThreadResponse">CommentThreadResponse</a> 5221 <a class="json-schema-ref" href="#/definitions/User">User</a>
5516 </span> 5222 </span>
5517 </div> 5223 </div>
5518 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> 5224 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
@@ -5521,6 +5227,17 @@
5521 <p>successful operation</p> 5227 <p>successful operation</p>
5522 </div> 5228 </div>
5523 </div> 5229 </div>
5230 <div class="prop-row prop-inner">
5231 <div class="prop-name">type</div>
5232 <div class="prop-value">
5233 <span class="json-property-type">
5234 <span class="json-schema-ref-array">
5235 <a class="json-schema-ref" href="#/definitions/User">User</a>
5236 </span>
5237 </span>
5238 <span class="json-property-range" title="Value limits"></span>
5239 </div>
5240 </div>
5524 </section> 5241 </section>
5525 </div> 5242 </div>
5526 <div class="doc-examples"> 5243 <div class="doc-examples">
@@ -5531,68 +5248,102 @@
5531 <h5>Response Example 5248 <h5>Response Example
5532 <span>(200 OK)</span> 5249 <span>(200 OK)</span>
5533 </h5> 5250 </h5>
5534 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ 5251 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
5535 <span class="hljs-attr">&quot;total&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5252 {
5536 <span class="hljs-attr">&quot;data&quot;</span>: [ 5253 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5537 { 5254 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5255 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5256 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5257 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5258 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5259 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5260 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5261 <span class="hljs-attr">&quot;account&quot;</span>: {
5262 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5538 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5263 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5264 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5539 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5265 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5540 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5266 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5541 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5267 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5542 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5268 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5543 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5269 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5544 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5270 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5545 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5271 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5546 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5272 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5547 <span class="hljs-attr">&quot;account&quot;</span>: { 5273 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5548 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5549 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5550 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5551 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5552 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5553 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5554 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5555 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5556 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5274 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5557 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5275 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5558 <span class="hljs-attr">&quot;avatar&quot;</span>: { 5276 }
5559 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5277 },
5560 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5278 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
5561 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span> 5279 {
5280 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5281 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5282 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5283 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
5284 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5285 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5562 } 5286 }
5563 } 5287 }
5564 } 5288 ]
5565 ] 5289 }
5566} 5290]
5567</code></pre> 5291</code></pre>
5568 <!-- </div> --> 5292 <!-- </div> -->
5569 </section> 5293 </section>
5570 </div> 5294 </div>
5571 </div> 5295 </div>
5296 <div class="doc-row">
5297 <div class="doc-copy">
5298 <section class="swagger-request-security">
5299 <table class="table">
5300 <thead>
5301 <tr>
5302 <th class="swagger-request-security-schema"></th>
5303 <th class="swagger-request-security-scopes"></th>
5304 </tr>
5305 </thead>
5306 <tbody>
5307 <tr>
5308 <td>
5309 <a href="#security-definition-OAuth2">OAuth2</a>
5310 </td>
5311 <td> </td>
5312 </tr>
5313 </tbody>
5314 </table>
5315 </section>
5316 </div>
5317 </div>
5572 </div> 5318 </div>
5573 <div id="operation--videos--id--comment-threads-post" class="operation panel" data-traverse-target="operation--videos--id--comment-threads-post"> 5319 <div id="operation--users--id--delete" class="operation panel" data-traverse-target="operation--users--id--delete">
5574 <!-- <section class="operation-tags row"> --> 5320 <!-- <section class="operation-tags row"> -->
5575 <!-- <div class="doc-copy"> --> 5321 <!-- <div class="doc-copy"> -->
5576 <div class="operation-tags"> 5322 <div class="operation-tags">
5577 <a class="label" href="#tag-VideoComment">VideoComment</a> 5323 <a class="label" href="#tag-User">User</a>
5578 <!----> 5324 <!---->
5579 </div> 5325 </div>
5580 <!-- </div> --> 5326 <!-- </div> -->
5581 <!-- </section> --> 5327 <!-- </section> -->
5582 <h2 class="operation-title"> 5328 <h2 class="operation-title">
5583 <span class="operation-name"> 5329 <span class="operation-summary">Delete a user by its id</span>
5584 <span class="operation-name">POST</span>
5585 <span class="operation-path">/videos/{id}/comment-threads</span>
5586 </span>
5587 </h2> 5330 </h2>
5588 <div class="doc-row"> 5331 <div class="doc-row">
5589 <div class="doc-copy"> 5332 <div class="doc-copy">
5333 <section class="swagger-operation-path">
5334 <span class="operation-method">DELETE</span>
5335 <span class="operation-path">/users/{id}</span>
5336 </section>
5337 </div>
5338 </div>
5339 <div class="doc-row">
5340 <div class="doc-copy">
5590 <section class="swagger-request-params"> 5341 <section class="swagger-request-params">
5591 <div class="prop-row prop-group"> 5342 <div class="prop-row prop-group">
5592 <div class="prop-name"> 5343 <div class="prop-name">
5593 <div class="prop-title">id: 5344 <div class="prop-title">id:
5594 <span class="prop-type"> 5345 <span class="prop-type">
5595 <span class="json-property-type">string</span> 5346 <span class="json-property-type">number</span>
5596 <span class="json-property-range" title="Value limits"></span> 5347 <span class="json-property-range" title="Value limits"></span>
5597 </span> 5348 </span>
5598 </div> 5349 </div>
@@ -5600,7 +5351,93 @@
5600 <div class="prop-subtitle"> in path </div> 5351 <div class="prop-subtitle"> in path </div>
5601 </div> 5352 </div>
5602 <div class="prop-value"> 5353 <div class="prop-value">
5603 <p>The video id or uuid</p> 5354 <p>The user id</p>
5355 </div>
5356 </div>
5357 </section>
5358 </div>
5359 <div class="doc-examples"></div>
5360 </div>
5361 <div class="doc-row">
5362 <div class="doc-copy">
5363 <section class="swagger-responses">
5364 <div class="prop-row prop-group">
5365 <div class="prop-name">
5366 <div class="prop-title">204 No Content</div>
5367 </div>
5368 <div class="prop-value">
5369 <p>Successful operation</p>
5370 </div>
5371 </div>
5372 </section>
5373 </div>
5374 <div class="doc-examples">
5375 <h5>Response Content-Types:
5376 <span>application/json</span>
5377 </h5>
5378 </div>
5379 </div>
5380 <div class="doc-row">
5381 <div class="doc-copy">
5382 <section class="swagger-request-security">
5383 <table class="table">
5384 <thead>
5385 <tr>
5386 <th class="swagger-request-security-schema"></th>
5387 <th class="swagger-request-security-scopes"></th>
5388 </tr>
5389 </thead>
5390 <tbody>
5391 <tr>
5392 <td>
5393 <a href="#security-definition-OAuth2">OAuth2</a>
5394 </td>
5395 <td>
5396 <a href="#security-definition-scope-admin">admin</a>
5397 </td>
5398 </tr>
5399 </tbody>
5400 </table>
5401 </section>
5402 </div>
5403 </div>
5404 </div>
5405 <div id="operation--users--id--get" class="operation panel" data-traverse-target="operation--users--id--get">
5406 <!-- <section class="operation-tags row"> -->
5407 <!-- <div class="doc-copy"> -->
5408 <div class="operation-tags">
5409 <a class="label" href="#tag-User">User</a>
5410 <!---->
5411 </div>
5412 <!-- </div> -->
5413 <!-- </section> -->
5414 <h2 class="operation-title">
5415 <span class="operation-summary">Get user by its id</span>
5416 </h2>
5417 <div class="doc-row">
5418 <div class="doc-copy">
5419 <section class="swagger-operation-path">
5420 <span class="operation-method">GET</span>
5421 <span class="operation-path">/users/{id}</span>
5422 </section>
5423 </div>
5424 </div>
5425 <div class="doc-row">
5426 <div class="doc-copy">
5427 <section class="swagger-request-params">
5428 <div class="prop-row prop-group">
5429 <div class="prop-name">
5430 <div class="prop-title">id:
5431 <span class="prop-type">
5432 <span class="json-property-type">number</span>
5433 <span class="json-property-range" title="Value limits"></span>
5434 </span>
5435 </div>
5436 <span class="json-property-required"></span>
5437 <div class="prop-subtitle"> in path </div>
5438 </div>
5439 <div class="prop-value">
5440 <p>The user id</p>
5604 </div> 5441 </div>
5605 </div> 5442 </div>
5606 </section> 5443 </section>
@@ -5615,7 +5452,7 @@
5615 <div class="prop-title">200 OK</div> 5452 <div class="prop-title">200 OK</div>
5616 <div class="prop-ref"> 5453 <div class="prop-ref">
5617 <span class=""> 5454 <span class="">
5618 <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a> 5455 <a class="json-schema-ref" href="#/definitions/User">User</a>
5619 </span> 5456 </span>
5620 </div> 5457 </div>
5621 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> 5458 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
@@ -5635,34 +5472,42 @@
5635 <span>(200 OK)</span> 5472 <span>(200 OK)</span>
5636 </h5> 5473 </h5>
5637 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ 5474 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5638 <span class="hljs-attr">&quot;comment&quot;</span>: { 5475 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5476 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5477 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5478 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5479 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5480 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5481 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5482 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5483 <span class="hljs-attr">&quot;account&quot;</span>: {
5484 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5639 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5485 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5486 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5640 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5487 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5641 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5488 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5642 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5489 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5643 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5490 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5644 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5491 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5645 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5492 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5646 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5493 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5647 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5494 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5648 <span class="hljs-attr">&quot;account&quot;</span>: { 5495 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5649 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5650 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5651 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5652 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5653 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5654 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5655 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5656 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5657 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5496 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5658 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5497 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5659 <span class="hljs-attr">&quot;avatar&quot;</span>: { 5498 }
5660 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5499 },
5661 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5500 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
5662 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span> 5501 {
5502 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5503 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5504 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5505 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
5506 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5507 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5663 } 5508 }
5664 } 5509 }
5665 } 5510 ]
5666} 5511}
5667</code></pre> 5512</code></pre>
5668 <!-- </div> --> 5513 <!-- </div> -->
@@ -5692,29 +5537,50 @@
5692 </div> 5537 </div>
5693 </div> 5538 </div>
5694 </div> 5539 </div>
5695 <div id="operation--videos--id--comment-threads--threadId--get" class="operation panel" data-traverse-target="operation--videos--id--comment-threads--threadId--get"> 5540 <div id="operation--users--id--put" class="operation panel" data-traverse-target="operation--users--id--put">
5696 <!-- <section class="operation-tags row"> --> 5541 <!-- <section class="operation-tags row"> -->
5697 <!-- <div class="doc-copy"> --> 5542 <!-- <div class="doc-copy"> -->
5698 <div class="operation-tags"> 5543 <div class="operation-tags">
5699 <a class="label" href="#tag-VideoComment">VideoComment</a> 5544 <a class="label" href="#tag-User">User</a>
5700 <!----> 5545 <!---->
5701 </div> 5546 </div>
5702 <!-- </div> --> 5547 <!-- </div> -->
5703 <!-- </section> --> 5548 <!-- </section> -->
5704 <h2 class="operation-title"> 5549 <h2 class="operation-title">
5705 <span class="operation-name"> 5550 <span class="operation-summary">Update user profile by its id</span>
5706 <span class="operation-name">GET</span>
5707 <span class="operation-path">/videos/{id}/comment-threads/{threadId}</span>
5708 </span>
5709 </h2> 5551 </h2>
5710 <div class="doc-row"> 5552 <div class="doc-row">
5711 <div class="doc-copy"> 5553 <div class="doc-copy">
5554 <section class="swagger-operation-path">
5555 <span class="operation-method">PUT</span>
5556 <span class="operation-path">/users/{id}</span>
5557 </section>
5558 </div>
5559 </div>
5560 <div class="doc-row">
5561 <div class="doc-copy">
5562 <section class="swagger-request-body">
5563 <div class="prop-row">
5564 <div class="prop-name">
5565 <div class="swagger-request-model">
5566 <span class="">
5567 <a class="json-schema-ref" href="#/definitions/UpdateUser">UpdateUser</a>
5568 </span>
5569 </div>
5570 </div>
5571 <div class="prop-value columns small-6">
5572 <!-- <div class="swagger-request-description"> -->
5573 <p>undefined</p>
5574 <!-- </div> -->
5575 </div>
5576 </div>
5577 </section>
5712 <section class="swagger-request-params"> 5578 <section class="swagger-request-params">
5713 <div class="prop-row prop-group"> 5579 <div class="prop-row prop-group">
5714 <div class="prop-name"> 5580 <div class="prop-name">
5715 <div class="prop-title">id: 5581 <div class="prop-title">id:
5716 <span class="prop-type"> 5582 <span class="prop-type">
5717 <span class="json-property-type">string</span> 5583 <span class="json-property-type">number</span>
5718 <span class="json-property-range" title="Value limits"></span> 5584 <span class="json-property-range" title="Value limits"></span>
5719 </span> 5585 </span>
5720 </div> 5586 </div>
@@ -5722,26 +5588,92 @@
5722 <div class="prop-subtitle"> in path </div> 5588 <div class="prop-subtitle"> in path </div>
5723 </div> 5589 </div>
5724 <div class="prop-value"> 5590 <div class="prop-value">
5725 <p>The video id or uuid</p> 5591 <p>The user id</p>
5726 </div> 5592 </div>
5727 </div> 5593 </div>
5594 </section>
5595 </div>
5596 <div class="doc-examples">
5597 <section>
5598 <h5>Request Content-Types:
5599 <span>application/json</span>
5600 </h5>
5601 <h5>Request Example</h5>
5602 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5603 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5604 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5605 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5606 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5607}
5608</code></pre>
5609 <!-- </div> -->
5610 </section>
5611 </div>
5612 </div>
5613 <div class="doc-row">
5614 <div class="doc-copy">
5615 <section class="swagger-responses">
5728 <div class="prop-row prop-group"> 5616 <div class="prop-row prop-group">
5729 <div class="prop-name"> 5617 <div class="prop-name">
5730 <div class="prop-title">threadId: 5618 <div class="prop-title">204 No Content</div>
5731 <span class="prop-type">
5732 <span class="json-property-type">number</span>
5733 <span class="json-property-range" title="Value limits"></span>
5734 </span>
5735 </div>
5736 <span class="json-property-required"></span>
5737 <div class="prop-subtitle"> in path </div>
5738 </div> 5619 </div>
5739 <div class="prop-value"> 5620 <div class="prop-value">
5740 <p>The thread id (root comment id)</p> 5621 <p>Successful operation</p>
5741 </div> 5622 </div>
5742 </div> 5623 </div>
5743 </section> 5624 </section>
5744 </div> 5625 </div>
5626 <div class="doc-examples">
5627 <h5>Response Content-Types:
5628 <span>application/json</span>
5629 </h5>
5630 </div>
5631 </div>
5632 <div class="doc-row">
5633 <div class="doc-copy">
5634 <section class="swagger-request-security">
5635 <table class="table">
5636 <thead>
5637 <tr>
5638 <th class="swagger-request-security-schema"></th>
5639 <th class="swagger-request-security-scopes"></th>
5640 </tr>
5641 </thead>
5642 <tbody>
5643 <tr>
5644 <td>
5645 <a href="#security-definition-OAuth2">OAuth2</a>
5646 </td>
5647 <td> </td>
5648 </tr>
5649 </tbody>
5650 </table>
5651 </section>
5652 </div>
5653 </div>
5654 </div>
5655 <div id="operation--users-me-get" class="operation panel" data-traverse-target="operation--users-me-get">
5656 <!-- <section class="operation-tags row"> -->
5657 <!-- <div class="doc-copy"> -->
5658 <div class="operation-tags">
5659 <a class="label" href="#tag-User">User</a>
5660 <!---->
5661 </div>
5662 <!-- </div> -->
5663 <!-- </section> -->
5664 <h2 class="operation-title">
5665 <span class="operation-summary">Get current user information</span>
5666 </h2>
5667 <div class="doc-row">
5668 <div class="doc-copy">
5669 <section class="swagger-operation-path">
5670 <span class="operation-method">GET</span>
5671 <span class="operation-path">/users/me</span>
5672 </section>
5673 </div>
5674 </div>
5675 <div class="doc-row">
5676 <div class="doc-copy"> </div>
5745 <div class="doc-examples"></div> 5677 <div class="doc-examples"></div>
5746 </div> 5678 </div>
5747 <div class="doc-row"> 5679 <div class="doc-row">
@@ -5751,8 +5683,8 @@
5751 <div class="prop-name"> 5683 <div class="prop-name">
5752 <div class="prop-title">200 OK</div> 5684 <div class="prop-title">200 OK</div>
5753 <div class="prop-ref"> 5685 <div class="prop-ref">
5754 <span class=""> 5686 <span class="json-schema-ref-array">
5755 <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> 5687 <a class="json-schema-ref" href="#/definitions/User">User</a>
5756 </span> 5688 </span>
5757 </div> 5689 </div>
5758 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> 5690 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
@@ -5761,6 +5693,17 @@
5761 <p>successful operation</p> 5693 <p>successful operation</p>
5762 </div> 5694 </div>
5763 </div> 5695 </div>
5696 <div class="prop-row prop-inner">
5697 <div class="prop-name">type</div>
5698 <div class="prop-value">
5699 <span class="json-property-type">
5700 <span class="json-schema-ref-array">
5701 <a class="json-schema-ref" href="#/definitions/User">User</a>
5702 </span>
5703 </span>
5704 <span class="json-property-range" title="Value limits"></span>
5705 </div>
5706 </div>
5764 </section> 5707 </section>
5765 </div> 5708 </div>
5766 <div class="doc-examples"> 5709 <div class="doc-examples">
@@ -5771,17 +5714,16 @@
5771 <h5>Response Example 5714 <h5>Response Example
5772 <span>(200 OK)</span> 5715 <span>(200 OK)</span>
5773 </h5> 5716 </h5>
5774 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ 5717 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
5775 <span class="hljs-attr">&quot;comment&quot;</span>: { 5718 {
5776 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5719 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5777 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5720 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5778 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5721 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5779 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5722 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5780 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5723 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5781 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5724 <span class="hljs-attr">&quot;role&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5725 <span class="hljs-attr">&quot;videoQuota&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5782 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5726 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5783 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5784 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5785 <span class="hljs-attr">&quot;account&quot;</span>: { 5727 <span class="hljs-attr">&quot;account&quot;</span>: {
5786 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5728 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5787 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5729 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
@@ -5798,99 +5740,255 @@
5798 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5740 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5799 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span> 5741 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5800 } 5742 }
5801 } 5743 },
5802 }, 5744 <span class="hljs-attr">&quot;videoChannels&quot;</span>: [
5803 <span class="hljs-attr">&quot;children&quot;</span>: [ 5745 {
5804 { 5746 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5805 <span class="hljs-attr">&quot;comment&quot;</span>: { 5747 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5806 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5748 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5807 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5749 <span class="hljs-attr">&quot;ownerAccount&quot;</span>: {
5808 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5809 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5810 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5811 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5812 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5813 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5814 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5815 <span class="hljs-attr">&quot;account&quot;</span>: {
5816 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5817 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 5750 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5818 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 5751 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5819 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5820 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5821 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5822 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5823 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5824 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5825 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5826 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5827 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5828 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5829 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5830 }
5831 }
5832 },
5833 <span class="hljs-attr">&quot;children&quot;</span>: [
5834 {
5835 <span class="hljs-attr">&quot;comment&quot;</span>: {
5836 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5837 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5838 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5839 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5840 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5841 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5842 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5843 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5844 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5845 <span class="hljs-attr">&quot;account&quot;</span>: {
5846 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5847 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5848 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5849 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5850 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5851 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5852 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5853 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5854 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5855 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5856 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5857 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5858 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5859 }
5860 }
5861 }
5862 } 5752 }
5863 ] 5753 }
5864 } 5754 ]
5865 ] 5755 }
5756]
5757</code></pre>
5758 <!-- </div> -->
5759 </section>
5760 </div>
5761 </div>
5762 <div class="doc-row">
5763 <div class="doc-copy">
5764 <section class="swagger-request-security">
5765 <table class="table">
5766 <thead>
5767 <tr>
5768 <th class="swagger-request-security-schema"></th>
5769 <th class="swagger-request-security-scopes"></th>
5770 </tr>
5771 </thead>
5772 <tbody>
5773 <tr>
5774 <td>
5775 <a href="#security-definition-OAuth2">OAuth2</a>
5776 </td>
5777 <td> </td>
5778 </tr>
5779 </tbody>
5780 </table>
5781 </section>
5782 </div>
5783 </div>
5784 </div>
5785 <div id="operation--users-me-put" class="operation panel" data-traverse-target="operation--users-me-put">
5786 <!-- <section class="operation-tags row"> -->
5787 <!-- <div class="doc-copy"> -->
5788 <div class="operation-tags">
5789 <a class="label" href="#tag-User">User</a>
5790 <!---->
5791 </div>
5792 <!-- </div> -->
5793 <!-- </section> -->
5794 <h2 class="operation-title">
5795 <span class="operation-summary">Update current user information</span>
5796 </h2>
5797 <div class="doc-row">
5798 <div class="doc-copy">
5799 <section class="swagger-operation-path">
5800 <span class="operation-method">PUT</span>
5801 <span class="operation-path">/users/me</span>
5802 </section>
5803 </div>
5804 </div>
5805 <div class="doc-row">
5806 <div class="doc-copy">
5807 <section class="swagger-request-body">
5808 <div class="prop-row">
5809 <div class="prop-name">
5810 <div class="swagger-request-model">
5811 <span class="">
5812 <a class="json-schema-ref" href="#/definitions/UpdateMe">UpdateMe</a>
5813 </span>
5814 </div>
5815 </div>
5816 <div class="prop-value columns small-6">
5817 <!-- <div class="swagger-request-description"> -->
5818 <p>undefined</p>
5819 <!-- </div> -->
5820 </div>
5821 </div>
5822 </section>
5823 </div>
5824 <div class="doc-examples">
5825 <section>
5826 <h5>Request Content-Types:
5827 <span>application/json</span>
5828 </h5>
5829 <h5>Request Example</h5>
5830 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
5831 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5832 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5833 <span class="hljs-attr">&quot;displayNSFW&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5834 <span class="hljs-attr">&quot;autoPlayVideo&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
5866} 5835}
5867</code></pre> 5836</code></pre>
5868 <!-- </div> --> 5837 <!-- </div> -->
5869 </section> 5838 </section>
5870 </div> 5839 </div>
5871 </div> 5840 </div>
5841 <div class="doc-row">
5842 <div class="doc-copy">
5843 <section class="swagger-responses">
5844 <div class="prop-row prop-group">
5845 <div class="prop-name">
5846 <div class="prop-title">204 No Content</div>
5847 </div>
5848 <div class="prop-value">
5849 <p>Successful operation</p>
5850 </div>
5851 </div>
5852 </section>
5853 </div>
5854 <div class="doc-examples">
5855 <h5>Response Content-Types:
5856 <span>application/json</span>
5857 </h5>
5858 </div>
5859 </div>
5860 <div class="doc-row">
5861 <div class="doc-copy">
5862 <section class="swagger-request-security">
5863 <table class="table">
5864 <thead>
5865 <tr>
5866 <th class="swagger-request-security-schema"></th>
5867 <th class="swagger-request-security-scopes"></th>
5868 </tr>
5869 </thead>
5870 <tbody>
5871 <tr>
5872 <td>
5873 <a href="#security-definition-OAuth2">OAuth2</a>
5874 </td>
5875 <td> </td>
5876 </tr>
5877 </tbody>
5878 </table>
5879 </section>
5880 </div>
5881 </div>
5872 </div> 5882 </div>
5873 <div id="operation--videos--id--comments--commentId--post" class="operation panel" data-traverse-target="operation--videos--id--comments--commentId--post"> 5883 <div id="operation--users-me-video-quota-used-get" class="operation panel" data-traverse-target="operation--users-me-video-quota-used-get">
5874 <!-- <section class="operation-tags row"> --> 5884 <!-- <section class="operation-tags row"> -->
5875 <!-- <div class="doc-copy"> --> 5885 <!-- <div class="doc-copy"> -->
5876 <div class="operation-tags"> 5886 <div class="operation-tags">
5877 <a class="label" href="#tag-VideoComment">VideoComment</a> 5887 <a class="label" href="#tag-User">User</a>
5878 <!----> 5888 <!---->
5879 </div> 5889 </div>
5880 <!-- </div> --> 5890 <!-- </div> -->
5881 <!-- </section> --> 5891 <!-- </section> -->
5882 <h2 class="operation-title"> 5892 <h2 class="operation-title">
5883 <span class="operation-name"> 5893 <span class="operation-summary">Get current user used quota</span>
5884 <span class="operation-name">POST</span>
5885 <span class="operation-path">/videos/{id}/comments/{commentId}</span>
5886 </span>
5887 </h2> 5894 </h2>
5888 <div class="doc-row"> 5895 <div class="doc-row">
5889 <div class="doc-copy"> 5896 <div class="doc-copy">
5897 <section class="swagger-operation-path">
5898 <span class="operation-method">GET</span>
5899 <span class="operation-path">/users/me/video-quota-used</span>
5900 </section>
5901 </div>
5902 </div>
5903 <div class="doc-row">
5904 <div class="doc-copy"> </div>
5905 <div class="doc-examples"></div>
5906 </div>
5907 <div class="doc-row">
5908 <div class="doc-copy">
5909 <section class="swagger-responses">
5910 <div class="prop-row prop-group">
5911 <div class="prop-name">
5912 <div class="prop-title">200 OK</div>
5913 <div class="prop-ref"></div>
5914 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
5915 </div>
5916 <div class="prop-value">
5917 <p>successful operation</p>
5918 </div>
5919 </div>
5920 <div class="prop-row prop-inner">
5921 <div class="prop-name">type</div>
5922 <div class="prop-value">
5923 <span class="json-property-type">number</span>
5924 <span class="json-property-range" title="Value limits"></span>
5925 </div>
5926 </div>
5927 </section>
5928 </div>
5929 <div class="doc-examples">
5930 <h5>Response Content-Types:
5931 <span>application/json</span>
5932 </h5>
5933 <section>
5934 <h5>Response Example
5935 <span>(200 OK)</span>
5936 </h5>
5937 <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">&quot;number&quot;</span>
5938</code></pre>
5939 <!-- </div> -->
5940 </section>
5941 </div>
5942 </div>
5943 <div class="doc-row">
5944 <div class="doc-copy">
5945 <section class="swagger-request-security">
5946 <table class="table">
5947 <thead>
5948 <tr>
5949 <th class="swagger-request-security-schema"></th>
5950 <th class="swagger-request-security-scopes"></th>
5951 </tr>
5952 </thead>
5953 <tbody>
5954 <tr>
5955 <td>
5956 <a href="#security-definition-OAuth2">OAuth2</a>
5957 </td>
5958 <td> </td>
5959 </tr>
5960 </tbody>
5961 </table>
5962 </section>
5963 </div>
5964 </div>
5965 </div>
5966 <div id="operation--users-me-videos--videoId--rating-get" class="operation panel" data-traverse-target="operation--users-me-videos--videoId--rating-get">
5967 <!-- <section class="operation-tags row"> -->
5968 <!-- <div class="doc-copy"> -->
5969 <div class="operation-tags">
5970 <a class="label" href="#tag-User">User</a>
5971 <!---->
5972 </div>
5973 <!-- </div> -->
5974 <!-- </section> -->
5975 <h2 class="operation-title">
5976 <span class="operation-summary">Get rating of video by its id, among those of the current user</span>
5977 </h2>
5978 <div class="doc-row">
5979 <div class="doc-copy">
5980 <section class="swagger-operation-path">
5981 <span class="operation-method">GET</span>
5982 <span class="operation-path">/users/me/videos/{videoId}/rating</span>
5983 </section>
5984 </div>
5985 </div>
5986 <div class="doc-row">
5987 <div class="doc-copy">
5890 <section class="swagger-request-params"> 5988 <section class="swagger-request-params">
5891 <div class="prop-row prop-group"> 5989 <div class="prop-row prop-group">
5892 <div class="prop-name"> 5990 <div class="prop-name">
5893 <div class="prop-title">id: 5991 <div class="prop-title">videoId:
5894 <span class="prop-type"> 5992 <span class="prop-type">
5895 <span class="json-property-type">string</span> 5993 <span class="json-property-type">string</span>
5896 <span class="json-property-range" title="Value limits"></span> 5994 <span class="json-property-range" title="Value limits"></span>
@@ -5900,22 +5998,135 @@
5900 <div class="prop-subtitle"> in path </div> 5998 <div class="prop-subtitle"> in path </div>
5901 </div> 5999 </div>
5902 <div class="prop-value"> 6000 <div class="prop-value">
5903 <p>The video id or uuid</p> 6001 <p>The video id </p>
5904 </div> 6002 </div>
5905 </div> 6003 </div>
6004 </section>
6005 </div>
6006 <div class="doc-examples"></div>
6007 </div>
6008 <div class="doc-row">
6009 <div class="doc-copy">
6010 <section class="swagger-responses">
5906 <div class="prop-row prop-group"> 6011 <div class="prop-row prop-group">
5907 <div class="prop-name"> 6012 <div class="prop-name">
5908 <div class="prop-title">threadId: 6013 <div class="prop-title">200 OK</div>
6014 <div class="prop-ref">
6015 <span class="">
6016 <a class="json-schema-ref" href="#/definitions/GetMeVideoRating">GetMeVideoRating</a>
6017 </span>
6018 </div>
6019 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
6020 </div>
6021 <div class="prop-value">
6022 <p>successful operation</p>
6023 </div>
6024 </div>
6025 </section>
6026 </div>
6027 <div class="doc-examples">
6028 <h5>Response Content-Types:
6029 <span>application/json</span>
6030 </h5>
6031 <section>
6032 <h5>Response Example
6033 <span>(200 OK)</span>
6034 </h5>
6035 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6036 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6037 <span class="hljs-attr">&quot;rating&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>
6038}
6039</code></pre>
6040 <!-- </div> -->
6041 </section>
6042 </div>
6043 </div>
6044 <div class="doc-row">
6045 <div class="doc-copy">
6046 <section class="swagger-request-security">
6047 <table class="table">
6048 <thead>
6049 <tr>
6050 <th class="swagger-request-security-schema"></th>
6051 <th class="swagger-request-security-scopes"></th>
6052 </tr>
6053 </thead>
6054 <tbody>
6055 <tr>
6056 <td>
6057 <a href="#security-definition-OAuth2">OAuth2</a>
6058 </td>
6059 <td> </td>
6060 </tr>
6061 </tbody>
6062 </table>
6063 </section>
6064 </div>
6065 </div>
6066 </div>
6067 <div id="operation--users-me-videos-get" class="operation panel" data-traverse-target="operation--users-me-videos-get">
6068 <!-- <section class="operation-tags row"> -->
6069 <!-- <div class="doc-copy"> -->
6070 <div class="operation-tags">
6071 <a class="label" href="#tag-User">User</a>
6072 <!---->
6073 </div>
6074 <!-- </div> -->
6075 <!-- </section> -->
6076 <h2 class="operation-title">
6077 <span class="operation-summary">Get videos of the current user</span>
6078 </h2>
6079 <div class="doc-row">
6080 <div class="doc-copy">
6081 <section class="swagger-operation-path">
6082 <span class="operation-method">GET</span>
6083 <span class="operation-path">/users/me/videos</span>
6084 </section>
6085 </div>
6086 </div>
6087 <div class="doc-row">
6088 <div class="doc-copy">
6089 <section class="swagger-request-params">
6090 <div class="prop-row prop-group">
6091 <div class="prop-name">
6092 <div class="prop-title">start:
5909 <span class="prop-type"> 6093 <span class="prop-type">
5910 <span class="json-property-type">number</span> 6094 <span class="json-property-type">number</span>
5911 <span class="json-property-range" title="Value limits"></span> 6095 <span class="json-property-range" title="Value limits"></span>
5912 </span> 6096 </span>
5913 </div> 6097 </div>
5914 <span class="json-property-required"></span> 6098 <div class="prop-subtitle"> in query </div>
5915 <div class="prop-subtitle"> in path </div>
5916 </div> 6099 </div>
5917 <div class="prop-value"> 6100 <div class="prop-value">
5918 <p>The comment id</p> 6101 <p>Offset</p>
6102 </div>
6103 </div>
6104 <div class="prop-row prop-group">
6105 <div class="prop-name">
6106 <div class="prop-title">count:
6107 <span class="prop-type">
6108 <span class="json-property-type">number</span>
6109 <span class="json-property-range" title="Value limits"></span>
6110 </span>
6111 </div>
6112 <div class="prop-subtitle"> in query </div>
6113 </div>
6114 <div class="prop-value">
6115 <p>Number of items</p>
6116 </div>
6117 </div>
6118 <div class="prop-row prop-group">
6119 <div class="prop-name">
6120 <div class="prop-title">sort:
6121 <span class="prop-type">
6122 <span class="json-property-type">string</span>
6123 <span class="json-property-range" title="Value limits"></span>
6124 </span>
6125 </div>
6126 <div class="prop-subtitle"> in query </div>
6127 </div>
6128 <div class="prop-value">
6129 <p>Sort column (-createdAt for example)</p>
5919 </div> 6130 </div>
5920 </div> 6131 </div>
5921 </section> 6132 </section>
@@ -5929,8 +6140,8 @@
5929 <div class="prop-name"> 6140 <div class="prop-name">
5930 <div class="prop-title">200 OK</div> 6141 <div class="prop-title">200 OK</div>
5931 <div class="prop-ref"> 6142 <div class="prop-ref">
5932 <span class=""> 6143 <span class="json-schema-ref-array">
5933 <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a> 6144 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
5934 </span> 6145 </span>
5935 </div> 6146 </div>
5936 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> 6147 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
@@ -5939,6 +6150,17 @@
5939 <p>successful operation</p> 6150 <p>successful operation</p>
5940 </div> 6151 </div>
5941 </div> 6152 </div>
6153 <div class="prop-row prop-inner">
6154 <div class="prop-name">type</div>
6155 <div class="prop-value">
6156 <span class="json-property-type">
6157 <span class="json-schema-ref-array">
6158 <a class="json-schema-ref" href="#/definitions/Video">Video</a>
6159 </span>
6160 </span>
6161 <span class="json-property-range" title="Value limits"></span>
6162 </div>
6163 </div>
5942 </section> 6164 </section>
5943 </div> 6165 </div>
5944 <div class="doc-examples"> 6166 <div class="doc-examples">
@@ -5949,28 +6171,42 @@
5949 <h5>Response Example 6171 <h5>Response Example
5950 <span>(200 OK)</span> 6172 <span>(200 OK)</span>
5951 </h5> 6173 </h5>
5952 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ 6174 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
5953 <span class="hljs-attr">&quot;comment&quot;</span>: { 6175 {
5954 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 6176 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5955 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 6177 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5956 <span class="hljs-attr">&quot;text&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5957 <span class="hljs-attr">&quot;threadId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5958 <span class="hljs-attr">&quot;inReplyToCommentId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5959 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5960 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 6178 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6179 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5961 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 6180 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5962 <span class="hljs-attr">&quot;totalReplies&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 6181 <span class="hljs-attr">&quot;category&quot;</span>: {
6182 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6183 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6184 },
6185 <span class="hljs-attr">&quot;licence&quot;</span>: {
6186 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6187 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6188 },
6189 <span class="hljs-attr">&quot;language&quot;</span>: {
6190 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6191 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6192 },
6193 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6194 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6195 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6196 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
6197 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6198 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6199 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6200 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6201 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6202 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6203 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6204 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
5963 <span class="hljs-attr">&quot;account&quot;</span>: { 6205 <span class="hljs-attr">&quot;account&quot;</span>: {
6206 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5964 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 6207 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5965 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5966 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5967 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 6208 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5968 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5969 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 6209 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5970 <span class="hljs-attr">&quot;followingCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5971 <span class="hljs-attr">&quot;followersCount&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
5972 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5973 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5974 <span class="hljs-attr">&quot;avatar&quot;</span>: { 6210 <span class="hljs-attr">&quot;avatar&quot;</span>: {
5975 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 6211 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
5976 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 6212 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
@@ -5978,7 +6214,7 @@
5978 } 6214 }
5979 } 6215 }
5980 } 6216 }
5981} 6217]
5982</code></pre> 6218</code></pre>
5983 <!-- </div> --> 6219 <!-- </div> -->
5984 </section> 6220 </section>
@@ -6007,44 +6243,211 @@
6007 </div> 6243 </div>
6008 </div> 6244 </div>
6009 </div> 6245 </div>
6010 <div id="operation--videos--id--comments--commentId--delete" class="operation panel" data-traverse-target="operation--videos--id--comments--commentId--delete"> 6246 <div id="operation--users-register-post" class="operation panel" data-traverse-target="operation--users-register-post">
6011 <!-- <section class="operation-tags row"> --> 6247 <!-- <section class="operation-tags row"> -->
6012 <!-- <div class="doc-copy"> --> 6248 <!-- <div class="doc-copy"> -->
6013 <div class="operation-tags"> 6249 <div class="operation-tags">
6014 <a class="label" href="#tag-VideoComment">VideoComment</a> 6250 <a class="label" href="#tag-User">User</a>
6251 <!---->
6252 </div>
6253 <!-- </div> -->
6254 <!-- </section> -->
6255 <h2 class="operation-title">
6256 <span class="operation-summary">Register a user</span>
6257 </h2>
6258 <div class="doc-row">
6259 <div class="doc-copy">
6260 <section class="swagger-operation-path">
6261 <span class="operation-method">POST</span>
6262 <span class="operation-path">/users/register</span>
6263 </section>
6264 </div>
6265 </div>
6266 <div class="doc-row">
6267 <div class="doc-copy">
6268 <section class="swagger-request-body">
6269 <div class="prop-row">
6270 <div class="prop-name">
6271 <div class="swagger-request-model">
6272 <span class="">
6273 <a class="json-schema-ref" href="#/definitions/RegisterUser">RegisterUser</a>
6274 </span>
6275 </div>
6276 </div>
6277 <div class="prop-value columns small-6">
6278 <!-- <div class="swagger-request-description"> -->
6279 <p>undefined</p>
6280 <!-- </div> -->
6281 </div>
6282 </div>
6283 </section>
6284 </div>
6285 <div class="doc-examples">
6286 <section>
6287 <h5>Request Content-Types:
6288 <span>application/json</span>
6289 </h5>
6290 <h5>Request Example</h5>
6291 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6292 <span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6293 <span class="hljs-attr">&quot;password&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6294 <span class="hljs-attr">&quot;email&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6295}
6296</code></pre>
6297 <!-- </div> -->
6298 </section>
6299 </div>
6300 </div>
6301 <div class="doc-row">
6302 <div class="doc-copy">
6303 <section class="swagger-responses">
6304 <div class="prop-row prop-group">
6305 <div class="prop-name">
6306 <div class="prop-title">204 No Content</div>
6307 </div>
6308 <div class="prop-value">
6309 <p>Successful operation</p>
6310 </div>
6311 </div>
6312 </section>
6313 </div>
6314 <div class="doc-examples">
6315 <h5>Response Content-Types:
6316 <span>application/json</span>
6317 </h5>
6318 </div>
6319 </div>
6320 </div>
6321 <div id="operation--users-me-avatar-pick-post" class="operation panel" data-traverse-target="operation--users-me-avatar-pick-post">
6322 <!-- <section class="operation-tags row"> -->
6323 <!-- <div class="doc-copy"> -->
6324 <div class="operation-tags">
6325 <a class="label" href="#tag-User">User</a>
6015 <!----> 6326 <!---->
6016 </div> 6327 </div>
6017 <!-- </div> --> 6328 <!-- </div> -->
6018 <!-- </section> --> 6329 <!-- </section> -->
6019 <h2 class="operation-title"> 6330 <h2 class="operation-title">
6020 <span class="operation-name"> 6331 <span class="operation-summary">Update current user avatar</span>
6021 <span class="operation-name">DELETE</span>
6022 <span class="operation-path">/videos/{id}/comments/{commentId}</span>
6023 </span>
6024 </h2> 6332 </h2>
6025 <div class="doc-row"> 6333 <div class="doc-row">
6026 <div class="doc-copy"> 6334 <div class="doc-copy">
6335 <section class="swagger-operation-path">
6336 <span class="operation-method">POST</span>
6337 <span class="operation-path">/users/me/avatar/pick</span>
6338 </section>
6339 </div>
6340 </div>
6341 <div class="doc-row">
6342 <div class="doc-copy">
6027 <section class="swagger-request-params"> 6343 <section class="swagger-request-params">
6028 <div class="prop-row prop-group"> 6344 <div class="prop-row prop-group">
6029 <div class="prop-name"> 6345 <div class="prop-name">
6030 <div class="prop-title">id: 6346 <div class="prop-title">avatarfile:
6031 <span class="prop-type"> 6347 <span class="prop-type">
6032 <span class="json-property-type">string</span> 6348 <span class="json-property-type">file</span>
6033 <span class="json-property-range" title="Value limits"></span> 6349 <span class="json-property-range" title="Value limits"></span>
6034 </span> 6350 </span>
6035 </div> 6351 </div>
6036 <span class="json-property-required"></span> 6352 <div class="prop-subtitle"> in formData </div>
6037 <div class="prop-subtitle"> in path </div>
6038 </div> 6353 </div>
6039 <div class="prop-value"> 6354 <div class="prop-value">
6040 <p>The video id or uuid</p> 6355 <p>The file to upload.</p>
6041 </div> 6356 </div>
6042 </div> 6357 </div>
6358 </section>
6359 </div>
6360 <div class="doc-examples"></div>
6361 </div>
6362 <div class="doc-row">
6363 <div class="doc-copy">
6364 <section class="swagger-responses">
6043 <div class="prop-row prop-group"> 6365 <div class="prop-row prop-group">
6044 <div class="prop-name"> 6366 <div class="prop-name">
6045 <div class="prop-title">threadId: 6367 <div class="prop-title">200 OK</div>
6368 <div class="prop-ref">
6369 <span class="">
6370 <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
6371 </span>
6372 </div>
6373 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
6374 </div>
6375 <div class="prop-value">
6376 <p>successful operation</p>
6377 </div>
6378 </div>
6379 </section>
6380 </div>
6381 <div class="doc-examples">
6382 <h5>Response Content-Types:
6383 <span>application/json</span>
6384 </h5>
6385 <section>
6386 <h5>Response Example
6387 <span>(200 OK)</span>
6388 </h5>
6389 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
6390 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6391 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6392 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6393}
6394</code></pre>
6395 <!-- </div> -->
6396 </section>
6397 </div>
6398 </div>
6399 <div class="doc-row">
6400 <div class="doc-copy">
6401 <section class="swagger-request-security">
6402 <table class="table">
6403 <thead>
6404 <tr>
6405 <th class="swagger-request-security-schema"></th>
6406 <th class="swagger-request-security-scopes"></th>
6407 </tr>
6408 </thead>
6409 <tbody>
6410 <tr>
6411 <td>
6412 <a href="#security-definition-OAuth2">OAuth2</a>
6413 </td>
6414 <td> </td>
6415 </tr>
6416 </tbody>
6417 </table>
6418 </section>
6419 </div>
6420 </div>
6421 </div>
6422 <h1 id="tag-VideoBlacklist" class="swagger-summary-tag" data-traverse-target="tag-VideoBlacklist">VideoBlacklist</h1>
6423 <div id="operation--videos--id--blacklist-post" class="operation panel" data-traverse-target="operation--videos--id--blacklist-post">
6424 <!-- <section class="operation-tags row"> -->
6425 <!-- <div class="doc-copy"> -->
6426 <div class="operation-tags">
6427 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
6428 <!---->
6429 </div>
6430 <!-- </div> -->
6431 <!-- </section> -->
6432 <h2 class="operation-title">
6433 <span class="operation-summary">Put on blacklist a video by its id</span>
6434 </h2>
6435 <div class="doc-row">
6436 <div class="doc-copy">
6437 <section class="swagger-operation-path">
6438 <span class="operation-method">POST</span>
6439 <span class="operation-path">/videos/{id}/blacklist</span>
6440 </section>
6441 </div>
6442 </div>
6443 <div class="doc-row">
6444 <div class="doc-copy">
6445 <section class="swagger-request-params">
6446 <div class="prop-row prop-group">
6447 <div class="prop-name">
6448 <div class="prop-title">id:
6046 <span class="prop-type"> 6449 <span class="prop-type">
6047 <span class="json-property-type">number</span> 6450 <span class="json-property-type">string</span>
6048 <span class="json-property-range" title="Value limits"></span> 6451 <span class="json-property-range" title="Value limits"></span>
6049 </span> 6452 </span>
6050 </div> 6453 </div>
@@ -6052,7 +6455,7 @@
6052 <div class="prop-subtitle"> in path </div> 6455 <div class="prop-subtitle"> in path </div>
6053 </div> 6456 </div>
6054 <div class="prop-value"> 6457 <div class="prop-value">
6055 <p>The comment id</p> 6458 <p>The video id or uuid</p>
6056 </div> 6459 </div>
6057 </div> 6460 </div>
6058 </section> 6461 </section>
@@ -6093,7 +6496,10 @@
6093 <td> 6496 <td>
6094 <a href="#security-definition-OAuth2">OAuth2</a> 6497 <a href="#security-definition-OAuth2">OAuth2</a>
6095 </td> 6498 </td>
6096 <td> </td> 6499 <td>
6500 <a href="#security-definition-scope-admin">admin</a>,
6501 <a href="#security-definition-scope-moderator">moderator</a>
6502 </td>
6097 </tr> 6503 </tr>
6098 </tbody> 6504 </tbody>
6099 </table> 6505 </table>
@@ -6101,24 +6507,28 @@
6101 </div> 6507 </div>
6102 </div> 6508 </div>
6103 </div> 6509 </div>
6104 <h1 id="tag-VideoRate" class="swagger-summary-tag" data-traverse-target="tag-VideoRate">VideoRate</h1> 6510 <div id="operation--videos--id--blacklist-delete" class="operation panel" data-traverse-target="operation--videos--id--blacklist-delete">
6105 <div id="operation--videos--id--rate-put" class="operation panel" data-traverse-target="operation--videos--id--rate-put">
6106 <!-- <section class="operation-tags row"> --> 6511 <!-- <section class="operation-tags row"> -->
6107 <!-- <div class="doc-copy"> --> 6512 <!-- <div class="doc-copy"> -->
6108 <div class="operation-tags"> 6513 <div class="operation-tags">
6109 <a class="label" href="#tag-VideoRate">VideoRate</a> 6514 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
6110 <!----> 6515 <!---->
6111 </div> 6516 </div>
6112 <!-- </div> --> 6517 <!-- </div> -->
6113 <!-- </section> --> 6518 <!-- </section> -->
6114 <h2 class="operation-title"> 6519 <h2 class="operation-title">
6115 <span class="operation-name"> 6520 <span class="operation-summary">Delete an entry of the blacklist of a video by its id</span>
6116 <span class="operation-name">PUT</span>
6117 <span class="operation-path">/videos/{id}/rate</span>
6118 </span>
6119 </h2> 6521 </h2>
6120 <div class="doc-row"> 6522 <div class="doc-row">
6121 <div class="doc-copy"> 6523 <div class="doc-copy">
6524 <section class="swagger-operation-path">
6525 <span class="operation-method">DELETE</span>
6526 <span class="operation-path">/videos/{id}/blacklist</span>
6527 </section>
6528 </div>
6529 </div>
6530 <div class="doc-row">
6531 <div class="doc-copy">
6122 <section class="swagger-request-params"> 6532 <section class="swagger-request-params">
6123 <div class="prop-row prop-group"> 6533 <div class="prop-row prop-group">
6124 <div class="prop-name"> 6534 <div class="prop-name">
@@ -6173,7 +6583,10 @@
6173 <td> 6583 <td>
6174 <a href="#security-definition-OAuth2">OAuth2</a> 6584 <a href="#security-definition-OAuth2">OAuth2</a>
6175 </td> 6585 </td>
6176 <td> </td> 6586 <td>
6587 <a href="#security-definition-scope-admin">admin</a>,
6588 <a href="#security-definition-scope-moderator">moderator</a>
6589 </td>
6177 </tr> 6590 </tr>
6178 </tbody> 6591 </tbody>
6179 </table> 6592 </table>
@@ -6181,24 +6594,28 @@
6181 </div> 6594 </div>
6182 </div> 6595 </div>
6183 </div> 6596 </div>
6184 <h1 id="tag-Search" class="swagger-summary-tag" data-traverse-target="tag-Search">Search</h1> 6597 <div id="operation--videos-blacklist-get" class="operation panel" data-traverse-target="operation--videos-blacklist-get">
6185 <div id="operation--search-videos-get" class="operation panel" data-traverse-target="operation--search-videos-get">
6186 <!-- <section class="operation-tags row"> --> 6598 <!-- <section class="operation-tags row"> -->
6187 <!-- <div class="doc-copy"> --> 6599 <!-- <div class="doc-copy"> -->
6188 <div class="operation-tags"> 6600 <div class="operation-tags">
6189 <a class="label" href="#tag-Search">Search</a> 6601 <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a>
6190 <!----> 6602 <!---->
6191 </div> 6603 </div>
6192 <!-- </div> --> 6604 <!-- </div> -->
6193 <!-- </section> --> 6605 <!-- </section> -->
6194 <h2 class="operation-title"> 6606 <h2 class="operation-title">
6195 <span class="operation-name"> 6607 <span class="operation-summary">Get list of videos on blacklist</span>
6196 <span class="operation-name">GET</span>
6197 <span class="operation-path">/search/videos</span>
6198 </span>
6199 </h2> 6608 </h2>
6200 <div class="doc-row"> 6609 <div class="doc-row">
6201 <div class="doc-copy"> 6610 <div class="doc-copy">
6611 <section class="swagger-operation-path">
6612 <span class="operation-method">GET</span>
6613 <span class="operation-path">/videos/blacklist</span>
6614 </section>
6615 </div>
6616 </div>
6617 <div class="doc-row">
6618 <div class="doc-copy">
6202 <section class="swagger-request-params"> 6619 <section class="swagger-request-params">
6203 <div class="prop-row prop-group"> 6620 <div class="prop-row prop-group">
6204 <div class="prop-name"> 6621 <div class="prop-name">
@@ -6242,21 +6659,6 @@
6242 <p>Sort column (-createdAt for example)</p> 6659 <p>Sort column (-createdAt for example)</p>
6243 </div> 6660 </div>
6244 </div> 6661 </div>
6245 <div class="prop-row prop-group">
6246 <div class="prop-name">
6247 <div class="prop-title">search:
6248 <span class="prop-type">
6249 <span class="json-property-type">string</span>
6250 <span class="json-property-range" title="Value limits"></span>
6251 </span>
6252 </div>
6253 <span class="json-property-required"></span>
6254 <div class="prop-subtitle"> in query </div>
6255 </div>
6256 <div class="prop-value">
6257 <p>String to search</p>
6258 </div>
6259 </div>
6260 </section> 6662 </section>
6261 </div> 6663 </div>
6262 <div class="doc-examples"></div> 6664 <div class="doc-examples"></div>
@@ -6269,7 +6671,7 @@
6269 <div class="prop-title">200 OK</div> 6671 <div class="prop-title">200 OK</div>
6270 <div class="prop-ref"> 6672 <div class="prop-ref">
6271 <span class="json-schema-ref-array"> 6673 <span class="json-schema-ref-array">
6272 <a class="json-schema-ref" href="#/definitions/Video">Video</a> 6674 <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a>
6273 </span> 6675 </span>
6274 </div> 6676 </div>
6275 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> 6677 <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
@@ -6283,7 +6685,7 @@
6283 <div class="prop-value"> 6685 <div class="prop-value">
6284 <span class="json-property-type"> 6686 <span class="json-property-type">
6285 <span class="json-schema-ref-array"> 6687 <span class="json-schema-ref-array">
6286 <a class="json-schema-ref" href="#/definitions/Video">Video</a> 6688 <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a>
6287 </span> 6689 </span>
6288 </span> 6690 </span>
6289 <span class="json-property-range" title="Value limits"></span> 6691 <span class="json-property-range" title="Value limits"></span>
@@ -6302,45 +6704,17 @@
6302 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ 6704 <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
6303 { 6705 {
6304 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 6706 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6305 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 6707 <span class="hljs-attr">&quot;videoId&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6306 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 6708 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6307 <span class="hljs-attr">&quot;publishedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6308 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 6709 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6309 <span class="hljs-attr">&quot;category&quot;</span>: { 6710 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6310 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 6711 <span class="hljs-attr">&quot;uuid&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6311 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6312 },
6313 <span class="hljs-attr">&quot;licence&quot;</span>: {
6314 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6315 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6316 },
6317 <span class="hljs-attr">&quot;language&quot;</span>: {
6318 <span class="hljs-attr">&quot;id&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6319 <span class="hljs-attr">&quot;label&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6320 },
6321 <span class="hljs-attr">&quot;privacy&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6322 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>, 6712 <span class="hljs-attr">&quot;description&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6323 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 6713 <span class="hljs-attr">&quot;duration&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6324 <span class="hljs-attr">&quot;isLocal&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>,
6325 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6326 <span class="hljs-attr">&quot;thumbnailPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6327 <span class="hljs-attr">&quot;previewPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6328 <span class="hljs-attr">&quot;embedPath&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6329 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 6714 <span class="hljs-attr">&quot;views&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6330 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 6715 <span class="hljs-attr">&quot;likes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6331 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>, 6716 <span class="hljs-attr">&quot;dislikes&quot;</span>: <span class="hljs-string">&quot;number&quot;</span>,
6332 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>, 6717 <span class="hljs-attr">&quot;nsfw&quot;</span>: <span class="hljs-string">&quot;boolean&quot;</span>
6333 <span class="hljs-attr">&quot;account&quot;</span>: {
6334 <span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6335 <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6336 <span class="hljs-attr">&quot;url&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6337 <span class="hljs-attr">&quot;host&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6338 <span class="hljs-attr">&quot;avatar&quot;</span>: {
6339 <span class="hljs-attr">&quot;path&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6340 <span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
6341 <span class="hljs-attr">&quot;updatedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
6342 }
6343 }
6344 } 6718 }
6345] 6719]
6346</code></pre> 6720</code></pre>
@@ -6348,13 +6722,122 @@
6348 </section> 6722 </section>
6349 </div> 6723 </div>
6350 </div> 6724 </div>
6725 <div class="doc-row">
6726 <div class="doc-copy">
6727 <section class="swagger-request-security">
6728 <table class="table">
6729 <thead>
6730 <tr>
6731 <th class="swagger-request-security-schema"></th>
6732 <th class="swagger-request-security-scopes"></th>
6733 </tr>
6734 </thead>
6735 <tbody>
6736 <tr>
6737 <td>
6738 <a href="#security-definition-OAuth2">OAuth2</a>
6739 </td>
6740 <td>
6741 <a href="#security-definition-scope-admin">admin</a>,
6742 <a href="#security-definition-scope-moderator">moderator</a>
6743 </td>
6744 </tr>
6745 </tbody>
6746 </table>
6747 </section>
6748 </div>
6749 </div>
6750 </div>
6751 <h1 id="tag-VideoRate" class="swagger-summary-tag" data-traverse-target="tag-VideoRate">VideoRate</h1>
6752 <div id="operation--videos--id--rate-put" class="operation panel" data-traverse-target="operation--videos--id--rate-put">
6753 <!-- <section class="operation-tags row"> -->
6754 <!-- <div class="doc-copy"> -->
6755 <div class="operation-tags">
6756 <a class="label" href="#tag-VideoRate">VideoRate</a>
6757 <!---->
6758 </div>
6759 <!-- </div> -->
6760 <!-- </section> -->
6761 <h2 class="operation-title">
6762 <span class="operation-summary">Vote for a video by its id</span>
6763 </h2>
6764 <div class="doc-row">
6765 <div class="doc-copy">
6766 <section class="swagger-operation-path">
6767 <span class="operation-method">PUT</span>
6768 <span class="operation-path">/videos/{id}/rate</span>
6769 </section>
6770 </div>
6771 </div>
6772 <div class="doc-row">
6773 <div class="doc-copy">
6774 <section class="swagger-request-params">
6775 <div class="prop-row prop-group">
6776 <div class="prop-name">
6777 <div class="prop-title">id:
6778 <span class="prop-type">
6779 <span class="json-property-type">string</span>
6780 <span class="json-property-range" title="Value limits"></span>
6781 </span>
6782 </div>
6783 <span class="json-property-required"></span>
6784 <div class="prop-subtitle"> in path </div>
6785 </div>
6786 <div class="prop-value">
6787 <p>The video id or uuid</p>
6788 </div>
6789 </div>
6790 </section>
6791 </div>
6792 <div class="doc-examples"></div>
6793 </div>
6794 <div class="doc-row">
6795 <div class="doc-copy">
6796 <section class="swagger-responses">
6797 <div class="prop-row prop-group">
6798 <div class="prop-name">
6799 <div class="prop-title">204 No Content</div>
6800 </div>
6801 <div class="prop-value">
6802 <p>Successful operation</p>
6803 </div>
6804 </div>
6805 </section>
6806 </div>
6807 <div class="doc-examples">
6808 <h5>Response Content-Types:
6809 <span>application/json</span>
6810 </h5>
6811 </div>
6812 </div>
6813 <div class="doc-row">
6814 <div class="doc-copy">
6815 <section class="swagger-request-security">
6816 <table class="table">
6817 <thead>
6818 <tr>
6819 <th class="swagger-request-security-schema"></th>
6820 <th class="swagger-request-security-scopes"></th>
6821 </tr>
6822 </thead>
6823 <tbody>
6824 <tr>
6825 <td>
6826 <a href="#security-definition-OAuth2">OAuth2</a>
6827 </td>
6828 <td> </td>
6829 </tr>
6830 </tbody>
6831 </table>
6832 </section>
6833 </div>
6834 </div>
6351 </div> 6835 </div>
6352 <h1>Schema Definitions</h1> 6836 <h1>Schema Definitions</h1>
6353 <div id="definition-VideoConstantNumber" class="definition panel" data-traverse-target="definition-VideoConstantNumber"> 6837 <div id="definition-VideoConstantNumber" class="definition panel" data-traverse-target="definition-VideoConstantNumber">
6354 <h2 class="panel-title"> 6838 <h2 class="panel-title">
6355 <a name="/definitions/VideoConstantNumber"></a>VideoConstantNumber: 6839 <a name="/definitions/VideoConstantNumber"></a>VideoConstantNumber:
6356 <!-- <span class="json-property-type"> 6840 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6357 <span class="json-property-type">object</span>
6358 <span class="json-property-range" title="Value limits"></span> 6841 <span class="json-property-range" title="Value limits"></span>
6359 6842
6360 6843
@@ -6393,8 +6876,7 @@
6393 <div id="definition-VideoConstantString" class="definition panel" data-traverse-target="definition-VideoConstantString"> 6876 <div id="definition-VideoConstantString" class="definition panel" data-traverse-target="definition-VideoConstantString">
6394 <h2 class="panel-title"> 6877 <h2 class="panel-title">
6395 <a name="/definitions/VideoConstantString"></a>VideoConstantString: 6878 <a name="/definitions/VideoConstantString"></a>VideoConstantString:
6396 <!-- <span class="json-property-type"> 6879 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6397 <span class="json-property-type">object</span>
6398 <span class="json-property-range" title="Value limits"></span> 6880 <span class="json-property-range" title="Value limits"></span>
6399 6881
6400 6882
@@ -6433,8 +6915,7 @@
6433 <div id="definition-VideoPrivacy" class="definition panel" data-traverse-target="definition-VideoPrivacy"> 6915 <div id="definition-VideoPrivacy" class="definition panel" data-traverse-target="definition-VideoPrivacy">
6434 <h2 class="panel-title"> 6916 <h2 class="panel-title">
6435 <a name="/definitions/VideoPrivacy"></a>VideoPrivacy: string 6917 <a name="/definitions/VideoPrivacy"></a>VideoPrivacy: string
6436 <!-- <span class="json-property-type"> 6918 <!-- <span class="json-property-type"><span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values">
6437 <span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values">
6438 <span class="json-property-enum-item">Public</span>, 6919 <span class="json-property-enum-item">Public</span>,
6439 <span class="json-property-enum-item">Unlisted</span>, 6920 <span class="json-property-enum-item">Unlisted</span>,
6440 <span class="json-property-enum-item">Private</span> 6921 <span class="json-property-enum-item">Private</span>
@@ -6459,8 +6940,7 @@
6459 <div id="definition-Video" class="definition panel" data-traverse-target="definition-Video"> 6940 <div id="definition-Video" class="definition panel" data-traverse-target="definition-Video">
6460 <h2 class="panel-title"> 6941 <h2 class="panel-title">
6461 <a name="/definitions/Video"></a>Video: 6942 <a name="/definitions/Video"></a>Video:
6462 <!-- <span class="json-property-type"> 6943 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6463 <span class="json-property-type">object</span>
6464 <span class="json-property-range" title="Value limits"></span> 6944 <span class="json-property-range" title="Value limits"></span>
6465 6945
6466 6946
@@ -6683,8 +7163,7 @@
6683 <div id="definition-VideoAbuse" class="definition panel" data-traverse-target="definition-VideoAbuse"> 7163 <div id="definition-VideoAbuse" class="definition panel" data-traverse-target="definition-VideoAbuse">
6684 <h2 class="panel-title"> 7164 <h2 class="panel-title">
6685 <a name="/definitions/VideoAbuse"></a>VideoAbuse: 7165 <a name="/definitions/VideoAbuse"></a>VideoAbuse:
6686 <!-- <span class="json-property-type"> 7166 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6687 <span class="json-property-type">object</span>
6688 <span class="json-property-range" title="Value limits"></span> 7167 <span class="json-property-range" title="Value limits"></span>
6689 7168
6690 7169
@@ -6792,8 +7271,7 @@
6792 <div id="definition-VideoBlacklist" class="definition panel" data-traverse-target="definition-VideoBlacklist"> 7271 <div id="definition-VideoBlacklist" class="definition panel" data-traverse-target="definition-VideoBlacklist">
6793 <h2 class="panel-title"> 7272 <h2 class="panel-title">
6794 <a name="/definitions/VideoBlacklist"></a>VideoBlacklist: 7273 <a name="/definitions/VideoBlacklist"></a>VideoBlacklist:
6795 <!-- <span class="json-property-type"> 7274 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6796 <span class="json-property-type">object</span>
6797 <span class="json-property-range" title="Value limits"></span> 7275 <span class="json-property-range" title="Value limits"></span>
6798 7276
6799 7277
@@ -6892,8 +7370,7 @@
6892 <div id="definition-VideoChannel" class="definition panel" data-traverse-target="definition-VideoChannel"> 7370 <div id="definition-VideoChannel" class="definition panel" data-traverse-target="definition-VideoChannel">
6893 <h2 class="panel-title"> 7371 <h2 class="panel-title">
6894 <a name="/definitions/VideoChannel"></a>VideoChannel: 7372 <a name="/definitions/VideoChannel"></a>VideoChannel:
6895 <!-- <span class="json-property-type"> 7373 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6896 <span class="json-property-type">object</span>
6897 <span class="json-property-range" title="Value limits"></span> 7374 <span class="json-property-range" title="Value limits"></span>
6898 7375
6899 7376
@@ -6963,8 +7440,7 @@
6963 <div id="definition-VideoComment" class="definition panel" data-traverse-target="definition-VideoComment"> 7440 <div id="definition-VideoComment" class="definition panel" data-traverse-target="definition-VideoComment">
6964 <h2 class="panel-title"> 7441 <h2 class="panel-title">
6965 <a name="/definitions/VideoComment"></a>VideoComment: 7442 <a name="/definitions/VideoComment"></a>VideoComment:
6966 <!-- <span class="json-property-type"> 7443 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
6967 <span class="json-property-type">object</span>
6968 <span class="json-property-range" title="Value limits"></span> 7444 <span class="json-property-range" title="Value limits"></span>
6969 7445
6970 7446
@@ -7071,8 +7547,7 @@
7071 <div id="definition-VideoCommentThreadTree" class="definition panel" data-traverse-target="definition-VideoCommentThreadTree"> 7547 <div id="definition-VideoCommentThreadTree" class="definition panel" data-traverse-target="definition-VideoCommentThreadTree">
7072 <h2 class="panel-title"> 7548 <h2 class="panel-title">
7073 <a name="/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree: 7549 <a name="/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree:
7074 <!-- <span class="json-property-type"> 7550 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7075 <span class="json-property-type">object</span>
7076 <span class="json-property-range" title="Value limits"></span> 7551 <span class="json-property-range" title="Value limits"></span>
7077 7552
7078 7553
@@ -7220,8 +7695,7 @@
7220 <div id="definition-Avatar" class="definition panel" data-traverse-target="definition-Avatar"> 7695 <div id="definition-Avatar" class="definition panel" data-traverse-target="definition-Avatar">
7221 <h2 class="panel-title"> 7696 <h2 class="panel-title">
7222 <a name="/definitions/Avatar"></a>Avatar: 7697 <a name="/definitions/Avatar"></a>Avatar:
7223 <!-- <span class="json-property-type"> 7698 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7224 <span class="json-property-type">object</span>
7225 <span class="json-property-range" title="Value limits"></span> 7699 <span class="json-property-range" title="Value limits"></span>
7226 7700
7227 7701
@@ -7266,8 +7740,7 @@
7266 <div id="definition-Actor" class="definition panel" data-traverse-target="definition-Actor"> 7740 <div id="definition-Actor" class="definition panel" data-traverse-target="definition-Actor">
7267 <h2 class="panel-title"> 7741 <h2 class="panel-title">
7268 <a name="/definitions/Actor"></a>Actor: 7742 <a name="/definitions/Actor"></a>Actor:
7269 <!-- <span class="json-property-type"> 7743 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7270 <span class="json-property-type">object</span>
7271 <span class="json-property-range" title="Value limits"></span> 7744 <span class="json-property-range" title="Value limits"></span>
7272 7745
7273 7746
@@ -7362,8 +7835,7 @@
7362 <div id="definition-Account" class="definition panel" data-traverse-target="definition-Account"> 7835 <div id="definition-Account" class="definition panel" data-traverse-target="definition-Account">
7363 <h2 class="panel-title"> 7836 <h2 class="panel-title">
7364 <a name="/definitions/Account"></a>Account: 7837 <a name="/definitions/Account"></a>Account:
7365 <!-- <span class="json-property-type"> 7838 <!-- <span class="json-property-type"><span class="json-property-type"></span>
7366 <span class="json-property-type"></span>
7367 <span class="json-property-range" title="Value limits"></span> 7839 <span class="json-property-range" title="Value limits"></span>
7368 7840
7369 7841
@@ -7421,8 +7893,7 @@
7421 <div id="definition-User" class="definition panel" data-traverse-target="definition-User"> 7893 <div id="definition-User" class="definition panel" data-traverse-target="definition-User">
7422 <h2 class="panel-title"> 7894 <h2 class="panel-title">
7423 <a name="/definitions/User"></a>User: 7895 <a name="/definitions/User"></a>User:
7424 <!-- <span class="json-property-type"> 7896 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7425 <span class="json-property-type">object</span>
7426 <span class="json-property-range" title="Value limits"></span> 7897 <span class="json-property-range" title="Value limits"></span>
7427 7898
7428 7899
@@ -7559,8 +8030,7 @@
7559 <div id="definition-ServerConfig" class="definition panel" data-traverse-target="definition-ServerConfig"> 8030 <div id="definition-ServerConfig" class="definition panel" data-traverse-target="definition-ServerConfig">
7560 <h2 class="panel-title"> 8031 <h2 class="panel-title">
7561 <a name="/definitions/ServerConfig"></a>ServerConfig: 8032 <a name="/definitions/ServerConfig"></a>ServerConfig:
7562 <!-- <span class="json-property-type"> 8033 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7563 <span class="json-property-type">object</span>
7564 <span class="json-property-range" title="Value limits"></span> 8034 <span class="json-property-range" title="Value limits"></span>
7565 8035
7566 8036
@@ -7735,8 +8205,7 @@
7735 <div id="definition-Follow" class="definition panel" data-traverse-target="definition-Follow"> 8205 <div id="definition-Follow" class="definition panel" data-traverse-target="definition-Follow">
7736 <h2 class="panel-title"> 8206 <h2 class="panel-title">
7737 <a name="/definitions/Follow"></a>Follow: 8207 <a name="/definitions/Follow"></a>Follow:
7738 <!-- <span class="json-property-type"> 8208 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7739 <span class="json-property-type">object</span>
7740 <span class="json-property-range" title="Value limits"></span> 8209 <span class="json-property-range" title="Value limits"></span>
7741 8210
7742 8211
@@ -7847,8 +8316,7 @@
7847 <div id="definition-Job" class="definition panel" data-traverse-target="definition-Job"> 8316 <div id="definition-Job" class="definition panel" data-traverse-target="definition-Job">
7848 <h2 class="panel-title"> 8317 <h2 class="panel-title">
7849 <a name="/definitions/Job"></a>Job: 8318 <a name="/definitions/Job"></a>Job:
7850 <!-- <span class="json-property-type"> 8319 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7851 <span class="json-property-type">object</span>
7852 <span class="json-property-range" title="Value limits"></span> 8320 <span class="json-property-range" title="Value limits"></span>
7853 8321
7854 8322
@@ -7927,8 +8395,7 @@
7927 <div id="definition-AddUserResponse" class="definition panel" data-traverse-target="definition-AddUserResponse"> 8395 <div id="definition-AddUserResponse" class="definition panel" data-traverse-target="definition-AddUserResponse">
7928 <h2 class="panel-title"> 8396 <h2 class="panel-title">
7929 <a name="/definitions/AddUserResponse"></a>AddUserResponse: 8397 <a name="/definitions/AddUserResponse"></a>AddUserResponse:
7930 <!-- <span class="json-property-type"> 8398 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7931 <span class="json-property-type">object</span>
7932 <span class="json-property-range" title="Value limits"></span> 8399 <span class="json-property-range" title="Value limits"></span>
7933 8400
7934 8401
@@ -7967,8 +8434,7 @@
7967 <div id="definition-VideoUploadResponse" class="definition panel" data-traverse-target="definition-VideoUploadResponse"> 8434 <div id="definition-VideoUploadResponse" class="definition panel" data-traverse-target="definition-VideoUploadResponse">
7968 <h2 class="panel-title"> 8435 <h2 class="panel-title">
7969 <a name="/definitions/VideoUploadResponse"></a>VideoUploadResponse: 8436 <a name="/definitions/VideoUploadResponse"></a>VideoUploadResponse:
7970 <!-- <span class="json-property-type"> 8437 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
7971 <span class="json-property-type">object</span>
7972 <span class="json-property-range" title="Value limits"></span> 8438 <span class="json-property-range" title="Value limits"></span>
7973 8439
7974 8440
@@ -8020,8 +8486,7 @@
8020 <div id="definition-CommentThreadResponse" class="definition panel" data-traverse-target="definition-CommentThreadResponse"> 8486 <div id="definition-CommentThreadResponse" class="definition panel" data-traverse-target="definition-CommentThreadResponse">
8021 <h2 class="panel-title"> 8487 <h2 class="panel-title">
8022 <a name="/definitions/CommentThreadResponse"></a>CommentThreadResponse: 8488 <a name="/definitions/CommentThreadResponse"></a>CommentThreadResponse:
8023 <!-- <span class="json-property-type"> 8489 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8024 <span class="json-property-type">object</span>
8025 <span class="json-property-range" title="Value limits"></span> 8490 <span class="json-property-range" title="Value limits"></span>
8026 8491
8027 8492
@@ -8104,8 +8569,7 @@
8104 <div id="definition-CommentThreadPostResponse" class="definition panel" data-traverse-target="definition-CommentThreadPostResponse"> 8569 <div id="definition-CommentThreadPostResponse" class="definition panel" data-traverse-target="definition-CommentThreadPostResponse">
8105 <h2 class="panel-title"> 8570 <h2 class="panel-title">
8106 <a name="/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse: 8571 <a name="/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse:
8107 <!-- <span class="json-property-type"> 8572 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8108 <span class="json-property-type">object</span>
8109 <span class="json-property-range" title="Value limits"></span> 8573 <span class="json-property-range" title="Value limits"></span>
8110 8574
8111 8575
@@ -8169,8 +8633,7 @@
8169 <div id="definition-AddUser" class="definition panel" data-traverse-target="definition-AddUser"> 8633 <div id="definition-AddUser" class="definition panel" data-traverse-target="definition-AddUser">
8170 <h2 class="panel-title"> 8634 <h2 class="panel-title">
8171 <a name="/definitions/AddUser"></a>AddUser: 8635 <a name="/definitions/AddUser"></a>AddUser:
8172 <!-- <span class="json-property-type"> 8636 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8173 <span class="json-property-type">object</span>
8174 <span class="json-property-range" title="Value limits"></span> 8637 <span class="json-property-range" title="Value limits"></span>
8175 8638
8176 8639
@@ -8247,8 +8710,7 @@
8247 <div id="definition-UpdateUser" class="definition panel" data-traverse-target="definition-UpdateUser"> 8710 <div id="definition-UpdateUser" class="definition panel" data-traverse-target="definition-UpdateUser">
8248 <h2 class="panel-title"> 8711 <h2 class="panel-title">
8249 <a name="/definitions/UpdateUser"></a>UpdateUser: 8712 <a name="/definitions/UpdateUser"></a>UpdateUser:
8250 <!-- <span class="json-property-type"> 8713 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8251 <span class="json-property-type">object</span>
8252 <span class="json-property-range" title="Value limits"></span> 8714 <span class="json-property-range" title="Value limits"></span>
8253 8715
8254 8716
@@ -8315,8 +8777,7 @@
8315 <div id="definition-UpdateMe" class="definition panel" data-traverse-target="definition-UpdateMe"> 8777 <div id="definition-UpdateMe" class="definition panel" data-traverse-target="definition-UpdateMe">
8316 <h2 class="panel-title"> 8778 <h2 class="panel-title">
8317 <a name="/definitions/UpdateMe"></a>UpdateMe: 8779 <a name="/definitions/UpdateMe"></a>UpdateMe:
8318 <!-- <span class="json-property-type"> 8780 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8319 <span class="json-property-type">object</span>
8320 <span class="json-property-range" title="Value limits"></span> 8781 <span class="json-property-range" title="Value limits"></span>
8321 8782
8322 8783
@@ -8383,8 +8844,7 @@
8383 <div id="definition-GetMeVideoRating" class="definition panel" data-traverse-target="definition-GetMeVideoRating"> 8844 <div id="definition-GetMeVideoRating" class="definition panel" data-traverse-target="definition-GetMeVideoRating">
8384 <h2 class="panel-title"> 8845 <h2 class="panel-title">
8385 <a name="/definitions/GetMeVideoRating"></a>GetMeVideoRating: 8846 <a name="/definitions/GetMeVideoRating"></a>GetMeVideoRating:
8386 <!-- <span class="json-property-type"> 8847 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8387 <span class="json-property-type">object</span>
8388 <span class="json-property-range" title="Value limits"></span> 8848 <span class="json-property-range" title="Value limits"></span>
8389 8849
8390 8850
@@ -8431,8 +8891,7 @@
8431 <div id="definition-RegisterUser" class="definition panel" data-traverse-target="definition-RegisterUser"> 8891 <div id="definition-RegisterUser" class="definition panel" data-traverse-target="definition-RegisterUser">
8432 <h2 class="panel-title"> 8892 <h2 class="panel-title">
8433 <a name="/definitions/RegisterUser"></a>RegisterUser: 8893 <a name="/definitions/RegisterUser"></a>RegisterUser:
8434 <!-- <span class="json-property-type"> 8894 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8435 <span class="json-property-type">object</span>
8436 <span class="json-property-range" title="Value limits"></span> 8895 <span class="json-property-range" title="Value limits"></span>
8437 8896
8438 8897
@@ -8489,8 +8948,7 @@
8489 <div id="definition-VideoChannelInput" class="definition panel" data-traverse-target="definition-VideoChannelInput"> 8948 <div id="definition-VideoChannelInput" class="definition panel" data-traverse-target="definition-VideoChannelInput">
8490 <h2 class="panel-title"> 8949 <h2 class="panel-title">
8491 <a name="/definitions/VideoChannelInput"></a>VideoChannelInput: 8950 <a name="/definitions/VideoChannelInput"></a>VideoChannelInput:
8492 <!-- <span class="json-property-type"> 8951 <!-- <span class="json-property-type"><span class="json-property-type">object</span>
8493 <span class="json-property-type">object</span>
8494 <span class="json-property-range" title="Value limits"></span> 8952 <span class="json-property-range" title="Value limits"></span>
8495 8953
8496 8954
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index f3520a7b1..e88c05333 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -2,24 +2,105 @@ swagger: '2.0'
2info: 2info:
3 title: PeerTube 3 title: PeerTube
4 version: 1.1.0-alpha.2 4 version: 1.1.0-alpha.2
5 description: Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular. 5 contact:
6host: peertube.example.com 6 name: PeerTube Community
7 url: 'https://joinpeertube.org'
8 license:
9 name: AGPLv3.0
10 url: 'https://github.com/Chocobozzz/PeerTube/blob/master/LICENSE'
11 x-logo:
12 url: 'https://joinpeertube.org/img/brand.png'
13 description: |
14 # Introduction
15 The PeerTube API is built on HTTP(S). Our API is RESTful. It has predictable
16 resource URLs. It returns HTTP response codes to indicate errors. It also
17 accepts and returns JSON in the HTTP body. You can use your favorite
18 HTTP/REST library for your programming language to use PeerTube. No official
19 SDK is currently provided.
20
21 # Authentication
22 When you sign up for an account, you are given the possibility to generate
23 sessions, and authenticate using this session token. One session token can
24 currently be used at a time.
7securityDefinitions: 25securityDefinitions:
8 OAuth2: 26 OAuth2:
9 description: 'In the header: *Authorization: Bearer mytoken*' 27 description: |
28 In the header: *Authorization: Bearer <token\>*
29
30 Authenticating via OAuth requires the following steps:
31
32 - Have an account with sufficient authorization levels
33 - [Generate](https://docs.joinpeertube.org/lang/en/devdocs/rest.html) a Bearer Token
34 - Make Authenticated Requests
10 type: oauth2 35 type: oauth2
11 flow: password 36 flow: password
12 # Not implemented yet 37 # Not implemented yet
13 # authorizationUrl: https://example.com/oauth/authorize 38 # authorizationUrl: https://example.com/oauth/authorize
14 tokenUrl: https://peertube.example.com/api/v1/users/token 39 tokenUrl: https://peertube.example.com/api/v1/users/token
40 scopes:
41 admin: Admin scope
42 moderator: Moderator scope
43 user: User scope
15basePath: '/api/v1' 44basePath: '/api/v1'
16schemes: 45schemes:
17 - https 46 - https
47host: peertube.example.com
48x-servers:
49 - url: 'https://peertube.cpy.re/api/v1'
50 description: Live Server
51produces:
52 - application/json; charset=utf-8
53consumes:
54 - application/json
55tags:
56 - name: Accounts
57 description: |
58 Using some features of PeerTube require authentication, for which Accounts
59 provide different levels of permission as well as associated user information.
60 Accounts also encompass remote accounts discovered across the federation.
61 - name: Config
62 description: |
63 Each server exposes public information regarding supported videos and options.
64 - name: Feeds
65 description: |
66 Feeds of videos and feeds of comments allow to see updates and get them in
67 an aggregator or script of your choice.
68 - name: Job
69 description: |
70 Jobs are long-running tasks enqueued and processed by the instance itself.
71 No additional worker registration is currently available.
72 - name: ServerFollowing
73 description: |
74 Managing servers which the instance interacts with is crucial to the concept
75 of federation in PeerTube and external video indexation. The PeerTube server
76 then deals with inter-server ActivityPub operations and propagates
77 information across its social graph by posting activities to actors' inbox
78 endpoints.
79 - name: VideoAbuse
80 description: |
81 Video abuses deal with reports of local or remote videos alike.
82 - name: Video
83 description: |
84 Operations dealing with listing, uploading, fetching or modifying videos.
85 - name: Search
86 description: |
87 The search helps to find _videos_ from within the instance and beyond.
88 Videos from other instances federated by the instance (that is, instances
89 followed by the instance) can be found via keywords and other criteria of
90 the advanced search.
91 - name: VideoComment
92 description: |
93 Operations dealing with comments to a video. Comments are organized in threads.
94 - name: VideoChannel
95 description: |
96 Operations dealing with creation, modification and video listing of a user's
97 channels.
18paths: 98paths:
19 '/accounts/{name}': 99 '/accounts/{name}':
20 get: 100 get:
21 tags: 101 tags:
22 - Accounts 102 - Accounts
103 summary: Get the account by name
23 consumes: 104 consumes:
24 - application/json 105 - application/json
25 produces: 106 produces:
@@ -38,6 +119,8 @@ paths:
38 get: 119 get:
39 tags: 120 tags:
40 - Accounts 121 - Accounts
122 - Video
123 summary: Get videos for an account, provided the name of that account
41 consumes: 124 consumes:
42 - application/json 125 - application/json
43 produces: 126 produces:
@@ -49,14 +132,24 @@ paths:
49 description: successful operation 132 description: successful operation
50 schema: 133 schema:
51 $ref: '#/definitions/Video' 134 $ref: '#/definitions/Video'
135 x-code-samples:
136 - lang: JavaScript
137 source: |
138 fetch('https://peertube.cpy.re/api/v1/accounts/{name}/videos')
139 .then(function(response) {
140 return response.json()
141 }).then(function(data) {
142 console.log(data)
143 })
52 /accounts: 144 /accounts:
53 get: 145 get:
54 tags: 146 tags:
55 - Accounts 147 - Accounts
148 summary: Get all accounts
56 consumes: 149 consumes:
57 - application/json 150 - application/json
58 produces: 151 produces:
59 - application/json 152 - application/jsonhttps://peertube.cpy.re/api/v1
60 responses: 153 responses:
61 '200': 154 '200':
62 description: successful operation 155 description: successful operation
@@ -68,6 +161,7 @@ paths:
68 get: 161 get:
69 tags: 162 tags:
70 - Config 163 - Config
164 summary: Get the configuration of the server
71 consumes: 165 consumes:
72 - application/json 166 - application/json
73 produces: 167 produces:
@@ -79,6 +173,7 @@ paths:
79 $ref: '#/definitions/ServerConfig' 173 $ref: '#/definitions/ServerConfig'
80 /feeds/videos.{format}: 174 /feeds/videos.{format}:
81 get: 175 get:
176 summary: Get the feed of videos for the server, with optional filter by account name or id
82 tags: 177 tags:
83 - Feeds 178 - Feeds
84 produces: 179 produces:
@@ -108,8 +203,9 @@ paths:
108 description: successful operation 203 description: successful operation
109 /jobs: 204 /jobs:
110 get: 205 get:
206 summary: Get list of jobs
111 security: 207 security:
112 - OAuth2: [ ] 208 - OAuth2: [ admin ]
113 tags: 209 tags:
114 - Job 210 - Job
115 consumes: 211 consumes:
@@ -135,9 +231,10 @@ paths:
135 '/server/following/{host}': 231 '/server/following/{host}':
136 delete: 232 delete:
137 security: 233 security:
138 - OAuth2: [ ] 234 - OAuth2: [ admin ]
139 tags: 235 tags:
140 - ServerFollowing 236 - ServerFollowing
237 summary: Unfollow a server by hostname
141 consumes: 238 consumes:
142 - application/json 239 - application/json
143 produces: 240 produces:
@@ -155,6 +252,7 @@ paths:
155 get: 252 get:
156 tags: 253 tags:
157 - ServerFollowing 254 - ServerFollowing
255 summary: Get followers of the server
158 consumes: 256 consumes:
159 - application/json 257 - application/json
160 produces: 258 produces:
@@ -174,6 +272,7 @@ paths:
174 get: 272 get:
175 tags: 273 tags:
176 - ServerFollowing 274 - ServerFollowing
275 summary: Get servers followed by the server
177 consumes: 276 consumes:
178 - application/json 277 - application/json
179 produces: 278 produces:
@@ -191,9 +290,10 @@ paths:
191 $ref: '#/definitions/Follow' 290 $ref: '#/definitions/Follow'
192 post: 291 post:
193 security: 292 security:
194 - OAuth2: [ ] 293 - OAuth2: [ admin ]
195 tags: 294 tags:
196 - ServerFollowing 295 - ServerFollowing
296 summary: Follow a server
197 consumes: 297 consumes:
198 - application/json 298 - application/json
199 produces: 299 produces:
@@ -208,8 +308,9 @@ paths:
208 $ref: "commons.yaml#/responses/emptySuccess" 308 $ref: "commons.yaml#/responses/emptySuccess"
209 /users: 309 /users:
210 post: 310 post:
311 summary: Creates user
211 security: 312 security:
212 - OAuth2: [ ] 313 - OAuth2: [ admin ]
213 tags: 314 tags:
214 - User 315 - User
215 consumes: 316 consumes:
@@ -229,6 +330,7 @@ paths:
229 schema: 330 schema:
230 $ref: '#/definitions/AddUserResponse' 331 $ref: '#/definitions/AddUserResponse'
231 get: 332 get:
333 summary: Get a list of users
232 security: 334 security:
233 - OAuth2: [ ] 335 - OAuth2: [ ]
234 tags: 336 tags:
@@ -250,8 +352,9 @@ paths:
250 $ref: '#/definitions/User' 352 $ref: '#/definitions/User'
251 '/users/{id}': 353 '/users/{id}':
252 delete: 354 delete:
355 summary: Delete a user by its id
253 security: 356 security:
254 - OAuth2: [ ] 357 - OAuth2: [ admin ]
255 tags: 358 tags:
256 - User 359 - User
257 consumes: 360 consumes:
@@ -264,6 +367,7 @@ paths:
264 '204': 367 '204':
265 $ref: "commons.yaml#/responses/emptySuccess" 368 $ref: "commons.yaml#/responses/emptySuccess"
266 get: 369 get:
370 summary: Get user by its id
267 security: 371 security:
268 - OAuth2: [ ] 372 - OAuth2: [ ]
269 tags: 373 tags:
@@ -280,6 +384,7 @@ paths:
280 schema: 384 schema:
281 $ref: '#/definitions/User' 385 $ref: '#/definitions/User'
282 put: 386 put:
387 summary: Update user profile by its id
283 security: 388 security:
284 - OAuth2: [ ] 389 - OAuth2: [ ]
285 tags: 390 tags:
@@ -300,6 +405,7 @@ paths:
300 $ref: "commons.yaml#/responses/emptySuccess" 405 $ref: "commons.yaml#/responses/emptySuccess"
301 /users/me: 406 /users/me:
302 get: 407 get:
408 summary: Get current user information
303 security: 409 security:
304 - OAuth2: [ ] 410 - OAuth2: [ ]
305 tags: 411 tags:
@@ -316,6 +422,7 @@ paths:
316 items: 422 items:
317 $ref: '#/definitions/User' 423 $ref: '#/definitions/User'
318 put: 424 put:
425 summary: Update current user information
319 security: 426 security:
320 - OAuth2: [ ] 427 - OAuth2: [ ]
321 tags: 428 tags:
@@ -335,6 +442,7 @@ paths:
335 $ref: "commons.yaml#/responses/emptySuccess" 442 $ref: "commons.yaml#/responses/emptySuccess"
336 /users/me/video-quota-used: 443 /users/me/video-quota-used:
337 get: 444 get:
445 summary: Get current user used quota
338 security: 446 security:
339 - OAuth2: [ ] 447 - OAuth2: [ ]
340 tags: 448 tags:
@@ -351,6 +459,7 @@ paths:
351 type: number 459 type: number
352 '/users/me/videos/{videoId}/rating': 460 '/users/me/videos/{videoId}/rating':
353 get: 461 get:
462 summary: Get rating of video by its id, among those of the current user
354 security: 463 security:
355 - OAuth2: [ ] 464 - OAuth2: [ ]
356 tags: 465 tags:
@@ -372,6 +481,7 @@ paths:
372 $ref: '#/definitions/GetMeVideoRating' 481 $ref: '#/definitions/GetMeVideoRating'
373 /users/me/videos: 482 /users/me/videos:
374 get: 483 get:
484 summary: Get videos of the current user
375 security: 485 security:
376 - OAuth2: [ ] 486 - OAuth2: [ ]
377 tags: 487 tags:
@@ -393,6 +503,7 @@ paths:
393 $ref: '#/definitions/Video' 503 $ref: '#/definitions/Video'
394 /users/register: 504 /users/register:
395 post: 505 post:
506 summary: Register a user
396 tags: 507 tags:
397 - User 508 - User
398 consumes: 509 consumes:
@@ -410,6 +521,7 @@ paths:
410 $ref: "commons.yaml#/responses/emptySuccess" 521 $ref: "commons.yaml#/responses/emptySuccess"
411 /users/me/avatar/pick: 522 /users/me/avatar/pick:
412 post: 523 post:
524 summary: Update current user avatar
413 security: 525 security:
414 - OAuth2: [ ] 526 - OAuth2: [ ]
415 tags: 527 tags:
@@ -430,6 +542,7 @@ paths:
430 $ref: '#/definitions/Avatar' 542 $ref: '#/definitions/Avatar'
431 /videos: 543 /videos:
432 get: 544 get:
545 summary: Get list of videos
433 tags: 546 tags:
434 - Video 547 - Video
435 consumes: 548 consumes:
@@ -454,6 +567,7 @@ paths:
454 $ref: '#/definitions/Video' 567 $ref: '#/definitions/Video'
455 /videos/categories: 568 /videos/categories:
456 get: 569 get:
570 summary: Get list of video licences known by the server
457 tags: 571 tags:
458 - Video 572 - Video
459 consumes: 573 consumes:
@@ -469,6 +583,7 @@ paths:
469 type: string 583 type: string
470 /videos/licences: 584 /videos/licences:
471 get: 585 get:
586 summary: Get list of video licences known by the server
472 tags: 587 tags:
473 - Video 588 - Video
474 consumes: 589 consumes:
@@ -484,6 +599,7 @@ paths:
484 type: string 599 type: string
485 /videos/languages: 600 /videos/languages:
486 get: 601 get:
602 summary: Get list of languages known by the server
487 tags: 603 tags:
488 - Video 604 - Video
489 consumes: 605 consumes:
@@ -499,6 +615,7 @@ paths:
499 type: string 615 type: string
500 /videos/privacies: 616 /videos/privacies:
501 get: 617 get:
618 summary: Get list of privacy policies supported by the server
502 tags: 619 tags:
503 - Video 620 - Video
504 consumes: 621 consumes:
@@ -514,6 +631,7 @@ paths:
514 type: string 631 type: string
515 "/videos/{id}": 632 "/videos/{id}":
516 put: 633 put:
634 summary: Update metadata for a video by its id
517 security: 635 security:
518 - OAuth2: [ ] 636 - OAuth2: [ ]
519 tags: 637 tags:
@@ -544,6 +662,7 @@ paths:
544 schema: 662 schema:
545 $ref: '#/definitions/Video' 663 $ref: '#/definitions/Video'
546 get: 664 get:
665 summary: Get a video by its id
547 tags: 666 tags:
548 - Video 667 - Video
549 consumes: 668 consumes:
@@ -558,6 +677,7 @@ paths:
558 schema: 677 schema:
559 $ref: '#/definitions/Video' 678 $ref: '#/definitions/Video'
560 delete: 679 delete:
680 summary: Delete a video by its id
561 security: 681 security:
562 - OAuth2: [ ] 682 - OAuth2: [ ]
563 tags: 683 tags:
@@ -573,6 +693,7 @@ paths:
573 $ref: "commons.yaml#/responses/emptySuccess" 693 $ref: "commons.yaml#/responses/emptySuccess"
574 "/videos/{id}/description": 694 "/videos/{id}/description":
575 get: 695 get:
696 summary: Get a video description by its id
576 tags: 697 tags:
577 - Video 698 - Video
578 consumes: 699 consumes:
@@ -588,6 +709,7 @@ paths:
588 type: string 709 type: string
589 "/videos/{id}/views": 710 "/videos/{id}/views":
590 post: 711 post:
712 summary: Add a view to the video by its id
591 tags: 713 tags:
592 - Video 714 - Video
593 consumes: 715 consumes:
@@ -601,6 +723,7 @@ paths:
601 $ref: "commons.yaml#/responses/emptySuccess" 723 $ref: "commons.yaml#/responses/emptySuccess"
602 /videos/upload: 724 /videos/upload:
603 post: 725 post:
726 summary: Upload a video file with its metadata
604 security: 727 security:
605 - OAuth2: [ ] 728 - OAuth2: [ ]
606 tags: 729 tags:
@@ -641,6 +764,7 @@ paths:
641 $ref: '#/definitions/VideoUploadResponse' 764 $ref: '#/definitions/VideoUploadResponse'
642 /videos/abuse: 765 /videos/abuse:
643 get: 766 get:
767 summary: Get list of reported video abuses
644 security: 768 security:
645 - OAuth2: [ ] 769 - OAuth2: [ ]
646 tags: 770 tags:
@@ -662,6 +786,7 @@ paths:
662 $ref: '#/definitions/VideoAbuse' 786 $ref: '#/definitions/VideoAbuse'
663 "/videos/{id}/abuse": 787 "/videos/{id}/abuse":
664 post: 788 post:
789 summary: Report an abuse, on a video by its id
665 security: 790 security:
666 - OAuth2: [ ] 791 - OAuth2: [ ]
667 tags: 792 tags:
@@ -677,8 +802,9 @@ paths:
677 $ref: "commons.yaml#/responses/emptySuccess" 802 $ref: "commons.yaml#/responses/emptySuccess"
678 "/videos/{id}/blacklist": 803 "/videos/{id}/blacklist":
679 post: 804 post:
805 summary: Put on blacklist a video by its id
680 security: 806 security:
681 - OAuth2: [ ] 807 - OAuth2: [ admin, moderator ]
682 tags: 808 tags:
683 - VideoBlacklist 809 - VideoBlacklist
684 consumes: 810 consumes:
@@ -691,8 +817,9 @@ paths:
691 '204': 817 '204':
692 $ref: "commons.yaml#/responses/emptySuccess" 818 $ref: "commons.yaml#/responses/emptySuccess"
693 delete: 819 delete:
820 summary: Delete an entry of the blacklist of a video by its id
694 security: 821 security:
695 - OAuth2: [ ] 822 - OAuth2: [ admin, moderator ]
696 tags: 823 tags:
697 - VideoBlacklist 824 - VideoBlacklist
698 consumes: 825 consumes:
@@ -706,8 +833,9 @@ paths:
706 $ref: "commons.yaml#/responses/emptySuccess" 833 $ref: "commons.yaml#/responses/emptySuccess"
707 /videos/blacklist: 834 /videos/blacklist:
708 get: 835 get:
836 summary: Get list of videos on blacklist
709 security: 837 security:
710 - OAuth2: [ ] 838 - OAuth2: [ admin, moderator ]
711 tags: 839 tags:
712 - VideoBlacklist 840 - VideoBlacklist
713 consumes: 841 consumes:
@@ -727,6 +855,7 @@ paths:
727 $ref: '#/definitions/VideoBlacklist' 855 $ref: '#/definitions/VideoBlacklist'
728 /video-channels: 856 /video-channels:
729 get: 857 get:
858 summary: Get list of video channels
730 tags: 859 tags:
731 - VideoChannel 860 - VideoChannel
732 consumes: 861 consumes:
@@ -745,6 +874,7 @@ paths:
745 items: 874 items:
746 $ref: '#/definitions/VideoChannel' 875 $ref: '#/definitions/VideoChannel'
747 post: 876 post:
877 summary: Creates a video channel for the current user
748 security: 878 security:
749 - OAuth2: [ ] 879 - OAuth2: [ ]
750 tags: 880 tags:
@@ -763,6 +893,7 @@ paths:
763 $ref: "commons.yaml#/responses/emptySuccess" 893 $ref: "commons.yaml#/responses/emptySuccess"
764 "/video-channels/{id}": 894 "/video-channels/{id}":
765 get: 895 get:
896 summary: Get a video channel by its id
766 tags: 897 tags:
767 - VideoChannel 898 - VideoChannel
768 consumes: 899 consumes:
@@ -777,6 +908,7 @@ paths:
777 schema: 908 schema:
778 $ref: '#/definitions/VideoChannel' 909 $ref: '#/definitions/VideoChannel'
779 put: 910 put:
911 summary: Update a video channel by its id
780 security: 912 security:
781 - OAuth2: [ ] 913 - OAuth2: [ ]
782 tags: 914 tags:
@@ -795,6 +927,7 @@ paths:
795 '204': 927 '204':
796 $ref: "commons.yaml#/responses/emptySuccess" 928 $ref: "commons.yaml#/responses/emptySuccess"
797 delete: 929 delete:
930 summary: Delete a video channel by its id
798 security: 931 security:
799 - OAuth2: [ ] 932 - OAuth2: [ ]
800 tags: 933 tags:
@@ -810,6 +943,7 @@ paths:
810 $ref: "commons.yaml#/responses/emptySuccess" 943 $ref: "commons.yaml#/responses/emptySuccess"
811 "/video-channels/{id}/videos": 944 "/video-channels/{id}/videos":
812 get: 945 get:
946 summary: Get videos of a video channel by its id
813 tags: 947 tags:
814 - VideoChannel 948 - VideoChannel
815 consumes: 949 consumes:
@@ -825,6 +959,7 @@ paths:
825 $ref: '#/definitions/Video' 959 $ref: '#/definitions/Video'
826 /accounts/{name}/video-channels: 960 /accounts/{name}/video-channels:
827 get: 961 get:
962 summary: Get video channels of an account by its name
828 tags: 963 tags:
829 - VideoChannel 964 - VideoChannel
830 consumes: 965 consumes:
@@ -842,6 +977,7 @@ paths:
842 $ref: '#/definitions/VideoChannel' 977 $ref: '#/definitions/VideoChannel'
843 "/videos/{id}/comment-threads": 978 "/videos/{id}/comment-threads":
844 get: 979 get:
980 summary: Get the comment threads of a video by its id
845 tags: 981 tags:
846 - VideoComment 982 - VideoComment
847 consumes: 983 consumes:
@@ -859,6 +995,7 @@ paths:
859 schema: 995 schema:
860 $ref: '#/definitions/CommentThreadResponse' 996 $ref: '#/definitions/CommentThreadResponse'
861 post: 997 post:
998 summary: Creates a comment thread, on a video by its id
862 security: 999 security:
863 - OAuth2: [ ] 1000 - OAuth2: [ ]
864 tags: 1001 tags:
@@ -876,6 +1013,7 @@ paths:
876 $ref: '#/definitions/CommentThreadPostResponse' 1013 $ref: '#/definitions/CommentThreadPostResponse'
877 "/videos/{id}/comment-threads/{threadId}": 1014 "/videos/{id}/comment-threads/{threadId}":
878 get: 1015 get:
1016 summary: Get the comment thread by its id, of a video by its id
879 tags: 1017 tags:
880 - VideoComment 1018 - VideoComment
881 consumes: 1019 consumes:
@@ -892,6 +1030,7 @@ paths:
892 $ref: '#/definitions/VideoCommentThreadTree' 1030 $ref: '#/definitions/VideoCommentThreadTree'
893 "/videos/{id}/comments/{commentId}": 1031 "/videos/{id}/comments/{commentId}":
894 post: 1032 post:
1033 summary: Creates a comment in a comment thread by its id, of a video by its id
895 security: 1034 security:
896 - OAuth2: [ ] 1035 - OAuth2: [ ]
897 tags: 1036 tags:
@@ -909,6 +1048,7 @@ paths:
909 schema: 1048 schema:
910 $ref: '#/definitions/CommentThreadPostResponse' 1049 $ref: '#/definitions/CommentThreadPostResponse'
911 delete: 1050 delete:
1051 summary: Delete a comment in a comment therad by its id, of a video by its id
912 security: 1052 security:
913 - OAuth2: [ ] 1053 - OAuth2: [ ]
914 tags: 1054 tags:
@@ -925,6 +1065,7 @@ paths:
925 $ref: "commons.yaml#/responses/emptySuccess" 1065 $ref: "commons.yaml#/responses/emptySuccess"
926 "/videos/{id}/rate": 1066 "/videos/{id}/rate":
927 put: 1067 put:
1068 summary: Vote for a video by its id
928 security: 1069 security:
929 - OAuth2: [ ] 1070 - OAuth2: [ ]
930 tags: 1071 tags:
@@ -942,6 +1083,7 @@ paths:
942 get: 1083 get:
943 tags: 1084 tags:
944 - Search 1085 - Search
1086 summary: Get the videos corresponding to a given query
945 consumes: 1087 consumes:
946 - application/json 1088 - application/json
947 produces: 1089 produces:
@@ -1383,4 +1525,4 @@ definitions:
1383 name: 1525 name:
1384 type: string 1526 type: string
1385 description: 1527 description:
1386 type: string \ No newline at end of file 1528 type: string
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-22 14:16:20 +0000