diff options
Diffstat (limited to 'support/doc/api/html/index.html')
-rw-r--r-- | support/doc/api/html/index.html | 8540 |
1 files changed, 0 insertions, 8540 deletions
diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html deleted file mode 100644 index 0efc24f02..000000000 --- a/support/doc/api/html/index.html +++ /dev/null | |||
@@ -1,8540 +0,0 @@ | |||
1 | <!doctype html> | ||
2 | <html class="no-js" lang="en"> | ||
3 | <head> | ||
4 | <meta charset="utf-8" /> | ||
5 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
6 | <title>PeerTube | API Reference</title> | ||
7 | <link rel="stylesheet" href="stylesheets/foundation.min.css" /> | ||
8 | <link rel="stylesheet" href="stylesheets/spectacle.min.css" /> | ||
9 | <script src="https://code.jquery.com/jquery-2.1.4.min.js"></script> | ||
10 | <!-- <script src="javascripts/foundation.js"></script> --> | ||
11 | <script src="javascripts/spectacle.min.js"></script> | ||
12 | </head> | ||
13 | <body id="spectacle"> | ||
14 | <div id="page" class="drawer-layout drawer-slide-right-large"> | ||
15 | <div id="sidebar"> | ||
16 | <button class="close-button" aria-label="Close menu" type="button" data-drawer-close> | ||
17 | <span aria-hidden="true">×</span> | ||
18 | </button> | ||
19 | <nav id="nav" role="navigation"> | ||
20 | <h5>Topics</h5> | ||
21 | <a href="#introduction">Introduction</a> | ||
22 | <a href="#authentication">Authentication</a> | ||
23 | <h5>Operations</h5> | ||
24 | <section> | ||
25 | <a href="#tag-Accounts">Accounts</a> | ||
26 | <ul> | ||
27 | <li> | ||
28 | <a href="#operation--accounts--name--get"> GET /accounts/{name} </a> | ||
29 | </li> | ||
30 | <li> | ||
31 | <a href="#operation--accounts--name--videos-get"> GET /accounts/{name}/videos </a> | ||
32 | </li> | ||
33 | <li> | ||
34 | <a href="#operation--accounts-get"> GET /accounts </a> | ||
35 | </li> | ||
36 | </ul> | ||
37 | </section> | ||
38 | <section> | ||
39 | <a href="#tag-Config">Config</a> | ||
40 | <ul> | ||
41 | <li> | ||
42 | <a href="#operation--config-get"> GET /config </a> | ||
43 | </li> | ||
44 | </ul> | ||
45 | </section> | ||
46 | <section> | ||
47 | <a href="#tag-Feeds">Feeds</a> | ||
48 | <ul> | ||
49 | <li> | ||
50 | <a href="#operation--feeds-videos.-format--get"> GET /feeds/videos.{format} </a> | ||
51 | </li> | ||
52 | </ul> | ||
53 | </section> | ||
54 | <section> | ||
55 | <a href="#tag-Job">Job</a> | ||
56 | <ul> | ||
57 | <li> | ||
58 | <a href="#operation--jobs-get"> GET /jobs </a> | ||
59 | </li> | ||
60 | </ul> | ||
61 | </section> | ||
62 | <section> | ||
63 | <a href="#tag-ServerFollowing">ServerFollowing</a> | ||
64 | <ul> | ||
65 | <li> | ||
66 | <a href="#operation--server-following--host--delete"> DELETE /server/following/{host} </a> | ||
67 | </li> | ||
68 | <li> | ||
69 | <a href="#operation--server-followers-get"> GET /server/followers </a> | ||
70 | </li> | ||
71 | <li> | ||
72 | <a href="#operation--server-following-get"> GET /server/following </a> | ||
73 | </li> | ||
74 | <li> | ||
75 | <a href="#operation--server-following-post"> POST /server/following </a> | ||
76 | </li> | ||
77 | </ul> | ||
78 | </section> | ||
79 | <section> | ||
80 | <a href="#tag-User">User</a> | ||
81 | <ul> | ||
82 | <li> | ||
83 | <a href="#operation--users-post"> POST /users </a> | ||
84 | </li> | ||
85 | <li> | ||
86 | <a href="#operation--users-get"> GET /users </a> | ||
87 | </li> | ||
88 | <li> | ||
89 | <a href="#operation--users--id--delete"> DELETE /users/{id} </a> | ||
90 | </li> | ||
91 | <li> | ||
92 | <a href="#operation--users--id--get"> GET /users/{id} </a> | ||
93 | </li> | ||
94 | <li> | ||
95 | <a href="#operation--users--id--put"> PUT /users/{id} </a> | ||
96 | </li> | ||
97 | <li> | ||
98 | <a href="#operation--users-me-get"> GET /users/me </a> | ||
99 | </li> | ||
100 | <li> | ||
101 | <a href="#operation--users-me-put"> PUT /users/me </a> | ||
102 | </li> | ||
103 | <li> | ||
104 | <a href="#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used </a> | ||
105 | </li> | ||
106 | <li> | ||
107 | <a href="#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating </a> | ||
108 | </li> | ||
109 | <li> | ||
110 | <a href="#operation--users-me-videos-get"> GET /users/me/videos </a> | ||
111 | </li> | ||
112 | <li> | ||
113 | <a href="#operation--users-register-post"> POST /users/register </a> | ||
114 | </li> | ||
115 | <li> | ||
116 | <a href="#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick </a> | ||
117 | </li> | ||
118 | </ul> | ||
119 | </section> | ||
120 | <section> | ||
121 | <a href="#tag-Video">Video</a> | ||
122 | <ul> | ||
123 | <li> | ||
124 | <a href="#operation--videos-get"> GET /videos </a> | ||
125 | </li> | ||
126 | <li> | ||
127 | <a href="#operation--videos-categories-get"> GET /videos/categories </a> | ||
128 | </li> | ||
129 | <li> | ||
130 | <a href="#operation--videos-licences-get"> GET /videos/licences </a> | ||
131 | </li> | ||
132 | <li> | ||
133 | <a href="#operation--videos-languages-get"> GET /videos/languages </a> | ||
134 | </li> | ||
135 | <li> | ||
136 | <a href="#operation--videos-privacies-get"> GET /videos/privacies </a> | ||
137 | </li> | ||
138 | <li> | ||
139 | <a href="#operation--videos--id--put"> PUT /videos/{id} </a> | ||
140 | </li> | ||
141 | <li> | ||
142 | <a href="#operation--videos--id--get"> GET /videos/{id} </a> | ||
143 | </li> | ||
144 | <li> | ||
145 | <a href="#operation--videos--id--delete"> DELETE /videos/{id} </a> | ||
146 | </li> | ||
147 | <li> | ||
148 | <a href="#operation--videos--id--description-get"> GET /videos/{id}/description </a> | ||
149 | </li> | ||
150 | <li> | ||
151 | <a href="#operation--videos--id--views-post"> POST /videos/{id}/views </a> | ||
152 | </li> | ||
153 | <li> | ||
154 | <a href="#operation--videos-upload-post"> POST /videos/upload </a> | ||
155 | </li> | ||
156 | </ul> | ||
157 | </section> | ||
158 | <section> | ||
159 | <a href="#tag-VideoAbuse">VideoAbuse</a> | ||
160 | <ul> | ||
161 | <li> | ||
162 | <a href="#operation--videos-abuse-get"> GET /videos/abuse </a> | ||
163 | </li> | ||
164 | <li> | ||
165 | <a href="#operation--videos--id--abuse-post"> POST /videos/{id}/abuse </a> | ||
166 | </li> | ||
167 | </ul> | ||
168 | </section> | ||
169 | <section> | ||
170 | <a href="#tag-VideoBlacklist">VideoBlacklist</a> | ||
171 | <ul> | ||
172 | <li> | ||
173 | <a href="#operation--videos--id--blacklist-post"> POST /videos/{id}/blacklist </a> | ||
174 | </li> | ||
175 | <li> | ||
176 | <a href="#operation--videos--id--blacklist-delete"> DELETE /videos/{id}/blacklist </a> | ||
177 | </li> | ||
178 | <li> | ||
179 | <a href="#operation--videos-blacklist-get"> GET /videos/blacklist </a> | ||
180 | </li> | ||
181 | </ul> | ||
182 | </section> | ||
183 | <section> | ||
184 | <a href="#tag-VideoChannel">VideoChannel</a> | ||
185 | <ul> | ||
186 | <li> | ||
187 | <a href="#operation--video-channels-get"> GET /video-channels </a> | ||
188 | </li> | ||
189 | <li> | ||
190 | <a href="#operation--video-channels-post"> POST /video-channels </a> | ||
191 | </li> | ||
192 | <li> | ||
193 | <a href="#operation--video-channels--id--get"> GET /video-channels/{id} </a> | ||
194 | </li> | ||
195 | <li> | ||
196 | <a href="#operation--video-channels--id--put"> PUT /video-channels/{id} </a> | ||
197 | </li> | ||
198 | <li> | ||
199 | <a href="#operation--video-channels--id--delete"> DELETE /video-channels/{id} </a> | ||
200 | </li> | ||
201 | <li> | ||
202 | <a href="#operation--video-channels--id--videos-get"> GET /video-channels/{id}/videos </a> | ||
203 | </li> | ||
204 | <li> | ||
205 | <a href="#operation--accounts--name--video-channels-get"> GET /accounts/{name}/video-channels </a> | ||
206 | </li> | ||
207 | </ul> | ||
208 | </section> | ||
209 | <section> | ||
210 | <a href="#tag-VideoComment">VideoComment</a> | ||
211 | <ul> | ||
212 | <li> | ||
213 | <a href="#operation--videos--id--comment-threads-get"> GET /videos/{id}/comment-threads </a> | ||
214 | </li> | ||
215 | <li> | ||
216 | <a href="#operation--videos--id--comment-threads-post"> POST /videos/{id}/comment-threads </a> | ||
217 | </li> | ||
218 | <li> | ||
219 | <a href="#operation--videos--id--comment-threads--threadId--get"> GET /videos/{id}/comment-threads/{threadId} </a> | ||
220 | </li> | ||
221 | <li> | ||
222 | <a href="#operation--videos--id--comments--commentId--post"> POST /videos/{id}/comments/{commentId} </a> | ||
223 | </li> | ||
224 | <li> | ||
225 | <a href="#operation--videos--id--comments--commentId--delete"> DELETE /videos/{id}/comments/{commentId} </a> | ||
226 | </li> | ||
227 | </ul> | ||
228 | </section> | ||
229 | <section> | ||
230 | <a href="#tag-VideoRate">VideoRate</a> | ||
231 | <ul> | ||
232 | <li> | ||
233 | <a href="#operation--videos--id--rate-put"> PUT /videos/{id}/rate </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> | ||
243 | </ul> | ||
244 | </section> | ||
245 | <h5>Schema Definitions</h5> | ||
246 | <a href="#definition-VideoConstantNumber"> VideoConstantNumber </a> | ||
247 | <a href="#definition-VideoConstantString"> VideoConstantString </a> | ||
248 | <a href="#definition-VideoPrivacy"> VideoPrivacy </a> | ||
249 | <a href="#definition-Video"> Video </a> | ||
250 | <a href="#definition-VideoAbuse"> VideoAbuse </a> | ||
251 | <a href="#definition-VideoBlacklist"> VideoBlacklist </a> | ||
252 | <a href="#definition-VideoChannel"> VideoChannel </a> | ||
253 | <a href="#definition-VideoComment"> VideoComment </a> | ||
254 | <a href="#definition-VideoCommentThreadTree"> VideoCommentThreadTree </a> | ||
255 | <a href="#definition-Avatar"> Avatar </a> | ||
256 | <a href="#definition-Actor"> Actor </a> | ||
257 | <a href="#definition-Account"> Account </a> | ||
258 | <a href="#definition-User"> User </a> | ||
259 | <a href="#definition-ServerConfig"> ServerConfig </a> | ||
260 | <a href="#definition-Follow"> Follow </a> | ||
261 | <a href="#definition-Job"> Job </a> | ||
262 | <a href="#definition-AddUserResponse"> AddUserResponse </a> | ||
263 | <a href="#definition-VideoUploadResponse"> VideoUploadResponse </a> | ||
264 | <a href="#definition-CommentThreadResponse"> CommentThreadResponse </a> | ||
265 | <a href="#definition-CommentThreadPostResponse"> CommentThreadPostResponse </a> | ||
266 | <a href="#definition-AddUser"> AddUser </a> | ||
267 | <a href="#definition-UpdateUser"> UpdateUser </a> | ||
268 | <a href="#definition-UpdateMe"> UpdateMe </a> | ||
269 | <a href="#definition-GetMeVideoRating"> GetMeVideoRating </a> | ||
270 | <a href="#definition-RegisterUser"> RegisterUser </a> | ||
271 | <a href="#definition-VideoChannelInput"> VideoChannelInput </a> | ||
272 | </nav> | ||
273 | </div> | ||
274 | <div id="docs" class="row collapse expanded drawer" data-drawer> | ||
275 | <button class="floating-menu-icon" type="button" data-drawer-slide="right"> | ||
276 | <span class="hamburger"></span> | ||
277 | </button> | ||
278 | <div class="example-box doc-content"></div> | ||
279 | <article> | ||
280 | <h1 class="doc-title">PeerTube | ||
281 | <span>API Reference</span> | ||
282 | </h1> | ||
283 | <div id="introduction" data-traverse-target="introduction"> | ||
284 | <div class="doc-row"> | ||
285 | <div class="doc-copy"> | ||
286 | <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.</p> | ||
287 | </div> | ||
288 | <div class="doc-examples"> | ||
289 | <section> | ||
290 | <h5>API Endpoint</h5> | ||
291 | <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre> | ||
292 | <!-- </div> --> | ||
293 | <h5>Schemes: | ||
294 | <span>https</span> | ||
295 | </h5> | ||
296 | <h5>Version: | ||
297 | <span>1.0.0-beta</span> | ||
298 | </h5> | ||
299 | </section> | ||
300 | </div> | ||
301 | </div> | ||
302 | </div> | ||
303 | <!-- <h1 id="security" data-traverse-target="security">Security</h1> --> | ||
304 | <h1 id="authentication" data-traverse-target="authentication">Authentication</h1> | ||
305 | <div id="security-definition-OAuth2" class="panel"> | ||
306 | <div class="doc-row"> | ||
307 | <div class="doc-copy"> | ||
308 | <h3 class="security-definition-title"> | ||
309 | <span class="security-name">OAuth2</span> | ||
310 | <span class="swagger-security-definition-oauth2"></span> | ||
311 | </h3> | ||
312 | <section class="security-definition-description"> | ||
313 | <p>In the header: | ||
314 | <em>Authorization: Bearer mytoken</em> | ||
315 | </p> | ||
316 | </section> | ||
317 | <section class="swagger-security-definition-properties"> | ||
318 | <div class="prop-row security-definition-property"> | ||
319 | <div class="prop-name"> | ||
320 | <div class="prop-title security-definition-property-name">type</div> | ||
321 | </div> | ||
322 | <div class="prop-value security-definition-property-type"> oauth2 </div> | ||
323 | </div> | ||
324 | <div class="prop-row security-definition-property"> | ||
325 | <div class="prop-name"> | ||
326 | <div class="prop-title security-definition-property-name">flow</div> | ||
327 | </div> | ||
328 | <div class="prop-value security-definition-property-type"> password </div> | ||
329 | </div> | ||
330 | <div class="prop-row security-definition-property"> | ||
331 | <div class="prop-name"> | ||
332 | <div class="prop-title security-definition-property-name">tokenUrl</div> | ||
333 | </div> | ||
334 | <div class="prop-value security-definition-property-type"> https://peertube.example.com/api/v1/users/token </div> | ||
335 | </div> | ||
336 | </section> | ||
337 | </div> | ||
338 | </div> | ||
339 | </div> | ||
340 | <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1> | ||
341 | <div id="operation--accounts--name--get" class="operation panel" data-traverse-target="operation--accounts--name--get"> | ||
342 | <!-- <section class="operation-tags row"> --> | ||
343 | <!-- <div class="doc-copy"> --> | ||
344 | <div class="operation-tags"> | ||
345 | <a class="label" href="#tag-Accounts">Accounts</a> | ||
346 | <!----> | ||
347 | </div> | ||
348 | <!-- </div> --> | ||
349 | <!-- </section> --> | ||
350 | <h2 class="operation-title"> | ||
351 | <span class="operation-name"> | ||
352 | <span class="operation-name">GET</span> | ||
353 | <span class="operation-path">/accounts/{name}</span> | ||
354 | </span> | ||
355 | </h2> | ||
356 | <div class="doc-row"> | ||
357 | <div class="doc-copy"> | ||
358 | <section class="swagger-request-params"> | ||
359 | <div class="prop-row prop-group"> | ||
360 | <div class="prop-name"> | ||
361 | <div class="prop-title">name: | ||
362 | <span class="prop-type"> | ||
363 | <span class="json-property-type">string</span> | ||
364 | <span class="json-property-range" title="Value limits"></span> | ||
365 | </span> | ||
366 | </div> | ||
367 | <span class="json-property-required"></span> | ||
368 | <div class="prop-subtitle"> in path </div> | ||
369 | </div> | ||
370 | <div class="prop-value"> | ||
371 | <p>The name of the account (chocobozzz or | ||
372 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | ||
373 | </div> | ||
374 | </div> | ||
375 | <div class="prop-row prop-group"> | ||
376 | <div class="prop-name"> | ||
377 | <div class="prop-title">start: | ||
378 | <span class="prop-type"> | ||
379 | <span class="json-property-type">number</span> | ||
380 | <span class="json-property-range" title="Value limits"></span> | ||
381 | </span> | ||
382 | </div> | ||
383 | <div class="prop-subtitle"> in query </div> | ||
384 | </div> | ||
385 | <div class="prop-value"> | ||
386 | <p>Offset</p> | ||
387 | </div> | ||
388 | </div> | ||
389 | <div class="prop-row prop-group"> | ||
390 | <div class="prop-name"> | ||
391 | <div class="prop-title">count: | ||
392 | <span class="prop-type"> | ||
393 | <span class="json-property-type">number</span> | ||
394 | <span class="json-property-range" title="Value limits"></span> | ||
395 | </span> | ||
396 | </div> | ||
397 | <div class="prop-subtitle"> in query </div> | ||
398 | </div> | ||
399 | <div class="prop-value"> | ||
400 | <p>Number of items</p> | ||
401 | </div> | ||
402 | </div> | ||
403 | <div class="prop-row prop-group"> | ||
404 | <div class="prop-name"> | ||
405 | <div class="prop-title">sort: | ||
406 | <span class="prop-type"> | ||
407 | <span class="json-property-type">string</span> | ||
408 | <span class="json-property-range" title="Value limits"></span> | ||
409 | </span> | ||
410 | </div> | ||
411 | <div class="prop-subtitle"> in query </div> | ||
412 | </div> | ||
413 | <div class="prop-value"> | ||
414 | <p>Sort column (-createdAt for example)</p> | ||
415 | </div> | ||
416 | </div> | ||
417 | </section> | ||
418 | </div> | ||
419 | <div class="doc-examples"></div> | ||
420 | </div> | ||
421 | <div class="doc-row"> | ||
422 | <div class="doc-copy"> | ||
423 | <section class="swagger-responses"> | ||
424 | <div class="prop-row prop-group"> | ||
425 | <div class="prop-name"> | ||
426 | <div class="prop-title">200 OK</div> | ||
427 | <div class="prop-ref"> | ||
428 | <span class=""> | ||
429 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | ||
430 | </span> | ||
431 | </div> | ||
432 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
433 | </div> | ||
434 | <div class="prop-value"> | ||
435 | <p>successful operation</p> | ||
436 | </div> | ||
437 | </div> | ||
438 | </section> | ||
439 | </div> | ||
440 | <div class="doc-examples"> | ||
441 | <h5>Response Content-Types: | ||
442 | <span>application/json</span> | ||
443 | </h5> | ||
444 | <section> | ||
445 | <h5>Response Example | ||
446 | <span>(200 OK)</span> | ||
447 | </h5> | ||
448 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
449 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
450 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
451 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
452 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
453 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
454 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
455 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
456 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
457 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
458 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
459 | <span class="hljs-attr">"avatar"</span>: { | ||
460 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
461 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
462 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
463 | } | ||
464 | } | ||
465 | </code></pre> | ||
466 | <!-- </div> --> | ||
467 | </section> | ||
468 | </div> | ||
469 | </div> | ||
470 | </div> | ||
471 | <div id="operation--accounts--name--videos-get" class="operation panel" data-traverse-target="operation--accounts--name--videos-get"> | ||
472 | <!-- <section class="operation-tags row"> --> | ||
473 | <!-- <div class="doc-copy"> --> | ||
474 | <div class="operation-tags"> | ||
475 | <a class="label" href="#tag-Accounts">Accounts</a> | ||
476 | <!----> | ||
477 | </div> | ||
478 | <!-- </div> --> | ||
479 | <!-- </section> --> | ||
480 | <h2 class="operation-title"> | ||
481 | <span class="operation-name"> | ||
482 | <span class="operation-name">GET</span> | ||
483 | <span class="operation-path">/accounts/{name}/videos</span> | ||
484 | </span> | ||
485 | </h2> | ||
486 | <div class="doc-row"> | ||
487 | <div class="doc-copy"> | ||
488 | <section class="swagger-request-params"> | ||
489 | <div class="prop-row prop-group"> | ||
490 | <div class="prop-name"> | ||
491 | <div class="prop-title">name: | ||
492 | <span class="prop-type"> | ||
493 | <span class="json-property-type">string</span> | ||
494 | <span class="json-property-range" title="Value limits"></span> | ||
495 | </span> | ||
496 | </div> | ||
497 | <span class="json-property-required"></span> | ||
498 | <div class="prop-subtitle"> in path </div> | ||
499 | </div> | ||
500 | <div class="prop-value"> | ||
501 | <p>The name of the account (chocobozzz or | ||
502 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | ||
503 | </div> | ||
504 | </div> | ||
505 | </section> | ||
506 | </div> | ||
507 | <div class="doc-examples"></div> | ||
508 | </div> | ||
509 | <div class="doc-row"> | ||
510 | <div class="doc-copy"> | ||
511 | <section class="swagger-responses"> | ||
512 | <div class="prop-row prop-group"> | ||
513 | <div class="prop-name"> | ||
514 | <div class="prop-title">200 OK</div> | ||
515 | <div class="prop-ref"> | ||
516 | <span class=""> | ||
517 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | ||
518 | </span> | ||
519 | </div> | ||
520 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
521 | </div> | ||
522 | <div class="prop-value"> | ||
523 | <p>successful operation</p> | ||
524 | </div> | ||
525 | </div> | ||
526 | </section> | ||
527 | </div> | ||
528 | <div class="doc-examples"> | ||
529 | <h5>Response Content-Types: | ||
530 | <span>application/json</span> | ||
531 | </h5> | ||
532 | <section> | ||
533 | <h5>Response Example | ||
534 | <span>(200 OK)</span> | ||
535 | </h5> | ||
536 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
537 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
538 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
539 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
540 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | ||
541 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
542 | <span class="hljs-attr">"category"</span>: { | ||
543 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
544 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
545 | }, | ||
546 | <span class="hljs-attr">"licence"</span>: { | ||
547 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
548 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
549 | }, | ||
550 | <span class="hljs-attr">"language"</span>: { | ||
551 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
552 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
553 | }, | ||
554 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | ||
555 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
556 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | ||
557 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
558 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
559 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | ||
560 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | ||
561 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | ||
562 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | ||
563 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | ||
564 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | ||
565 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | ||
566 | <span class="hljs-attr">"account"</span>: { | ||
567 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
568 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
569 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
570 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
571 | <span class="hljs-attr">"avatar"</span>: { | ||
572 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
573 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
574 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
575 | } | ||
576 | } | ||
577 | } | ||
578 | </code></pre> | ||
579 | <!-- </div> --> | ||
580 | </section> | ||
581 | </div> | ||
582 | </div> | ||
583 | </div> | ||
584 | <div id="operation--accounts-get" class="operation panel" data-traverse-target="operation--accounts-get"> | ||
585 | <!-- <section class="operation-tags row"> --> | ||
586 | <!-- <div class="doc-copy"> --> | ||
587 | <div class="operation-tags"> | ||
588 | <a class="label" href="#tag-Accounts">Accounts</a> | ||
589 | <!----> | ||
590 | </div> | ||
591 | <!-- </div> --> | ||
592 | <!-- </section> --> | ||
593 | <h2 class="operation-title"> | ||
594 | <span class="operation-name"> | ||
595 | <span class="operation-name">GET</span> | ||
596 | <span class="operation-path">/accounts</span> | ||
597 | </span> | ||
598 | </h2> | ||
599 | <div class="doc-row"> | ||
600 | <div class="doc-copy"> </div> | ||
601 | <div class="doc-examples"></div> | ||
602 | </div> | ||
603 | <div class="doc-row"> | ||
604 | <div class="doc-copy"> | ||
605 | <section class="swagger-responses"> | ||
606 | <div class="prop-row prop-group"> | ||
607 | <div class="prop-name"> | ||
608 | <div class="prop-title">200 OK</div> | ||
609 | <div class="prop-ref"> | ||
610 | <span class="json-schema-ref-array"> | ||
611 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | ||
612 | </span> | ||
613 | </div> | ||
614 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
615 | </div> | ||
616 | <div class="prop-value"> | ||
617 | <p>successful operation</p> | ||
618 | </div> | ||
619 | </div> | ||
620 | <div class="prop-row prop-inner"> | ||
621 | <div class="prop-name">type</div> | ||
622 | <div class="prop-value"> | ||
623 | <span class="json-property-type"> | ||
624 | <span class="json-schema-ref-array"> | ||
625 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | ||
626 | </span> | ||
627 | </span> | ||
628 | <span class="json-property-range" title="Value limits"></span> | ||
629 | </div> | ||
630 | </div> | ||
631 | </section> | ||
632 | </div> | ||
633 | <div class="doc-examples"> | ||
634 | <h5>Response Content-Types: | ||
635 | <span>application/json</span> | ||
636 | </h5> | ||
637 | <section> | ||
638 | <h5>Response Example | ||
639 | <span>(200 OK)</span> | ||
640 | </h5> | ||
641 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
642 | { | ||
643 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
644 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
645 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
646 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
647 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
648 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
649 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
650 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
651 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
652 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
653 | <span class="hljs-attr">"avatar"</span>: { | ||
654 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
655 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
656 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
657 | } | ||
658 | } | ||
659 | ] | ||
660 | </code></pre> | ||
661 | <!-- </div> --> | ||
662 | </section> | ||
663 | </div> | ||
664 | </div> | ||
665 | </div> | ||
666 | <h1 id="tag-Config" class="swagger-summary-tag" data-traverse-target="tag-Config">Config</h1> | ||
667 | <div id="operation--config-get" class="operation panel" data-traverse-target="operation--config-get"> | ||
668 | <!-- <section class="operation-tags row"> --> | ||
669 | <!-- <div class="doc-copy"> --> | ||
670 | <div class="operation-tags"> | ||
671 | <a class="label" href="#tag-Config">Config</a> | ||
672 | <!----> | ||
673 | </div> | ||
674 | <!-- </div> --> | ||
675 | <!-- </section> --> | ||
676 | <h2 class="operation-title"> | ||
677 | <span class="operation-name"> | ||
678 | <span class="operation-name">GET</span> | ||
679 | <span class="operation-path">/config</span> | ||
680 | </span> | ||
681 | </h2> | ||
682 | <div class="doc-row"> | ||
683 | <div class="doc-copy"> </div> | ||
684 | <div class="doc-examples"></div> | ||
685 | </div> | ||
686 | <div class="doc-row"> | ||
687 | <div class="doc-copy"> | ||
688 | <section class="swagger-responses"> | ||
689 | <div class="prop-row prop-group"> | ||
690 | <div class="prop-name"> | ||
691 | <div class="prop-title">200 OK</div> | ||
692 | <div class="prop-ref"> | ||
693 | <span class=""> | ||
694 | <a class="json-schema-ref" href="#/definitions/ServerConfig">ServerConfig</a> | ||
695 | </span> | ||
696 | </div> | ||
697 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
698 | </div> | ||
699 | <div class="prop-value"> | ||
700 | <p>successful operation</p> | ||
701 | </div> | ||
702 | </div> | ||
703 | </section> | ||
704 | </div> | ||
705 | <div class="doc-examples"> | ||
706 | <h5>Response Content-Types: | ||
707 | <span>application/json</span> | ||
708 | </h5> | ||
709 | <section> | ||
710 | <h5>Response Example | ||
711 | <span>(200 OK)</span> | ||
712 | </h5> | ||
713 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
714 | <span class="hljs-attr">"signup"</span>: { | ||
715 | <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span> | ||
716 | }, | ||
717 | <span class="hljs-attr">"transcoding"</span>: { | ||
718 | <span class="hljs-attr">"enabledResolutions"</span>: [ | ||
719 | <span class="hljs-string">"number"</span> | ||
720 | ] | ||
721 | }, | ||
722 | <span class="hljs-attr">"avatar"</span>: { | ||
723 | <span class="hljs-attr">"file"</span>: { | ||
724 | <span class="hljs-attr">"size"</span>: { | ||
725 | <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span> | ||
726 | } | ||
727 | }, | ||
728 | <span class="hljs-attr">"extensions"</span>: [ | ||
729 | <span class="hljs-string">"string"</span> | ||
730 | ] | ||
731 | }, | ||
732 | <span class="hljs-attr">"video"</span>: { | ||
733 | <span class="hljs-attr">"file"</span>: { | ||
734 | <span class="hljs-attr">"extensions"</span>: [ | ||
735 | <span class="hljs-string">"string"</span> | ||
736 | ] | ||
737 | } | ||
738 | } | ||
739 | } | ||
740 | </code></pre> | ||
741 | <!-- </div> --> | ||
742 | </section> | ||
743 | </div> | ||
744 | </div> | ||
745 | </div> | ||
746 | <h1 id="tag-Feeds" class="swagger-summary-tag" data-traverse-target="tag-Feeds">Feeds</h1> | ||
747 | <div id="operation--feeds-videos.-format--get" class="operation panel" data-traverse-target="operation--feeds-videos.-format--get"> | ||
748 | <!-- <section class="operation-tags row"> --> | ||
749 | <!-- <div class="doc-copy"> --> | ||
750 | <div class="operation-tags"> | ||
751 | <a class="label" href="#tag-Feeds">Feeds</a> | ||
752 | <!----> | ||
753 | </div> | ||
754 | <!-- </div> --> | ||
755 | <!-- </section> --> | ||
756 | <h2 class="operation-title"> | ||
757 | <span class="operation-name"> | ||
758 | <span class="operation-name">GET</span> | ||
759 | <span class="operation-path">/feeds/videos.{format}</span> | ||
760 | </span> | ||
761 | </h2> | ||
762 | <div class="doc-row"> | ||
763 | <div class="doc-copy"> | ||
764 | <section class="swagger-request-params"> | ||
765 | <div class="prop-row prop-group"> | ||
766 | <div class="prop-name"> | ||
767 | <div class="prop-title">format: | ||
768 | <span class="prop-type"> | ||
769 | <span class="json-property-type">string</span> | ||
770 | <span class="json-property-enum" title="Possible values"> | ||
771 | <span class="json-property-enum-item json-property-enum-default-value">xml</span>, | ||
772 | <span class="json-property-enum-item">atom</span>, | ||
773 | <span class="json-property-enum-item">json</span> | ||
774 | </span> | ||
775 | <span class="json-property-range" title="Value limits"></span> | ||
776 | <span class="json-property-default-value" title="Default value">xml</span> | ||
777 | </span> | ||
778 | </div> | ||
779 | <span class="json-property-required"></span> | ||
780 | <div class="prop-subtitle"> in path </div> | ||
781 | </div> | ||
782 | <div class="prop-value"> | ||
783 | <p>The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0</p> | ||
784 | </div> | ||
785 | </div> | ||
786 | <div class="prop-row prop-group"> | ||
787 | <div class="prop-name"> | ||
788 | <div class="prop-title">accountId: | ||
789 | <span class="prop-type"> | ||
790 | <span class="json-property-type">number</span> | ||
791 | <span class="json-property-range" title="Value limits"></span> | ||
792 | </span> | ||
793 | </div> | ||
794 | <div class="prop-subtitle"> in query </div> | ||
795 | </div> | ||
796 | <div class="prop-value"> | ||
797 | <p>The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds</p> | ||
798 | </div> | ||
799 | </div> | ||
800 | <div class="prop-row prop-group"> | ||
801 | <div class="prop-name"> | ||
802 | <div class="prop-title">accountName: | ||
803 | <span class="prop-type"> | ||
804 | <span class="json-property-type">string</span> | ||
805 | <span class="json-property-range" title="Value limits"></span> | ||
806 | </span> | ||
807 | </div> | ||
808 | <div class="prop-subtitle"> in query </div> | ||
809 | </div> | ||
810 | <div class="prop-value"> | ||
811 | <p>The name of the local account to filter to</p> | ||
812 | </div> | ||
813 | </div> | ||
814 | </section> | ||
815 | </div> | ||
816 | <div class="doc-examples"></div> | ||
817 | </div> | ||
818 | <div class="doc-row"> | ||
819 | <div class="doc-copy"> | ||
820 | <section class="swagger-responses"> | ||
821 | <div class="prop-row prop-group"> | ||
822 | <div class="prop-name"> | ||
823 | <div class="prop-title">200 OK</div> | ||
824 | </div> | ||
825 | <div class="prop-value"> | ||
826 | <p>successful operation</p> | ||
827 | </div> | ||
828 | </div> | ||
829 | </section> | ||
830 | </div> | ||
831 | <div class="doc-examples"> | ||
832 | <h5>Response Content-Types: | ||
833 | <span>application/atom+xml, application/rss+xml, application/json</span> | ||
834 | </h5> | ||
835 | </div> | ||
836 | </div> | ||
837 | </div> | ||
838 | <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1> | ||
839 | <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get"> | ||
840 | <!-- <section class="operation-tags row"> --> | ||
841 | <!-- <div class="doc-copy"> --> | ||
842 | <div class="operation-tags"> | ||
843 | <a class="label" href="#tag-Job">Job</a> | ||
844 | <!----> | ||
845 | </div> | ||
846 | <!-- </div> --> | ||
847 | <!-- </section> --> | ||
848 | <h2 class="operation-title"> | ||
849 | <span class="operation-name"> | ||
850 | <span class="operation-name">GET</span> | ||
851 | <span class="operation-path">/jobs</span> | ||
852 | </span> | ||
853 | </h2> | ||
854 | <div class="doc-row"> | ||
855 | <div class="doc-copy"> | ||
856 | <section class="swagger-request-params"> | ||
857 | <div class="prop-row prop-group"> | ||
858 | <div class="prop-name"> | ||
859 | <div class="prop-title">state: | ||
860 | <span class="prop-type"> | ||
861 | <span class="json-property-type">string</span> | ||
862 | <span class="json-property-range" title="Value limits"></span> | ||
863 | </span> | ||
864 | </div> | ||
865 | <span class="json-property-required"></span> | ||
866 | <div class="prop-subtitle"> in path </div> | ||
867 | </div> | ||
868 | <div class="prop-value"> | ||
869 | <p>The state of the job</p> | ||
870 | </div> | ||
871 | </div> | ||
872 | <div class="prop-row prop-group"> | ||
873 | <div class="prop-name"> | ||
874 | <div class="prop-title">start: | ||
875 | <span class="prop-type"> | ||
876 | <span class="json-property-type">number</span> | ||
877 | <span class="json-property-range" title="Value limits"></span> | ||
878 | </span> | ||
879 | </div> | ||
880 | <div class="prop-subtitle"> in query </div> | ||
881 | </div> | ||
882 | <div class="prop-value"> | ||
883 | <p>Offset</p> | ||
884 | </div> | ||
885 | </div> | ||
886 | <div class="prop-row prop-group"> | ||
887 | <div class="prop-name"> | ||
888 | <div class="prop-title">count: | ||
889 | <span class="prop-type"> | ||
890 | <span class="json-property-type">number</span> | ||
891 | <span class="json-property-range" title="Value limits"></span> | ||
892 | </span> | ||
893 | </div> | ||
894 | <div class="prop-subtitle"> in query </div> | ||
895 | </div> | ||
896 | <div class="prop-value"> | ||
897 | <p>Number of items</p> | ||
898 | </div> | ||
899 | </div> | ||
900 | <div class="prop-row prop-group"> | ||
901 | <div class="prop-name"> | ||
902 | <div class="prop-title">sort: | ||
903 | <span class="prop-type"> | ||
904 | <span class="json-property-type">string</span> | ||
905 | <span class="json-property-range" title="Value limits"></span> | ||
906 | </span> | ||
907 | </div> | ||
908 | <div class="prop-subtitle"> in query </div> | ||
909 | </div> | ||
910 | <div class="prop-value"> | ||
911 | <p>Sort column (-createdAt for example)</p> | ||
912 | </div> | ||
913 | </div> | ||
914 | </section> | ||
915 | </div> | ||
916 | <div class="doc-examples"></div> | ||
917 | </div> | ||
918 | <div class="doc-row"> | ||
919 | <div class="doc-copy"> | ||
920 | <section class="swagger-responses"> | ||
921 | <div class="prop-row prop-group"> | ||
922 | <div class="prop-name"> | ||
923 | <div class="prop-title">200 OK</div> | ||
924 | <div class="prop-ref"> | ||
925 | <span class="json-schema-ref-array"> | ||
926 | <a class="json-schema-ref" href="#/definitions/Job">Job</a> | ||
927 | </span> | ||
928 | </div> | ||
929 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
930 | </div> | ||
931 | <div class="prop-value"> | ||
932 | <p>successful operation</p> | ||
933 | </div> | ||
934 | </div> | ||
935 | <div class="prop-row prop-inner"> | ||
936 | <div class="prop-name">type</div> | ||
937 | <div class="prop-value"> | ||
938 | <span class="json-property-type"> | ||
939 | <span class="json-schema-ref-array"> | ||
940 | <a class="json-schema-ref" href="#/definitions/Job">Job</a> | ||
941 | </span> | ||
942 | </span> | ||
943 | <span class="json-property-range" title="Value limits"></span> | ||
944 | </div> | ||
945 | </div> | ||
946 | </section> | ||
947 | </div> | ||
948 | <div class="doc-examples"> | ||
949 | <h5>Response Content-Types: | ||
950 | <span>application/json</span> | ||
951 | </h5> | ||
952 | <section> | ||
953 | <h5>Response Example | ||
954 | <span>(200 OK)</span> | ||
955 | </h5> | ||
956 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
957 | { | ||
958 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
959 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | ||
960 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>, | ||
961 | <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>, | ||
962 | <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>, | ||
963 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
964 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
965 | } | ||
966 | ] | ||
967 | </code></pre> | ||
968 | <!-- </div> --> | ||
969 | </section> | ||
970 | </div> | ||
971 | </div> | ||
972 | <div class="doc-row"> | ||
973 | <div class="doc-copy"> | ||
974 | <section class="swagger-request-security"> | ||
975 | <table class="table"> | ||
976 | <thead> | ||
977 | <tr> | ||
978 | <th class="swagger-request-security-schema"></th> | ||
979 | <th class="swagger-request-security-scopes"></th> | ||
980 | </tr> | ||
981 | </thead> | ||
982 | <tbody> | ||
983 | <tr> | ||
984 | <td> | ||
985 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
986 | </td> | ||
987 | <td> </td> | ||
988 | </tr> | ||
989 | </tbody> | ||
990 | </table> | ||
991 | </section> | ||
992 | </div> | ||
993 | </div> | ||
994 | </div> | ||
995 | <h1 id="tag-ServerFollowing" class="swagger-summary-tag" data-traverse-target="tag-ServerFollowing">ServerFollowing</h1> | ||
996 | <div id="operation--server-following--host--delete" class="operation panel" data-traverse-target="operation--server-following--host--delete"> | ||
997 | <!-- <section class="operation-tags row"> --> | ||
998 | <!-- <div class="doc-copy"> --> | ||
999 | <div class="operation-tags"> | ||
1000 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | ||
1001 | <!----> | ||
1002 | </div> | ||
1003 | <!-- </div> --> | ||
1004 | <!-- </section> --> | ||
1005 | <h2 class="operation-title"> | ||
1006 | <span class="operation-name"> | ||
1007 | <span class="operation-name">DELETE</span> | ||
1008 | <span class="operation-path">/server/following/{host}</span> | ||
1009 | </span> | ||
1010 | </h2> | ||
1011 | <div class="doc-row"> | ||
1012 | <div class="doc-copy"> | ||
1013 | <section class="swagger-request-params"> | ||
1014 | <div class="prop-row prop-group"> | ||
1015 | <div class="prop-name"> | ||
1016 | <div class="prop-title">host: | ||
1017 | <span class="prop-type"> | ||
1018 | <span class="json-property-type">string</span> | ||
1019 | <span class="json-property-range" title="Value limits"></span> | ||
1020 | </span> | ||
1021 | </div> | ||
1022 | <span class="json-property-required"></span> | ||
1023 | <div class="prop-subtitle"> in path </div> | ||
1024 | </div> | ||
1025 | <div class="prop-value"> | ||
1026 | <p>The host to unfollow </p> | ||
1027 | </div> | ||
1028 | </div> | ||
1029 | </section> | ||
1030 | </div> | ||
1031 | <div class="doc-examples"></div> | ||
1032 | </div> | ||
1033 | <div class="doc-row"> | ||
1034 | <div class="doc-copy"> | ||
1035 | <section class="swagger-responses"> | ||
1036 | <div class="prop-row prop-group"> | ||
1037 | <div class="prop-name"> | ||
1038 | <div class="prop-title">201 Created</div> | ||
1039 | </div> | ||
1040 | <div class="prop-value"> | ||
1041 | <p>successful operation</p> | ||
1042 | </div> | ||
1043 | </div> | ||
1044 | </section> | ||
1045 | </div> | ||
1046 | <div class="doc-examples"> | ||
1047 | <h5>Response Content-Types: | ||
1048 | <span>application/json</span> | ||
1049 | </h5> | ||
1050 | </div> | ||
1051 | </div> | ||
1052 | <div class="doc-row"> | ||
1053 | <div class="doc-copy"> | ||
1054 | <section class="swagger-request-security"> | ||
1055 | <table class="table"> | ||
1056 | <thead> | ||
1057 | <tr> | ||
1058 | <th class="swagger-request-security-schema"></th> | ||
1059 | <th class="swagger-request-security-scopes"></th> | ||
1060 | </tr> | ||
1061 | </thead> | ||
1062 | <tbody> | ||
1063 | <tr> | ||
1064 | <td> | ||
1065 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
1066 | </td> | ||
1067 | <td> </td> | ||
1068 | </tr> | ||
1069 | </tbody> | ||
1070 | </table> | ||
1071 | </section> | ||
1072 | </div> | ||
1073 | </div> | ||
1074 | </div> | ||
1075 | <div id="operation--server-followers-get" class="operation panel" data-traverse-target="operation--server-followers-get"> | ||
1076 | <!-- <section class="operation-tags row"> --> | ||
1077 | <!-- <div class="doc-copy"> --> | ||
1078 | <div class="operation-tags"> | ||
1079 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | ||
1080 | <!----> | ||
1081 | </div> | ||
1082 | <!-- </div> --> | ||
1083 | <!-- </section> --> | ||
1084 | <h2 class="operation-title"> | ||
1085 | <span class="operation-name"> | ||
1086 | <span class="operation-name">GET</span> | ||
1087 | <span class="operation-path">/server/followers</span> | ||
1088 | </span> | ||
1089 | </h2> | ||
1090 | <div class="doc-row"> | ||
1091 | <div class="doc-copy"> | ||
1092 | <section class="swagger-request-params"> | ||
1093 | <div class="prop-row prop-group"> | ||
1094 | <div class="prop-name"> | ||
1095 | <div class="prop-title">start: | ||
1096 | <span class="prop-type"> | ||
1097 | <span class="json-property-type">number</span> | ||
1098 | <span class="json-property-range" title="Value limits"></span> | ||
1099 | </span> | ||
1100 | </div> | ||
1101 | <div class="prop-subtitle"> in query </div> | ||
1102 | </div> | ||
1103 | <div class="prop-value"> | ||
1104 | <p>Offset</p> | ||
1105 | </div> | ||
1106 | </div> | ||
1107 | <div class="prop-row prop-group"> | ||
1108 | <div class="prop-name"> | ||
1109 | <div class="prop-title">count: | ||
1110 | <span class="prop-type"> | ||
1111 | <span class="json-property-type">number</span> | ||
1112 | <span class="json-property-range" title="Value limits"></span> | ||
1113 | </span> | ||
1114 | </div> | ||
1115 | <div class="prop-subtitle"> in query </div> | ||
1116 | </div> | ||
1117 | <div class="prop-value"> | ||
1118 | <p>Number of items</p> | ||
1119 | </div> | ||
1120 | </div> | ||
1121 | <div class="prop-row prop-group"> | ||
1122 | <div class="prop-name"> | ||
1123 | <div class="prop-title">sort: | ||
1124 | <span class="prop-type"> | ||
1125 | <span class="json-property-type">string</span> | ||
1126 | <span class="json-property-range" title="Value limits"></span> | ||
1127 | </span> | ||
1128 | </div> | ||
1129 | <div class="prop-subtitle"> in query </div> | ||
1130 | </div> | ||
1131 | <div class="prop-value"> | ||
1132 | <p>Sort column (-createdAt for example)</p> | ||
1133 | </div> | ||
1134 | </div> | ||
1135 | </section> | ||
1136 | </div> | ||
1137 | <div class="doc-examples"></div> | ||
1138 | </div> | ||
1139 | <div class="doc-row"> | ||
1140 | <div class="doc-copy"> | ||
1141 | <section class="swagger-responses"> | ||
1142 | <div class="prop-row prop-group"> | ||
1143 | <div class="prop-name"> | ||
1144 | <div class="prop-title">200 OK</div> | ||
1145 | <div class="prop-ref"> | ||
1146 | <span class="json-schema-ref-array"> | ||
1147 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | ||
1148 | </span> | ||
1149 | </div> | ||
1150 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
1151 | </div> | ||
1152 | <div class="prop-value"> | ||
1153 | <p>successful operation</p> | ||
1154 | </div> | ||
1155 | </div> | ||
1156 | <div class="prop-row prop-inner"> | ||
1157 | <div class="prop-name">type</div> | ||
1158 | <div class="prop-value"> | ||
1159 | <span class="json-property-type"> | ||
1160 | <span class="json-schema-ref-array"> | ||
1161 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | ||
1162 | </span> | ||
1163 | </span> | ||
1164 | <span class="json-property-range" title="Value limits"></span> | ||
1165 | </div> | ||
1166 | </div> | ||
1167 | </section> | ||
1168 | </div> | ||
1169 | <div class="doc-examples"> | ||
1170 | <h5>Response Content-Types: | ||
1171 | <span>application/json</span> | ||
1172 | </h5> | ||
1173 | <section> | ||
1174 | <h5>Response Example | ||
1175 | <span>(200 OK)</span> | ||
1176 | </h5> | ||
1177 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
1178 | { | ||
1179 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1180 | <span class="hljs-attr">"follower"</span>: { | ||
1181 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1182 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
1183 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
1184 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
1185 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
1186 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
1187 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
1188 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1189 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
1190 | <span class="hljs-attr">"avatar"</span>: { | ||
1191 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
1192 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1193 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
1194 | } | ||
1195 | }, | ||
1196 | <span class="hljs-attr">"following"</span>: { | ||
1197 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1198 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
1199 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
1200 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
1201 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
1202 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
1203 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
1204 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1205 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
1206 | <span class="hljs-attr">"avatar"</span>: { | ||
1207 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
1208 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1209 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
1210 | } | ||
1211 | }, | ||
1212 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | ||
1213 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | ||
1214 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1215 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
1216 | } | ||
1217 | ] | ||
1218 | </code></pre> | ||
1219 | <!-- </div> --> | ||
1220 | </section> | ||
1221 | </div> | ||
1222 | </div> | ||
1223 | </div> | ||
1224 | <div id="operation--server-following-get" class="operation panel" data-traverse-target="operation--server-following-get"> | ||
1225 | <!-- <section class="operation-tags row"> --> | ||
1226 | <!-- <div class="doc-copy"> --> | ||
1227 | <div class="operation-tags"> | ||
1228 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | ||
1229 | <!----> | ||
1230 | </div> | ||
1231 | <!-- </div> --> | ||
1232 | <!-- </section> --> | ||
1233 | <h2 class="operation-title"> | ||
1234 | <span class="operation-name"> | ||
1235 | <span class="operation-name">GET</span> | ||
1236 | <span class="operation-path">/server/following</span> | ||
1237 | </span> | ||
1238 | </h2> | ||
1239 | <div class="doc-row"> | ||
1240 | <div class="doc-copy"> | ||
1241 | <section class="swagger-request-params"> | ||
1242 | <div class="prop-row prop-group"> | ||
1243 | <div class="prop-name"> | ||
1244 | <div class="prop-title">start: | ||
1245 | <span class="prop-type"> | ||
1246 | <span class="json-property-type">number</span> | ||
1247 | <span class="json-property-range" title="Value limits"></span> | ||
1248 | </span> | ||
1249 | </div> | ||
1250 | <div class="prop-subtitle"> in query </div> | ||
1251 | </div> | ||
1252 | <div class="prop-value"> | ||
1253 | <p>Offset</p> | ||
1254 | </div> | ||
1255 | </div> | ||
1256 | <div class="prop-row prop-group"> | ||
1257 | <div class="prop-name"> | ||
1258 | <div class="prop-title">count: | ||
1259 | <span class="prop-type"> | ||
1260 | <span class="json-property-type">number</span> | ||
1261 | <span class="json-property-range" title="Value limits"></span> | ||
1262 | </span> | ||
1263 | </div> | ||
1264 | <div class="prop-subtitle"> in query </div> | ||
1265 | </div> | ||
1266 | <div class="prop-value"> | ||
1267 | <p>Number of items</p> | ||
1268 | </div> | ||
1269 | </div> | ||
1270 | <div class="prop-row prop-group"> | ||
1271 | <div class="prop-name"> | ||
1272 | <div class="prop-title">sort: | ||
1273 | <span class="prop-type"> | ||
1274 | <span class="json-property-type">string</span> | ||
1275 | <span class="json-property-range" title="Value limits"></span> | ||
1276 | </span> | ||
1277 | </div> | ||
1278 | <div class="prop-subtitle"> in query </div> | ||
1279 | </div> | ||
1280 | <div class="prop-value"> | ||
1281 | <p>Sort column (-createdAt for example)</p> | ||
1282 | </div> | ||
1283 | </div> | ||
1284 | </section> | ||
1285 | </div> | ||
1286 | <div class="doc-examples"></div> | ||
1287 | </div> | ||
1288 | <div class="doc-row"> | ||
1289 | <div class="doc-copy"> | ||
1290 | <section class="swagger-responses"> | ||
1291 | <div class="prop-row prop-group"> | ||
1292 | <div class="prop-name"> | ||
1293 | <div class="prop-title">200 OK</div> | ||
1294 | <div class="prop-ref"> | ||
1295 | <span class="json-schema-ref-array"> | ||
1296 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | ||
1297 | </span> | ||
1298 | </div> | ||
1299 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
1300 | </div> | ||
1301 | <div class="prop-value"> | ||
1302 | <p>successful operation</p> | ||
1303 | </div> | ||
1304 | </div> | ||
1305 | <div class="prop-row prop-inner"> | ||
1306 | <div class="prop-name">type</div> | ||
1307 | <div class="prop-value"> | ||
1308 | <span class="json-property-type"> | ||
1309 | <span class="json-schema-ref-array"> | ||
1310 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | ||
1311 | </span> | ||
1312 | </span> | ||
1313 | <span class="json-property-range" title="Value limits"></span> | ||
1314 | </div> | ||
1315 | </div> | ||
1316 | </section> | ||
1317 | </div> | ||
1318 | <div class="doc-examples"> | ||
1319 | <h5>Response Content-Types: | ||
1320 | <span>application/json</span> | ||
1321 | </h5> | ||
1322 | <section> | ||
1323 | <h5>Response Example | ||
1324 | <span>(200 OK)</span> | ||
1325 | </h5> | ||
1326 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
1327 | { | ||
1328 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1329 | <span class="hljs-attr">"follower"</span>: { | ||
1330 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1331 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
1332 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
1333 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
1334 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
1335 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
1336 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
1337 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1338 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
1339 | <span class="hljs-attr">"avatar"</span>: { | ||
1340 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
1341 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1342 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
1343 | } | ||
1344 | }, | ||
1345 | <span class="hljs-attr">"following"</span>: { | ||
1346 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1347 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
1348 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
1349 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
1350 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
1351 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
1352 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
1353 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1354 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
1355 | <span class="hljs-attr">"avatar"</span>: { | ||
1356 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
1357 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1358 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
1359 | } | ||
1360 | }, | ||
1361 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | ||
1362 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | ||
1363 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1364 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
1365 | } | ||
1366 | ] | ||
1367 | </code></pre> | ||
1368 | <!-- </div> --> | ||
1369 | </section> | ||
1370 | </div> | ||
1371 | </div> | ||
1372 | </div> | ||
1373 | <div id="operation--server-following-post" class="operation panel" data-traverse-target="operation--server-following-post"> | ||
1374 | <!-- <section class="operation-tags row"> --> | ||
1375 | <!-- <div class="doc-copy"> --> | ||
1376 | <div class="operation-tags"> | ||
1377 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | ||
1378 | <!----> | ||
1379 | </div> | ||
1380 | <!-- </div> --> | ||
1381 | <!-- </section> --> | ||
1382 | <h2 class="operation-title"> | ||
1383 | <span class="operation-name"> | ||
1384 | <span class="operation-name">POST</span> | ||
1385 | <span class="operation-path">/server/following</span> | ||
1386 | </span> | ||
1387 | </h2> | ||
1388 | <div class="doc-row"> | ||
1389 | <div class="doc-copy"> | ||
1390 | <section class="swagger-request-body"> | ||
1391 | <div class="prop-row"> | ||
1392 | <div class="prop-name"> | ||
1393 | <div class="swagger-request-model"> | ||
1394 | <span class=""> | ||
1395 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | ||
1396 | </span> | ||
1397 | </div> | ||
1398 | </div> | ||
1399 | <div class="prop-value columns small-6"> | ||
1400 | <!-- <div class="swagger-request-description"> --> | ||
1401 | <p>undefined</p> | ||
1402 | <!-- </div> --> | ||
1403 | </div> | ||
1404 | </div> | ||
1405 | </section> | ||
1406 | </div> | ||
1407 | <div class="doc-examples"> | ||
1408 | <section> | ||
1409 | <h5>Request Content-Types: | ||
1410 | <span>application/json</span> | ||
1411 | </h5> | ||
1412 | <h5>Request Example</h5> | ||
1413 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
1414 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1415 | <span class="hljs-attr">"follower"</span>: { | ||
1416 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1417 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
1418 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
1419 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
1420 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
1421 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
1422 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
1423 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1424 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
1425 | <span class="hljs-attr">"avatar"</span>: { | ||
1426 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
1427 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1428 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
1429 | } | ||
1430 | }, | ||
1431 | <span class="hljs-attr">"following"</span>: { | ||
1432 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1433 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
1434 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
1435 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
1436 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
1437 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
1438 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
1439 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1440 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
1441 | <span class="hljs-attr">"avatar"</span>: { | ||
1442 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
1443 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1444 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
1445 | } | ||
1446 | }, | ||
1447 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | ||
1448 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | ||
1449 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1450 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
1451 | } | ||
1452 | </code></pre> | ||
1453 | <!-- </div> --> | ||
1454 | </section> | ||
1455 | </div> | ||
1456 | </div> | ||
1457 | <div class="doc-row"> | ||
1458 | <div class="doc-copy"> | ||
1459 | <section class="swagger-responses"> | ||
1460 | <div class="prop-row prop-group"> | ||
1461 | <div class="prop-name"> | ||
1462 | <div class="prop-title">204 No Content</div> | ||
1463 | </div> | ||
1464 | <div class="prop-value"> | ||
1465 | <p>Successful operation</p> | ||
1466 | </div> | ||
1467 | </div> | ||
1468 | </section> | ||
1469 | </div> | ||
1470 | <div class="doc-examples"> | ||
1471 | <h5>Response Content-Types: | ||
1472 | <span>application/json</span> | ||
1473 | </h5> | ||
1474 | </div> | ||
1475 | </div> | ||
1476 | <div class="doc-row"> | ||
1477 | <div class="doc-copy"> | ||
1478 | <section class="swagger-request-security"> | ||
1479 | <table class="table"> | ||
1480 | <thead> | ||
1481 | <tr> | ||
1482 | <th class="swagger-request-security-schema"></th> | ||
1483 | <th class="swagger-request-security-scopes"></th> | ||
1484 | </tr> | ||
1485 | </thead> | ||
1486 | <tbody> | ||
1487 | <tr> | ||
1488 | <td> | ||
1489 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
1490 | </td> | ||
1491 | <td> </td> | ||
1492 | </tr> | ||
1493 | </tbody> | ||
1494 | </table> | ||
1495 | </section> | ||
1496 | </div> | ||
1497 | </div> | ||
1498 | </div> | ||
1499 | <h1 id="tag-User" class="swagger-summary-tag" data-traverse-target="tag-User">User</h1> | ||
1500 | <div id="operation--users-post" class="operation panel" data-traverse-target="operation--users-post"> | ||
1501 | <!-- <section class="operation-tags row"> --> | ||
1502 | <!-- <div class="doc-copy"> --> | ||
1503 | <div class="operation-tags"> | ||
1504 | <a class="label" href="#tag-User">User</a> | ||
1505 | <!----> | ||
1506 | </div> | ||
1507 | <!-- </div> --> | ||
1508 | <!-- </section> --> | ||
1509 | <h2 class="operation-title"> | ||
1510 | <span class="operation-name"> | ||
1511 | <span class="operation-name">POST</span> | ||
1512 | <span class="operation-path">/users</span> | ||
1513 | </span> | ||
1514 | </h2> | ||
1515 | <div class="doc-row"> | ||
1516 | <div class="doc-copy"> | ||
1517 | <section class="swagger-request-body"> | ||
1518 | <div class="prop-row"> | ||
1519 | <div class="prop-name"> | ||
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">"username"</span>: <span class="hljs-string">"string"</span>, | ||
1542 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | ||
1543 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | ||
1544 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | ||
1545 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | ||
1546 | } | ||
1547 | </code></pre> | ||
1548 | <!-- </div> --> | ||
1549 | </section> | ||
1550 | </div> | ||
1551 | </div> | ||
1552 | <div class="doc-row"> | ||
1553 | <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">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1581 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</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"> | ||
1629 | <div class="prop-row prop-group"> | ||
1630 | <div class="prop-name"> | ||
1631 | <div class="prop-title">start: | ||
1632 | <span class="prop-type"> | ||
1633 | <span class="json-property-type">number</span> | ||
1634 | <span class="json-property-range" title="Value limits"></span> | ||
1635 | </span> | ||
1636 | </div> | ||
1637 | <div class="prop-subtitle"> in query </div> | ||
1638 | </div> | ||
1639 | <div class="prop-value"> | ||
1640 | <p>Offset</p> | ||
1641 | </div> | ||
1642 | </div> | ||
1643 | <div class="prop-row prop-group"> | ||
1644 | <div class="prop-name"> | ||
1645 | <div class="prop-title">count: | ||
1646 | <span class="prop-type"> | ||
1647 | <span class="json-property-type">number</span> | ||
1648 | <span class="json-property-range" title="Value limits"></span> | ||
1649 | </span> | ||
1650 | </div> | ||
1651 | <div class="prop-subtitle"> in query </div> | ||
1652 | </div> | ||
1653 | <div class="prop-value"> | ||
1654 | <p>Number of items</p> | ||
1655 | </div> | ||
1656 | </div> | ||
1657 | <div class="prop-row prop-group"> | ||
1658 | <div class="prop-name"> | ||
1659 | <div class="prop-title">sort: | ||
1660 | <span class="prop-type"> | ||
1661 | <span class="json-property-type">string</span> | ||
1662 | <span class="json-property-range" title="Value limits"></span> | ||
1663 | </span> | ||
1664 | </div> | ||
1665 | <div class="prop-subtitle"> in query </div> | ||
1666 | </div> | ||
1667 | <div class="prop-value"> | ||
1668 | <p>Sort column (-createdAt for example)</p> | ||
1669 | </div> | ||
1670 | </div> | ||
1671 | </section> | ||
1672 | </div> | ||
1673 | <div class="doc-examples"></div> | ||
1674 | </div> | ||
1675 | <div class="doc-row"> | ||
1676 | <div class="doc-copy"> | ||
1677 | <section class="swagger-responses"> | ||
1678 | <div class="prop-row prop-group"> | ||
1679 | <div class="prop-name"> | ||
1680 | <div class="prop-title">200 OK</div> | ||
1681 | <div class="prop-ref"> | ||
1682 | <span class="json-schema-ref-array"> | ||
1683 | <a class="json-schema-ref" href="#/definitions/User">User</a> | ||
1684 | </span> | ||
1685 | </div> | ||
1686 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
1687 | </div> | ||
1688 | <div class="prop-value"> | ||
1689 | <p>successful operation</p> | ||
1690 | </div> | ||
1691 | </div> | ||
1692 | <div class="prop-row prop-inner"> | ||
1693 | <div class="prop-name">type</div> | ||
1694 | <div class="prop-value"> | ||
1695 | <span class="json-property-type"> | ||
1696 | <span class="json-schema-ref-array"> | ||
1697 | <a class="json-schema-ref" href="#/definitions/User">User</a> | ||
1698 | </span> | ||
1699 | </span> | ||
1700 | <span class="json-property-range" title="Value limits"></span> | ||
1701 | </div> | ||
1702 | </div> | ||
1703 | </section> | ||
1704 | </div> | ||
1705 | <div class="doc-examples"> | ||
1706 | <h5>Response Content-Types: | ||
1707 | <span>application/json</span> | ||
1708 | </h5> | ||
1709 | <section> | ||
1710 | <h5>Response Example | ||
1711 | <span>(200 OK)</span> | ||
1712 | </h5> | ||
1713 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
1714 | { | ||
1715 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1716 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | ||
1717 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | ||
1718 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | ||
1719 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | ||
1720 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | ||
1721 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | ||
1722 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1723 | <span class="hljs-attr">"account"</span>: { | ||
1724 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
1725 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1726 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
1727 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
1728 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
1729 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
1730 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
1731 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
1732 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1733 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
1734 | <span class="hljs-attr">"avatar"</span>: { | ||
1735 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
1736 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1737 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
1738 | } | ||
1739 | }, | ||
1740 | <span class="hljs-attr">"videoChannels"</span>: [ | ||
1741 | { | ||
1742 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
1743 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
1744 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
1745 | <span class="hljs-attr">"ownerAccount"</span>: { | ||
1746 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1747 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | ||
1748 | } | ||
1749 | } | ||
1750 | ] | ||
1751 | } | ||
1752 | ] | ||
1753 | </code></pre> | ||
1754 | <!-- </div> --> | ||
1755 | </section> | ||
1756 | </div> | ||
1757 | </div> | ||
1758 | <div class="doc-row"> | ||
1759 | <div class="doc-copy"> | ||
1760 | <section class="swagger-request-security"> | ||
1761 | <table class="table"> | ||
1762 | <thead> | ||
1763 | <tr> | ||
1764 | <th class="swagger-request-security-schema"></th> | ||
1765 | <th class="swagger-request-security-scopes"></th> | ||
1766 | </tr> | ||
1767 | </thead> | ||
1768 | <tbody> | ||
1769 | <tr> | ||
1770 | <td> | ||
1771 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
1772 | </td> | ||
1773 | <td> </td> | ||
1774 | </tr> | ||
1775 | </tbody> | ||
1776 | </table> | ||
1777 | </section> | ||
1778 | </div> | ||
1779 | </div> | ||
1780 | </div> | ||
1781 | <div id="operation--users--id--delete" class="operation panel" data-traverse-target="operation--users--id--delete"> | ||
1782 | <!-- <section class="operation-tags row"> --> | ||
1783 | <!-- <div class="doc-copy"> --> | ||
1784 | <div class="operation-tags"> | ||
1785 | <a class="label" href="#tag-User">User</a> | ||
1786 | <!----> | ||
1787 | </div> | ||
1788 | <!-- </div> --> | ||
1789 | <!-- </section> --> | ||
1790 | <h2 class="operation-title"> | ||
1791 | <span class="operation-name"> | ||
1792 | <span class="operation-name">DELETE</span> | ||
1793 | <span class="operation-path">/users/{id}</span> | ||
1794 | </span> | ||
1795 | </h2> | ||
1796 | <div class="doc-row"> | ||
1797 | <div class="doc-copy"> | ||
1798 | <section class="swagger-request-params"> | ||
1799 | <div class="prop-row prop-group"> | ||
1800 | <div class="prop-name"> | ||
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> | ||
1857 | </div> | ||
1858 | </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"> | ||
1876 | <div class="doc-copy"> | ||
1877 | <section class="swagger-request-params"> | ||
1878 | <div class="prop-row prop-group"> | ||
1879 | <div class="prop-name"> | ||
1880 | <div class="prop-title">id: | ||
1881 | <span class="prop-type"> | ||
1882 | <span class="json-property-type">number</span> | ||
1883 | <span class="json-property-range" title="Value limits"></span> | ||
1884 | </span> | ||
1885 | </div> | ||
1886 | <span class="json-property-required"></span> | ||
1887 | <div class="prop-subtitle"> in path </div> | ||
1888 | </div> | ||
1889 | <div class="prop-value"> | ||
1890 | <p>The user id</p> | ||
1891 | </div> | ||
1892 | </div> | ||
1893 | </section> | ||
1894 | </div> | ||
1895 | <div class="doc-examples"></div> | ||
1896 | </div> | ||
1897 | <div class="doc-row"> | ||
1898 | <div class="doc-copy"> | ||
1899 | <section class="swagger-responses"> | ||
1900 | <div class="prop-row prop-group"> | ||
1901 | <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">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1926 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | ||
1927 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | ||
1928 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | ||
1929 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | ||
1930 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | ||
1931 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | ||
1932 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1933 | <span class="hljs-attr">"account"</span>: { | ||
1934 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
1935 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1936 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
1937 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
1938 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
1939 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
1940 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
1941 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
1942 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1943 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
1944 | <span class="hljs-attr">"avatar"</span>: { | ||
1945 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
1946 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
1947 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
1948 | } | ||
1949 | }, | ||
1950 | <span class="hljs-attr">"videoChannels"</span>: [ | ||
1951 | { | ||
1952 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
1953 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
1954 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
1955 | <span class="hljs-attr">"ownerAccount"</span>: { | ||
1956 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
1957 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</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">"id"</span>: <span class="hljs-string">"string"</span>, | ||
2049 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | ||
2050 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | ||
2051 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</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> | ||
2064 | </div> | ||
2065 | <div class="prop-value"> | ||
2066 | <p>Successful operation</p> | ||
2067 | </div> | ||
2068 | </div> | ||
2069 | </section> | ||
2070 | </div> | ||
2071 | <div class="doc-examples"> | ||
2072 | <h5>Response Content-Types: | ||
2073 | <span>application/json</span> | ||
2074 | </h5> | ||
2075 | </div> | ||
2076 | </div> | ||
2077 | <div class="doc-row"> | ||
2078 | <div class="doc-copy"> | ||
2079 | <section class="swagger-request-security"> | ||
2080 | <table class="table"> | ||
2081 | <thead> | ||
2082 | <tr> | ||
2083 | <th class="swagger-request-security-schema"></th> | ||
2084 | <th class="swagger-request-security-scopes"></th> | ||
2085 | </tr> | ||
2086 | </thead> | ||
2087 | <tbody> | ||
2088 | <tr> | ||
2089 | <td> | ||
2090 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
2091 | </td> | ||
2092 | <td> </td> | ||
2093 | </tr> | ||
2094 | </tbody> | ||
2095 | </table> | ||
2096 | </section> | ||
2097 | </div> | ||
2098 | </div> | ||
2099 | </div> | ||
2100 | <div id="operation--users-me-get" class="operation panel" data-traverse-target="operation--users-me-get"> | ||
2101 | <!-- <section class="operation-tags row"> --> | ||
2102 | <!-- <div class="doc-copy"> --> | ||
2103 | <div class="operation-tags"> | ||
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">"id"</span>: <span class="hljs-string">"number"</span>, | ||
2160 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | ||
2161 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | ||
2162 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | ||
2163 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | ||
2164 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | ||
2165 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | ||
2166 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
2167 | <span class="hljs-attr">"account"</span>: { | ||
2168 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
2169 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
2170 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
2171 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
2172 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
2173 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
2174 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
2175 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
2176 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
2177 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
2178 | <span class="hljs-attr">"avatar"</span>: { | ||
2179 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
2180 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
2181 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
2182 | } | ||
2183 | }, | ||
2184 | <span class="hljs-attr">"videoChannels"</span>: [ | ||
2185 | { | ||
2186 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
2187 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
2188 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
2189 | <span class="hljs-attr">"ownerAccount"</span>: { | ||
2190 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
2191 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</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">"password"</span>: <span class="hljs-string">"string"</span>, | ||
2267 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | ||
2268 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>, | ||
2269 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</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> | ||
2317 | </div> | ||
2318 | <div id="operation--users-me-video-quota-used-get" class="operation panel" data-traverse-target="operation--users-me-video-quota-used-get"> | ||
2319 | <!-- <section class="operation-tags row"> --> | ||
2320 | <!-- <div class="doc-copy"> --> | ||
2321 | <div class="operation-tags"> | ||
2322 | <a class="label" href="#tag-User">User</a> | ||
2323 | <!----> | ||
2324 | </div> | ||
2325 | <!-- </div> --> | ||
2326 | <!-- </section> --> | ||
2327 | <h2 class="operation-title"> | ||
2328 | <span class="operation-name"> | ||
2329 | <span class="operation-name">GET</span> | ||
2330 | <span class="operation-path">/users/me/video-quota-used</span> | ||
2331 | </span> | ||
2332 | </h2> | ||
2333 | <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">"number"</span> | ||
2368 | </code></pre> | ||
2369 | <!-- </div> --> | ||
2370 | </section> | ||
2371 | </div> | ||
2372 | </div> | ||
2373 | <div class="doc-row"> | ||
2374 | <div class="doc-copy"> | ||
2375 | <section class="swagger-request-security"> | ||
2376 | <table class="table"> | ||
2377 | <thead> | ||
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> | ||
2393 | </div> | ||
2394 | </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"> | ||
2412 | <div class="doc-copy"> | ||
2413 | <section class="swagger-request-params"> | ||
2414 | <div class="prop-row prop-group"> | ||
2415 | <div class="prop-name"> | ||
2416 | <div class="prop-title">videoId: | ||
2417 | <span class="prop-type"> | ||
2418 | <span class="json-property-type">string</span> | ||
2419 | <span class="json-property-range" title="Value limits"></span> | ||
2420 | </span> | ||
2421 | </div> | ||
2422 | <span class="json-property-required"></span> | ||
2423 | <div class="prop-subtitle"> in path </div> | ||
2424 | </div> | ||
2425 | <div class="prop-value"> | ||
2426 | <p>The video id </p> | ||
2427 | </div> | ||
2428 | </div> | ||
2429 | </section> | ||
2430 | </div> | ||
2431 | <div class="doc-examples"></div> | ||
2432 | </div> | ||
2433 | <div class="doc-row"> | ||
2434 | <div class="doc-copy"> | ||
2435 | <section class="swagger-responses"> | ||
2436 | <div class="prop-row prop-group"> | ||
2437 | <div class="prop-name"> | ||
2438 | <div class="prop-title">200 OK</div> | ||
2439 | <div class="prop-ref"> | ||
2440 | <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">"id"</span>: <span class="hljs-string">"string"</span>, | ||
2462 | <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</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> | ||
2565 | </span> | ||
2566 | </div> | ||
2567 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
2568 | </div> | ||
2569 | <div class="prop-value"> | ||
2570 | <p>successful operation</p> | ||
2571 | </div> | ||
2572 | </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> | ||
2585 | </div> | ||
2586 | <div class="doc-examples"> | ||
2587 | <h5>Response Content-Types: | ||
2588 | <span>application/json</span> | ||
2589 | </h5> | ||
2590 | <section> | ||
2591 | <h5>Response Example | ||
2592 | <span>(200 OK)</span> | ||
2593 | </h5> | ||
2594 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
2595 | { | ||
2596 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
2597 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
2598 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
2599 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | ||
2600 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
2601 | <span class="hljs-attr">"category"</span>: { | ||
2602 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
2603 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
2604 | }, | ||
2605 | <span class="hljs-attr">"licence"</span>: { | ||
2606 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
2607 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
2608 | }, | ||
2609 | <span class="hljs-attr">"language"</span>: { | ||
2610 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
2611 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
2612 | }, | ||
2613 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | ||
2614 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
2615 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | ||
2616 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
2617 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
2618 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | ||
2619 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | ||
2620 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | ||
2621 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | ||
2622 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | ||
2623 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | ||
2624 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | ||
2625 | <span class="hljs-attr">"account"</span>: { | ||
2626 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
2627 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
2628 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
2629 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
2630 | <span class="hljs-attr">"avatar"</span>: { | ||
2631 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
2632 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
2633 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
2634 | } | ||
2635 | } | ||
2636 | } | ||
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">"username"</span>: <span class="hljs-string">"string"</span>, | ||
2708 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | ||
2709 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span> | ||
2710 | } | ||
2711 | </code></pre> | ||
2712 | <!-- </div> --> | ||
2713 | </section> | ||
2714 | </div> | ||
2715 | </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> | ||
2736 | <div id="operation--users-me-avatar-pick-post" class="operation panel" data-traverse-target="operation--users-me-avatar-pick-post"> | ||
2737 | <!-- <section class="operation-tags row"> --> | ||
2738 | <!-- <div class="doc-copy"> --> | ||
2739 | <div class="operation-tags"> | ||
2740 | <a class="label" href="#tag-User">User</a> | ||
2741 | <!----> | ||
2742 | </div> | ||
2743 | <!-- </div> --> | ||
2744 | <!-- </section> --> | ||
2745 | <h2 class="operation-title"> | ||
2746 | <span class="operation-name"> | ||
2747 | <span class="operation-name">POST</span> | ||
2748 | <span class="operation-path">/users/me/avatar/pick</span> | ||
2749 | </span> | ||
2750 | </h2> | ||
2751 | <div class="doc-row"> | ||
2752 | <div class="doc-copy"> | ||
2753 | <section class="swagger-request-params"> | ||
2754 | <div class="prop-row prop-group"> | ||
2755 | <div class="prop-name"> | ||
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">"path"</span>: <span class="hljs-string">"string"</span>, | ||
2801 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
2802 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</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> | ||
2829 | </div> | ||
2830 | </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"> | ||
2849 | <div class="doc-copy"> | ||
2850 | <section class="swagger-request-params"> | ||
2851 | <div class="prop-row prop-group"> | ||
2852 | <div class="prop-name"> | ||
2853 | <div class="prop-title">category: | ||
2854 | <span class="prop-type"> | ||
2855 | <span class="json-property-type">number</span> | ||
2856 | <span class="json-property-range" title="Value limits"></span> | ||
2857 | </span> | ||
2858 | </div> | ||
2859 | <div class="prop-subtitle"> in query </div> | ||
2860 | </div> | ||
2861 | <div class="prop-value"> | ||
2862 | <p>category id of the video</p> | ||
2863 | </div> | ||
2864 | </div> | ||
2865 | <div class="prop-row prop-group"> | ||
2866 | <div class="prop-name"> | ||
2867 | <div class="prop-title">start: | ||
2868 | <span class="prop-type"> | ||
2869 | <span class="json-property-type">number</span> | ||
2870 | <span class="json-property-range" title="Value limits"></span> | ||
2871 | </span> | ||
2872 | </div> | ||
2873 | <div class="prop-subtitle"> in query </div> | ||
2874 | </div> | ||
2875 | <div class="prop-value"> | ||
2876 | <p>Offset</p> | ||
2877 | </div> | ||
2878 | </div> | ||
2879 | <div class="prop-row prop-group"> | ||
2880 | <div class="prop-name"> | ||
2881 | <div class="prop-title">count: | ||
2882 | <span class="prop-type"> | ||
2883 | <span class="json-property-type">number</span> | ||
2884 | <span class="json-property-range" title="Value limits"></span> | ||
2885 | </span> | ||
2886 | </div> | ||
2887 | <div class="prop-subtitle"> in query </div> | ||
2888 | </div> | ||
2889 | <div class="prop-value"> | ||
2890 | <p>Number of items</p> | ||
2891 | </div> | ||
2892 | </div> | ||
2893 | <div class="prop-row prop-group"> | ||
2894 | <div class="prop-name"> | ||
2895 | <div class="prop-title">sort: | ||
2896 | <span class="prop-type"> | ||
2897 | <span class="json-property-type">string</span> | ||
2898 | <span class="json-property-range" title="Value limits"></span> | ||
2899 | </span> | ||
2900 | </div> | ||
2901 | <div class="prop-subtitle"> in query </div> | ||
2902 | </div> | ||
2903 | <div class="prop-value"> | ||
2904 | <p>Sort column (-createdAt for example)</p> | ||
2905 | </div> | ||
2906 | </div> | ||
2907 | </section> | ||
2908 | </div> | ||
2909 | <div class="doc-examples"></div> | ||
2910 | </div> | ||
2911 | <div class="doc-row"> | ||
2912 | <div class="doc-copy"> | ||
2913 | <section class="swagger-responses"> | ||
2914 | <div class="prop-row prop-group"> | ||
2915 | <div class="prop-name"> | ||
2916 | <div class="prop-title">200 OK</div> | ||
2917 | <div class="prop-ref"> | ||
2918 | <span class="json-schema-ref-array"> | ||
2919 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | ||
2920 | </span> | ||
2921 | </div> | ||
2922 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
2923 | </div> | ||
2924 | <div class="prop-value"> | ||
2925 | <p>successful operation</p> | ||
2926 | </div> | ||
2927 | </div> | ||
2928 | <div class="prop-row prop-inner"> | ||
2929 | <div class="prop-name">type</div> | ||
2930 | <div class="prop-value"> | ||
2931 | <span class="json-property-type"> | ||
2932 | <span class="json-schema-ref-array"> | ||
2933 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | ||
2934 | </span> | ||
2935 | </span> | ||
2936 | <span class="json-property-range" title="Value limits"></span> | ||
2937 | </div> | ||
2938 | </div> | ||
2939 | </section> | ||
2940 | </div> | ||
2941 | <div class="doc-examples"> | ||
2942 | <h5>Response Content-Types: | ||
2943 | <span>application/json</span> | ||
2944 | </h5> | ||
2945 | <section> | ||
2946 | <h5>Response Example | ||
2947 | <span>(200 OK)</span> | ||
2948 | </h5> | ||
2949 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
2950 | { | ||
2951 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
2952 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
2953 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
2954 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | ||
2955 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
2956 | <span class="hljs-attr">"category"</span>: { | ||
2957 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
2958 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
2959 | }, | ||
2960 | <span class="hljs-attr">"licence"</span>: { | ||
2961 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
2962 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
2963 | }, | ||
2964 | <span class="hljs-attr">"language"</span>: { | ||
2965 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
2966 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
2967 | }, | ||
2968 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | ||
2969 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
2970 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | ||
2971 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
2972 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
2973 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | ||
2974 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | ||
2975 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | ||
2976 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | ||
2977 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | ||
2978 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | ||
2979 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | ||
2980 | <span class="hljs-attr">"account"</span>: { | ||
2981 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
2982 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
2983 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
2984 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
2985 | <span class="hljs-attr">"avatar"</span>: { | ||
2986 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
2987 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
2988 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
2989 | } | ||
2990 | } | ||
2991 | } | ||
2992 | ] | ||
2993 | </code></pre> | ||
2994 | <!-- </div> --> | ||
2995 | </section> | ||
2996 | </div> | ||
2997 | </div> | ||
2998 | </div> | ||
2999 | <div id="operation--videos-categories-get" class="operation panel" data-traverse-target="operation--videos-categories-get"> | ||
3000 | <!-- <section class="operation-tags row"> --> | ||
3001 | <!-- <div class="doc-copy"> --> | ||
3002 | <div class="operation-tags"> | ||
3003 | <a class="label" href="#tag-Video">Video</a> | ||
3004 | <!----> | ||
3005 | </div> | ||
3006 | <!-- </div> --> | ||
3007 | <!-- </section> --> | ||
3008 | <h2 class="operation-title"> | ||
3009 | <span class="operation-name"> | ||
3010 | <span class="operation-name">GET</span> | ||
3011 | <span class="operation-path">/videos/categories</span> | ||
3012 | </span> | ||
3013 | </h2> | ||
3014 | <div class="doc-row"> | ||
3015 | <div class="doc-copy"> </div> | ||
3016 | <div class="doc-examples"></div> | ||
3017 | </div> | ||
3018 | <div class="doc-row"> | ||
3019 | <div class="doc-copy"> | ||
3020 | <section class="swagger-responses"> | ||
3021 | <div class="prop-row prop-group"> | ||
3022 | <div class="prop-name"> | ||
3023 | <div class="prop-title">200 OK</div> | ||
3024 | <div class="prop-ref"> </div> | ||
3025 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
3026 | </div> | ||
3027 | <div class="prop-value"> | ||
3028 | <p>successful operation</p> | ||
3029 | </div> | ||
3030 | </div> | ||
3031 | <div class="prop-row prop-inner"> | ||
3032 | <div class="prop-name">type</div> | ||
3033 | <div class="prop-value"> | ||
3034 | <span class="json-property-type">string[]</span> | ||
3035 | <span class="json-property-range" title="Value limits"></span> | ||
3036 | </div> | ||
3037 | </div> | ||
3038 | </section> | ||
3039 | </div> | ||
3040 | <div class="doc-examples"> | ||
3041 | <h5>Response Content-Types: | ||
3042 | <span>application/json</span> | ||
3043 | </h5> | ||
3044 | <section> | ||
3045 | <h5>Response Example | ||
3046 | <span>(200 OK)</span> | ||
3047 | </h5> | ||
3048 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
3049 | <span class="hljs-string">"string"</span> | ||
3050 | ] | ||
3051 | </code></pre> | ||
3052 | <!-- </div> --> | ||
3053 | </section> | ||
3054 | </div> | ||
3055 | </div> | ||
3056 | </div> | ||
3057 | <div id="operation--videos-licences-get" class="operation panel" data-traverse-target="operation--videos-licences-get"> | ||
3058 | <!-- <section class="operation-tags row"> --> | ||
3059 | <!-- <div class="doc-copy"> --> | ||
3060 | <div class="operation-tags"> | ||
3061 | <a class="label" href="#tag-Video">Video</a> | ||
3062 | <!----> | ||
3063 | </div> | ||
3064 | <!-- </div> --> | ||
3065 | <!-- </section> --> | ||
3066 | <h2 class="operation-title"> | ||
3067 | <span class="operation-name"> | ||
3068 | <span class="operation-name">GET</span> | ||
3069 | <span class="operation-path">/videos/licences</span> | ||
3070 | </span> | ||
3071 | </h2> | ||
3072 | <div class="doc-row"> | ||
3073 | <div class="doc-copy"> </div> | ||
3074 | <div class="doc-examples"></div> | ||
3075 | </div> | ||
3076 | <div class="doc-row"> | ||
3077 | <div class="doc-copy"> | ||
3078 | <section class="swagger-responses"> | ||
3079 | <div class="prop-row prop-group"> | ||
3080 | <div class="prop-name"> | ||
3081 | <div class="prop-title">200 OK</div> | ||
3082 | <div class="prop-ref"> </div> | ||
3083 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
3084 | </div> | ||
3085 | <div class="prop-value"> | ||
3086 | <p>successful operation</p> | ||
3087 | </div> | ||
3088 | </div> | ||
3089 | <div class="prop-row prop-inner"> | ||
3090 | <div class="prop-name">type</div> | ||
3091 | <div class="prop-value"> | ||
3092 | <span class="json-property-type">string[]</span> | ||
3093 | <span class="json-property-range" title="Value limits"></span> | ||
3094 | </div> | ||
3095 | </div> | ||
3096 | </section> | ||
3097 | </div> | ||
3098 | <div class="doc-examples"> | ||
3099 | <h5>Response Content-Types: | ||
3100 | <span>application/json</span> | ||
3101 | </h5> | ||
3102 | <section> | ||
3103 | <h5>Response Example | ||
3104 | <span>(200 OK)</span> | ||
3105 | </h5> | ||
3106 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
3107 | <span class="hljs-string">"string"</span> | ||
3108 | ] | ||
3109 | </code></pre> | ||
3110 | <!-- </div> --> | ||
3111 | </section> | ||
3112 | </div> | ||
3113 | </div> | ||
3114 | </div> | ||
3115 | <div id="operation--videos-languages-get" class="operation panel" data-traverse-target="operation--videos-languages-get"> | ||
3116 | <!-- <section class="operation-tags row"> --> | ||
3117 | <!-- <div class="doc-copy"> --> | ||
3118 | <div class="operation-tags"> | ||
3119 | <a class="label" href="#tag-Video">Video</a> | ||
3120 | <!----> | ||
3121 | </div> | ||
3122 | <!-- </div> --> | ||
3123 | <!-- </section> --> | ||
3124 | <h2 class="operation-title"> | ||
3125 | <span class="operation-name"> | ||
3126 | <span class="operation-name">GET</span> | ||
3127 | <span class="operation-path">/videos/languages</span> | ||
3128 | </span> | ||
3129 | </h2> | ||
3130 | <div class="doc-row"> | ||
3131 | <div class="doc-copy"> </div> | ||
3132 | <div class="doc-examples"></div> | ||
3133 | </div> | ||
3134 | <div class="doc-row"> | ||
3135 | <div class="doc-copy"> | ||
3136 | <section class="swagger-responses"> | ||
3137 | <div class="prop-row prop-group"> | ||
3138 | <div class="prop-name"> | ||
3139 | <div class="prop-title">200 OK</div> | ||
3140 | <div class="prop-ref"> </div> | ||
3141 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
3142 | </div> | ||
3143 | <div class="prop-value"> | ||
3144 | <p>successful operation</p> | ||
3145 | </div> | ||
3146 | </div> | ||
3147 | <div class="prop-row prop-inner"> | ||
3148 | <div class="prop-name">type</div> | ||
3149 | <div class="prop-value"> | ||
3150 | <span class="json-property-type">string[]</span> | ||
3151 | <span class="json-property-range" title="Value limits"></span> | ||
3152 | </div> | ||
3153 | </div> | ||
3154 | </section> | ||
3155 | </div> | ||
3156 | <div class="doc-examples"> | ||
3157 | <h5>Response Content-Types: | ||
3158 | <span>application/json</span> | ||
3159 | </h5> | ||
3160 | <section> | ||
3161 | <h5>Response Example | ||
3162 | <span>(200 OK)</span> | ||
3163 | </h5> | ||
3164 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
3165 | <span class="hljs-string">"string"</span> | ||
3166 | ] | ||
3167 | </code></pre> | ||
3168 | <!-- </div> --> | ||
3169 | </section> | ||
3170 | </div> | ||
3171 | </div> | ||
3172 | </div> | ||
3173 | <div id="operation--videos-privacies-get" class="operation panel" data-traverse-target="operation--videos-privacies-get"> | ||
3174 | <!-- <section class="operation-tags row"> --> | ||
3175 | <!-- <div class="doc-copy"> --> | ||
3176 | <div class="operation-tags"> | ||
3177 | <a class="label" href="#tag-Video">Video</a> | ||
3178 | <!----> | ||
3179 | </div> | ||
3180 | <!-- </div> --> | ||
3181 | <!-- </section> --> | ||
3182 | <h2 class="operation-title"> | ||
3183 | <span class="operation-name"> | ||
3184 | <span class="operation-name">GET</span> | ||
3185 | <span class="operation-path">/videos/privacies</span> | ||
3186 | </span> | ||
3187 | </h2> | ||
3188 | <div class="doc-row"> | ||
3189 | <div class="doc-copy"> </div> | ||
3190 | <div class="doc-examples"></div> | ||
3191 | </div> | ||
3192 | <div class="doc-row"> | ||
3193 | <div class="doc-copy"> | ||
3194 | <section class="swagger-responses"> | ||
3195 | <div class="prop-row prop-group"> | ||
3196 | <div class="prop-name"> | ||
3197 | <div class="prop-title">200 OK</div> | ||
3198 | <div class="prop-ref"> </div> | ||
3199 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
3200 | </div> | ||
3201 | <div class="prop-value"> | ||
3202 | <p>successful operation</p> | ||
3203 | </div> | ||
3204 | </div> | ||
3205 | <div class="prop-row prop-inner"> | ||
3206 | <div class="prop-name">type</div> | ||
3207 | <div class="prop-value"> | ||
3208 | <span class="json-property-type">string[]</span> | ||
3209 | <span class="json-property-range" title="Value limits"></span> | ||
3210 | </div> | ||
3211 | </div> | ||
3212 | </section> | ||
3213 | </div> | ||
3214 | <div class="doc-examples"> | ||
3215 | <h5>Response Content-Types: | ||
3216 | <span>application/json</span> | ||
3217 | </h5> | ||
3218 | <section> | ||
3219 | <h5>Response Example | ||
3220 | <span>(200 OK)</span> | ||
3221 | </h5> | ||
3222 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
3223 | <span class="hljs-string">"string"</span> | ||
3224 | ] | ||
3225 | </code></pre> | ||
3226 | <!-- </div> --> | ||
3227 | </section> | ||
3228 | </div> | ||
3229 | </div> | ||
3230 | </div> | ||
3231 | <div id="operation--videos--id--put" class="operation panel" data-traverse-target="operation--videos--id--put"> | ||
3232 | <!-- <section class="operation-tags row"> --> | ||
3233 | <!-- <div class="doc-copy"> --> | ||
3234 | <div class="operation-tags"> | ||
3235 | <a class="label" href="#tag-Video">Video</a> | ||
3236 | <!----> | ||
3237 | </div> | ||
3238 | <!-- </div> --> | ||
3239 | <!-- </section> --> | ||
3240 | <h2 class="operation-title"> | ||
3241 | <span class="operation-name"> | ||
3242 | <span class="operation-name">PUT</span> | ||
3243 | <span class="operation-path">/videos/{id}</span> | ||
3244 | </span> | ||
3245 | </h2> | ||
3246 | <div class="doc-row"> | ||
3247 | <div class="doc-copy"> | ||
3248 | <section class="swagger-request-params"> | ||
3249 | <div class="prop-row prop-group"> | ||
3250 | <div class="prop-name"> | ||
3251 | <div class="prop-title">id: | ||
3252 | <span class="prop-type"> | ||
3253 | <span class="json-property-type">string</span> | ||
3254 | <span class="json-property-range" title="Value limits"></span> | ||
3255 | </span> | ||
3256 | </div> | ||
3257 | <span class="json-property-required"></span> | ||
3258 | <div class="prop-subtitle"> in path </div> | ||
3259 | </div> | ||
3260 | <div class="prop-value"> | ||
3261 | <p>The video id or uuid</p> | ||
3262 | </div> | ||
3263 | </div> | ||
3264 | <div class="prop-row prop-group"> | ||
3265 | <div class="prop-name"> | ||
3266 | <div class="prop-title">thumbnailfile: | ||
3267 | <span class="prop-type"> | ||
3268 | <span class="json-property-type">file</span> | ||
3269 | <span class="json-property-range" title="Value limits"></span> | ||
3270 | </span> | ||
3271 | </div> | ||
3272 | <div class="prop-subtitle"> in formData </div> | ||
3273 | </div> | ||
3274 | <div class="prop-value"> | ||
3275 | <p>Video thumbnail file</p> | ||
3276 | </div> | ||
3277 | </div> | ||
3278 | <div class="prop-row prop-group"> | ||
3279 | <div class="prop-name"> | ||
3280 | <div class="prop-title">previewfile: | ||
3281 | <span class="prop-type"> | ||
3282 | <span class="json-property-type">file</span> | ||
3283 | <span class="json-property-range" title="Value limits"></span> | ||
3284 | </span> | ||
3285 | </div> | ||
3286 | <div class="prop-subtitle"> in formData </div> | ||
3287 | </div> | ||
3288 | <div class="prop-value"> | ||
3289 | <p>Video preview file</p> | ||
3290 | </div> | ||
3291 | </div> | ||
3292 | <div class="prop-row prop-group"> | ||
3293 | <div class="prop-name"> | ||
3294 | <div class="prop-title">category: | ||
3295 | <span class="prop-type"> | ||
3296 | <span class="json-property-type">number</span> | ||
3297 | <span class="json-property-range" title="Value limits"></span> | ||
3298 | </span> | ||
3299 | </div> | ||
3300 | <div class="prop-subtitle"> in formData </div> | ||
3301 | </div> | ||
3302 | <div class="prop-value"> | ||
3303 | <p>Video category</p> | ||
3304 | </div> | ||
3305 | </div> | ||
3306 | <div class="prop-row prop-group"> | ||
3307 | <div class="prop-name"> | ||
3308 | <div class="prop-title">licence: | ||
3309 | <span class="prop-type"> | ||
3310 | <span class="json-property-type">number</span> | ||
3311 | <span class="json-property-range" title="Value limits"></span> | ||
3312 | </span> | ||
3313 | </div> | ||
3314 | <div class="prop-subtitle"> in formData </div> | ||
3315 | </div> | ||
3316 | <div class="prop-value"> | ||
3317 | <p>Video licence</p> | ||
3318 | </div> | ||
3319 | </div> | ||
3320 | <div class="prop-row prop-group"> | ||
3321 | <div class="prop-name"> | ||
3322 | <div class="prop-title">language: | ||
3323 | <span class="prop-type"> | ||
3324 | <span class="json-property-type">string</span> | ||
3325 | <span class="json-property-range" title="Value limits"></span> | ||
3326 | </span> | ||
3327 | </div> | ||
3328 | <div class="prop-subtitle"> in formData </div> | ||
3329 | </div> | ||
3330 | <div class="prop-value"> | ||
3331 | <p>Video language</p> | ||
3332 | </div> | ||
3333 | </div> | ||
3334 | <div class="prop-row prop-group"> | ||
3335 | <div class="prop-name"> | ||
3336 | <div class="prop-title">description: | ||
3337 | <span class="prop-type"> | ||
3338 | <span class="json-property-type">string</span> | ||
3339 | <span class="json-property-range" title="Value limits"></span> | ||
3340 | </span> | ||
3341 | </div> | ||
3342 | <div class="prop-subtitle"> in formData </div> | ||
3343 | </div> | ||
3344 | <div class="prop-value"> | ||
3345 | <p>Video description</p> | ||
3346 | </div> | ||
3347 | </div> | ||
3348 | <div class="prop-row prop-group"> | ||
3349 | <div class="prop-name"> | ||
3350 | <div class="prop-title">waitTranscoding: | ||
3351 | <span class="prop-type"> | ||
3352 | <span class="json-property-type">boolean</span> | ||
3353 | <span class="json-property-range" title="Value limits"></span> | ||
3354 | </span> | ||
3355 | </div> | ||
3356 | <div class="prop-subtitle"> in formData </div> | ||
3357 | </div> | ||
3358 | <div class="prop-value"> | ||
3359 | <p>Whether or not we wait transcoding before publish the video</p> | ||
3360 | </div> | ||
3361 | </div> | ||
3362 | <div class="prop-row prop-group"> | ||
3363 | <div class="prop-name"> | ||
3364 | <div class="prop-title">support: | ||
3365 | <span class="prop-type"> | ||
3366 | <span class="json-property-type">string</span> | ||
3367 | <span class="json-property-range" title="Value limits"></span> | ||
3368 | </span> | ||
3369 | </div> | ||
3370 | <div class="prop-subtitle"> in formData </div> | ||
3371 | </div> | ||
3372 | <div class="prop-value"> | ||
3373 | <p>Text describing how to support the video uploader</p> | ||
3374 | </div> | ||
3375 | </div> | ||
3376 | <div class="prop-row prop-group"> | ||
3377 | <div class="prop-name"> | ||
3378 | <div class="prop-title">nsfw: | ||
3379 | <span class="prop-type"> | ||
3380 | <span class="json-property-type">boolean</span> | ||
3381 | <span class="json-property-range" title="Value limits"></span> | ||
3382 | </span> | ||
3383 | </div> | ||
3384 | <div class="prop-subtitle"> in formData </div> | ||
3385 | </div> | ||
3386 | <div class="prop-value"> | ||
3387 | <p>Whether or not this video contains sensitive content</p> | ||
3388 | </div> | ||
3389 | </div> | ||
3390 | <div class="prop-row prop-group"> | ||
3391 | <div class="prop-name"> | ||
3392 | <div class="prop-title">name: | ||
3393 | <span class="prop-type"> | ||
3394 | <span class="json-property-type">string</span> | ||
3395 | <span class="json-property-range" title="Value limits"></span> | ||
3396 | </span> | ||
3397 | </div> | ||
3398 | <div class="prop-subtitle"> in formData </div> | ||
3399 | </div> | ||
3400 | <div class="prop-value"> | ||
3401 | <p>Video name</p> | ||
3402 | </div> | ||
3403 | </div> | ||
3404 | <div class="prop-row prop-group"> | ||
3405 | <div class="prop-name"> | ||
3406 | <div class="prop-title">tags: | ||
3407 | <span class="prop-type"> | ||
3408 | <span class="json-property-type">string[]</span> | ||
3409 | <span class="json-property-range" title="Value limits"></span> | ||
3410 | </span> | ||
3411 | </div> | ||
3412 | <div class="prop-subtitle"> in formData </div> | ||
3413 | </div> | ||
3414 | <div class="prop-value"> | ||
3415 | <p>Video tags</p> | ||
3416 | </div> | ||
3417 | </div> | ||
3418 | <div class="prop-row prop-group"> | ||
3419 | <div class="prop-name"> | ||
3420 | <div class="prop-title">commentsEnabled: | ||
3421 | <span class="prop-type"> | ||
3422 | <span class="json-property-type">boolean</span> | ||
3423 | <span class="json-property-range" title="Value limits"></span> | ||
3424 | </span> | ||
3425 | </div> | ||
3426 | <div class="prop-subtitle"> in formData </div> | ||
3427 | </div> | ||
3428 | <div class="prop-value"> | ||
3429 | <p>Enable or disable comments for this video</p> | ||
3430 | </div> | ||
3431 | </div> | ||
3432 | <div class="prop-row prop-group"> | ||
3433 | <div class="prop-name"> | ||
3434 | <div class="prop-title">privacy: | ||
3435 | <span class="prop-type"> | ||
3436 | <span class="json-property-type">string</span> | ||
3437 | <span class="json-property-enum" title="Possible values"> | ||
3438 | <span class="json-property-enum-item">Public</span>, | ||
3439 | <span class="json-property-enum-item">Unlisted</span> | ||
3440 | </span> | ||
3441 | <span class="json-property-range" title="Value limits"></span> | ||
3442 | </span> | ||
3443 | </div> | ||
3444 | <div class="prop-subtitle"> in formData </div> | ||
3445 | </div> | ||
3446 | <div class="prop-value"> | ||
3447 | <p>Video privacy</p> | ||
3448 | </div> | ||
3449 | </div> | ||
3450 | <div class="prop-row prop-group"> | ||
3451 | <div class="prop-name"> | ||
3452 | <div class="prop-title">scheduleUpdate: | ||
3453 | <span class="prop-type"> | ||
3454 | <span class="json-property-type">object</span> | ||
3455 | <span class="json-property-range" title="Value limits"></span> | ||
3456 | </span> | ||
3457 | </div> | ||
3458 | <div class="prop-subtitle"> in formData </div> | ||
3459 | </div> | ||
3460 | <div class="prop-value"> | ||
3461 | <p>Schedule an update at a specific datetime</p> | ||
3462 | </div> | ||
3463 | </div> | ||
3464 | </section> | ||
3465 | </div> | ||
3466 | <div class="doc-examples"></div> | ||
3467 | </div> | ||
3468 | <div class="doc-row"> | ||
3469 | <div class="doc-copy"> | ||
3470 | <section class="swagger-responses"> | ||
3471 | <div class="prop-row prop-group"> | ||
3472 | <div class="prop-name"> | ||
3473 | <div class="prop-title">200 OK</div> | ||
3474 | <div class="prop-ref"> | ||
3475 | <span class=""> | ||
3476 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | ||
3477 | </span> | ||
3478 | </div> | ||
3479 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
3480 | </div> | ||
3481 | <div class="prop-value"> | ||
3482 | <p>successful operation</p> | ||
3483 | </div> | ||
3484 | </div> | ||
3485 | </section> | ||
3486 | </div> | ||
3487 | <div class="doc-examples"> | ||
3488 | <h5>Response Content-Types: | ||
3489 | <span>application/json</span> | ||
3490 | </h5> | ||
3491 | <section> | ||
3492 | <h5>Response Example | ||
3493 | <span>(200 OK)</span> | ||
3494 | </h5> | ||
3495 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
3496 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
3497 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
3498 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
3499 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | ||
3500 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
3501 | <span class="hljs-attr">"category"</span>: { | ||
3502 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
3503 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
3504 | }, | ||
3505 | <span class="hljs-attr">"licence"</span>: { | ||
3506 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
3507 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
3508 | }, | ||
3509 | <span class="hljs-attr">"language"</span>: { | ||
3510 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
3511 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
3512 | }, | ||
3513 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | ||
3514 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
3515 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | ||
3516 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
3517 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
3518 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | ||
3519 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | ||
3520 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | ||
3521 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | ||
3522 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | ||
3523 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | ||
3524 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | ||
3525 | <span class="hljs-attr">"account"</span>: { | ||
3526 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
3527 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
3528 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
3529 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
3530 | <span class="hljs-attr">"avatar"</span>: { | ||
3531 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
3532 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
3533 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
3534 | } | ||
3535 | } | ||
3536 | } | ||
3537 | </code></pre> | ||
3538 | <!-- </div> --> | ||
3539 | </section> | ||
3540 | </div> | ||
3541 | </div> | ||
3542 | <div class="doc-row"> | ||
3543 | <div class="doc-copy"> | ||
3544 | <section class="swagger-request-security"> | ||
3545 | <table class="table"> | ||
3546 | <thead> | ||
3547 | <tr> | ||
3548 | <th class="swagger-request-security-schema"></th> | ||
3549 | <th class="swagger-request-security-scopes"></th> | ||
3550 | </tr> | ||
3551 | </thead> | ||
3552 | <tbody> | ||
3553 | <tr> | ||
3554 | <td> | ||
3555 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
3556 | </td> | ||
3557 | <td> </td> | ||
3558 | </tr> | ||
3559 | </tbody> | ||
3560 | </table> | ||
3561 | </section> | ||
3562 | </div> | ||
3563 | </div> | ||
3564 | </div> | ||
3565 | <div id="operation--videos--id--get" class="operation panel" data-traverse-target="operation--videos--id--get"> | ||
3566 | <!-- <section class="operation-tags row"> --> | ||
3567 | <!-- <div class="doc-copy"> --> | ||
3568 | <div class="operation-tags"> | ||
3569 | <a class="label" href="#tag-Video">Video</a> | ||
3570 | <!----> | ||
3571 | </div> | ||
3572 | <!-- </div> --> | ||
3573 | <!-- </section> --> | ||
3574 | <h2 class="operation-title"> | ||
3575 | <span class="operation-name"> | ||
3576 | <span class="operation-name">GET</span> | ||
3577 | <span class="operation-path">/videos/{id}</span> | ||
3578 | </span> | ||
3579 | </h2> | ||
3580 | <div class="doc-row"> | ||
3581 | <div class="doc-copy"> | ||
3582 | <section class="swagger-request-params"> | ||
3583 | <div class="prop-row prop-group"> | ||
3584 | <div class="prop-name"> | ||
3585 | <div class="prop-title">id: | ||
3586 | <span class="prop-type"> | ||
3587 | <span class="json-property-type">string</span> | ||
3588 | <span class="json-property-range" title="Value limits"></span> | ||
3589 | </span> | ||
3590 | </div> | ||
3591 | <span class="json-property-required"></span> | ||
3592 | <div class="prop-subtitle"> in path </div> | ||
3593 | </div> | ||
3594 | <div class="prop-value"> | ||
3595 | <p>The video id or uuid</p> | ||
3596 | </div> | ||
3597 | </div> | ||
3598 | </section> | ||
3599 | </div> | ||
3600 | <div class="doc-examples"></div> | ||
3601 | </div> | ||
3602 | <div class="doc-row"> | ||
3603 | <div class="doc-copy"> | ||
3604 | <section class="swagger-responses"> | ||
3605 | <div class="prop-row prop-group"> | ||
3606 | <div class="prop-name"> | ||
3607 | <div class="prop-title">200 OK</div> | ||
3608 | <div class="prop-ref"> | ||
3609 | <span class=""> | ||
3610 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | ||
3611 | </span> | ||
3612 | </div> | ||
3613 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
3614 | </div> | ||
3615 | <div class="prop-value"> | ||
3616 | <p>successful operation</p> | ||
3617 | </div> | ||
3618 | </div> | ||
3619 | </section> | ||
3620 | </div> | ||
3621 | <div class="doc-examples"> | ||
3622 | <h5>Response Content-Types: | ||
3623 | <span>application/json</span> | ||
3624 | </h5> | ||
3625 | <section> | ||
3626 | <h5>Response Example | ||
3627 | <span>(200 OK)</span> | ||
3628 | </h5> | ||
3629 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
3630 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
3631 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
3632 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
3633 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | ||
3634 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
3635 | <span class="hljs-attr">"category"</span>: { | ||
3636 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
3637 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
3638 | }, | ||
3639 | <span class="hljs-attr">"licence"</span>: { | ||
3640 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
3641 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
3642 | }, | ||
3643 | <span class="hljs-attr">"language"</span>: { | ||
3644 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
3645 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
3646 | }, | ||
3647 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | ||
3648 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
3649 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | ||
3650 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
3651 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
3652 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | ||
3653 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | ||
3654 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | ||
3655 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | ||
3656 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | ||
3657 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | ||
3658 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | ||
3659 | <span class="hljs-attr">"account"</span>: { | ||
3660 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
3661 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
3662 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
3663 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
3664 | <span class="hljs-attr">"avatar"</span>: { | ||
3665 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
3666 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
3667 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
3668 | } | ||
3669 | } | ||
3670 | } | ||
3671 | </code></pre> | ||
3672 | <!-- </div> --> | ||
3673 | </section> | ||
3674 | </div> | ||
3675 | </div> | ||
3676 | </div> | ||
3677 | <div id="operation--videos--id--delete" class="operation panel" data-traverse-target="operation--videos--id--delete"> | ||
3678 | <!-- <section class="operation-tags row"> --> | ||
3679 | <!-- <div class="doc-copy"> --> | ||
3680 | <div class="operation-tags"> | ||
3681 | <a class="label" href="#tag-Video">Video</a> | ||
3682 | <!----> | ||
3683 | </div> | ||
3684 | <!-- </div> --> | ||
3685 | <!-- </section> --> | ||
3686 | <h2 class="operation-title"> | ||
3687 | <span class="operation-name"> | ||
3688 | <span class="operation-name">DELETE</span> | ||
3689 | <span class="operation-path">/videos/{id}</span> | ||
3690 | </span> | ||
3691 | </h2> | ||
3692 | <div class="doc-row"> | ||
3693 | <div class="doc-copy"> | ||
3694 | <section class="swagger-request-params"> | ||
3695 | <div class="prop-row prop-group"> | ||
3696 | <div class="prop-name"> | ||
3697 | <div class="prop-title">id: | ||
3698 | <span class="prop-type"> | ||
3699 | <span class="json-property-type">string</span> | ||
3700 | <span class="json-property-range" title="Value limits"></span> | ||
3701 | </span> | ||
3702 | </div> | ||
3703 | <span class="json-property-required"></span> | ||
3704 | <div class="prop-subtitle"> in path </div> | ||
3705 | </div> | ||
3706 | <div class="prop-value"> | ||
3707 | <p>The video id or uuid</p> | ||
3708 | </div> | ||
3709 | </div> | ||
3710 | </section> | ||
3711 | </div> | ||
3712 | <div class="doc-examples"></div> | ||
3713 | </div> | ||
3714 | <div class="doc-row"> | ||
3715 | <div class="doc-copy"> | ||
3716 | <section class="swagger-responses"> | ||
3717 | <div class="prop-row prop-group"> | ||
3718 | <div class="prop-name"> | ||
3719 | <div class="prop-title">204 No Content</div> | ||
3720 | </div> | ||
3721 | <div class="prop-value"> | ||
3722 | <p>Successful operation</p> | ||
3723 | </div> | ||
3724 | </div> | ||
3725 | </section> | ||
3726 | </div> | ||
3727 | <div class="doc-examples"> | ||
3728 | <h5>Response Content-Types: | ||
3729 | <span>application/json</span> | ||
3730 | </h5> | ||
3731 | </div> | ||
3732 | </div> | ||
3733 | <div class="doc-row"> | ||
3734 | <div class="doc-copy"> | ||
3735 | <section class="swagger-request-security"> | ||
3736 | <table class="table"> | ||
3737 | <thead> | ||
3738 | <tr> | ||
3739 | <th class="swagger-request-security-schema"></th> | ||
3740 | <th class="swagger-request-security-scopes"></th> | ||
3741 | </tr> | ||
3742 | </thead> | ||
3743 | <tbody> | ||
3744 | <tr> | ||
3745 | <td> | ||
3746 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
3747 | </td> | ||
3748 | <td> </td> | ||
3749 | </tr> | ||
3750 | </tbody> | ||
3751 | </table> | ||
3752 | </section> | ||
3753 | </div> | ||
3754 | </div> | ||
3755 | </div> | ||
3756 | <div id="operation--videos--id--description-get" class="operation panel" data-traverse-target="operation--videos--id--description-get"> | ||
3757 | <!-- <section class="operation-tags row"> --> | ||
3758 | <!-- <div class="doc-copy"> --> | ||
3759 | <div class="operation-tags"> | ||
3760 | <a class="label" href="#tag-Video">Video</a> | ||
3761 | <!----> | ||
3762 | </div> | ||
3763 | <!-- </div> --> | ||
3764 | <!-- </section> --> | ||
3765 | <h2 class="operation-title"> | ||
3766 | <span class="operation-name"> | ||
3767 | <span class="operation-name">GET</span> | ||
3768 | <span class="operation-path">/videos/{id}/description</span> | ||
3769 | </span> | ||
3770 | </h2> | ||
3771 | <div class="doc-row"> | ||
3772 | <div class="doc-copy"> | ||
3773 | <section class="swagger-request-params"> | ||
3774 | <div class="prop-row prop-group"> | ||
3775 | <div class="prop-name"> | ||
3776 | <div class="prop-title">id: | ||
3777 | <span class="prop-type"> | ||
3778 | <span class="json-property-type">string</span> | ||
3779 | <span class="json-property-range" title="Value limits"></span> | ||
3780 | </span> | ||
3781 | </div> | ||
3782 | <span class="json-property-required"></span> | ||
3783 | <div class="prop-subtitle"> in path </div> | ||
3784 | </div> | ||
3785 | <div class="prop-value"> | ||
3786 | <p>The video id or uuid</p> | ||
3787 | </div> | ||
3788 | </div> | ||
3789 | </section> | ||
3790 | </div> | ||
3791 | <div class="doc-examples"></div> | ||
3792 | </div> | ||
3793 | <div class="doc-row"> | ||
3794 | <div class="doc-copy"> | ||
3795 | <section class="swagger-responses"> | ||
3796 | <div class="prop-row prop-group"> | ||
3797 | <div class="prop-name"> | ||
3798 | <div class="prop-title">200 OK</div> | ||
3799 | <div class="prop-ref"> </div> | ||
3800 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
3801 | </div> | ||
3802 | <div class="prop-value"> | ||
3803 | <p>successful operation</p> | ||
3804 | </div> | ||
3805 | </div> | ||
3806 | <div class="prop-row prop-inner"> | ||
3807 | <div class="prop-name">type</div> | ||
3808 | <div class="prop-value"> | ||
3809 | <span class="json-property-type">string</span> | ||
3810 | <span class="json-property-range" title="Value limits"></span> | ||
3811 | </div> | ||
3812 | </div> | ||
3813 | </section> | ||
3814 | </div> | ||
3815 | <div class="doc-examples"> | ||
3816 | <h5>Response Content-Types: | ||
3817 | <span>application/json</span> | ||
3818 | </h5> | ||
3819 | <section> | ||
3820 | <h5>Response Example | ||
3821 | <span>(200 OK)</span> | ||
3822 | </h5> | ||
3823 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"string"</span> | ||
3824 | </code></pre> | ||
3825 | <!-- </div> --> | ||
3826 | </section> | ||
3827 | </div> | ||
3828 | </div> | ||
3829 | </div> | ||
3830 | <div id="operation--videos--id--views-post" class="operation panel" data-traverse-target="operation--videos--id--views-post"> | ||
3831 | <!-- <section class="operation-tags row"> --> | ||
3832 | <!-- <div class="doc-copy"> --> | ||
3833 | <div class="operation-tags"> | ||
3834 | <a class="label" href="#tag-Video">Video</a> | ||
3835 | <!----> | ||
3836 | </div> | ||
3837 | <!-- </div> --> | ||
3838 | <!-- </section> --> | ||
3839 | <h2 class="operation-title"> | ||
3840 | <span class="operation-name"> | ||
3841 | <span class="operation-name">POST</span> | ||
3842 | <span class="operation-path">/videos/{id}/views</span> | ||
3843 | </span> | ||
3844 | </h2> | ||
3845 | <div class="doc-row"> | ||
3846 | <div class="doc-copy"> | ||
3847 | <section class="swagger-request-params"> | ||
3848 | <div class="prop-row prop-group"> | ||
3849 | <div class="prop-name"> | ||
3850 | <div class="prop-title">id: | ||
3851 | <span class="prop-type"> | ||
3852 | <span class="json-property-type">string</span> | ||
3853 | <span class="json-property-range" title="Value limits"></span> | ||
3854 | </span> | ||
3855 | </div> | ||
3856 | <span class="json-property-required"></span> | ||
3857 | <div class="prop-subtitle"> in path </div> | ||
3858 | </div> | ||
3859 | <div class="prop-value"> | ||
3860 | <p>The video id or uuid</p> | ||
3861 | </div> | ||
3862 | </div> | ||
3863 | </section> | ||
3864 | </div> | ||
3865 | <div class="doc-examples"></div> | ||
3866 | </div> | ||
3867 | <div class="doc-row"> | ||
3868 | <div class="doc-copy"> | ||
3869 | <section class="swagger-responses"> | ||
3870 | <div class="prop-row prop-group"> | ||
3871 | <div class="prop-name"> | ||
3872 | <div class="prop-title">204 No Content</div> | ||
3873 | </div> | ||
3874 | <div class="prop-value"> | ||
3875 | <p>Successful operation</p> | ||
3876 | </div> | ||
3877 | </div> | ||
3878 | </section> | ||
3879 | </div> | ||
3880 | <div class="doc-examples"> | ||
3881 | <h5>Response Content-Types: | ||
3882 | <span>application/json</span> | ||
3883 | </h5> | ||
3884 | </div> | ||
3885 | </div> | ||
3886 | </div> | ||
3887 | <div id="operation--videos-upload-post" class="operation panel" data-traverse-target="operation--videos-upload-post"> | ||
3888 | <!-- <section class="operation-tags row"> --> | ||
3889 | <!-- <div class="doc-copy"> --> | ||
3890 | <div class="operation-tags"> | ||
3891 | <a class="label" href="#tag-Video">Video</a> | ||
3892 | <!----> | ||
3893 | </div> | ||
3894 | <!-- </div> --> | ||
3895 | <!-- </section> --> | ||
3896 | <h2 class="operation-title"> | ||
3897 | <span class="operation-name"> | ||
3898 | <span class="operation-name">POST</span> | ||
3899 | <span class="operation-path">/videos/upload</span> | ||
3900 | </span> | ||
3901 | </h2> | ||
3902 | <div class="doc-row"> | ||
3903 | <div class="doc-copy"> | ||
3904 | <section class="swagger-request-params"> | ||
3905 | <div class="prop-row prop-group"> | ||
3906 | <div class="prop-name"> | ||
3907 | <div class="prop-title">videofile: | ||
3908 | <span class="prop-type"> | ||
3909 | <span class="json-property-type">file</span> | ||
3910 | <span class="json-property-range" title="Value limits"></span> | ||
3911 | </span> | ||
3912 | </div> | ||
3913 | <span class="json-property-required"></span> | ||
3914 | <div class="prop-subtitle"> in formData </div> | ||
3915 | </div> | ||
3916 | <div class="prop-value"> | ||
3917 | <p>Video file</p> | ||
3918 | </div> | ||
3919 | </div> | ||
3920 | <div class="prop-row prop-group"> | ||
3921 | <div class="prop-name"> | ||
3922 | <div class="prop-title">channelId: | ||
3923 | <span class="prop-type"> | ||
3924 | <span class="json-property-type">number</span> | ||
3925 | <span class="json-property-range" title="Value limits"></span> | ||
3926 | </span> | ||
3927 | </div> | ||
3928 | <span class="json-property-required"></span> | ||
3929 | <div class="prop-subtitle"> in formData </div> | ||
3930 | </div> | ||
3931 | <div class="prop-value"> | ||
3932 | <p>Channel id that will contain this video</p> | ||
3933 | </div> | ||
3934 | </div> | ||
3935 | <div class="prop-row prop-group"> | ||
3936 | <div class="prop-name"> | ||
3937 | <div class="prop-title">thumbnailfile: | ||
3938 | <span class="prop-type"> | ||
3939 | <span class="json-property-type">file</span> | ||
3940 | <span class="json-property-range" title="Value limits"></span> | ||
3941 | </span> | ||
3942 | </div> | ||
3943 | <div class="prop-subtitle"> in formData </div> | ||
3944 | </div> | ||
3945 | <div class="prop-value"> | ||
3946 | <p>Video thumbnail file</p> | ||
3947 | </div> | ||
3948 | </div> | ||
3949 | <div class="prop-row prop-group"> | ||
3950 | <div class="prop-name"> | ||
3951 | <div class="prop-title">previewfile: | ||
3952 | <span class="prop-type"> | ||
3953 | <span class="json-property-type">file</span> | ||
3954 | <span class="json-property-range" title="Value limits"></span> | ||
3955 | </span> | ||
3956 | </div> | ||
3957 | <div class="prop-subtitle"> in formData </div> | ||
3958 | </div> | ||
3959 | <div class="prop-value"> | ||
3960 | <p>Video preview file</p> | ||
3961 | </div> | ||
3962 | </div> | ||
3963 | <div class="prop-row prop-group"> | ||
3964 | <div class="prop-name"> | ||
3965 | <div class="prop-title">category: | ||
3966 | <span class="prop-type"> | ||
3967 | <span class="json-property-type">number</span> | ||
3968 | <span class="json-property-range" title="Value limits"></span> | ||
3969 | </span> | ||
3970 | </div> | ||
3971 | <div class="prop-subtitle"> in formData </div> | ||
3972 | </div> | ||
3973 | <div class="prop-value"> | ||
3974 | <p>Video category</p> | ||
3975 | </div> | ||
3976 | </div> | ||
3977 | <div class="prop-row prop-group"> | ||
3978 | <div class="prop-name"> | ||
3979 | <div class="prop-title">licence: | ||
3980 | <span class="prop-type"> | ||
3981 | <span class="json-property-type">number</span> | ||
3982 | <span class="json-property-range" title="Value limits"></span> | ||
3983 | </span> | ||
3984 | </div> | ||
3985 | <div class="prop-subtitle"> in formData </div> | ||
3986 | </div> | ||
3987 | <div class="prop-value"> | ||
3988 | <p>Video licence</p> | ||
3989 | </div> | ||
3990 | </div> | ||
3991 | <div class="prop-row prop-group"> | ||
3992 | <div class="prop-name"> | ||
3993 | <div class="prop-title">language: | ||
3994 | <span class="prop-type"> | ||
3995 | <span class="json-property-type">string</span> | ||
3996 | <span class="json-property-range" title="Value limits"></span> | ||
3997 | </span> | ||
3998 | </div> | ||
3999 | <div class="prop-subtitle"> in formData </div> | ||
4000 | </div> | ||
4001 | <div class="prop-value"> | ||
4002 | <p>Video language</p> | ||
4003 | </div> | ||
4004 | </div> | ||
4005 | <div class="prop-row prop-group"> | ||
4006 | <div class="prop-name"> | ||
4007 | <div class="prop-title">description: | ||
4008 | <span class="prop-type"> | ||
4009 | <span class="json-property-type">string</span> | ||
4010 | <span class="json-property-range" title="Value limits"></span> | ||
4011 | </span> | ||
4012 | </div> | ||
4013 | <div class="prop-subtitle"> in formData </div> | ||
4014 | </div> | ||
4015 | <div class="prop-value"> | ||
4016 | <p>Video description</p> | ||
4017 | </div> | ||
4018 | </div> | ||
4019 | <div class="prop-row prop-group"> | ||
4020 | <div class="prop-name"> | ||
4021 | <div class="prop-title">waitTranscoding: | ||
4022 | <span class="prop-type"> | ||
4023 | <span class="json-property-type">boolean</span> | ||
4024 | <span class="json-property-range" title="Value limits"></span> | ||
4025 | </span> | ||
4026 | </div> | ||
4027 | <div class="prop-subtitle"> in formData </div> | ||
4028 | </div> | ||
4029 | <div class="prop-value"> | ||
4030 | <p>Whether or not we wait transcoding before publish the video</p> | ||
4031 | </div> | ||
4032 | </div> | ||
4033 | <div class="prop-row prop-group"> | ||
4034 | <div class="prop-name"> | ||
4035 | <div class="prop-title">support: | ||
4036 | <span class="prop-type"> | ||
4037 | <span class="json-property-type">string</span> | ||
4038 | <span class="json-property-range" title="Value limits"></span> | ||
4039 | </span> | ||
4040 | </div> | ||
4041 | <div class="prop-subtitle"> in formData </div> | ||
4042 | </div> | ||
4043 | <div class="prop-value"> | ||
4044 | <p>Text describing how to support the video uploader</p> | ||
4045 | </div> | ||
4046 | </div> | ||
4047 | <div class="prop-row prop-group"> | ||
4048 | <div class="prop-name"> | ||
4049 | <div class="prop-title">nsfw: | ||
4050 | <span class="prop-type"> | ||
4051 | <span class="json-property-type">boolean</span> | ||
4052 | <span class="json-property-range" title="Value limits"></span> | ||
4053 | </span> | ||
4054 | </div> | ||
4055 | <div class="prop-subtitle"> in formData </div> | ||
4056 | </div> | ||
4057 | <div class="prop-value"> | ||
4058 | <p>Whether or not this video contains sensitive content</p> | ||
4059 | </div> | ||
4060 | </div> | ||
4061 | <div class="prop-row prop-group"> | ||
4062 | <div class="prop-name"> | ||
4063 | <div class="prop-title">name: | ||
4064 | <span class="prop-type"> | ||
4065 | <span class="json-property-type">string</span> | ||
4066 | <span class="json-property-range" title="Value limits"></span> | ||
4067 | </span> | ||
4068 | </div> | ||
4069 | <div class="prop-subtitle"> in formData </div> | ||
4070 | </div> | ||
4071 | <div class="prop-value"> | ||
4072 | <p>Video name</p> | ||
4073 | </div> | ||
4074 | </div> | ||
4075 | <div class="prop-row prop-group"> | ||
4076 | <div class="prop-name"> | ||
4077 | <div class="prop-title">tags: | ||
4078 | <span class="prop-type"> | ||
4079 | <span class="json-property-type">string[]</span> | ||
4080 | <span class="json-property-range" title="Value limits"></span> | ||
4081 | </span> | ||
4082 | </div> | ||
4083 | <div class="prop-subtitle"> in formData </div> | ||
4084 | </div> | ||
4085 | <div class="prop-value"> | ||
4086 | <p>Video tags</p> | ||
4087 | </div> | ||
4088 | </div> | ||
4089 | <div class="prop-row prop-group"> | ||
4090 | <div class="prop-name"> | ||
4091 | <div class="prop-title">commentsEnabled: | ||
4092 | <span class="prop-type"> | ||
4093 | <span class="json-property-type">boolean</span> | ||
4094 | <span class="json-property-range" title="Value limits"></span> | ||
4095 | </span> | ||
4096 | </div> | ||
4097 | <div class="prop-subtitle"> in formData </div> | ||
4098 | </div> | ||
4099 | <div class="prop-value"> | ||
4100 | <p>Enable or disable comments for this video</p> | ||
4101 | </div> | ||
4102 | </div> | ||
4103 | <div class="prop-row prop-group"> | ||
4104 | <div class="prop-name"> | ||
4105 | <div class="prop-title">privacy: | ||
4106 | <span class="prop-type"> | ||
4107 | <span class="json-property-type">string</span> | ||
4108 | <span class="json-property-enum" title="Possible values"> | ||
4109 | <span class="json-property-enum-item">Public</span>, | ||
4110 | <span class="json-property-enum-item">Unlisted</span> | ||
4111 | </span> | ||
4112 | <span class="json-property-range" title="Value limits"></span> | ||
4113 | </span> | ||
4114 | </div> | ||
4115 | <div class="prop-subtitle"> in formData </div> | ||
4116 | </div> | ||
4117 | <div class="prop-value"> | ||
4118 | <p>Video privacy</p> | ||
4119 | </div> | ||
4120 | </div> | ||
4121 | <div class="prop-row prop-group"> | ||
4122 | <div class="prop-name"> | ||
4123 | <div class="prop-title">scheduleUpdate: | ||
4124 | <span class="prop-type"> | ||
4125 | <span class="json-property-type">object</span> | ||
4126 | <span class="json-property-range" title="Value limits"></span> | ||
4127 | </span> | ||
4128 | </div> | ||
4129 | <div class="prop-subtitle"> in formData </div> | ||
4130 | </div> | ||
4131 | <div class="prop-value"> | ||
4132 | <p>Schedule an update at a specific datetime</p> | ||
4133 | </div> | ||
4134 | </div> | ||
4135 | </section> | ||
4136 | </div> | ||
4137 | <div class="doc-examples"></div> | ||
4138 | </div> | ||
4139 | <div class="doc-row"> | ||
4140 | <div class="doc-copy"> | ||
4141 | <section class="swagger-responses"> | ||
4142 | <div class="prop-row prop-group"> | ||
4143 | <div class="prop-name"> | ||
4144 | <div class="prop-title">200 OK</div> | ||
4145 | <div class="prop-ref"> | ||
4146 | <span class=""> | ||
4147 | <a class="json-schema-ref" href="#/definitions/VideoUploadResponse">VideoUploadResponse</a> | ||
4148 | </span> | ||
4149 | </div> | ||
4150 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
4151 | </div> | ||
4152 | <div class="prop-value"> | ||
4153 | <p>successful operation</p> | ||
4154 | </div> | ||
4155 | </div> | ||
4156 | </section> | ||
4157 | </div> | ||
4158 | <div class="doc-examples"> | ||
4159 | <h5>Response Content-Types: | ||
4160 | <span>application/json</span> | ||
4161 | </h5> | ||
4162 | <section> | ||
4163 | <h5>Response Example | ||
4164 | <span>(200 OK)</span> | ||
4165 | </h5> | ||
4166 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
4167 | <span class="hljs-attr">"video"</span>: { | ||
4168 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
4169 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | ||
4170 | } | ||
4171 | } | ||
4172 | </code></pre> | ||
4173 | <!-- </div> --> | ||
4174 | </section> | ||
4175 | </div> | ||
4176 | </div> | ||
4177 | <div class="doc-row"> | ||
4178 | <div class="doc-copy"> | ||
4179 | <section class="swagger-request-security"> | ||
4180 | <table class="table"> | ||
4181 | <thead> | ||
4182 | <tr> | ||
4183 | <th class="swagger-request-security-schema"></th> | ||
4184 | <th class="swagger-request-security-scopes"></th> | ||
4185 | </tr> | ||
4186 | </thead> | ||
4187 | <tbody> | ||
4188 | <tr> | ||
4189 | <td> | ||
4190 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
4191 | </td> | ||
4192 | <td> </td> | ||
4193 | </tr> | ||
4194 | </tbody> | ||
4195 | </table> | ||
4196 | </section> | ||
4197 | </div> | ||
4198 | </div> | ||
4199 | </div> | ||
4200 | <h1 id="tag-VideoAbuse" class="swagger-summary-tag" data-traverse-target="tag-VideoAbuse">VideoAbuse</h1> | ||
4201 | <div id="operation--videos-abuse-get" class="operation panel" data-traverse-target="operation--videos-abuse-get"> | ||
4202 | <!-- <section class="operation-tags row"> --> | ||
4203 | <!-- <div class="doc-copy"> --> | ||
4204 | <div class="operation-tags"> | ||
4205 | <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> | ||
4206 | <!----> | ||
4207 | </div> | ||
4208 | <!-- </div> --> | ||
4209 | <!-- </section> --> | ||
4210 | <h2 class="operation-title"> | ||
4211 | <span class="operation-name"> | ||
4212 | <span class="operation-name">GET</span> | ||
4213 | <span class="operation-path">/videos/abuse</span> | ||
4214 | </span> | ||
4215 | </h2> | ||
4216 | <div class="doc-row"> | ||
4217 | <div class="doc-copy"> | ||
4218 | <section class="swagger-request-params"> | ||
4219 | <div class="prop-row prop-group"> | ||
4220 | <div class="prop-name"> | ||
4221 | <div class="prop-title">start: | ||
4222 | <span class="prop-type"> | ||
4223 | <span class="json-property-type">number</span> | ||
4224 | <span class="json-property-range" title="Value limits"></span> | ||
4225 | </span> | ||
4226 | </div> | ||
4227 | <div class="prop-subtitle"> in query </div> | ||
4228 | </div> | ||
4229 | <div class="prop-value"> | ||
4230 | <p>Offset</p> | ||
4231 | </div> | ||
4232 | </div> | ||
4233 | <div class="prop-row prop-group"> | ||
4234 | <div class="prop-name"> | ||
4235 | <div class="prop-title">count: | ||
4236 | <span class="prop-type"> | ||
4237 | <span class="json-property-type">number</span> | ||
4238 | <span class="json-property-range" title="Value limits"></span> | ||
4239 | </span> | ||
4240 | </div> | ||
4241 | <div class="prop-subtitle"> in query </div> | ||
4242 | </div> | ||
4243 | <div class="prop-value"> | ||
4244 | <p>Number of items</p> | ||
4245 | </div> | ||
4246 | </div> | ||
4247 | <div class="prop-row prop-group"> | ||
4248 | <div class="prop-name"> | ||
4249 | <div class="prop-title">sort: | ||
4250 | <span class="prop-type"> | ||
4251 | <span class="json-property-type">string</span> | ||
4252 | <span class="json-property-range" title="Value limits"></span> | ||
4253 | </span> | ||
4254 | </div> | ||
4255 | <div class="prop-subtitle"> in query </div> | ||
4256 | </div> | ||
4257 | <div class="prop-value"> | ||
4258 | <p>Sort column (-createdAt for example)</p> | ||
4259 | </div> | ||
4260 | </div> | ||
4261 | </section> | ||
4262 | </div> | ||
4263 | <div class="doc-examples"></div> | ||
4264 | </div> | ||
4265 | <div class="doc-row"> | ||
4266 | <div class="doc-copy"> | ||
4267 | <section class="swagger-responses"> | ||
4268 | <div class="prop-row prop-group"> | ||
4269 | <div class="prop-name"> | ||
4270 | <div class="prop-title">200 OK</div> | ||
4271 | <div class="prop-ref"> | ||
4272 | <span class="json-schema-ref-array"> | ||
4273 | <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a> | ||
4274 | </span> | ||
4275 | </div> | ||
4276 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
4277 | </div> | ||
4278 | <div class="prop-value"> | ||
4279 | <p>successful operation</p> | ||
4280 | </div> | ||
4281 | </div> | ||
4282 | <div class="prop-row prop-inner"> | ||
4283 | <div class="prop-name">type</div> | ||
4284 | <div class="prop-value"> | ||
4285 | <span class="json-property-type"> | ||
4286 | <span class="json-schema-ref-array"> | ||
4287 | <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a> | ||
4288 | </span> | ||
4289 | </span> | ||
4290 | <span class="json-property-range" title="Value limits"></span> | ||
4291 | </div> | ||
4292 | </div> | ||
4293 | </section> | ||
4294 | </div> | ||
4295 | <div class="doc-examples"> | ||
4296 | <h5>Response Content-Types: | ||
4297 | <span>application/json</span> | ||
4298 | </h5> | ||
4299 | <section> | ||
4300 | <h5>Response Example | ||
4301 | <span>(200 OK)</span> | ||
4302 | </h5> | ||
4303 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
4304 | { | ||
4305 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
4306 | <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>, | ||
4307 | <span class="hljs-attr">"reporterAccount"</span>: { | ||
4308 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
4309 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
4310 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
4311 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
4312 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
4313 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
4314 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
4315 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
4316 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
4317 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
4318 | <span class="hljs-attr">"avatar"</span>: { | ||
4319 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
4320 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
4321 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
4322 | } | ||
4323 | }, | ||
4324 | <span class="hljs-attr">"video"</span>: { | ||
4325 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
4326 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
4327 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
4328 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span> | ||
4329 | }, | ||
4330 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span> | ||
4331 | } | ||
4332 | ] | ||
4333 | </code></pre> | ||
4334 | <!-- </div> --> | ||
4335 | </section> | ||
4336 | </div> | ||
4337 | </div> | ||
4338 | <div class="doc-row"> | ||
4339 | <div class="doc-copy"> | ||
4340 | <section class="swagger-request-security"> | ||
4341 | <table class="table"> | ||
4342 | <thead> | ||
4343 | <tr> | ||
4344 | <th class="swagger-request-security-schema"></th> | ||
4345 | <th class="swagger-request-security-scopes"></th> | ||
4346 | </tr> | ||
4347 | </thead> | ||
4348 | <tbody> | ||
4349 | <tr> | ||
4350 | <td> | ||
4351 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
4352 | </td> | ||
4353 | <td> </td> | ||
4354 | </tr> | ||
4355 | </tbody> | ||
4356 | </table> | ||
4357 | </section> | ||
4358 | </div> | ||
4359 | </div> | ||
4360 | </div> | ||
4361 | <div id="operation--videos--id--abuse-post" class="operation panel" data-traverse-target="operation--videos--id--abuse-post"> | ||
4362 | <!-- <section class="operation-tags row"> --> | ||
4363 | <!-- <div class="doc-copy"> --> | ||
4364 | <div class="operation-tags"> | ||
4365 | <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> | ||
4366 | <!----> | ||
4367 | </div> | ||
4368 | <!-- </div> --> | ||
4369 | <!-- </section> --> | ||
4370 | <h2 class="operation-title"> | ||
4371 | <span class="operation-name"> | ||
4372 | <span class="operation-name">POST</span> | ||
4373 | <span class="operation-path">/videos/{id}/abuse</span> | ||
4374 | </span> | ||
4375 | </h2> | ||
4376 | <div class="doc-row"> | ||
4377 | <div class="doc-copy"> | ||
4378 | <section class="swagger-request-params"> | ||
4379 | <div class="prop-row prop-group"> | ||
4380 | <div class="prop-name"> | ||
4381 | <div class="prop-title">id: | ||
4382 | <span class="prop-type"> | ||
4383 | <span class="json-property-type">string</span> | ||
4384 | <span class="json-property-range" title="Value limits"></span> | ||
4385 | </span> | ||
4386 | </div> | ||
4387 | <span class="json-property-required"></span> | ||
4388 | <div class="prop-subtitle"> in path </div> | ||
4389 | </div> | ||
4390 | <div class="prop-value"> | ||
4391 | <p>The video id or uuid</p> | ||
4392 | </div> | ||
4393 | </div> | ||
4394 | </section> | ||
4395 | </div> | ||
4396 | <div class="doc-examples"></div> | ||
4397 | </div> | ||
4398 | <div class="doc-row"> | ||
4399 | <div class="doc-copy"> | ||
4400 | <section class="swagger-responses"> | ||
4401 | <div class="prop-row prop-group"> | ||
4402 | <div class="prop-name"> | ||
4403 | <div class="prop-title">204 No Content</div> | ||
4404 | </div> | ||
4405 | <div class="prop-value"> | ||
4406 | <p>Successful operation</p> | ||
4407 | </div> | ||
4408 | </div> | ||
4409 | </section> | ||
4410 | </div> | ||
4411 | <div class="doc-examples"> | ||
4412 | <h5>Response Content-Types: | ||
4413 | <span>application/json</span> | ||
4414 | </h5> | ||
4415 | </div> | ||
4416 | </div> | ||
4417 | <div class="doc-row"> | ||
4418 | <div class="doc-copy"> | ||
4419 | <section class="swagger-request-security"> | ||
4420 | <table class="table"> | ||
4421 | <thead> | ||
4422 | <tr> | ||
4423 | <th class="swagger-request-security-schema"></th> | ||
4424 | <th class="swagger-request-security-scopes"></th> | ||
4425 | </tr> | ||
4426 | </thead> | ||
4427 | <tbody> | ||
4428 | <tr> | ||
4429 | <td> | ||
4430 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
4431 | </td> | ||
4432 | <td> </td> | ||
4433 | </tr> | ||
4434 | </tbody> | ||
4435 | </table> | ||
4436 | </section> | ||
4437 | </div> | ||
4438 | </div> | ||
4439 | </div> | ||
4440 | <h1 id="tag-VideoBlacklist" class="swagger-summary-tag" data-traverse-target="tag-VideoBlacklist">VideoBlacklist</h1> | ||
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"> --> | ||
4443 | <!-- <div class="doc-copy"> --> | ||
4444 | <div class="operation-tags"> | ||
4445 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | ||
4446 | <!----> | ||
4447 | </div> | ||
4448 | <!-- </div> --> | ||
4449 | <!-- </section> --> | ||
4450 | <h2 class="operation-title"> | ||
4451 | <span class="operation-name"> | ||
4452 | <span class="operation-name">POST</span> | ||
4453 | <span class="operation-path">/videos/{id}/blacklist</span> | ||
4454 | </span> | ||
4455 | </h2> | ||
4456 | <div class="doc-row"> | ||
4457 | <div class="doc-copy"> | ||
4458 | <section class="swagger-request-params"> | ||
4459 | <div class="prop-row prop-group"> | ||
4460 | <div class="prop-name"> | ||
4461 | <div class="prop-title">id: | ||
4462 | <span class="prop-type"> | ||
4463 | <span class="json-property-type">string</span> | ||
4464 | <span class="json-property-range" title="Value limits"></span> | ||
4465 | </span> | ||
4466 | </div> | ||
4467 | <span class="json-property-required"></span> | ||
4468 | <div class="prop-subtitle"> in path </div> | ||
4469 | </div> | ||
4470 | <div class="prop-value"> | ||
4471 | <p>The video id or uuid</p> | ||
4472 | </div> | ||
4473 | </div> | ||
4474 | </section> | ||
4475 | </div> | ||
4476 | <div class="doc-examples"></div> | ||
4477 | </div> | ||
4478 | <div class="doc-row"> | ||
4479 | <div class="doc-copy"> | ||
4480 | <section class="swagger-responses"> | ||
4481 | <div class="prop-row prop-group"> | ||
4482 | <div class="prop-name"> | ||
4483 | <div class="prop-title">204 No Content</div> | ||
4484 | </div> | ||
4485 | <div class="prop-value"> | ||
4486 | <p>Successful operation</p> | ||
4487 | </div> | ||
4488 | </div> | ||
4489 | </section> | ||
4490 | </div> | ||
4491 | <div class="doc-examples"> | ||
4492 | <h5>Response Content-Types: | ||
4493 | <span>application/json</span> | ||
4494 | </h5> | ||
4495 | </div> | ||
4496 | </div> | ||
4497 | <div class="doc-row"> | ||
4498 | <div class="doc-copy"> | ||
4499 | <section class="swagger-request-security"> | ||
4500 | <table class="table"> | ||
4501 | <thead> | ||
4502 | <tr> | ||
4503 | <th class="swagger-request-security-schema"></th> | ||
4504 | <th class="swagger-request-security-scopes"></th> | ||
4505 | </tr> | ||
4506 | </thead> | ||
4507 | <tbody> | ||
4508 | <tr> | ||
4509 | <td> | ||
4510 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
4511 | </td> | ||
4512 | <td> </td> | ||
4513 | </tr> | ||
4514 | </tbody> | ||
4515 | </table> | ||
4516 | </section> | ||
4517 | </div> | ||
4518 | </div> | ||
4519 | </div> | ||
4520 | <div id="operation--videos--id--blacklist-delete" class="operation panel" data-traverse-target="operation--videos--id--blacklist-delete"> | ||
4521 | <!-- <section class="operation-tags row"> --> | ||
4522 | <!-- <div class="doc-copy"> --> | ||
4523 | <div class="operation-tags"> | ||
4524 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | ||
4525 | <!----> | ||
4526 | </div> | ||
4527 | <!-- </div> --> | ||
4528 | <!-- </section> --> | ||
4529 | <h2 class="operation-title"> | ||
4530 | <span class="operation-name"> | ||
4531 | <span class="operation-name">DELETE</span> | ||
4532 | <span class="operation-path">/videos/{id}/blacklist</span> | ||
4533 | </span> | ||
4534 | </h2> | ||
4535 | <div class="doc-row"> | ||
4536 | <div class="doc-copy"> | ||
4537 | <section class="swagger-request-params"> | ||
4538 | <div class="prop-row prop-group"> | ||
4539 | <div class="prop-name"> | ||
4540 | <div class="prop-title">id: | ||
4541 | <span class="prop-type"> | ||
4542 | <span class="json-property-type">string</span> | ||
4543 | <span class="json-property-range" title="Value limits"></span> | ||
4544 | </span> | ||
4545 | </div> | ||
4546 | <span class="json-property-required"></span> | ||
4547 | <div class="prop-subtitle"> in path </div> | ||
4548 | </div> | ||
4549 | <div class="prop-value"> | ||
4550 | <p>The video id or uuid</p> | ||
4551 | </div> | ||
4552 | </div> | ||
4553 | </section> | ||
4554 | </div> | ||
4555 | <div class="doc-examples"></div> | ||
4556 | </div> | ||
4557 | <div class="doc-row"> | ||
4558 | <div class="doc-copy"> | ||
4559 | <section class="swagger-responses"> | ||
4560 | <div class="prop-row prop-group"> | ||
4561 | <div class="prop-name"> | ||
4562 | <div class="prop-title">204 No Content</div> | ||
4563 | </div> | ||
4564 | <div class="prop-value"> | ||
4565 | <p>Successful operation</p> | ||
4566 | </div> | ||
4567 | </div> | ||
4568 | </section> | ||
4569 | </div> | ||
4570 | <div class="doc-examples"> | ||
4571 | <h5>Response Content-Types: | ||
4572 | <span>application/json</span> | ||
4573 | </h5> | ||
4574 | </div> | ||
4575 | </div> | ||
4576 | <div class="doc-row"> | ||
4577 | <div class="doc-copy"> | ||
4578 | <section class="swagger-request-security"> | ||
4579 | <table class="table"> | ||
4580 | <thead> | ||
4581 | <tr> | ||
4582 | <th class="swagger-request-security-schema"></th> | ||
4583 | <th class="swagger-request-security-scopes"></th> | ||
4584 | </tr> | ||
4585 | </thead> | ||
4586 | <tbody> | ||
4587 | <tr> | ||
4588 | <td> | ||
4589 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
4590 | </td> | ||
4591 | <td> </td> | ||
4592 | </tr> | ||
4593 | </tbody> | ||
4594 | </table> | ||
4595 | </section> | ||
4596 | </div> | ||
4597 | </div> | ||
4598 | </div> | ||
4599 | <div id="operation--videos-blacklist-get" class="operation panel" data-traverse-target="operation--videos-blacklist-get"> | ||
4600 | <!-- <section class="operation-tags row"> --> | ||
4601 | <!-- <div class="doc-copy"> --> | ||
4602 | <div class="operation-tags"> | ||
4603 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | ||
4604 | <!----> | ||
4605 | </div> | ||
4606 | <!-- </div> --> | ||
4607 | <!-- </section> --> | ||
4608 | <h2 class="operation-title"> | ||
4609 | <span class="operation-name"> | ||
4610 | <span class="operation-name">GET</span> | ||
4611 | <span class="operation-path">/videos/blacklist</span> | ||
4612 | </span> | ||
4613 | </h2> | ||
4614 | <div class="doc-row"> | ||
4615 | <div class="doc-copy"> | ||
4616 | <section class="swagger-request-params"> | ||
4617 | <div class="prop-row prop-group"> | ||
4618 | <div class="prop-name"> | ||
4619 | <div class="prop-title">start: | ||
4620 | <span class="prop-type"> | ||
4621 | <span class="json-property-type">number</span> | ||
4622 | <span class="json-property-range" title="Value limits"></span> | ||
4623 | </span> | ||
4624 | </div> | ||
4625 | <div class="prop-subtitle"> in query </div> | ||
4626 | </div> | ||
4627 | <div class="prop-value"> | ||
4628 | <p>Offset</p> | ||
4629 | </div> | ||
4630 | </div> | ||
4631 | <div class="prop-row prop-group"> | ||
4632 | <div class="prop-name"> | ||
4633 | <div class="prop-title">count: | ||
4634 | <span class="prop-type"> | ||
4635 | <span class="json-property-type">number</span> | ||
4636 | <span class="json-property-range" title="Value limits"></span> | ||
4637 | </span> | ||
4638 | </div> | ||
4639 | <div class="prop-subtitle"> in query </div> | ||
4640 | </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> | ||
4655 | <div class="prop-value"> | ||
4656 | <p>Sort column (-createdAt for example)</p> | ||
4657 | </div> | ||
4658 | </div> | ||
4659 | </section> | ||
4660 | </div> | ||
4661 | <div class="doc-examples"></div> | ||
4662 | </div> | ||
4663 | <div class="doc-row"> | ||
4664 | <div class="doc-copy"> | ||
4665 | <section class="swagger-responses"> | ||
4666 | <div class="prop-row prop-group"> | ||
4667 | <div class="prop-name"> | ||
4668 | <div class="prop-title">200 OK</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> | ||
4679 | </div> | ||
4680 | <div class="prop-row prop-inner"> | ||
4681 | <div class="prop-name">type</div> | ||
4682 | <div class="prop-value"> | ||
4683 | <span class="json-property-type"> | ||
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> | ||
4690 | </div> | ||
4691 | </section> | ||
4692 | </div> | ||
4693 | <div class="doc-examples"> | ||
4694 | <h5>Response Content-Types: | ||
4695 | <span>application/json</span> | ||
4696 | </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">"id"</span>: <span class="hljs-string">"number"</span>, | ||
4704 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
4705 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
4706 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
4707 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
4708 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
4709 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
4710 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | ||
4711 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | ||
4712 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | ||
4713 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | ||
4714 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | ||
4715 | } | ||
4716 | ] | ||
4717 | </code></pre> | ||
4718 | <!-- </div> --> | ||
4719 | </section> | ||
4720 | </div> | ||
4721 | </div> | ||
4722 | <div class="doc-row"> | ||
4723 | <div class="doc-copy"> | ||
4724 | <section class="swagger-request-security"> | ||
4725 | <table class="table"> | ||
4726 | <thead> | ||
4727 | <tr> | ||
4728 | <th class="swagger-request-security-schema"></th> | ||
4729 | <th class="swagger-request-security-scopes"></th> | ||
4730 | </tr> | ||
4731 | </thead> | ||
4732 | <tbody> | ||
4733 | <tr> | ||
4734 | <td> | ||
4735 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
4736 | </td> | ||
4737 | <td> </td> | ||
4738 | </tr> | ||
4739 | </tbody> | ||
4740 | </table> | ||
4741 | </section> | ||
4742 | </div> | ||
4743 | </div> | ||
4744 | </div> | ||
4745 | <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1> | ||
4746 | <div id="operation--video-channels-get" class="operation panel" data-traverse-target="operation--video-channels-get"> | ||
4747 | <!-- <section class="operation-tags row"> --> | ||
4748 | <!-- <div class="doc-copy"> --> | ||
4749 | <div class="operation-tags"> | ||
4750 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | ||
4751 | <!----> | ||
4752 | </div> | ||
4753 | <!-- </div> --> | ||
4754 | <!-- </section> --> | ||
4755 | <h2 class="operation-title"> | ||
4756 | <span class="operation-name"> | ||
4757 | <span class="operation-name">GET</span> | ||
4758 | <span class="operation-path">/video-channels</span> | ||
4759 | </span> | ||
4760 | </h2> | ||
4761 | <div class="doc-row"> | ||
4762 | <div class="doc-copy"> | ||
4763 | <section class="swagger-request-params"> | ||
4764 | <div class="prop-row prop-group"> | ||
4765 | <div class="prop-name"> | ||
4766 | <div class="prop-title">start: | ||
4767 | <span class="prop-type"> | ||
4768 | <span class="json-property-type">number</span> | ||
4769 | <span class="json-property-range" title="Value limits"></span> | ||
4770 | </span> | ||
4771 | </div> | ||
4772 | <div class="prop-subtitle"> in query </div> | ||
4773 | </div> | ||
4774 | <div class="prop-value"> | ||
4775 | <p>Offset</p> | ||
4776 | </div> | ||
4777 | </div> | ||
4778 | <div class="prop-row prop-group"> | ||
4779 | <div class="prop-name"> | ||
4780 | <div class="prop-title">count: | ||
4781 | <span class="prop-type"> | ||
4782 | <span class="json-property-type">number</span> | ||
4783 | <span class="json-property-range" title="Value limits"></span> | ||
4784 | </span> | ||
4785 | </div> | ||
4786 | <div class="prop-subtitle"> in query </div> | ||
4787 | </div> | ||
4788 | <div class="prop-value"> | ||
4789 | <p>Number of items</p> | ||
4790 | </div> | ||
4791 | </div> | ||
4792 | <div class="prop-row prop-group"> | ||
4793 | <div class="prop-name"> | ||
4794 | <div class="prop-title">sort: | ||
4795 | <span class="prop-type"> | ||
4796 | <span class="json-property-type">string</span> | ||
4797 | <span class="json-property-range" title="Value limits"></span> | ||
4798 | </span> | ||
4799 | </div> | ||
4800 | <div class="prop-subtitle"> in query </div> | ||
4801 | </div> | ||
4802 | <div class="prop-value"> | ||
4803 | <p>Sort column (-createdAt for example)</p> | ||
4804 | </div> | ||
4805 | </div> | ||
4806 | </section> | ||
4807 | </div> | ||
4808 | <div class="doc-examples"></div> | ||
4809 | </div> | ||
4810 | <div class="doc-row"> | ||
4811 | <div class="doc-copy"> | ||
4812 | <section class="swagger-responses"> | ||
4813 | <div class="prop-row prop-group"> | ||
4814 | <div class="prop-name"> | ||
4815 | <div class="prop-title">200 OK</div> | ||
4816 | <div class="prop-ref"> | ||
4817 | <span class="json-schema-ref-array"> | ||
4818 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | ||
4819 | </span> | ||
4820 | </div> | ||
4821 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
4822 | </div> | ||
4823 | <div class="prop-value"> | ||
4824 | <p>successful operation</p> | ||
4825 | </div> | ||
4826 | </div> | ||
4827 | <div class="prop-row prop-inner"> | ||
4828 | <div class="prop-name">type</div> | ||
4829 | <div class="prop-value"> | ||
4830 | <span class="json-property-type"> | ||
4831 | <span class="json-schema-ref-array"> | ||
4832 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | ||
4833 | </span> | ||
4834 | </span> | ||
4835 | <span class="json-property-range" title="Value limits"></span> | ||
4836 | </div> | ||
4837 | </div> | ||
4838 | </section> | ||
4839 | </div> | ||
4840 | <div class="doc-examples"> | ||
4841 | <h5>Response Content-Types: | ||
4842 | <span>application/json</span> | ||
4843 | </h5> | ||
4844 | <section> | ||
4845 | <h5>Response Example | ||
4846 | <span>(200 OK)</span> | ||
4847 | </h5> | ||
4848 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
4849 | { | ||
4850 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
4851 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
4852 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
4853 | <span class="hljs-attr">"ownerAccount"</span>: { | ||
4854 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
4855 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | ||
4856 | } | ||
4857 | } | ||
4858 | ] | ||
4859 | </code></pre> | ||
4860 | <!-- </div> --> | ||
4861 | </section> | ||
4862 | </div> | ||
4863 | </div> | ||
4864 | </div> | ||
4865 | <div id="operation--video-channels-post" class="operation panel" data-traverse-target="operation--video-channels-post"> | ||
4866 | <!-- <section class="operation-tags row"> --> | ||
4867 | <!-- <div class="doc-copy"> --> | ||
4868 | <div class="operation-tags"> | ||
4869 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | ||
4870 | <!----> | ||
4871 | </div> | ||
4872 | <!-- </div> --> | ||
4873 | <!-- </section> --> | ||
4874 | <h2 class="operation-title"> | ||
4875 | <span class="operation-name"> | ||
4876 | <span class="operation-name">POST</span> | ||
4877 | <span class="operation-path">/video-channels</span> | ||
4878 | </span> | ||
4879 | </h2> | ||
4880 | <div class="doc-row"> | ||
4881 | <div class="doc-copy"> | ||
4882 | <section class="swagger-request-body"> | ||
4883 | <div class="prop-row"> | ||
4884 | <div class="prop-name"> | ||
4885 | <div class="swagger-request-model"> | ||
4886 | <span class=""> | ||
4887 | <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a> | ||
4888 | </span> | ||
4889 | </div> | ||
4890 | </div> | ||
4891 | <div class="prop-value columns small-6"> | ||
4892 | <!-- <div class="swagger-request-description"> --> | ||
4893 | <p>undefined</p> | ||
4894 | <!-- </div> --> | ||
4895 | </div> | ||
4896 | </div> | ||
4897 | </section> | ||
4898 | </div> | ||
4899 | <div class="doc-examples"> | ||
4900 | <section> | ||
4901 | <h5>Request Content-Types: | ||
4902 | <span>application/json</span> | ||
4903 | </h5> | ||
4904 | <h5>Request Example</h5> | ||
4905 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
4906 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
4907 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | ||
4908 | } | ||
4909 | </code></pre> | ||
4910 | <!-- </div> --> | ||
4911 | </section> | ||
4912 | </div> | ||
4913 | </div> | ||
4914 | <div class="doc-row"> | ||
4915 | <div class="doc-copy"> | ||
4916 | <section class="swagger-responses"> | ||
4917 | <div class="prop-row prop-group"> | ||
4918 | <div class="prop-name"> | ||
4919 | <div class="prop-title">204 No Content</div> | ||
4920 | </div> | ||
4921 | <div class="prop-value"> | ||
4922 | <p>Successful operation</p> | ||
4923 | </div> | ||
4924 | </div> | ||
4925 | </section> | ||
4926 | </div> | ||
4927 | <div class="doc-examples"> | ||
4928 | <h5>Response Content-Types: | ||
4929 | <span>application/json</span> | ||
4930 | </h5> | ||
4931 | </div> | ||
4932 | </div> | ||
4933 | <div class="doc-row"> | ||
4934 | <div class="doc-copy"> | ||
4935 | <section class="swagger-request-security"> | ||
4936 | <table class="table"> | ||
4937 | <thead> | ||
4938 | <tr> | ||
4939 | <th class="swagger-request-security-schema"></th> | ||
4940 | <th class="swagger-request-security-scopes"></th> | ||
4941 | </tr> | ||
4942 | </thead> | ||
4943 | <tbody> | ||
4944 | <tr> | ||
4945 | <td> | ||
4946 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
4947 | </td> | ||
4948 | <td> </td> | ||
4949 | </tr> | ||
4950 | </tbody> | ||
4951 | </table> | ||
4952 | </section> | ||
4953 | </div> | ||
4954 | </div> | ||
4955 | </div> | ||
4956 | <div id="operation--video-channels--id--get" class="operation panel" data-traverse-target="operation--video-channels--id--get"> | ||
4957 | <!-- <section class="operation-tags row"> --> | ||
4958 | <!-- <div class="doc-copy"> --> | ||
4959 | <div class="operation-tags"> | ||
4960 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | ||
4961 | <!----> | ||
4962 | </div> | ||
4963 | <!-- </div> --> | ||
4964 | <!-- </section> --> | ||
4965 | <h2 class="operation-title"> | ||
4966 | <span class="operation-name"> | ||
4967 | <span class="operation-name">GET</span> | ||
4968 | <span class="operation-path">/video-channels/{id}</span> | ||
4969 | </span> | ||
4970 | </h2> | ||
4971 | <div class="doc-row"> | ||
4972 | <div class="doc-copy"> | ||
4973 | <section class="swagger-request-params"> | ||
4974 | <div class="prop-row prop-group"> | ||
4975 | <div class="prop-name"> | ||
4976 | <div class="prop-title">id: | ||
4977 | <span class="prop-type"> | ||
4978 | <span class="json-property-type">string</span> | ||
4979 | <span class="json-property-range" title="Value limits"></span> | ||
4980 | </span> | ||
4981 | </div> | ||
4982 | <span class="json-property-required"></span> | ||
4983 | <div class="prop-subtitle"> in path </div> | ||
4984 | </div> | ||
4985 | <div class="prop-value"> | ||
4986 | <p>The video channel id or uuid</p> | ||
4987 | </div> | ||
4988 | </div> | ||
4989 | </section> | ||
4990 | </div> | ||
4991 | <div class="doc-examples"></div> | ||
4992 | </div> | ||
4993 | <div class="doc-row"> | ||
4994 | <div class="doc-copy"> | ||
4995 | <section class="swagger-responses"> | ||
4996 | <div class="prop-row prop-group"> | ||
4997 | <div class="prop-name"> | ||
4998 | <div class="prop-title">200 OK</div> | ||
4999 | <div class="prop-ref"> | ||
5000 | <span class=""> | ||
5001 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | ||
5002 | </span> | ||
5003 | </div> | ||
5004 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
5005 | </div> | ||
5006 | <div class="prop-value"> | ||
5007 | <p>successful operation</p> | ||
5008 | </div> | ||
5009 | </div> | ||
5010 | </section> | ||
5011 | </div> | ||
5012 | <div class="doc-examples"> | ||
5013 | <h5>Response Content-Types: | ||
5014 | <span>application/json</span> | ||
5015 | </h5> | ||
5016 | <section> | ||
5017 | <h5>Response Example | ||
5018 | <span>(200 OK)</span> | ||
5019 | </h5> | ||
5020 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
5021 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
5022 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
5023 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
5024 | <span class="hljs-attr">"ownerAccount"</span>: { | ||
5025 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5026 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | ||
5027 | } | ||
5028 | } | ||
5029 | </code></pre> | ||
5030 | <!-- </div> --> | ||
5031 | </section> | ||
5032 | </div> | ||
5033 | </div> | ||
5034 | </div> | ||
5035 | <div id="operation--video-channels--id--put" class="operation panel" data-traverse-target="operation--video-channels--id--put"> | ||
5036 | <!-- <section class="operation-tags row"> --> | ||
5037 | <!-- <div class="doc-copy"> --> | ||
5038 | <div class="operation-tags"> | ||
5039 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | ||
5040 | <!----> | ||
5041 | </div> | ||
5042 | <!-- </div> --> | ||
5043 | <!-- </section> --> | ||
5044 | <h2 class="operation-title"> | ||
5045 | <span class="operation-name"> | ||
5046 | <span class="operation-name">PUT</span> | ||
5047 | <span class="operation-path">/video-channels/{id}</span> | ||
5048 | </span> | ||
5049 | </h2> | ||
5050 | <div class="doc-row"> | ||
5051 | <div class="doc-copy"> | ||
5052 | <section class="swagger-request-body"> | ||
5053 | <div class="prop-row"> | ||
5054 | <div class="prop-name"> | ||
5055 | <div class="swagger-request-model"> | ||
5056 | <span class=""> | ||
5057 | <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a> | ||
5058 | </span> | ||
5059 | </div> | ||
5060 | </div> | ||
5061 | <div class="prop-value columns small-6"> | ||
5062 | <!-- <div class="swagger-request-description"> --> | ||
5063 | <p>undefined</p> | ||
5064 | <!-- </div> --> | ||
5065 | </div> | ||
5066 | </div> | ||
5067 | </section> | ||
5068 | <section class="swagger-request-params"> | ||
5069 | <div class="prop-row prop-group"> | ||
5070 | <div class="prop-name"> | ||
5071 | <div class="prop-title">id: | ||
5072 | <span class="prop-type"> | ||
5073 | <span class="json-property-type">string</span> | ||
5074 | <span class="json-property-range" title="Value limits"></span> | ||
5075 | </span> | ||
5076 | </div> | ||
5077 | <span class="json-property-required"></span> | ||
5078 | <div class="prop-subtitle"> in path </div> | ||
5079 | </div> | ||
5080 | <div class="prop-value"> | ||
5081 | <p>The video channel id or uuid</p> | ||
5082 | </div> | ||
5083 | </div> | ||
5084 | </section> | ||
5085 | </div> | ||
5086 | <div class="doc-examples"> | ||
5087 | <section> | ||
5088 | <h5>Request Content-Types: | ||
5089 | <span>application/json</span> | ||
5090 | </h5> | ||
5091 | <h5>Request Example</h5> | ||
5092 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
5093 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5094 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | ||
5095 | } | ||
5096 | </code></pre> | ||
5097 | <!-- </div> --> | ||
5098 | </section> | ||
5099 | </div> | ||
5100 | </div> | ||
5101 | <div class="doc-row"> | ||
5102 | <div class="doc-copy"> | ||
5103 | <section class="swagger-responses"> | ||
5104 | <div class="prop-row prop-group"> | ||
5105 | <div class="prop-name"> | ||
5106 | <div class="prop-title">204 No Content</div> | ||
5107 | </div> | ||
5108 | <div class="prop-value"> | ||
5109 | <p>Successful operation</p> | ||
5110 | </div> | ||
5111 | </div> | ||
5112 | </section> | ||
5113 | </div> | ||
5114 | <div class="doc-examples"> | ||
5115 | <h5>Response Content-Types: | ||
5116 | <span>application/json</span> | ||
5117 | </h5> | ||
5118 | </div> | ||
5119 | </div> | ||
5120 | <div class="doc-row"> | ||
5121 | <div class="doc-copy"> | ||
5122 | <section class="swagger-request-security"> | ||
5123 | <table class="table"> | ||
5124 | <thead> | ||
5125 | <tr> | ||
5126 | <th class="swagger-request-security-schema"></th> | ||
5127 | <th class="swagger-request-security-scopes"></th> | ||
5128 | </tr> | ||
5129 | </thead> | ||
5130 | <tbody> | ||
5131 | <tr> | ||
5132 | <td> | ||
5133 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
5134 | </td> | ||
5135 | <td> </td> | ||
5136 | </tr> | ||
5137 | </tbody> | ||
5138 | </table> | ||
5139 | </section> | ||
5140 | </div> | ||
5141 | </div> | ||
5142 | </div> | ||
5143 | <div id="operation--video-channels--id--delete" class="operation panel" data-traverse-target="operation--video-channels--id--delete"> | ||
5144 | <!-- <section class="operation-tags row"> --> | ||
5145 | <!-- <div class="doc-copy"> --> | ||
5146 | <div class="operation-tags"> | ||
5147 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | ||
5148 | <!----> | ||
5149 | </div> | ||
5150 | <!-- </div> --> | ||
5151 | <!-- </section> --> | ||
5152 | <h2 class="operation-title"> | ||
5153 | <span class="operation-name"> | ||
5154 | <span class="operation-name">DELETE</span> | ||
5155 | <span class="operation-path">/video-channels/{id}</span> | ||
5156 | </span> | ||
5157 | </h2> | ||
5158 | <div class="doc-row"> | ||
5159 | <div class="doc-copy"> | ||
5160 | <section class="swagger-request-params"> | ||
5161 | <div class="prop-row prop-group"> | ||
5162 | <div class="prop-name"> | ||
5163 | <div class="prop-title">id: | ||
5164 | <span class="prop-type"> | ||
5165 | <span class="json-property-type">string</span> | ||
5166 | <span class="json-property-range" title="Value limits"></span> | ||
5167 | </span> | ||
5168 | </div> | ||
5169 | <span class="json-property-required"></span> | ||
5170 | <div class="prop-subtitle"> in path </div> | ||
5171 | </div> | ||
5172 | <div class="prop-value"> | ||
5173 | <p>The video channel id or uuid</p> | ||
5174 | </div> | ||
5175 | </div> | ||
5176 | </section> | ||
5177 | </div> | ||
5178 | <div class="doc-examples"></div> | ||
5179 | </div> | ||
5180 | <div class="doc-row"> | ||
5181 | <div class="doc-copy"> | ||
5182 | <section class="swagger-responses"> | ||
5183 | <div class="prop-row prop-group"> | ||
5184 | <div class="prop-name"> | ||
5185 | <div class="prop-title">204 No Content</div> | ||
5186 | </div> | ||
5187 | <div class="prop-value"> | ||
5188 | <p>Successful operation</p> | ||
5189 | </div> | ||
5190 | </div> | ||
5191 | </section> | ||
5192 | </div> | ||
5193 | <div class="doc-examples"> | ||
5194 | <h5>Response Content-Types: | ||
5195 | <span>application/json</span> | ||
5196 | </h5> | ||
5197 | </div> | ||
5198 | </div> | ||
5199 | <div class="doc-row"> | ||
5200 | <div class="doc-copy"> | ||
5201 | <section class="swagger-request-security"> | ||
5202 | <table class="table"> | ||
5203 | <thead> | ||
5204 | <tr> | ||
5205 | <th class="swagger-request-security-schema"></th> | ||
5206 | <th class="swagger-request-security-scopes"></th> | ||
5207 | </tr> | ||
5208 | </thead> | ||
5209 | <tbody> | ||
5210 | <tr> | ||
5211 | <td> | ||
5212 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
5213 | </td> | ||
5214 | <td> </td> | ||
5215 | </tr> | ||
5216 | </tbody> | ||
5217 | </table> | ||
5218 | </section> | ||
5219 | </div> | ||
5220 | </div> | ||
5221 | </div> | ||
5222 | <div id="operation--video-channels--id--videos-get" class="operation panel" data-traverse-target="operation--video-channels--id--videos-get"> | ||
5223 | <!-- <section class="operation-tags row"> --> | ||
5224 | <!-- <div class="doc-copy"> --> | ||
5225 | <div class="operation-tags"> | ||
5226 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | ||
5227 | <!----> | ||
5228 | </div> | ||
5229 | <!-- </div> --> | ||
5230 | <!-- </section> --> | ||
5231 | <h2 class="operation-title"> | ||
5232 | <span class="operation-name"> | ||
5233 | <span class="operation-name">GET</span> | ||
5234 | <span class="operation-path">/video-channels/{id}/videos</span> | ||
5235 | </span> | ||
5236 | </h2> | ||
5237 | <div class="doc-row"> | ||
5238 | <div class="doc-copy"> | ||
5239 | <section class="swagger-request-params"> | ||
5240 | <div class="prop-row prop-group"> | ||
5241 | <div class="prop-name"> | ||
5242 | <div class="prop-title">id: | ||
5243 | <span class="prop-type"> | ||
5244 | <span class="json-property-type">string</span> | ||
5245 | <span class="json-property-range" title="Value limits"></span> | ||
5246 | </span> | ||
5247 | </div> | ||
5248 | <span class="json-property-required"></span> | ||
5249 | <div class="prop-subtitle"> in path </div> | ||
5250 | </div> | ||
5251 | <div class="prop-value"> | ||
5252 | <p>The video channel id or uuid</p> | ||
5253 | </div> | ||
5254 | </div> | ||
5255 | </section> | ||
5256 | </div> | ||
5257 | <div class="doc-examples"></div> | ||
5258 | </div> | ||
5259 | <div class="doc-row"> | ||
5260 | <div class="doc-copy"> | ||
5261 | <section class="swagger-responses"> | ||
5262 | <div class="prop-row prop-group"> | ||
5263 | <div class="prop-name"> | ||
5264 | <div class="prop-title">200 OK</div> | ||
5265 | <div class="prop-ref"> | ||
5266 | <span class=""> | ||
5267 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | ||
5268 | </span> | ||
5269 | </div> | ||
5270 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
5271 | </div> | ||
5272 | <div class="prop-value"> | ||
5273 | <p>successful operation</p> | ||
5274 | </div> | ||
5275 | </div> | ||
5276 | </section> | ||
5277 | </div> | ||
5278 | <div class="doc-examples"> | ||
5279 | <h5>Response Content-Types: | ||
5280 | <span>application/json</span> | ||
5281 | </h5> | ||
5282 | <section> | ||
5283 | <h5>Response Example | ||
5284 | <span>(200 OK)</span> | ||
5285 | </h5> | ||
5286 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
5287 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5288 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
5289 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5290 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5291 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5292 | <span class="hljs-attr">"category"</span>: { | ||
5293 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5294 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
5295 | }, | ||
5296 | <span class="hljs-attr">"licence"</span>: { | ||
5297 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5298 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
5299 | }, | ||
5300 | <span class="hljs-attr">"language"</span>: { | ||
5301 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
5302 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
5303 | }, | ||
5304 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | ||
5305 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
5306 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | ||
5307 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
5308 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5309 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | ||
5310 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | ||
5311 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | ||
5312 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | ||
5313 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | ||
5314 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | ||
5315 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | ||
5316 | <span class="hljs-attr">"account"</span>: { | ||
5317 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5318 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
5319 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5320 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
5321 | <span class="hljs-attr">"avatar"</span>: { | ||
5322 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
5323 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5324 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
5325 | } | ||
5326 | } | ||
5327 | } | ||
5328 | </code></pre> | ||
5329 | <!-- </div> --> | ||
5330 | </section> | ||
5331 | </div> | ||
5332 | </div> | ||
5333 | </div> | ||
5334 | <div id="operation--accounts--name--video-channels-get" class="operation panel" data-traverse-target="operation--accounts--name--video-channels-get"> | ||
5335 | <!-- <section class="operation-tags row"> --> | ||
5336 | <!-- <div class="doc-copy"> --> | ||
5337 | <div class="operation-tags"> | ||
5338 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | ||
5339 | <!----> | ||
5340 | </div> | ||
5341 | <!-- </div> --> | ||
5342 | <!-- </section> --> | ||
5343 | <h2 class="operation-title"> | ||
5344 | <span class="operation-name"> | ||
5345 | <span class="operation-name">GET</span> | ||
5346 | <span class="operation-path">/accounts/{name}/video-channels</span> | ||
5347 | </span> | ||
5348 | </h2> | ||
5349 | <div class="doc-row"> | ||
5350 | <div class="doc-copy"> | ||
5351 | <section class="swagger-request-params"> | ||
5352 | <div class="prop-row prop-group"> | ||
5353 | <div class="prop-name"> | ||
5354 | <div class="prop-title">name: | ||
5355 | <span class="prop-type"> | ||
5356 | <span class="json-property-type">string</span> | ||
5357 | <span class="json-property-range" title="Value limits"></span> | ||
5358 | </span> | ||
5359 | </div> | ||
5360 | <span class="json-property-required"></span> | ||
5361 | <div class="prop-subtitle"> in path </div> | ||
5362 | </div> | ||
5363 | <div class="prop-value"> | ||
5364 | <p>The name of the account (chocobozzz or | ||
5365 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | ||
5366 | </div> | ||
5367 | </div> | ||
5368 | </section> | ||
5369 | </div> | ||
5370 | <div class="doc-examples"></div> | ||
5371 | </div> | ||
5372 | <div class="doc-row"> | ||
5373 | <div class="doc-copy"> | ||
5374 | <section class="swagger-responses"> | ||
5375 | <div class="prop-row prop-group"> | ||
5376 | <div class="prop-name"> | ||
5377 | <div class="prop-title">200 OK</div> | ||
5378 | <div class="prop-ref"> | ||
5379 | <span class="json-schema-ref-array"> | ||
5380 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | ||
5381 | </span> | ||
5382 | </div> | ||
5383 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
5384 | </div> | ||
5385 | <div class="prop-value"> | ||
5386 | <p>successful operation</p> | ||
5387 | </div> | ||
5388 | </div> | ||
5389 | <div class="prop-row prop-inner"> | ||
5390 | <div class="prop-name">type</div> | ||
5391 | <div class="prop-value"> | ||
5392 | <span class="json-property-type"> | ||
5393 | <span class="json-schema-ref-array"> | ||
5394 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | ||
5395 | </span> | ||
5396 | </span> | ||
5397 | <span class="json-property-range" title="Value limits"></span> | ||
5398 | </div> | ||
5399 | </div> | ||
5400 | </section> | ||
5401 | </div> | ||
5402 | <div class="doc-examples"> | ||
5403 | <h5>Response Content-Types: | ||
5404 | <span>application/json</span> | ||
5405 | </h5> | ||
5406 | <section> | ||
5407 | <h5>Response Example | ||
5408 | <span>(200 OK)</span> | ||
5409 | </h5> | ||
5410 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
5411 | { | ||
5412 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
5413 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
5414 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
5415 | <span class="hljs-attr">"ownerAccount"</span>: { | ||
5416 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5417 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | ||
5418 | } | ||
5419 | } | ||
5420 | ] | ||
5421 | </code></pre> | ||
5422 | <!-- </div> --> | ||
5423 | </section> | ||
5424 | </div> | ||
5425 | </div> | ||
5426 | </div> | ||
5427 | <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1> | ||
5428 | <div id="operation--videos--id--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--id--comment-threads-get"> | ||
5429 | <!-- <section class="operation-tags row"> --> | ||
5430 | <!-- <div class="doc-copy"> --> | ||
5431 | <div class="operation-tags"> | ||
5432 | <a class="label" href="#tag-VideoComment">VideoComment</a> | ||
5433 | <!----> | ||
5434 | </div> | ||
5435 | <!-- </div> --> | ||
5436 | <!-- </section> --> | ||
5437 | <h2 class="operation-title"> | ||
5438 | <span class="operation-name"> | ||
5439 | <span class="operation-name">GET</span> | ||
5440 | <span class="operation-path">/videos/{id}/comment-threads</span> | ||
5441 | </span> | ||
5442 | </h2> | ||
5443 | <div class="doc-row"> | ||
5444 | <div class="doc-copy"> | ||
5445 | <section class="swagger-request-params"> | ||
5446 | <div class="prop-row prop-group"> | ||
5447 | <div class="prop-name"> | ||
5448 | <div class="prop-title">id: | ||
5449 | <span class="prop-type"> | ||
5450 | <span class="json-property-type">string</span> | ||
5451 | <span class="json-property-range" title="Value limits"></span> | ||
5452 | </span> | ||
5453 | </div> | ||
5454 | <span class="json-property-required"></span> | ||
5455 | <div class="prop-subtitle"> in path </div> | ||
5456 | </div> | ||
5457 | <div class="prop-value"> | ||
5458 | <p>The video id or uuid</p> | ||
5459 | </div> | ||
5460 | </div> | ||
5461 | <div class="prop-row prop-group"> | ||
5462 | <div class="prop-name"> | ||
5463 | <div class="prop-title">start: | ||
5464 | <span class="prop-type"> | ||
5465 | <span class="json-property-type">number</span> | ||
5466 | <span class="json-property-range" title="Value limits"></span> | ||
5467 | </span> | ||
5468 | </div> | ||
5469 | <div class="prop-subtitle"> in query </div> | ||
5470 | </div> | ||
5471 | <div class="prop-value"> | ||
5472 | <p>Offset</p> | ||
5473 | </div> | ||
5474 | </div> | ||
5475 | <div class="prop-row prop-group"> | ||
5476 | <div class="prop-name"> | ||
5477 | <div class="prop-title">count: | ||
5478 | <span class="prop-type"> | ||
5479 | <span class="json-property-type">number</span> | ||
5480 | <span class="json-property-range" title="Value limits"></span> | ||
5481 | </span> | ||
5482 | </div> | ||
5483 | <div class="prop-subtitle"> in query </div> | ||
5484 | </div> | ||
5485 | <div class="prop-value"> | ||
5486 | <p>Number of items</p> | ||
5487 | </div> | ||
5488 | </div> | ||
5489 | <div class="prop-row prop-group"> | ||
5490 | <div class="prop-name"> | ||
5491 | <div class="prop-title">sort: | ||
5492 | <span class="prop-type"> | ||
5493 | <span class="json-property-type">string</span> | ||
5494 | <span class="json-property-range" title="Value limits"></span> | ||
5495 | </span> | ||
5496 | </div> | ||
5497 | <div class="prop-subtitle"> in query </div> | ||
5498 | </div> | ||
5499 | <div class="prop-value"> | ||
5500 | <p>Sort column (-createdAt for example)</p> | ||
5501 | </div> | ||
5502 | </div> | ||
5503 | </section> | ||
5504 | </div> | ||
5505 | <div class="doc-examples"></div> | ||
5506 | </div> | ||
5507 | <div class="doc-row"> | ||
5508 | <div class="doc-copy"> | ||
5509 | <section class="swagger-responses"> | ||
5510 | <div class="prop-row prop-group"> | ||
5511 | <div class="prop-name"> | ||
5512 | <div class="prop-title">200 OK</div> | ||
5513 | <div class="prop-ref"> | ||
5514 | <span class=""> | ||
5515 | <a class="json-schema-ref" href="#/definitions/CommentThreadResponse">CommentThreadResponse</a> | ||
5516 | </span> | ||
5517 | </div> | ||
5518 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
5519 | </div> | ||
5520 | <div class="prop-value"> | ||
5521 | <p>successful operation</p> | ||
5522 | </div> | ||
5523 | </div> | ||
5524 | </section> | ||
5525 | </div> | ||
5526 | <div class="doc-examples"> | ||
5527 | <h5>Response Content-Types: | ||
5528 | <span>application/json</span> | ||
5529 | </h5> | ||
5530 | <section> | ||
5531 | <h5>Response Example | ||
5532 | <span>(200 OK)</span> | ||
5533 | </h5> | ||
5534 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
5535 | <span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>, | ||
5536 | <span class="hljs-attr">"data"</span>: [ | ||
5537 | { | ||
5538 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5539 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5540 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | ||
5541 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | ||
5542 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | ||
5543 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
5544 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5545 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5546 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | ||
5547 | <span class="hljs-attr">"account"</span>: { | ||
5548 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
5549 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5550 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
5551 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5552 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5553 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
5554 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
5555 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
5556 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5557 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5558 | <span class="hljs-attr">"avatar"</span>: { | ||
5559 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
5560 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5561 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
5562 | } | ||
5563 | } | ||
5564 | } | ||
5565 | ] | ||
5566 | } | ||
5567 | </code></pre> | ||
5568 | <!-- </div> --> | ||
5569 | </section> | ||
5570 | </div> | ||
5571 | </div> | ||
5572 | </div> | ||
5573 | <div id="operation--videos--id--comment-threads-post" class="operation panel" data-traverse-target="operation--videos--id--comment-threads-post"> | ||
5574 | <!-- <section class="operation-tags row"> --> | ||
5575 | <!-- <div class="doc-copy"> --> | ||
5576 | <div class="operation-tags"> | ||
5577 | <a class="label" href="#tag-VideoComment">VideoComment</a> | ||
5578 | <!----> | ||
5579 | </div> | ||
5580 | <!-- </div> --> | ||
5581 | <!-- </section> --> | ||
5582 | <h2 class="operation-title"> | ||
5583 | <span class="operation-name"> | ||
5584 | <span class="operation-name">POST</span> | ||
5585 | <span class="operation-path">/videos/{id}/comment-threads</span> | ||
5586 | </span> | ||
5587 | </h2> | ||
5588 | <div class="doc-row"> | ||
5589 | <div class="doc-copy"> | ||
5590 | <section class="swagger-request-params"> | ||
5591 | <div class="prop-row prop-group"> | ||
5592 | <div class="prop-name"> | ||
5593 | <div class="prop-title">id: | ||
5594 | <span class="prop-type"> | ||
5595 | <span class="json-property-type">string</span> | ||
5596 | <span class="json-property-range" title="Value limits"></span> | ||
5597 | </span> | ||
5598 | </div> | ||
5599 | <span class="json-property-required"></span> | ||
5600 | <div class="prop-subtitle"> in path </div> | ||
5601 | </div> | ||
5602 | <div class="prop-value"> | ||
5603 | <p>The video id or uuid</p> | ||
5604 | </div> | ||
5605 | </div> | ||
5606 | </section> | ||
5607 | </div> | ||
5608 | <div class="doc-examples"></div> | ||
5609 | </div> | ||
5610 | <div class="doc-row"> | ||
5611 | <div class="doc-copy"> | ||
5612 | <section class="swagger-responses"> | ||
5613 | <div class="prop-row prop-group"> | ||
5614 | <div class="prop-name"> | ||
5615 | <div class="prop-title">200 OK</div> | ||
5616 | <div class="prop-ref"> | ||
5617 | <span class=""> | ||
5618 | <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a> | ||
5619 | </span> | ||
5620 | </div> | ||
5621 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
5622 | </div> | ||
5623 | <div class="prop-value"> | ||
5624 | <p>successful operation</p> | ||
5625 | </div> | ||
5626 | </div> | ||
5627 | </section> | ||
5628 | </div> | ||
5629 | <div class="doc-examples"> | ||
5630 | <h5>Response Content-Types: | ||
5631 | <span>application/json</span> | ||
5632 | </h5> | ||
5633 | <section> | ||
5634 | <h5>Response Example | ||
5635 | <span>(200 OK)</span> | ||
5636 | </h5> | ||
5637 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
5638 | <span class="hljs-attr">"comment"</span>: { | ||
5639 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5640 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5641 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | ||
5642 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | ||
5643 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | ||
5644 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
5645 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5646 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5647 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | ||
5648 | <span class="hljs-attr">"account"</span>: { | ||
5649 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
5650 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5651 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
5652 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5653 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5654 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
5655 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
5656 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
5657 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5658 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5659 | <span class="hljs-attr">"avatar"</span>: { | ||
5660 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
5661 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5662 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
5663 | } | ||
5664 | } | ||
5665 | } | ||
5666 | } | ||
5667 | </code></pre> | ||
5668 | <!-- </div> --> | ||
5669 | </section> | ||
5670 | </div> | ||
5671 | </div> | ||
5672 | <div class="doc-row"> | ||
5673 | <div class="doc-copy"> | ||
5674 | <section class="swagger-request-security"> | ||
5675 | <table class="table"> | ||
5676 | <thead> | ||
5677 | <tr> | ||
5678 | <th class="swagger-request-security-schema"></th> | ||
5679 | <th class="swagger-request-security-scopes"></th> | ||
5680 | </tr> | ||
5681 | </thead> | ||
5682 | <tbody> | ||
5683 | <tr> | ||
5684 | <td> | ||
5685 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
5686 | </td> | ||
5687 | <td> </td> | ||
5688 | </tr> | ||
5689 | </tbody> | ||
5690 | </table> | ||
5691 | </section> | ||
5692 | </div> | ||
5693 | </div> | ||
5694 | </div> | ||
5695 | <div id="operation--videos--id--comment-threads--threadId--get" class="operation panel" data-traverse-target="operation--videos--id--comment-threads--threadId--get"> | ||
5696 | <!-- <section class="operation-tags row"> --> | ||
5697 | <!-- <div class="doc-copy"> --> | ||
5698 | <div class="operation-tags"> | ||
5699 | <a class="label" href="#tag-VideoComment">VideoComment</a> | ||
5700 | <!----> | ||
5701 | </div> | ||
5702 | <!-- </div> --> | ||
5703 | <!-- </section> --> | ||
5704 | <h2 class="operation-title"> | ||
5705 | <span class="operation-name"> | ||
5706 | <span class="operation-name">GET</span> | ||
5707 | <span class="operation-path">/videos/{id}/comment-threads/{threadId}</span> | ||
5708 | </span> | ||
5709 | </h2> | ||
5710 | <div class="doc-row"> | ||
5711 | <div class="doc-copy"> | ||
5712 | <section class="swagger-request-params"> | ||
5713 | <div class="prop-row prop-group"> | ||
5714 | <div class="prop-name"> | ||
5715 | <div class="prop-title">id: | ||
5716 | <span class="prop-type"> | ||
5717 | <span class="json-property-type">string</span> | ||
5718 | <span class="json-property-range" title="Value limits"></span> | ||
5719 | </span> | ||
5720 | </div> | ||
5721 | <span class="json-property-required"></span> | ||
5722 | <div class="prop-subtitle"> in path </div> | ||
5723 | </div> | ||
5724 | <div class="prop-value"> | ||
5725 | <p>The video id or uuid</p> | ||
5726 | </div> | ||
5727 | </div> | ||
5728 | <div class="prop-row prop-group"> | ||
5729 | <div class="prop-name"> | ||
5730 | <div class="prop-title">threadId: | ||
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> | ||
5739 | <div class="prop-value"> | ||
5740 | <p>The thread id (root comment id)</p> | ||
5741 | </div> | ||
5742 | </div> | ||
5743 | </section> | ||
5744 | </div> | ||
5745 | <div class="doc-examples"></div> | ||
5746 | </div> | ||
5747 | <div class="doc-row"> | ||
5748 | <div class="doc-copy"> | ||
5749 | <section class="swagger-responses"> | ||
5750 | <div class="prop-row prop-group"> | ||
5751 | <div class="prop-name"> | ||
5752 | <div class="prop-title">200 OK</div> | ||
5753 | <div class="prop-ref"> | ||
5754 | <span class=""> | ||
5755 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | ||
5756 | </span> | ||
5757 | </div> | ||
5758 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
5759 | </div> | ||
5760 | <div class="prop-value"> | ||
5761 | <p>successful operation</p> | ||
5762 | </div> | ||
5763 | </div> | ||
5764 | </section> | ||
5765 | </div> | ||
5766 | <div class="doc-examples"> | ||
5767 | <h5>Response Content-Types: | ||
5768 | <span>application/json</span> | ||
5769 | </h5> | ||
5770 | <section> | ||
5771 | <h5>Response Example | ||
5772 | <span>(200 OK)</span> | ||
5773 | </h5> | ||
5774 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
5775 | <span class="hljs-attr">"comment"</span>: { | ||
5776 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5777 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5778 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | ||
5779 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | ||
5780 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | ||
5781 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
5782 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5783 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5784 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | ||
5785 | <span class="hljs-attr">"account"</span>: { | ||
5786 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
5787 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5788 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
5789 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5790 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5791 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
5792 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
5793 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
5794 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5795 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5796 | <span class="hljs-attr">"avatar"</span>: { | ||
5797 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
5798 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5799 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
5800 | } | ||
5801 | } | ||
5802 | }, | ||
5803 | <span class="hljs-attr">"children"</span>: [ | ||
5804 | { | ||
5805 | <span class="hljs-attr">"comment"</span>: { | ||
5806 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5807 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5808 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | ||
5809 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | ||
5810 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | ||
5811 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
5812 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5813 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5814 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | ||
5815 | <span class="hljs-attr">"account"</span>: { | ||
5816 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
5817 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5818 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
5819 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5820 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5821 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
5822 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
5823 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
5824 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5825 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5826 | <span class="hljs-attr">"avatar"</span>: { | ||
5827 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
5828 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5829 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
5830 | } | ||
5831 | } | ||
5832 | }, | ||
5833 | <span class="hljs-attr">"children"</span>: [ | ||
5834 | { | ||
5835 | <span class="hljs-attr">"comment"</span>: { | ||
5836 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5837 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5838 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | ||
5839 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | ||
5840 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | ||
5841 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
5842 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5843 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5844 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | ||
5845 | <span class="hljs-attr">"account"</span>: { | ||
5846 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5847 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
5848 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5849 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5850 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
5851 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
5852 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
5853 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5854 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5855 | <span class="hljs-attr">"avatar"</span>: { | ||
5856 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
5857 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5858 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
5859 | } | ||
5860 | } | ||
5861 | } | ||
5862 | } | ||
5863 | ] | ||
5864 | } | ||
5865 | ] | ||
5866 | } | ||
5867 | </code></pre> | ||
5868 | <!-- </div> --> | ||
5869 | </section> | ||
5870 | </div> | ||
5871 | </div> | ||
5872 | </div> | ||
5873 | <div id="operation--videos--id--comments--commentId--post" class="operation panel" data-traverse-target="operation--videos--id--comments--commentId--post"> | ||
5874 | <!-- <section class="operation-tags row"> --> | ||
5875 | <!-- <div class="doc-copy"> --> | ||
5876 | <div class="operation-tags"> | ||
5877 | <a class="label" href="#tag-VideoComment">VideoComment</a> | ||
5878 | <!----> | ||
5879 | </div> | ||
5880 | <!-- </div> --> | ||
5881 | <!-- </section> --> | ||
5882 | <h2 class="operation-title"> | ||
5883 | <span class="operation-name"> | ||
5884 | <span class="operation-name">POST</span> | ||
5885 | <span class="operation-path">/videos/{id}/comments/{commentId}</span> | ||
5886 | </span> | ||
5887 | </h2> | ||
5888 | <div class="doc-row"> | ||
5889 | <div class="doc-copy"> | ||
5890 | <section class="swagger-request-params"> | ||
5891 | <div class="prop-row prop-group"> | ||
5892 | <div class="prop-name"> | ||
5893 | <div class="prop-title">id: | ||
5894 | <span class="prop-type"> | ||
5895 | <span class="json-property-type">string</span> | ||
5896 | <span class="json-property-range" title="Value limits"></span> | ||
5897 | </span> | ||
5898 | </div> | ||
5899 | <span class="json-property-required"></span> | ||
5900 | <div class="prop-subtitle"> in path </div> | ||
5901 | </div> | ||
5902 | <div class="prop-value"> | ||
5903 | <p>The video id or uuid</p> | ||
5904 | </div> | ||
5905 | </div> | ||
5906 | <div class="prop-row prop-group"> | ||
5907 | <div class="prop-name"> | ||
5908 | <div class="prop-title">threadId: | ||
5909 | <span class="prop-type"> | ||
5910 | <span class="json-property-type">number</span> | ||
5911 | <span class="json-property-range" title="Value limits"></span> | ||
5912 | </span> | ||
5913 | </div> | ||
5914 | <span class="json-property-required"></span> | ||
5915 | <div class="prop-subtitle"> in path </div> | ||
5916 | </div> | ||
5917 | <div class="prop-value"> | ||
5918 | <p>The comment id</p> | ||
5919 | </div> | ||
5920 | </div> | ||
5921 | </section> | ||
5922 | </div> | ||
5923 | <div class="doc-examples"></div> | ||
5924 | </div> | ||
5925 | <div class="doc-row"> | ||
5926 | <div class="doc-copy"> | ||
5927 | <section class="swagger-responses"> | ||
5928 | <div class="prop-row prop-group"> | ||
5929 | <div class="prop-name"> | ||
5930 | <div class="prop-title">200 OK</div> | ||
5931 | <div class="prop-ref"> | ||
5932 | <span class=""> | ||
5933 | <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a> | ||
5934 | </span> | ||
5935 | </div> | ||
5936 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
5937 | </div> | ||
5938 | <div class="prop-value"> | ||
5939 | <p>successful operation</p> | ||
5940 | </div> | ||
5941 | </div> | ||
5942 | </section> | ||
5943 | </div> | ||
5944 | <div class="doc-examples"> | ||
5945 | <h5>Response Content-Types: | ||
5946 | <span>application/json</span> | ||
5947 | </h5> | ||
5948 | <section> | ||
5949 | <h5>Response Example | ||
5950 | <span>(200 OK)</span> | ||
5951 | </h5> | ||
5952 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
5953 | <span class="hljs-attr">"comment"</span>: { | ||
5954 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5955 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5956 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | ||
5957 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | ||
5958 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | ||
5959 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
5960 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5961 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5962 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | ||
5963 | <span class="hljs-attr">"account"</span>: { | ||
5964 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
5965 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
5966 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
5967 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
5968 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
5969 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
5970 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
5971 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
5972 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5973 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
5974 | <span class="hljs-attr">"avatar"</span>: { | ||
5975 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
5976 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
5977 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
5978 | } | ||
5979 | } | ||
5980 | } | ||
5981 | } | ||
5982 | </code></pre> | ||
5983 | <!-- </div> --> | ||
5984 | </section> | ||
5985 | </div> | ||
5986 | </div> | ||
5987 | <div class="doc-row"> | ||
5988 | <div class="doc-copy"> | ||
5989 | <section class="swagger-request-security"> | ||
5990 | <table class="table"> | ||
5991 | <thead> | ||
5992 | <tr> | ||
5993 | <th class="swagger-request-security-schema"></th> | ||
5994 | <th class="swagger-request-security-scopes"></th> | ||
5995 | </tr> | ||
5996 | </thead> | ||
5997 | <tbody> | ||
5998 | <tr> | ||
5999 | <td> | ||
6000 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
6001 | </td> | ||
6002 | <td> </td> | ||
6003 | </tr> | ||
6004 | </tbody> | ||
6005 | </table> | ||
6006 | </section> | ||
6007 | </div> | ||
6008 | </div> | ||
6009 | </div> | ||
6010 | <div id="operation--videos--id--comments--commentId--delete" class="operation panel" data-traverse-target="operation--videos--id--comments--commentId--delete"> | ||
6011 | <!-- <section class="operation-tags row"> --> | ||
6012 | <!-- <div class="doc-copy"> --> | ||
6013 | <div class="operation-tags"> | ||
6014 | <a class="label" href="#tag-VideoComment">VideoComment</a> | ||
6015 | <!----> | ||
6016 | </div> | ||
6017 | <!-- </div> --> | ||
6018 | <!-- </section> --> | ||
6019 | <h2 class="operation-title"> | ||
6020 | <span class="operation-name"> | ||
6021 | <span class="operation-name">DELETE</span> | ||
6022 | <span class="operation-path">/videos/{id}/comments/{commentId}</span> | ||
6023 | </span> | ||
6024 | </h2> | ||
6025 | <div class="doc-row"> | ||
6026 | <div class="doc-copy"> | ||
6027 | <section class="swagger-request-params"> | ||
6028 | <div class="prop-row prop-group"> | ||
6029 | <div class="prop-name"> | ||
6030 | <div class="prop-title">id: | ||
6031 | <span class="prop-type"> | ||
6032 | <span class="json-property-type">string</span> | ||
6033 | <span class="json-property-range" title="Value limits"></span> | ||
6034 | </span> | ||
6035 | </div> | ||
6036 | <span class="json-property-required"></span> | ||
6037 | <div class="prop-subtitle"> in path </div> | ||
6038 | </div> | ||
6039 | <div class="prop-value"> | ||
6040 | <p>The video id or uuid</p> | ||
6041 | </div> | ||
6042 | </div> | ||
6043 | <div class="prop-row prop-group"> | ||
6044 | <div class="prop-name"> | ||
6045 | <div class="prop-title">threadId: | ||
6046 | <span class="prop-type"> | ||
6047 | <span class="json-property-type">number</span> | ||
6048 | <span class="json-property-range" title="Value limits"></span> | ||
6049 | </span> | ||
6050 | </div> | ||
6051 | <span class="json-property-required"></span> | ||
6052 | <div class="prop-subtitle"> in path </div> | ||
6053 | </div> | ||
6054 | <div class="prop-value"> | ||
6055 | <p>The comment id</p> | ||
6056 | </div> | ||
6057 | </div> | ||
6058 | </section> | ||
6059 | </div> | ||
6060 | <div class="doc-examples"></div> | ||
6061 | </div> | ||
6062 | <div class="doc-row"> | ||
6063 | <div class="doc-copy"> | ||
6064 | <section class="swagger-responses"> | ||
6065 | <div class="prop-row prop-group"> | ||
6066 | <div class="prop-name"> | ||
6067 | <div class="prop-title">204 No Content</div> | ||
6068 | </div> | ||
6069 | <div class="prop-value"> | ||
6070 | <p>Successful operation</p> | ||
6071 | </div> | ||
6072 | </div> | ||
6073 | </section> | ||
6074 | </div> | ||
6075 | <div class="doc-examples"> | ||
6076 | <h5>Response Content-Types: | ||
6077 | <span>application/json</span> | ||
6078 | </h5> | ||
6079 | </div> | ||
6080 | </div> | ||
6081 | <div class="doc-row"> | ||
6082 | <div class="doc-copy"> | ||
6083 | <section class="swagger-request-security"> | ||
6084 | <table class="table"> | ||
6085 | <thead> | ||
6086 | <tr> | ||
6087 | <th class="swagger-request-security-schema"></th> | ||
6088 | <th class="swagger-request-security-scopes"></th> | ||
6089 | </tr> | ||
6090 | </thead> | ||
6091 | <tbody> | ||
6092 | <tr> | ||
6093 | <td> | ||
6094 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
6095 | </td> | ||
6096 | <td> </td> | ||
6097 | </tr> | ||
6098 | </tbody> | ||
6099 | </table> | ||
6100 | </section> | ||
6101 | </div> | ||
6102 | </div> | ||
6103 | </div> | ||
6104 | <h1 id="tag-VideoRate" class="swagger-summary-tag" data-traverse-target="tag-VideoRate">VideoRate</h1> | ||
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"> --> | ||
6107 | <!-- <div class="doc-copy"> --> | ||
6108 | <div class="operation-tags"> | ||
6109 | <a class="label" href="#tag-VideoRate">VideoRate</a> | ||
6110 | <!----> | ||
6111 | </div> | ||
6112 | <!-- </div> --> | ||
6113 | <!-- </section> --> | ||
6114 | <h2 class="operation-title"> | ||
6115 | <span class="operation-name"> | ||
6116 | <span class="operation-name">PUT</span> | ||
6117 | <span class="operation-path">/videos/{id}/rate</span> | ||
6118 | </span> | ||
6119 | </h2> | ||
6120 | <div class="doc-row"> | ||
6121 | <div class="doc-copy"> | ||
6122 | <section class="swagger-request-params"> | ||
6123 | <div class="prop-row prop-group"> | ||
6124 | <div class="prop-name"> | ||
6125 | <div class="prop-title">id: | ||
6126 | <span class="prop-type"> | ||
6127 | <span class="json-property-type">string</span> | ||
6128 | <span class="json-property-range" title="Value limits"></span> | ||
6129 | </span> | ||
6130 | </div> | ||
6131 | <span class="json-property-required"></span> | ||
6132 | <div class="prop-subtitle"> in path </div> | ||
6133 | </div> | ||
6134 | <div class="prop-value"> | ||
6135 | <p>The video id or uuid</p> | ||
6136 | </div> | ||
6137 | </div> | ||
6138 | </section> | ||
6139 | </div> | ||
6140 | <div class="doc-examples"></div> | ||
6141 | </div> | ||
6142 | <div class="doc-row"> | ||
6143 | <div class="doc-copy"> | ||
6144 | <section class="swagger-responses"> | ||
6145 | <div class="prop-row prop-group"> | ||
6146 | <div class="prop-name"> | ||
6147 | <div class="prop-title">204 No Content</div> | ||
6148 | </div> | ||
6149 | <div class="prop-value"> | ||
6150 | <p>Successful operation</p> | ||
6151 | </div> | ||
6152 | </div> | ||
6153 | </section> | ||
6154 | </div> | ||
6155 | <div class="doc-examples"> | ||
6156 | <h5>Response Content-Types: | ||
6157 | <span>application/json</span> | ||
6158 | </h5> | ||
6159 | </div> | ||
6160 | </div> | ||
6161 | <div class="doc-row"> | ||
6162 | <div class="doc-copy"> | ||
6163 | <section class="swagger-request-security"> | ||
6164 | <table class="table"> | ||
6165 | <thead> | ||
6166 | <tr> | ||
6167 | <th class="swagger-request-security-schema"></th> | ||
6168 | <th class="swagger-request-security-scopes"></th> | ||
6169 | </tr> | ||
6170 | </thead> | ||
6171 | <tbody> | ||
6172 | <tr> | ||
6173 | <td> | ||
6174 | <a href="#security-definition-OAuth2">OAuth2</a> | ||
6175 | </td> | ||
6176 | <td> </td> | ||
6177 | </tr> | ||
6178 | </tbody> | ||
6179 | </table> | ||
6180 | </section> | ||
6181 | </div> | ||
6182 | </div> | ||
6183 | </div> | ||
6184 | <h1 id="tag-Search" class="swagger-summary-tag" data-traverse-target="tag-Search">Search</h1> | ||
6185 | <div id="operation--search-videos-get" class="operation panel" data-traverse-target="operation--search-videos-get"> | ||
6186 | <!-- <section class="operation-tags row"> --> | ||
6187 | <!-- <div class="doc-copy"> --> | ||
6188 | <div class="operation-tags"> | ||
6189 | <a class="label" href="#tag-Search">Search</a> | ||
6190 | <!----> | ||
6191 | </div> | ||
6192 | <!-- </div> --> | ||
6193 | <!-- </section> --> | ||
6194 | <h2 class="operation-title"> | ||
6195 | <span class="operation-name"> | ||
6196 | <span class="operation-name">GET</span> | ||
6197 | <span class="operation-path">/search/videos</span> | ||
6198 | </span> | ||
6199 | </h2> | ||
6200 | <div class="doc-row"> | ||
6201 | <div class="doc-copy"> | ||
6202 | <section class="swagger-request-params"> | ||
6203 | <div class="prop-row prop-group"> | ||
6204 | <div class="prop-name"> | ||
6205 | <div class="prop-title">start: | ||
6206 | <span class="prop-type"> | ||
6207 | <span class="json-property-type">number</span> | ||
6208 | <span class="json-property-range" title="Value limits"></span> | ||
6209 | </span> | ||
6210 | </div> | ||
6211 | <div class="prop-subtitle"> in query </div> | ||
6212 | </div> | ||
6213 | <div class="prop-value"> | ||
6214 | <p>Offset</p> | ||
6215 | </div> | ||
6216 | </div> | ||
6217 | <div class="prop-row prop-group"> | ||
6218 | <div class="prop-name"> | ||
6219 | <div class="prop-title">count: | ||
6220 | <span class="prop-type"> | ||
6221 | <span class="json-property-type">number</span> | ||
6222 | <span class="json-property-range" title="Value limits"></span> | ||
6223 | </span> | ||
6224 | </div> | ||
6225 | <div class="prop-subtitle"> in query </div> | ||
6226 | </div> | ||
6227 | <div class="prop-value"> | ||
6228 | <p>Number of items</p> | ||
6229 | </div> | ||
6230 | </div> | ||
6231 | <div class="prop-row prop-group"> | ||
6232 | <div class="prop-name"> | ||
6233 | <div class="prop-title">sort: | ||
6234 | <span class="prop-type"> | ||
6235 | <span class="json-property-type">string</span> | ||
6236 | <span class="json-property-range" title="Value limits"></span> | ||
6237 | </span> | ||
6238 | </div> | ||
6239 | <div class="prop-subtitle"> in query </div> | ||
6240 | </div> | ||
6241 | <div class="prop-value"> | ||
6242 | <p>Sort column (-createdAt for example)</p> | ||
6243 | </div> | ||
6244 | </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> | ||
6261 | </div> | ||
6262 | <div class="doc-examples"></div> | ||
6263 | </div> | ||
6264 | <div class="doc-row"> | ||
6265 | <div class="doc-copy"> | ||
6266 | <section class="swagger-responses"> | ||
6267 | <div class="prop-row prop-group"> | ||
6268 | <div class="prop-name"> | ||
6269 | <div class="prop-title">200 OK</div> | ||
6270 | <div class="prop-ref"> | ||
6271 | <span class="json-schema-ref-array"> | ||
6272 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | ||
6273 | </span> | ||
6274 | </div> | ||
6275 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | ||
6276 | </div> | ||
6277 | <div class="prop-value"> | ||
6278 | <p>successful operation</p> | ||
6279 | </div> | ||
6280 | </div> | ||
6281 | <div class="prop-row prop-inner"> | ||
6282 | <div class="prop-name">type</div> | ||
6283 | <div class="prop-value"> | ||
6284 | <span class="json-property-type"> | ||
6285 | <span class="json-schema-ref-array"> | ||
6286 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | ||
6287 | </span> | ||
6288 | </span> | ||
6289 | <span class="json-property-range" title="Value limits"></span> | ||
6290 | </div> | ||
6291 | </div> | ||
6292 | </section> | ||
6293 | </div> | ||
6294 | <div class="doc-examples"> | ||
6295 | <h5>Response Content-Types: | ||
6296 | <span>application/json</span> | ||
6297 | </h5> | ||
6298 | <section> | ||
6299 | <h5>Response Example | ||
6300 | <span>(200 OK)</span> | ||
6301 | </h5> | ||
6302 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | ||
6303 | { | ||
6304 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
6305 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
6306 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
6307 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | ||
6308 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
6309 | <span class="hljs-attr">"category"</span>: { | ||
6310 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
6311 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
6312 | }, | ||
6313 | <span class="hljs-attr">"licence"</span>: { | ||
6314 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
6315 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
6316 | }, | ||
6317 | <span class="hljs-attr">"language"</span>: { | ||
6318 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
6319 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
6320 | }, | ||
6321 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | ||
6322 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
6323 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | ||
6324 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
6325 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
6326 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | ||
6327 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | ||
6328 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | ||
6329 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | ||
6330 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | ||
6331 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | ||
6332 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | ||
6333 | <span class="hljs-attr">"account"</span>: { | ||
6334 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
6335 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
6336 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
6337 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
6338 | <span class="hljs-attr">"avatar"</span>: { | ||
6339 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
6340 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
6341 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
6342 | } | ||
6343 | } | ||
6344 | } | ||
6345 | ] | ||
6346 | </code></pre> | ||
6347 | <!-- </div> --> | ||
6348 | </section> | ||
6349 | </div> | ||
6350 | </div> | ||
6351 | </div> | ||
6352 | <h1>Schema Definitions</h1> | ||
6353 | <div id="definition-VideoConstantNumber" class="definition panel" data-traverse-target="definition-VideoConstantNumber"> | ||
6354 | <h2 class="panel-title"> | ||
6355 | <a name="/definitions/VideoConstantNumber"></a>VideoConstantNumber: | ||
6356 | <!-- <span class="json-property-type"> | ||
6357 | <span class="json-property-type">object</span> | ||
6358 | <span class="json-property-range" title="Value limits"></span> | ||
6359 | |||
6360 | |||
6361 | </span> --> | ||
6362 | </h2> | ||
6363 | <div class="doc-row"> | ||
6364 | <div class="doc-copy"> | ||
6365 | <section class="json-schema-properties"> | ||
6366 | <dl> | ||
6367 | <dt data-property-name="id"> | ||
6368 | <span class="json-property-name">id:</span> | ||
6369 | <span class="json-property-type">number</span> | ||
6370 | <span class="json-property-range" title="Value limits"></span> | ||
6371 | </dt> | ||
6372 | <dt data-property-name="label"> | ||
6373 | <span class="json-property-name">label:</span> | ||
6374 | <span class="json-property-type">string</span> | ||
6375 | <span class="json-property-range" title="Value limits"></span> | ||
6376 | </dt> | ||
6377 | </dl> | ||
6378 | </section> | ||
6379 | </div> | ||
6380 | <div class="doc-examples"> | ||
6381 | <section> | ||
6382 | <h5>Example</h5> | ||
6383 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
6384 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
6385 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
6386 | } | ||
6387 | </code></pre> | ||
6388 | <!-- </div> --> | ||
6389 | </section> | ||
6390 | </div> | ||
6391 | </div> | ||
6392 | </div> | ||
6393 | <div id="definition-VideoConstantString" class="definition panel" data-traverse-target="definition-VideoConstantString"> | ||
6394 | <h2 class="panel-title"> | ||
6395 | <a name="/definitions/VideoConstantString"></a>VideoConstantString: | ||
6396 | <!-- <span class="json-property-type"> | ||
6397 | <span class="json-property-type">object</span> | ||
6398 | <span class="json-property-range" title="Value limits"></span> | ||
6399 | |||
6400 | |||
6401 | </span> --> | ||
6402 | </h2> | ||
6403 | <div class="doc-row"> | ||
6404 | <div class="doc-copy"> | ||
6405 | <section class="json-schema-properties"> | ||
6406 | <dl> | ||
6407 | <dt data-property-name="id"> | ||
6408 | <span class="json-property-name">id:</span> | ||
6409 | <span class="json-property-type">string</span> | ||
6410 | <span class="json-property-range" title="Value limits"></span> | ||
6411 | </dt> | ||
6412 | <dt data-property-name="label"> | ||
6413 | <span class="json-property-name">label:</span> | ||
6414 | <span class="json-property-type">string</span> | ||
6415 | <span class="json-property-range" title="Value limits"></span> | ||
6416 | </dt> | ||
6417 | </dl> | ||
6418 | </section> | ||
6419 | </div> | ||
6420 | <div class="doc-examples"> | ||
6421 | <section> | ||
6422 | <h5>Example</h5> | ||
6423 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
6424 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
6425 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
6426 | } | ||
6427 | </code></pre> | ||
6428 | <!-- </div> --> | ||
6429 | </section> | ||
6430 | </div> | ||
6431 | </div> | ||
6432 | </div> | ||
6433 | <div id="definition-VideoPrivacy" class="definition panel" data-traverse-target="definition-VideoPrivacy"> | ||
6434 | <h2 class="panel-title"> | ||
6435 | <a name="/definitions/VideoPrivacy"></a>VideoPrivacy: string | ||
6436 | <!-- <span class="json-property-type"> | ||
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>, | ||
6439 | <span class="json-property-enum-item">Unlisted</span>, | ||
6440 | <span class="json-property-enum-item">Private</span> | ||
6441 | </span> | ||
6442 | <span class="json-property-range" title="Value limits"></span> | ||
6443 | |||
6444 | |||
6445 | </span> --> | ||
6446 | </h2> | ||
6447 | <div class="doc-row"> | ||
6448 | <div class="doc-copy"> | ||
6449 | <span class="json-property-type">string</span> | ||
6450 | <span class="json-property-enum" title="Possible values"> | ||
6451 | <span class="json-property-enum-item">Public</span>, | ||
6452 | <span class="json-property-enum-item">Unlisted</span>, | ||
6453 | <span class="json-property-enum-item">Private</span> | ||
6454 | </span> | ||
6455 | <span class="json-property-range" title="Value limits"></span> | ||
6456 | </div> | ||
6457 | </div> | ||
6458 | </div> | ||
6459 | <div id="definition-Video" class="definition panel" data-traverse-target="definition-Video"> | ||
6460 | <h2 class="panel-title"> | ||
6461 | <a name="/definitions/Video"></a>Video: | ||
6462 | <!-- <span class="json-property-type"> | ||
6463 | <span class="json-property-type">object</span> | ||
6464 | <span class="json-property-range" title="Value limits"></span> | ||
6465 | |||
6466 | |||
6467 | </span> --> | ||
6468 | </h2> | ||
6469 | <div class="doc-row"> | ||
6470 | <div class="doc-copy"> | ||
6471 | <section class="json-schema-properties"> | ||
6472 | <dl> | ||
6473 | <dt data-property-name="id"> | ||
6474 | <span class="json-property-name">id:</span> | ||
6475 | <span class="json-property-type">number</span> | ||
6476 | <span class="json-property-range" title="Value limits"></span> | ||
6477 | </dt> | ||
6478 | <dt data-property-name="uuid"> | ||
6479 | <span class="json-property-name">uuid:</span> | ||
6480 | <span class="json-property-type">string</span> | ||
6481 | <span class="json-property-range" title="Value limits"></span> | ||
6482 | </dt> | ||
6483 | <dt data-property-name="createdAt"> | ||
6484 | <span class="json-property-name">createdAt:</span> | ||
6485 | <span class="json-property-type">string</span> | ||
6486 | <span class="json-property-range" title="Value limits"></span> | ||
6487 | </dt> | ||
6488 | <dt data-property-name="publishedAt"> | ||
6489 | <span class="json-property-name">publishedAt:</span> | ||
6490 | <span class="json-property-type">string</span> | ||
6491 | <span class="json-property-range" title="Value limits"></span> | ||
6492 | </dt> | ||
6493 | <dt data-property-name="updatedAt"> | ||
6494 | <span class="json-property-name">updatedAt:</span> | ||
6495 | <span class="json-property-type">string</span> | ||
6496 | <span class="json-property-range" title="Value limits"></span> | ||
6497 | </dt> | ||
6498 | <dt data-property-name="category"> | ||
6499 | <span class="json-property-name">category:</span> | ||
6500 | <span class="json-property-type"> | ||
6501 | <span class=""> | ||
6502 | <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a> | ||
6503 | </span> | ||
6504 | </span> | ||
6505 | <span class="json-property-range" title="Value limits"></span> | ||
6506 | </dt> | ||
6507 | <dt data-property-name="licence"> | ||
6508 | <span class="json-property-name">licence:</span> | ||
6509 | <span class="json-property-type"> | ||
6510 | <span class=""> | ||
6511 | <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a> | ||
6512 | </span> | ||
6513 | </span> | ||
6514 | <span class="json-property-range" title="Value limits"></span> | ||
6515 | </dt> | ||
6516 | <dt data-property-name="language"> | ||
6517 | <span class="json-property-name">language:</span> | ||
6518 | <span class="json-property-type"> | ||
6519 | <span class=""> | ||
6520 | <a class="json-schema-ref" href="#/definitions/VideoConstantString">VideoConstantString</a> | ||
6521 | </span> | ||
6522 | </span> | ||
6523 | <span class="json-property-range" title="Value limits"></span> | ||
6524 | </dt> | ||
6525 | <dt data-property-name="privacy"> | ||
6526 | <span class="json-property-name">privacy:</span> | ||
6527 | <span class="json-property-type"> | ||
6528 | <span class=""> | ||
6529 | <a class="json-schema-ref" href="#/definitions/VideoPrivacy">VideoPrivacy</a> | ||
6530 | </span> | ||
6531 | </span> | ||
6532 | <span class="json-property-range" title="Value limits"></span> | ||
6533 | </dt> | ||
6534 | <dt data-property-name="description"> | ||
6535 | <span class="json-property-name">description:</span> | ||
6536 | <span class="json-property-type">string</span> | ||
6537 | <span class="json-property-range" title="Value limits"></span> | ||
6538 | </dt> | ||
6539 | <dt data-property-name="duration"> | ||
6540 | <span class="json-property-name">duration:</span> | ||
6541 | <span class="json-property-type">number</span> | ||
6542 | <span class="json-property-range" title="Value limits"></span> | ||
6543 | </dt> | ||
6544 | <dt data-property-name="isLocal"> | ||
6545 | <span class="json-property-name">isLocal:</span> | ||
6546 | <span class="json-property-type">boolean</span> | ||
6547 | <span class="json-property-range" title="Value limits"></span> | ||
6548 | </dt> | ||
6549 | <dt data-property-name="name"> | ||
6550 | <span class="json-property-name">name:</span> | ||
6551 | <span class="json-property-type">string</span> | ||
6552 | <span class="json-property-range" title="Value limits"></span> | ||
6553 | </dt> | ||
6554 | <dt data-property-name="thumbnailPath"> | ||
6555 | <span class="json-property-name">thumbnailPath:</span> | ||
6556 | <span class="json-property-type">string</span> | ||
6557 | <span class="json-property-range" title="Value limits"></span> | ||
6558 | </dt> | ||
6559 | <dt data-property-name="previewPath"> | ||
6560 | <span class="json-property-name">previewPath:</span> | ||
6561 | <span class="json-property-type">string</span> | ||
6562 | <span class="json-property-range" title="Value limits"></span> | ||
6563 | </dt> | ||
6564 | <dt data-property-name="embedPath"> | ||
6565 | <span class="json-property-name">embedPath:</span> | ||
6566 | <span class="json-property-type">string</span> | ||
6567 | <span class="json-property-range" title="Value limits"></span> | ||
6568 | </dt> | ||
6569 | <dt data-property-name="views"> | ||
6570 | <span class="json-property-name">views:</span> | ||
6571 | <span class="json-property-type">number</span> | ||
6572 | <span class="json-property-range" title="Value limits"></span> | ||
6573 | </dt> | ||
6574 | <dt data-property-name="likes"> | ||
6575 | <span class="json-property-name">likes:</span> | ||
6576 | <span class="json-property-type">number</span> | ||
6577 | <span class="json-property-range" title="Value limits"></span> | ||
6578 | </dt> | ||
6579 | <dt data-property-name="dislikes"> | ||
6580 | <span class="json-property-name">dislikes:</span> | ||
6581 | <span class="json-property-type">number</span> | ||
6582 | <span class="json-property-range" title="Value limits"></span> | ||
6583 | </dt> | ||
6584 | <dt data-property-name="nsfw"> | ||
6585 | <span class="json-property-name">nsfw:</span> | ||
6586 | <span class="json-property-type">boolean</span> | ||
6587 | <span class="json-property-range" title="Value limits"></span> | ||
6588 | </dt> | ||
6589 | <dt data-property-name="account"> | ||
6590 | <span class="json-property-name">account:</span> | ||
6591 | <span class="json-property-type">object</span> | ||
6592 | <span class="json-property-range" title="Value limits"></span> | ||
6593 | </dt> | ||
6594 | <dt class="json-inner-schema"> | ||
6595 | <section class="json-schema-properties"> | ||
6596 | <dl> | ||
6597 | <dt data-property-name="name"> | ||
6598 | <span class="json-property-name">name:</span> | ||
6599 | <span class="json-property-type">string</span> | ||
6600 | <span class="json-property-range" title="Value limits"></span> | ||
6601 | </dt> | ||
6602 | <dt data-property-name="displayName"> | ||
6603 | <span class="json-property-name">displayName:</span> | ||
6604 | <span class="json-property-type">string</span> | ||
6605 | <span class="json-property-range" title="Value limits"></span> | ||
6606 | </dt> | ||
6607 | <dt data-property-name="url"> | ||
6608 | <span class="json-property-name">url:</span> | ||
6609 | <span class="json-property-type">string</span> | ||
6610 | <span class="json-property-range" title="Value limits"></span> | ||
6611 | </dt> | ||
6612 | <dt data-property-name="host"> | ||
6613 | <span class="json-property-name">host:</span> | ||
6614 | <span class="json-property-type">string</span> | ||
6615 | <span class="json-property-range" title="Value limits"></span> | ||
6616 | </dt> | ||
6617 | <dt data-property-name="avatar"> | ||
6618 | <span class="json-property-name">avatar:</span> | ||
6619 | <span class="json-property-type"> | ||
6620 | <span class=""> | ||
6621 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | ||
6622 | </span> | ||
6623 | </span> | ||
6624 | <span class="json-property-range" title="Value limits"></span> | ||
6625 | </dt> | ||
6626 | </dl> | ||
6627 | </section> | ||
6628 | </dt> | ||
6629 | </dl> | ||
6630 | </section> | ||
6631 | </div> | ||
6632 | <div class="doc-examples"> | ||
6633 | <section> | ||
6634 | <h5>Example</h5> | ||
6635 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
6636 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
6637 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
6638 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
6639 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | ||
6640 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
6641 | <span class="hljs-attr">"category"</span>: { | ||
6642 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
6643 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
6644 | }, | ||
6645 | <span class="hljs-attr">"licence"</span>: { | ||
6646 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
6647 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
6648 | }, | ||
6649 | <span class="hljs-attr">"language"</span>: { | ||
6650 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
6651 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | ||
6652 | }, | ||
6653 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | ||
6654 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
6655 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | ||
6656 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
6657 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
6658 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | ||
6659 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | ||
6660 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | ||
6661 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | ||
6662 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | ||
6663 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | ||
6664 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | ||
6665 | <span class="hljs-attr">"account"</span>: { | ||
6666 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
6667 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
6668 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
6669 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
6670 | <span class="hljs-attr">"avatar"</span>: { | ||
6671 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
6672 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
6673 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
6674 | } | ||
6675 | } | ||
6676 | } | ||
6677 | </code></pre> | ||
6678 | <!-- </div> --> | ||
6679 | </section> | ||
6680 | </div> | ||
6681 | </div> | ||
6682 | </div> | ||
6683 | <div id="definition-VideoAbuse" class="definition panel" data-traverse-target="definition-VideoAbuse"> | ||
6684 | <h2 class="panel-title"> | ||
6685 | <a name="/definitions/VideoAbuse"></a>VideoAbuse: | ||
6686 | <!-- <span class="json-property-type"> | ||
6687 | <span class="json-property-type">object</span> | ||
6688 | <span class="json-property-range" title="Value limits"></span> | ||
6689 | |||
6690 | |||
6691 | </span> --> | ||
6692 | </h2> | ||
6693 | <div class="doc-row"> | ||
6694 | <div class="doc-copy"> | ||
6695 | <section class="json-schema-properties"> | ||
6696 | <dl> | ||
6697 | <dt data-property-name="id"> | ||
6698 | <span class="json-property-name">id:</span> | ||
6699 | <span class="json-property-type">number</span> | ||
6700 | <span class="json-property-range" title="Value limits"></span> | ||
6701 | </dt> | ||
6702 | <dt data-property-name="reason"> | ||
6703 | <span class="json-property-name">reason:</span> | ||
6704 | <span class="json-property-type">string</span> | ||
6705 | <span class="json-property-range" title="Value limits"></span> | ||
6706 | </dt> | ||
6707 | <dt data-property-name="reporterAccount"> | ||
6708 | <span class="json-property-name">reporterAccount:</span> | ||
6709 | <span class="json-property-type"> | ||
6710 | <span class=""> | ||
6711 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | ||
6712 | </span> | ||
6713 | </span> | ||
6714 | <span class="json-property-range" title="Value limits"></span> | ||
6715 | </dt> | ||
6716 | <dt data-property-name="video"> | ||
6717 | <span class="json-property-name">video:</span> | ||
6718 | <span class="json-property-type">object</span> | ||
6719 | <span class="json-property-range" title="Value limits"></span> | ||
6720 | </dt> | ||
6721 | <dt class="json-inner-schema"> | ||
6722 | <section class="json-schema-properties"> | ||
6723 | <dl> | ||
6724 | <dt data-property-name="id"> | ||
6725 | <span class="json-property-name">id:</span> | ||
6726 | <span class="json-property-type">number</span> | ||
6727 | <span class="json-property-range" title="Value limits"></span> | ||
6728 | </dt> | ||
6729 | <dt data-property-name="name"> | ||
6730 | <span class="json-property-name">name:</span> | ||
6731 | <span class="json-property-type">string</span> | ||
6732 | <span class="json-property-range" title="Value limits"></span> | ||
6733 | </dt> | ||
6734 | <dt data-property-name="uuid"> | ||
6735 | <span class="json-property-name">uuid:</span> | ||
6736 | <span class="json-property-type">string</span> | ||
6737 | <span class="json-property-range" title="Value limits"></span> | ||
6738 | </dt> | ||
6739 | <dt data-property-name="url"> | ||
6740 | <span class="json-property-name">url:</span> | ||
6741 | <span class="json-property-type">string</span> | ||
6742 | <span class="json-property-range" title="Value limits"></span> | ||
6743 | </dt> | ||
6744 | </dl> | ||
6745 | </section> | ||
6746 | </dt> | ||
6747 | <dt data-property-name="createdAt"> | ||
6748 | <span class="json-property-name">createdAt:</span> | ||
6749 | <span class="json-property-type">string</span> | ||
6750 | <span class="json-property-range" title="Value limits"></span> | ||
6751 | </dt> | ||
6752 | </dl> | ||
6753 | </section> | ||
6754 | </div> | ||
6755 | <div class="doc-examples"> | ||
6756 | <section> | ||
6757 | <h5>Example</h5> | ||
6758 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
6759 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
6760 | <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>, | ||
6761 | <span class="hljs-attr">"reporterAccount"</span>: { | ||
6762 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
6763 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
6764 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
6765 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
6766 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
6767 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
6768 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
6769 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
6770 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
6771 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
6772 | <span class="hljs-attr">"avatar"</span>: { | ||
6773 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
6774 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
6775 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
6776 | } | ||
6777 | }, | ||
6778 | <span class="hljs-attr">"video"</span>: { | ||
6779 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
6780 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
6781 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
6782 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span> | ||
6783 | }, | ||
6784 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span> | ||
6785 | } | ||
6786 | </code></pre> | ||
6787 | <!-- </div> --> | ||
6788 | </section> | ||
6789 | </div> | ||
6790 | </div> | ||
6791 | </div> | ||
6792 | <div id="definition-VideoBlacklist" class="definition panel" data-traverse-target="definition-VideoBlacklist"> | ||
6793 | <h2 class="panel-title"> | ||
6794 | <a name="/definitions/VideoBlacklist"></a>VideoBlacklist: | ||
6795 | <!-- <span class="json-property-type"> | ||
6796 | <span class="json-property-type">object</span> | ||
6797 | <span class="json-property-range" title="Value limits"></span> | ||
6798 | |||
6799 | |||
6800 | </span> --> | ||
6801 | </h2> | ||
6802 | <div class="doc-row"> | ||
6803 | <div class="doc-copy"> | ||
6804 | <section class="json-schema-properties"> | ||
6805 | <dl> | ||
6806 | <dt data-property-name="id"> | ||
6807 | <span class="json-property-name">id:</span> | ||
6808 | <span class="json-property-type">number</span> | ||
6809 | <span class="json-property-range" title="Value limits"></span> | ||
6810 | </dt> | ||
6811 | <dt data-property-name="videoId"> | ||
6812 | <span class="json-property-name">videoId:</span> | ||
6813 | <span class="json-property-type">number</span> | ||
6814 | <span class="json-property-range" title="Value limits"></span> | ||
6815 | </dt> | ||
6816 | <dt data-property-name="createdAt"> | ||
6817 | <span class="json-property-name">createdAt:</span> | ||
6818 | <span class="json-property-type">string</span> | ||
6819 | <span class="json-property-range" title="Value limits"></span> | ||
6820 | </dt> | ||
6821 | <dt data-property-name="updatedAt"> | ||
6822 | <span class="json-property-name">updatedAt:</span> | ||
6823 | <span class="json-property-type">string</span> | ||
6824 | <span class="json-property-range" title="Value limits"></span> | ||
6825 | </dt> | ||
6826 | <dt data-property-name="name"> | ||
6827 | <span class="json-property-name">name:</span> | ||
6828 | <span class="json-property-type">string</span> | ||
6829 | <span class="json-property-range" title="Value limits"></span> | ||
6830 | </dt> | ||
6831 | <dt data-property-name="uuid"> | ||
6832 | <span class="json-property-name">uuid:</span> | ||
6833 | <span class="json-property-type">string</span> | ||
6834 | <span class="json-property-range" title="Value limits"></span> | ||
6835 | </dt> | ||
6836 | <dt data-property-name="description"> | ||
6837 | <span class="json-property-name">description:</span> | ||
6838 | <span class="json-property-type">string</span> | ||
6839 | <span class="json-property-range" title="Value limits"></span> | ||
6840 | </dt> | ||
6841 | <dt data-property-name="duration"> | ||
6842 | <span class="json-property-name">duration:</span> | ||
6843 | <span class="json-property-type">number</span> | ||
6844 | <span class="json-property-range" title="Value limits"></span> | ||
6845 | </dt> | ||
6846 | <dt data-property-name="views"> | ||
6847 | <span class="json-property-name">views:</span> | ||
6848 | <span class="json-property-type">number</span> | ||
6849 | <span class="json-property-range" title="Value limits"></span> | ||
6850 | </dt> | ||
6851 | <dt data-property-name="likes"> | ||
6852 | <span class="json-property-name">likes:</span> | ||
6853 | <span class="json-property-type">number</span> | ||
6854 | <span class="json-property-range" title="Value limits"></span> | ||
6855 | </dt> | ||
6856 | <dt data-property-name="dislikes"> | ||
6857 | <span class="json-property-name">dislikes:</span> | ||
6858 | <span class="json-property-type">number</span> | ||
6859 | <span class="json-property-range" title="Value limits"></span> | ||
6860 | </dt> | ||
6861 | <dt data-property-name="nsfw"> | ||
6862 | <span class="json-property-name">nsfw:</span> | ||
6863 | <span class="json-property-type">boolean</span> | ||
6864 | <span class="json-property-range" title="Value limits"></span> | ||
6865 | </dt> | ||
6866 | </dl> | ||
6867 | </section> | ||
6868 | </div> | ||
6869 | <div class="doc-examples"> | ||
6870 | <section> | ||
6871 | <h5>Example</h5> | ||
6872 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
6873 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
6874 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
6875 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
6876 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
6877 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
6878 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
6879 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
6880 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | ||
6881 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | ||
6882 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | ||
6883 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | ||
6884 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | ||
6885 | } | ||
6886 | </code></pre> | ||
6887 | <!-- </div> --> | ||
6888 | </section> | ||
6889 | </div> | ||
6890 | </div> | ||
6891 | </div> | ||
6892 | <div id="definition-VideoChannel" class="definition panel" data-traverse-target="definition-VideoChannel"> | ||
6893 | <h2 class="panel-title"> | ||
6894 | <a name="/definitions/VideoChannel"></a>VideoChannel: | ||
6895 | <!-- <span class="json-property-type"> | ||
6896 | <span class="json-property-type">object</span> | ||
6897 | <span class="json-property-range" title="Value limits"></span> | ||
6898 | |||
6899 | |||
6900 | </span> --> | ||
6901 | </h2> | ||
6902 | <div class="doc-row"> | ||
6903 | <div class="doc-copy"> | ||
6904 | <section class="json-schema-properties"> | ||
6905 | <dl> | ||
6906 | <dt data-property-name="displayName"> | ||
6907 | <span class="json-property-name">displayName:</span> | ||
6908 | <span class="json-property-type">string</span> | ||
6909 | <span class="json-property-range" title="Value limits"></span> | ||
6910 | </dt> | ||
6911 | <dt data-property-name="description"> | ||
6912 | <span class="json-property-name">description:</span> | ||
6913 | <span class="json-property-type">string</span> | ||
6914 | <span class="json-property-range" title="Value limits"></span> | ||
6915 | </dt> | ||
6916 | <dt data-property-name="isLocal"> | ||
6917 | <span class="json-property-name">isLocal:</span> | ||
6918 | <span class="json-property-type">boolean</span> | ||
6919 | <span class="json-property-range" title="Value limits"></span> | ||
6920 | </dt> | ||
6921 | <dt data-property-name="ownerAccount"> | ||
6922 | <span class="json-property-name">ownerAccount:</span> | ||
6923 | <span class="json-property-type">object</span> | ||
6924 | <span class="json-property-range" title="Value limits"></span> | ||
6925 | </dt> | ||
6926 | <dt class="json-inner-schema"> | ||
6927 | <section class="json-schema-properties"> | ||
6928 | <dl> | ||
6929 | <dt data-property-name="id"> | ||
6930 | <span class="json-property-name">id:</span> | ||
6931 | <span class="json-property-type">number</span> | ||
6932 | <span class="json-property-range" title="Value limits"></span> | ||
6933 | </dt> | ||
6934 | <dt data-property-name="uuid"> | ||
6935 | <span class="json-property-name">uuid:</span> | ||
6936 | <span class="json-property-type">string</span> | ||
6937 | <span class="json-property-range" title="Value limits"></span> | ||
6938 | </dt> | ||
6939 | </dl> | ||
6940 | </section> | ||
6941 | </dt> | ||
6942 | </dl> | ||
6943 | </section> | ||
6944 | </div> | ||
6945 | <div class="doc-examples"> | ||
6946 | <section> | ||
6947 | <h5>Example</h5> | ||
6948 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
6949 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
6950 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
6951 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
6952 | <span class="hljs-attr">"ownerAccount"</span>: { | ||
6953 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
6954 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | ||
6955 | } | ||
6956 | } | ||
6957 | </code></pre> | ||
6958 | <!-- </div> --> | ||
6959 | </section> | ||
6960 | </div> | ||
6961 | </div> | ||
6962 | </div> | ||
6963 | <div id="definition-VideoComment" class="definition panel" data-traverse-target="definition-VideoComment"> | ||
6964 | <h2 class="panel-title"> | ||
6965 | <a name="/definitions/VideoComment"></a>VideoComment: | ||
6966 | <!-- <span class="json-property-type"> | ||
6967 | <span class="json-property-type">object</span> | ||
6968 | <span class="json-property-range" title="Value limits"></span> | ||
6969 | |||
6970 | |||
6971 | </span> --> | ||
6972 | </h2> | ||
6973 | <div class="doc-row"> | ||
6974 | <div class="doc-copy"> | ||
6975 | <section class="json-schema-properties"> | ||
6976 | <dl> | ||
6977 | <dt data-property-name="id"> | ||
6978 | <span class="json-property-name">id:</span> | ||
6979 | <span class="json-property-type">number</span> | ||
6980 | <span class="json-property-range" title="Value limits"></span> | ||
6981 | </dt> | ||
6982 | <dt data-property-name="url"> | ||
6983 | <span class="json-property-name">url:</span> | ||
6984 | <span class="json-property-type">string</span> | ||
6985 | <span class="json-property-range" title="Value limits"></span> | ||
6986 | </dt> | ||
6987 | <dt data-property-name="text"> | ||
6988 | <span class="json-property-name">text:</span> | ||
6989 | <span class="json-property-type">string</span> | ||
6990 | <span class="json-property-range" title="Value limits"></span> | ||
6991 | </dt> | ||
6992 | <dt data-property-name="threadId"> | ||
6993 | <span class="json-property-name">threadId:</span> | ||
6994 | <span class="json-property-type">number</span> | ||
6995 | <span class="json-property-range" title="Value limits"></span> | ||
6996 | </dt> | ||
6997 | <dt data-property-name="inReplyToCommentId"> | ||
6998 | <span class="json-property-name">inReplyToCommentId:</span> | ||
6999 | <span class="json-property-type">number</span> | ||
7000 | <span class="json-property-range" title="Value limits"></span> | ||
7001 | </dt> | ||
7002 | <dt data-property-name="videoId"> | ||
7003 | <span class="json-property-name">videoId:</span> | ||
7004 | <span class="json-property-type">number</span> | ||
7005 | <span class="json-property-range" title="Value limits"></span> | ||
7006 | </dt> | ||
7007 | <dt data-property-name="createdAt"> | ||
7008 | <span class="json-property-name">createdAt:</span> | ||
7009 | <span class="json-property-type">string</span> | ||
7010 | <span class="json-property-range" title="Value limits"></span> | ||
7011 | </dt> | ||
7012 | <dt data-property-name="updatedAt"> | ||
7013 | <span class="json-property-name">updatedAt:</span> | ||
7014 | <span class="json-property-type">string</span> | ||
7015 | <span class="json-property-range" title="Value limits"></span> | ||
7016 | </dt> | ||
7017 | <dt data-property-name="totalReplies"> | ||
7018 | <span class="json-property-name">totalReplies:</span> | ||
7019 | <span class="json-property-type">number</span> | ||
7020 | <span class="json-property-range" title="Value limits"></span> | ||
7021 | </dt> | ||
7022 | <dt data-property-name="account"> | ||
7023 | <span class="json-property-name">account:</span> | ||
7024 | <span class="json-property-type"> | ||
7025 | <span class=""> | ||
7026 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | ||
7027 | </span> | ||
7028 | </span> | ||
7029 | <span class="json-property-range" title="Value limits"></span> | ||
7030 | </dt> | ||
7031 | </dl> | ||
7032 | </section> | ||
7033 | </div> | ||
7034 | <div class="doc-examples"> | ||
7035 | <section> | ||
7036 | <h5>Example</h5> | ||
7037 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
7038 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7039 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7040 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | ||
7041 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | ||
7042 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | ||
7043 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
7044 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7045 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7046 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | ||
7047 | <span class="hljs-attr">"account"</span>: { | ||
7048 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
7049 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7050 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
7051 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7052 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
7053 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
7054 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
7055 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
7056 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7057 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7058 | <span class="hljs-attr">"avatar"</span>: { | ||
7059 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
7060 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7061 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
7062 | } | ||
7063 | } | ||
7064 | } | ||
7065 | </code></pre> | ||
7066 | <!-- </div> --> | ||
7067 | </section> | ||
7068 | </div> | ||
7069 | </div> | ||
7070 | </div> | ||
7071 | <div id="definition-VideoCommentThreadTree" class="definition panel" data-traverse-target="definition-VideoCommentThreadTree"> | ||
7072 | <h2 class="panel-title"> | ||
7073 | <a name="/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree: | ||
7074 | <!-- <span class="json-property-type"> | ||
7075 | <span class="json-property-type">object</span> | ||
7076 | <span class="json-property-range" title="Value limits"></span> | ||
7077 | |||
7078 | |||
7079 | </span> --> | ||
7080 | </h2> | ||
7081 | <div class="doc-row"> | ||
7082 | <div class="doc-copy"> | ||
7083 | <section class="json-schema-properties"> | ||
7084 | <dl> | ||
7085 | <dt data-property-name="comment"> | ||
7086 | <span class="json-property-name">comment:</span> | ||
7087 | <span class="json-property-type"> | ||
7088 | <span class=""> | ||
7089 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | ||
7090 | </span> | ||
7091 | </span> | ||
7092 | <span class="json-property-range" title="Value limits"></span> | ||
7093 | </dt> | ||
7094 | <dt data-property-name="children"> | ||
7095 | <span class="json-property-name">children:</span> | ||
7096 | <span class="json-property-type"> | ||
7097 | <span class="json-schema-ref-array"> | ||
7098 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | ||
7099 | </span> | ||
7100 | </span> | ||
7101 | <span class="json-property-range" title="Value limits"></span> | ||
7102 | </dt> | ||
7103 | <dt class="json-inner-schema"> | ||
7104 | <section class="json-schema-array-items"> | ||
7105 | <span class="json-property-type"> | ||
7106 | <span class=""> | ||
7107 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | ||
7108 | </span> | ||
7109 | </span> | ||
7110 | <span class="json-property-range" title="Value limits"></span> | ||
7111 | <div class="json-inner-schema"> </div> | ||
7112 | </section> | ||
7113 | </dt> | ||
7114 | </dl> | ||
7115 | </section> | ||
7116 | </div> | ||
7117 | <div class="doc-examples"> | ||
7118 | <section> | ||
7119 | <h5>Example</h5> | ||
7120 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
7121 | <span class="hljs-attr">"comment"</span>: { | ||
7122 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7123 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7124 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | ||
7125 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | ||
7126 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | ||
7127 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
7128 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7129 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7130 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | ||
7131 | <span class="hljs-attr">"account"</span>: { | ||
7132 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
7133 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7134 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
7135 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7136 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
7137 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
7138 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
7139 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
7140 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7141 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7142 | <span class="hljs-attr">"avatar"</span>: { | ||
7143 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
7144 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7145 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
7146 | } | ||
7147 | } | ||
7148 | }, | ||
7149 | <span class="hljs-attr">"children"</span>: [ | ||
7150 | { | ||
7151 | <span class="hljs-attr">"comment"</span>: { | ||
7152 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7153 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7154 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | ||
7155 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | ||
7156 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | ||
7157 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
7158 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7159 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7160 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | ||
7161 | <span class="hljs-attr">"account"</span>: { | ||
7162 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
7163 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7164 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
7165 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7166 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
7167 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
7168 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
7169 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
7170 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7171 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7172 | <span class="hljs-attr">"avatar"</span>: { | ||
7173 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
7174 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7175 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
7176 | } | ||
7177 | } | ||
7178 | }, | ||
7179 | <span class="hljs-attr">"children"</span>: [ | ||
7180 | { | ||
7181 | <span class="hljs-attr">"comment"</span>: { | ||
7182 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7183 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7184 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | ||
7185 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | ||
7186 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | ||
7187 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
7188 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7189 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7190 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | ||
7191 | <span class="hljs-attr">"account"</span>: { | ||
7192 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
7193 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7194 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
7195 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7196 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
7197 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
7198 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
7199 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
7200 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7201 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7202 | <span class="hljs-attr">"avatar"</span>: { | ||
7203 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
7204 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7205 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
7206 | } | ||
7207 | } | ||
7208 | } | ||
7209 | } | ||
7210 | ] | ||
7211 | } | ||
7212 | ] | ||
7213 | } | ||
7214 | </code></pre> | ||
7215 | <!-- </div> --> | ||
7216 | </section> | ||
7217 | </div> | ||
7218 | </div> | ||
7219 | </div> | ||
7220 | <div id="definition-Avatar" class="definition panel" data-traverse-target="definition-Avatar"> | ||
7221 | <h2 class="panel-title"> | ||
7222 | <a name="/definitions/Avatar"></a>Avatar: | ||
7223 | <!-- <span class="json-property-type"> | ||
7224 | <span class="json-property-type">object</span> | ||
7225 | <span class="json-property-range" title="Value limits"></span> | ||
7226 | |||
7227 | |||
7228 | </span> --> | ||
7229 | </h2> | ||
7230 | <div class="doc-row"> | ||
7231 | <div class="doc-copy"> | ||
7232 | <section class="json-schema-properties"> | ||
7233 | <dl> | ||
7234 | <dt data-property-name="path"> | ||
7235 | <span class="json-property-name">path:</span> | ||
7236 | <span class="json-property-type">string</span> | ||
7237 | <span class="json-property-range" title="Value limits"></span> | ||
7238 | </dt> | ||
7239 | <dt data-property-name="createdAt"> | ||
7240 | <span class="json-property-name">createdAt:</span> | ||
7241 | <span class="json-property-type">string</span> | ||
7242 | <span class="json-property-range" title="Value limits"></span> | ||
7243 | </dt> | ||
7244 | <dt data-property-name="updatedAt"> | ||
7245 | <span class="json-property-name">updatedAt:</span> | ||
7246 | <span class="json-property-type">string</span> | ||
7247 | <span class="json-property-range" title="Value limits"></span> | ||
7248 | </dt> | ||
7249 | </dl> | ||
7250 | </section> | ||
7251 | </div> | ||
7252 | <div class="doc-examples"> | ||
7253 | <section> | ||
7254 | <h5>Example</h5> | ||
7255 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
7256 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
7257 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7258 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
7259 | } | ||
7260 | </code></pre> | ||
7261 | <!-- </div> --> | ||
7262 | </section> | ||
7263 | </div> | ||
7264 | </div> | ||
7265 | </div> | ||
7266 | <div id="definition-Actor" class="definition panel" data-traverse-target="definition-Actor"> | ||
7267 | <h2 class="panel-title"> | ||
7268 | <a name="/definitions/Actor"></a>Actor: | ||
7269 | <!-- <span class="json-property-type"> | ||
7270 | <span class="json-property-type">object</span> | ||
7271 | <span class="json-property-range" title="Value limits"></span> | ||
7272 | |||
7273 | |||
7274 | </span> --> | ||
7275 | </h2> | ||
7276 | <div class="doc-row"> | ||
7277 | <div class="doc-copy"> | ||
7278 | <section class="json-schema-properties"> | ||
7279 | <dl> | ||
7280 | <dt data-property-name="id"> | ||
7281 | <span class="json-property-name">id:</span> | ||
7282 | <span class="json-property-type">number</span> | ||
7283 | <span class="json-property-range" title="Value limits"></span> | ||
7284 | </dt> | ||
7285 | <dt data-property-name="uuid"> | ||
7286 | <span class="json-property-name">uuid:</span> | ||
7287 | <span class="json-property-type">string</span> | ||
7288 | <span class="json-property-range" title="Value limits"></span> | ||
7289 | </dt> | ||
7290 | <dt data-property-name="url"> | ||
7291 | <span class="json-property-name">url:</span> | ||
7292 | <span class="json-property-type">string</span> | ||
7293 | <span class="json-property-range" title="Value limits"></span> | ||
7294 | </dt> | ||
7295 | <dt data-property-name="name"> | ||
7296 | <span class="json-property-name">name:</span> | ||
7297 | <span class="json-property-type">string</span> | ||
7298 | <span class="json-property-range" title="Value limits"></span> | ||
7299 | </dt> | ||
7300 | <dt data-property-name="host"> | ||
7301 | <span class="json-property-name">host:</span> | ||
7302 | <span class="json-property-type">string</span> | ||
7303 | <span class="json-property-range" title="Value limits"></span> | ||
7304 | </dt> | ||
7305 | <dt data-property-name="followingCount"> | ||
7306 | <span class="json-property-name">followingCount:</span> | ||
7307 | <span class="json-property-type">number</span> | ||
7308 | <span class="json-property-range" title="Value limits"></span> | ||
7309 | </dt> | ||
7310 | <dt data-property-name="followersCount"> | ||
7311 | <span class="json-property-name">followersCount:</span> | ||
7312 | <span class="json-property-type">number</span> | ||
7313 | <span class="json-property-range" title="Value limits"></span> | ||
7314 | </dt> | ||
7315 | <dt data-property-name="createdAt"> | ||
7316 | <span class="json-property-name">createdAt:</span> | ||
7317 | <span class="json-property-type">string</span> | ||
7318 | <span class="json-property-range" title="Value limits"></span> | ||
7319 | </dt> | ||
7320 | <dt data-property-name="updatedAt"> | ||
7321 | <span class="json-property-name">updatedAt:</span> | ||
7322 | <span class="json-property-type">string</span> | ||
7323 | <span class="json-property-range" title="Value limits"></span> | ||
7324 | </dt> | ||
7325 | <dt data-property-name="avatar"> | ||
7326 | <span class="json-property-name">avatar:</span> | ||
7327 | <span class="json-property-type"> | ||
7328 | <span class=""> | ||
7329 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | ||
7330 | </span> | ||
7331 | </span> | ||
7332 | <span class="json-property-range" title="Value limits"></span> | ||
7333 | </dt> | ||
7334 | </dl> | ||
7335 | </section> | ||
7336 | </div> | ||
7337 | <div class="doc-examples"> | ||
7338 | <section> | ||
7339 | <h5>Example</h5> | ||
7340 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
7341 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7342 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
7343 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7344 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
7345 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
7346 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
7347 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
7348 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7349 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7350 | <span class="hljs-attr">"avatar"</span>: { | ||
7351 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
7352 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7353 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
7354 | } | ||
7355 | } | ||
7356 | </code></pre> | ||
7357 | <!-- </div> --> | ||
7358 | </section> | ||
7359 | </div> | ||
7360 | </div> | ||
7361 | </div> | ||
7362 | <div id="definition-Account" class="definition panel" data-traverse-target="definition-Account"> | ||
7363 | <h2 class="panel-title"> | ||
7364 | <a name="/definitions/Account"></a>Account: | ||
7365 | <!-- <span class="json-property-type"> | ||
7366 | <span class="json-property-type"></span> | ||
7367 | <span class="json-property-range" title="Value limits"></span> | ||
7368 | |||
7369 | |||
7370 | </span> --> | ||
7371 | </h2> | ||
7372 | <div class="doc-row"> | ||
7373 | <div class="doc-copy"> | ||
7374 | <section class="json-schema-allOf"> | ||
7375 | <section class="json-schema-allOf-inherited"> | ||
7376 | <ul> | ||
7377 | <span class=""> | ||
7378 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | ||
7379 | </span> | ||
7380 | </ul> | ||
7381 | </section> | ||
7382 | <section class="json-schema-allOf-additional"> | ||
7383 | <section class="json-schema-properties"> | ||
7384 | <dl> | ||
7385 | <dt data-property-name="displayName"> | ||
7386 | <span class="json-property-name">displayName:</span> | ||
7387 | <span class="json-property-type">string</span> | ||
7388 | <span class="json-property-range" title="Value limits"></span> | ||
7389 | </dt> | ||
7390 | </dl> | ||
7391 | </section> | ||
7392 | </section> | ||
7393 | </section> | ||
7394 | </div> | ||
7395 | <div class="doc-examples"> | ||
7396 | <section> | ||
7397 | <h5>Example</h5> | ||
7398 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
7399 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
7400 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7401 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
7402 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7403 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
7404 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
7405 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
7406 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
7407 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7408 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7409 | <span class="hljs-attr">"avatar"</span>: { | ||
7410 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
7411 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7412 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
7413 | } | ||
7414 | } | ||
7415 | </code></pre> | ||
7416 | <!-- </div> --> | ||
7417 | </section> | ||
7418 | </div> | ||
7419 | </div> | ||
7420 | </div> | ||
7421 | <div id="definition-User" class="definition panel" data-traverse-target="definition-User"> | ||
7422 | <h2 class="panel-title"> | ||
7423 | <a name="/definitions/User"></a>User: | ||
7424 | <!-- <span class="json-property-type"> | ||
7425 | <span class="json-property-type">object</span> | ||
7426 | <span class="json-property-range" title="Value limits"></span> | ||
7427 | |||
7428 | |||
7429 | </span> --> | ||
7430 | </h2> | ||
7431 | <div class="doc-row"> | ||
7432 | <div class="doc-copy"> | ||
7433 | <section class="json-schema-properties"> | ||
7434 | <dl> | ||
7435 | <dt data-property-name="id"> | ||
7436 | <span class="json-property-name">id:</span> | ||
7437 | <span class="json-property-type">number</span> | ||
7438 | <span class="json-property-range" title="Value limits"></span> | ||
7439 | </dt> | ||
7440 | <dt data-property-name="username"> | ||
7441 | <span class="json-property-name">username:</span> | ||
7442 | <span class="json-property-type">string</span> | ||
7443 | <span class="json-property-range" title="Value limits"></span> | ||
7444 | </dt> | ||
7445 | <dt data-property-name="email"> | ||
7446 | <span class="json-property-name">email:</span> | ||
7447 | <span class="json-property-type">string</span> | ||
7448 | <span class="json-property-range" title="Value limits"></span> | ||
7449 | </dt> | ||
7450 | <dt data-property-name="displayNSFW"> | ||
7451 | <span class="json-property-name">displayNSFW:</span> | ||
7452 | <span class="json-property-type">boolean</span> | ||
7453 | <span class="json-property-range" title="Value limits"></span> | ||
7454 | </dt> | ||
7455 | <dt data-property-name="autoPlayVideo"> | ||
7456 | <span class="json-property-name">autoPlayVideo:</span> | ||
7457 | <span class="json-property-type">boolean</span> | ||
7458 | <span class="json-property-range" title="Value limits"></span> | ||
7459 | </dt> | ||
7460 | <dt data-property-name="role"> | ||
7461 | <span class="json-property-name">role:</span> | ||
7462 | <span class="json-property-type">string</span> | ||
7463 | <span class="json-property-enum" title="Possible values"> | ||
7464 | <span class="json-property-enum-item">User</span>, | ||
7465 | <span class="json-property-enum-item">Moderator</span>, | ||
7466 | <span class="json-property-enum-item">Administrator</span> | ||
7467 | </span> | ||
7468 | <span class="json-property-range" title="Value limits"></span> | ||
7469 | </dt> | ||
7470 | <dt data-property-name="videoQuota"> | ||
7471 | <span class="json-property-name">videoQuota:</span> | ||
7472 | <span class="json-property-type">number</span> | ||
7473 | <span class="json-property-range" title="Value limits"></span> | ||
7474 | </dt> | ||
7475 | <dt data-property-name="createdAt"> | ||
7476 | <span class="json-property-name">createdAt:</span> | ||
7477 | <span class="json-property-type">string</span> | ||
7478 | <span class="json-property-range" title="Value limits"></span> | ||
7479 | </dt> | ||
7480 | <dt data-property-name="account"> | ||
7481 | <span class="json-property-name">account:</span> | ||
7482 | <span class="json-property-type"> | ||
7483 | <span class=""> | ||
7484 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | ||
7485 | </span> | ||
7486 | </span> | ||
7487 | <span class="json-property-range" title="Value limits"></span> | ||
7488 | </dt> | ||
7489 | <dt data-property-name="videoChannels"> | ||
7490 | <span class="json-property-name">videoChannels:</span> | ||
7491 | <span class="json-property-type"> | ||
7492 | <span class="json-schema-ref-array"> | ||
7493 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | ||
7494 | </span> | ||
7495 | </span> | ||
7496 | <span class="json-property-range" title="Value limits"></span> | ||
7497 | </dt> | ||
7498 | <dt class="json-inner-schema"> | ||
7499 | <section class="json-schema-array-items"> | ||
7500 | <span class="json-property-type"> | ||
7501 | <span class=""> | ||
7502 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | ||
7503 | </span> | ||
7504 | </span> | ||
7505 | <span class="json-property-range" title="Value limits"></span> | ||
7506 | <div class="json-inner-schema"> </div> | ||
7507 | </section> | ||
7508 | </dt> | ||
7509 | </dl> | ||
7510 | </section> | ||
7511 | </div> | ||
7512 | <div class="doc-examples"> | ||
7513 | <section> | ||
7514 | <h5>Example</h5> | ||
7515 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
7516 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7517 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | ||
7518 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | ||
7519 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | ||
7520 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | ||
7521 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | ||
7522 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | ||
7523 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7524 | <span class="hljs-attr">"account"</span>: { | ||
7525 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
7526 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7527 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
7528 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7529 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
7530 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
7531 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
7532 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
7533 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7534 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7535 | <span class="hljs-attr">"avatar"</span>: { | ||
7536 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
7537 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7538 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
7539 | } | ||
7540 | }, | ||
7541 | <span class="hljs-attr">"videoChannels"</span>: [ | ||
7542 | { | ||
7543 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
7544 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | ||
7545 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | ||
7546 | <span class="hljs-attr">"ownerAccount"</span>: { | ||
7547 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7548 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | ||
7549 | } | ||
7550 | } | ||
7551 | ] | ||
7552 | } | ||
7553 | </code></pre> | ||
7554 | <!-- </div> --> | ||
7555 | </section> | ||
7556 | </div> | ||
7557 | </div> | ||
7558 | </div> | ||
7559 | <div id="definition-ServerConfig" class="definition panel" data-traverse-target="definition-ServerConfig"> | ||
7560 | <h2 class="panel-title"> | ||
7561 | <a name="/definitions/ServerConfig"></a>ServerConfig: | ||
7562 | <!-- <span class="json-property-type"> | ||
7563 | <span class="json-property-type">object</span> | ||
7564 | <span class="json-property-range" title="Value limits"></span> | ||
7565 | |||
7566 | |||
7567 | </span> --> | ||
7568 | </h2> | ||
7569 | <div class="doc-row"> | ||
7570 | <div class="doc-copy"> | ||
7571 | <section class="json-schema-properties"> | ||
7572 | <dl> | ||
7573 | <dt data-property-name="signup"> | ||
7574 | <span class="json-property-name">signup:</span> | ||
7575 | <span class="json-property-type">object</span> | ||
7576 | <span class="json-property-range" title="Value limits"></span> | ||
7577 | </dt> | ||
7578 | <dt class="json-inner-schema"> | ||
7579 | <section class="json-schema-properties"> | ||
7580 | <dl> | ||
7581 | <dt data-property-name="allowed"> | ||
7582 | <span class="json-property-name">allowed:</span> | ||
7583 | <span class="json-property-type">boolean</span> | ||
7584 | <span class="json-property-range" title="Value limits"></span> | ||
7585 | </dt> | ||
7586 | </dl> | ||
7587 | </section> | ||
7588 | </dt> | ||
7589 | <dt data-property-name="transcoding"> | ||
7590 | <span class="json-property-name">transcoding:</span> | ||
7591 | <span class="json-property-type">object</span> | ||
7592 | <span class="json-property-range" title="Value limits"></span> | ||
7593 | </dt> | ||
7594 | <dt class="json-inner-schema"> | ||
7595 | <section class="json-schema-properties"> | ||
7596 | <dl> | ||
7597 | <dt data-property-name="enabledResolutions"> | ||
7598 | <span class="json-property-name">enabledResolutions:</span> | ||
7599 | <span class="json-property-type">number[]</span> | ||
7600 | <span class="json-property-range" title="Value limits"></span> | ||
7601 | </dt> | ||
7602 | <dt class="json-inner-schema"> | ||
7603 | <section class="json-schema-array-items"> | ||
7604 | <span class="json-property-type">number</span> | ||
7605 | <span class="json-property-range" title="Value limits"></span> | ||
7606 | <div class="json-inner-schema"> </div> | ||
7607 | </section> | ||
7608 | </dt> | ||
7609 | </dl> | ||
7610 | </section> | ||
7611 | </dt> | ||
7612 | <dt data-property-name="avatar"> | ||
7613 | <span class="json-property-name">avatar:</span> | ||
7614 | <span class="json-property-type">object</span> | ||
7615 | <span class="json-property-range" title="Value limits"></span> | ||
7616 | </dt> | ||
7617 | <dt class="json-inner-schema"> | ||
7618 | <section class="json-schema-properties"> | ||
7619 | <dl> | ||
7620 | <dt data-property-name="file"> | ||
7621 | <span class="json-property-name">file:</span> | ||
7622 | <span class="json-property-type">object</span> | ||
7623 | <span class="json-property-range" title="Value limits"></span> | ||
7624 | </dt> | ||
7625 | <dt class="json-inner-schema"> | ||
7626 | <section class="json-schema-properties"> | ||
7627 | <dl> | ||
7628 | <dt data-property-name="size"> | ||
7629 | <span class="json-property-name">size:</span> | ||
7630 | <span class="json-property-type">object</span> | ||
7631 | <span class="json-property-range" title="Value limits"></span> | ||
7632 | </dt> | ||
7633 | <dt class="json-inner-schema"> | ||
7634 | <section class="json-schema-properties"> | ||
7635 | <dl> | ||
7636 | <dt data-property-name="max"> | ||
7637 | <span class="json-property-name">max:</span> | ||
7638 | <span class="json-property-type">number</span> | ||
7639 | <span class="json-property-range" title="Value limits"></span> | ||
7640 | </dt> | ||
7641 | </dl> | ||
7642 | </section> | ||
7643 | </dt> | ||
7644 | </dl> | ||
7645 | </section> | ||
7646 | </dt> | ||
7647 | <dt data-property-name="extensions"> | ||
7648 | <span class="json-property-name">extensions:</span> | ||
7649 | <span class="json-property-type">string[]</span> | ||
7650 | <span class="json-property-range" title="Value limits"></span> | ||
7651 | </dt> | ||
7652 | <dt class="json-inner-schema"> | ||
7653 | <section class="json-schema-array-items"> | ||
7654 | <span class="json-property-type">string</span> | ||
7655 | <span class="json-property-range" title="Value limits"></span> | ||
7656 | <div class="json-inner-schema"> </div> | ||
7657 | </section> | ||
7658 | </dt> | ||
7659 | </dl> | ||
7660 | </section> | ||
7661 | </dt> | ||
7662 | <dt data-property-name="video"> | ||
7663 | <span class="json-property-name">video:</span> | ||
7664 | <span class="json-property-type">object</span> | ||
7665 | <span class="json-property-range" title="Value limits"></span> | ||
7666 | </dt> | ||
7667 | <dt class="json-inner-schema"> | ||
7668 | <section class="json-schema-properties"> | ||
7669 | <dl> | ||
7670 | <dt data-property-name="file"> | ||
7671 | <span class="json-property-name">file:</span> | ||
7672 | <span class="json-property-type">object</span> | ||
7673 | <span class="json-property-range" title="Value limits"></span> | ||
7674 | </dt> | ||
7675 | <dt class="json-inner-schema"> | ||
7676 | <section class="json-schema-properties"> | ||
7677 | <dl> | ||
7678 | <dt data-property-name="extensions"> | ||
7679 | <span class="json-property-name">extensions:</span> | ||
7680 | <span class="json-property-type">string[]</span> | ||
7681 | <span class="json-property-range" title="Value limits"></span> | ||
7682 | </dt> | ||
7683 | <dt class="json-inner-schema"> | ||
7684 | <section class="json-schema-array-items"> | ||
7685 | <span class="json-property-type">string</span> | ||
7686 | <span class="json-property-range" title="Value limits"></span> | ||
7687 | <div class="json-inner-schema"> </div> | ||
7688 | </section> | ||
7689 | </dt> | ||
7690 | </dl> | ||
7691 | </section> | ||
7692 | </dt> | ||
7693 | </dl> | ||
7694 | </section> | ||
7695 | </dt> | ||
7696 | </dl> | ||
7697 | </section> | ||
7698 | </div> | ||
7699 | <div class="doc-examples"> | ||
7700 | <section> | ||
7701 | <h5>Example</h5> | ||
7702 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
7703 | <span class="hljs-attr">"signup"</span>: { | ||
7704 | <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span> | ||
7705 | }, | ||
7706 | <span class="hljs-attr">"transcoding"</span>: { | ||
7707 | <span class="hljs-attr">"enabledResolutions"</span>: [ | ||
7708 | <span class="hljs-string">"number"</span> | ||
7709 | ] | ||
7710 | }, | ||
7711 | <span class="hljs-attr">"avatar"</span>: { | ||
7712 | <span class="hljs-attr">"file"</span>: { | ||
7713 | <span class="hljs-attr">"size"</span>: { | ||
7714 | <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span> | ||
7715 | } | ||
7716 | }, | ||
7717 | <span class="hljs-attr">"extensions"</span>: [ | ||
7718 | <span class="hljs-string">"string"</span> | ||
7719 | ] | ||
7720 | }, | ||
7721 | <span class="hljs-attr">"video"</span>: { | ||
7722 | <span class="hljs-attr">"file"</span>: { | ||
7723 | <span class="hljs-attr">"extensions"</span>: [ | ||
7724 | <span class="hljs-string">"string"</span> | ||
7725 | ] | ||
7726 | } | ||
7727 | } | ||
7728 | } | ||
7729 | </code></pre> | ||
7730 | <!-- </div> --> | ||
7731 | </section> | ||
7732 | </div> | ||
7733 | </div> | ||
7734 | </div> | ||
7735 | <div id="definition-Follow" class="definition panel" data-traverse-target="definition-Follow"> | ||
7736 | <h2 class="panel-title"> | ||
7737 | <a name="/definitions/Follow"></a>Follow: | ||
7738 | <!-- <span class="json-property-type"> | ||
7739 | <span class="json-property-type">object</span> | ||
7740 | <span class="json-property-range" title="Value limits"></span> | ||
7741 | |||
7742 | |||
7743 | </span> --> | ||
7744 | </h2> | ||
7745 | <div class="doc-row"> | ||
7746 | <div class="doc-copy"> | ||
7747 | <section class="json-schema-properties"> | ||
7748 | <dl> | ||
7749 | <dt data-property-name="id"> | ||
7750 | <span class="json-property-name">id:</span> | ||
7751 | <span class="json-property-type">number</span> | ||
7752 | <span class="json-property-range" title="Value limits"></span> | ||
7753 | </dt> | ||
7754 | <dt data-property-name="follower"> | ||
7755 | <span class="json-property-name">follower:</span> | ||
7756 | <span class="json-property-type"> | ||
7757 | <span class=""> | ||
7758 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | ||
7759 | </span> | ||
7760 | </span> | ||
7761 | <span class="json-property-range" title="Value limits"></span> | ||
7762 | </dt> | ||
7763 | <dt data-property-name="following"> | ||
7764 | <span class="json-property-name">following:</span> | ||
7765 | <span class="json-property-type"> | ||
7766 | <span class=""> | ||
7767 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | ||
7768 | </span> | ||
7769 | </span> | ||
7770 | <span class="json-property-range" title="Value limits"></span> | ||
7771 | </dt> | ||
7772 | <dt data-property-name="score"> | ||
7773 | <span class="json-property-name">score:</span> | ||
7774 | <span class="json-property-type">number</span> | ||
7775 | <span class="json-property-range" title="Value limits"></span> | ||
7776 | </dt> | ||
7777 | <dt data-property-name="state"> | ||
7778 | <span class="json-property-name">state:</span> | ||
7779 | <span class="json-property-type">string</span> | ||
7780 | <span class="json-property-enum" title="Possible values"> | ||
7781 | <span class="json-property-enum-item">pending</span>, | ||
7782 | <span class="json-property-enum-item">accepted</span> | ||
7783 | </span> | ||
7784 | <span class="json-property-range" title="Value limits"></span> | ||
7785 | </dt> | ||
7786 | <dt data-property-name="createdAt"> | ||
7787 | <span class="json-property-name">createdAt:</span> | ||
7788 | <span class="json-property-type">string</span> | ||
7789 | <span class="json-property-range" title="Value limits"></span> | ||
7790 | </dt> | ||
7791 | <dt data-property-name="updatedAt"> | ||
7792 | <span class="json-property-name">updatedAt:</span> | ||
7793 | <span class="json-property-type">string</span> | ||
7794 | <span class="json-property-range" title="Value limits"></span> | ||
7795 | </dt> | ||
7796 | </dl> | ||
7797 | </section> | ||
7798 | </div> | ||
7799 | <div class="doc-examples"> | ||
7800 | <section> | ||
7801 | <h5>Example</h5> | ||
7802 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
7803 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7804 | <span class="hljs-attr">"follower"</span>: { | ||
7805 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7806 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
7807 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7808 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
7809 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
7810 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
7811 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
7812 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7813 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7814 | <span class="hljs-attr">"avatar"</span>: { | ||
7815 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
7816 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7817 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
7818 | } | ||
7819 | }, | ||
7820 | <span class="hljs-attr">"following"</span>: { | ||
7821 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7822 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
7823 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
7824 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
7825 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
7826 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
7827 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
7828 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7829 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
7830 | <span class="hljs-attr">"avatar"</span>: { | ||
7831 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
7832 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7833 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
7834 | } | ||
7835 | }, | ||
7836 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | ||
7837 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | ||
7838 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7839 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
7840 | } | ||
7841 | </code></pre> | ||
7842 | <!-- </div> --> | ||
7843 | </section> | ||
7844 | </div> | ||
7845 | </div> | ||
7846 | </div> | ||
7847 | <div id="definition-Job" class="definition panel" data-traverse-target="definition-Job"> | ||
7848 | <h2 class="panel-title"> | ||
7849 | <a name="/definitions/Job"></a>Job: | ||
7850 | <!-- <span class="json-property-type"> | ||
7851 | <span class="json-property-type">object</span> | ||
7852 | <span class="json-property-range" title="Value limits"></span> | ||
7853 | |||
7854 | |||
7855 | </span> --> | ||
7856 | </h2> | ||
7857 | <div class="doc-row"> | ||
7858 | <div class="doc-copy"> | ||
7859 | <section class="json-schema-properties"> | ||
7860 | <dl> | ||
7861 | <dt data-property-name="id"> | ||
7862 | <span class="json-property-name">id:</span> | ||
7863 | <span class="json-property-type">number</span> | ||
7864 | <span class="json-property-range" title="Value limits"></span> | ||
7865 | </dt> | ||
7866 | <dt data-property-name="state"> | ||
7867 | <span class="json-property-name">state:</span> | ||
7868 | <span class="json-property-type">string</span> | ||
7869 | <span class="json-property-enum" title="Possible values"> | ||
7870 | <span class="json-property-enum-item">pending</span>, | ||
7871 | <span class="json-property-enum-item">processing</span>, | ||
7872 | <span class="json-property-enum-item">error</span>, | ||
7873 | <span class="json-property-enum-item">success</span> | ||
7874 | </span> | ||
7875 | <span class="json-property-range" title="Value limits"></span> | ||
7876 | </dt> | ||
7877 | <dt data-property-name="category"> | ||
7878 | <span class="json-property-name">category:</span> | ||
7879 | <span class="json-property-type">string</span> | ||
7880 | <span class="json-property-enum" title="Possible values"> | ||
7881 | <span class="json-property-enum-item">transcoding</span>, | ||
7882 | <span class="json-property-enum-item">activitypub-http</span> | ||
7883 | </span> | ||
7884 | <span class="json-property-range" title="Value limits"></span> | ||
7885 | </dt> | ||
7886 | <dt data-property-name="handlerName"> | ||
7887 | <span class="json-property-name">handlerName:</span> | ||
7888 | <span class="json-property-type">string</span> | ||
7889 | <span class="json-property-range" title="Value limits"></span> | ||
7890 | </dt> | ||
7891 | <dt data-property-name="handlerInputData"> | ||
7892 | <span class="json-property-name">handlerInputData:</span> | ||
7893 | <span class="json-property-type">string</span> | ||
7894 | <span class="json-property-range" title="Value limits"></span> | ||
7895 | </dt> | ||
7896 | <dt data-property-name="createdAt"> | ||
7897 | <span class="json-property-name">createdAt:</span> | ||
7898 | <span class="json-property-type">string</span> | ||
7899 | <span class="json-property-range" title="Value limits"></span> | ||
7900 | </dt> | ||
7901 | <dt data-property-name="updatedAt"> | ||
7902 | <span class="json-property-name">updatedAt:</span> | ||
7903 | <span class="json-property-type">string</span> | ||
7904 | <span class="json-property-range" title="Value limits"></span> | ||
7905 | </dt> | ||
7906 | </dl> | ||
7907 | </section> | ||
7908 | </div> | ||
7909 | <div class="doc-examples"> | ||
7910 | <section> | ||
7911 | <h5>Example</h5> | ||
7912 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
7913 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7914 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | ||
7915 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>, | ||
7916 | <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>, | ||
7917 | <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>, | ||
7918 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
7919 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
7920 | } | ||
7921 | </code></pre> | ||
7922 | <!-- </div> --> | ||
7923 | </section> | ||
7924 | </div> | ||
7925 | </div> | ||
7926 | </div> | ||
7927 | <div id="definition-AddUserResponse" class="definition panel" data-traverse-target="definition-AddUserResponse"> | ||
7928 | <h2 class="panel-title"> | ||
7929 | <a name="/definitions/AddUserResponse"></a>AddUserResponse: | ||
7930 | <!-- <span class="json-property-type"> | ||
7931 | <span class="json-property-type">object</span> | ||
7932 | <span class="json-property-range" title="Value limits"></span> | ||
7933 | |||
7934 | |||
7935 | </span> --> | ||
7936 | </h2> | ||
7937 | <div class="doc-row"> | ||
7938 | <div class="doc-copy"> | ||
7939 | <section class="json-schema-properties"> | ||
7940 | <dl> | ||
7941 | <dt data-property-name="id"> | ||
7942 | <span class="json-property-name">id:</span> | ||
7943 | <span class="json-property-type">number</span> | ||
7944 | <span class="json-property-range" title="Value limits"></span> | ||
7945 | </dt> | ||
7946 | <dt data-property-name="uuid"> | ||
7947 | <span class="json-property-name">uuid:</span> | ||
7948 | <span class="json-property-type">string</span> | ||
7949 | <span class="json-property-range" title="Value limits"></span> | ||
7950 | </dt> | ||
7951 | </dl> | ||
7952 | </section> | ||
7953 | </div> | ||
7954 | <div class="doc-examples"> | ||
7955 | <section> | ||
7956 | <h5>Example</h5> | ||
7957 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
7958 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
7959 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | ||
7960 | } | ||
7961 | </code></pre> | ||
7962 | <!-- </div> --> | ||
7963 | </section> | ||
7964 | </div> | ||
7965 | </div> | ||
7966 | </div> | ||
7967 | <div id="definition-VideoUploadResponse" class="definition panel" data-traverse-target="definition-VideoUploadResponse"> | ||
7968 | <h2 class="panel-title"> | ||
7969 | <a name="/definitions/VideoUploadResponse"></a>VideoUploadResponse: | ||
7970 | <!-- <span class="json-property-type"> | ||
7971 | <span class="json-property-type">object</span> | ||
7972 | <span class="json-property-range" title="Value limits"></span> | ||
7973 | |||
7974 | |||
7975 | </span> --> | ||
7976 | </h2> | ||
7977 | <div class="doc-row"> | ||
7978 | <div class="doc-copy"> | ||
7979 | <section class="json-schema-properties"> | ||
7980 | <dl> | ||
7981 | <dt data-property-name="video"> | ||
7982 | <span class="json-property-name">video:</span> | ||
7983 | <span class="json-property-type">object</span> | ||
7984 | <span class="json-property-range" title="Value limits"></span> | ||
7985 | </dt> | ||
7986 | <dt class="json-inner-schema"> | ||
7987 | <section class="json-schema-properties"> | ||
7988 | <dl> | ||
7989 | <dt data-property-name="id"> | ||
7990 | <span class="json-property-name">id:</span> | ||
7991 | <span class="json-property-type">number</span> | ||
7992 | <span class="json-property-range" title="Value limits"></span> | ||
7993 | </dt> | ||
7994 | <dt data-property-name="uuid"> | ||
7995 | <span class="json-property-name">uuid:</span> | ||
7996 | <span class="json-property-type">string</span> | ||
7997 | <span class="json-property-range" title="Value limits"></span> | ||
7998 | </dt> | ||
7999 | </dl> | ||
8000 | </section> | ||
8001 | </dt> | ||
8002 | </dl> | ||
8003 | </section> | ||
8004 | </div> | ||
8005 | <div class="doc-examples"> | ||
8006 | <section> | ||
8007 | <h5>Example</h5> | ||
8008 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
8009 | <span class="hljs-attr">"video"</span>: { | ||
8010 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
8011 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | ||
8012 | } | ||
8013 | } | ||
8014 | </code></pre> | ||
8015 | <!-- </div> --> | ||
8016 | </section> | ||
8017 | </div> | ||
8018 | </div> | ||
8019 | </div> | ||
8020 | <div id="definition-CommentThreadResponse" class="definition panel" data-traverse-target="definition-CommentThreadResponse"> | ||
8021 | <h2 class="panel-title"> | ||
8022 | <a name="/definitions/CommentThreadResponse"></a>CommentThreadResponse: | ||
8023 | <!-- <span class="json-property-type"> | ||
8024 | <span class="json-property-type">object</span> | ||
8025 | <span class="json-property-range" title="Value limits"></span> | ||
8026 | |||
8027 | |||
8028 | </span> --> | ||
8029 | </h2> | ||
8030 | <div class="doc-row"> | ||
8031 | <div class="doc-copy"> | ||
8032 | <section class="json-schema-properties"> | ||
8033 | <dl> | ||
8034 | <dt data-property-name="total"> | ||
8035 | <span class="json-property-name">total:</span> | ||
8036 | <span class="json-property-type">number</span> | ||
8037 | <span class="json-property-range" title="Value limits"></span> | ||
8038 | </dt> | ||
8039 | <dt data-property-name="data"> | ||
8040 | <span class="json-property-name">data:</span> | ||
8041 | <span class="json-property-type"> | ||
8042 | <span class="json-schema-ref-array"> | ||
8043 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | ||
8044 | </span> | ||
8045 | </span> | ||
8046 | <span class="json-property-range" title="Value limits"></span> | ||
8047 | </dt> | ||
8048 | <dt class="json-inner-schema"> | ||
8049 | <section class="json-schema-array-items"> | ||
8050 | <span class="json-property-type"> | ||
8051 | <span class=""> | ||
8052 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | ||
8053 | </span> | ||
8054 | </span> | ||
8055 | <span class="json-property-range" title="Value limits"></span> | ||
8056 | <div class="json-inner-schema"> </div> | ||
8057 | </section> | ||
8058 | </dt> | ||
8059 | </dl> | ||
8060 | </section> | ||
8061 | </div> | ||
8062 | <div class="doc-examples"> | ||
8063 | <section> | ||
8064 | <h5>Example</h5> | ||
8065 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
8066 | <span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>, | ||
8067 | <span class="hljs-attr">"data"</span>: [ | ||
8068 | { | ||
8069 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
8070 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
8071 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | ||
8072 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | ||
8073 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | ||
8074 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
8075 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
8076 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
8077 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | ||
8078 | <span class="hljs-attr">"account"</span>: { | ||
8079 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
8080 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
8081 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
8082 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
8083 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
8084 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
8085 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
8086 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
8087 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
8088 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
8089 | <span class="hljs-attr">"avatar"</span>: { | ||
8090 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
8091 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
8092 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
8093 | } | ||
8094 | } | ||
8095 | } | ||
8096 | ] | ||
8097 | } | ||
8098 | </code></pre> | ||
8099 | <!-- </div> --> | ||
8100 | </section> | ||
8101 | </div> | ||
8102 | </div> | ||
8103 | </div> | ||
8104 | <div id="definition-CommentThreadPostResponse" class="definition panel" data-traverse-target="definition-CommentThreadPostResponse"> | ||
8105 | <h2 class="panel-title"> | ||
8106 | <a name="/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse: | ||
8107 | <!-- <span class="json-property-type"> | ||
8108 | <span class="json-property-type">object</span> | ||
8109 | <span class="json-property-range" title="Value limits"></span> | ||
8110 | |||
8111 | |||
8112 | </span> --> | ||
8113 | </h2> | ||
8114 | <div class="doc-row"> | ||
8115 | <div class="doc-copy"> | ||
8116 | <section class="json-schema-properties"> | ||
8117 | <dl> | ||
8118 | <dt data-property-name="comment"> | ||
8119 | <span class="json-property-name">comment:</span> | ||
8120 | <span class="json-property-type"> | ||
8121 | <span class=""> | ||
8122 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | ||
8123 | </span> | ||
8124 | </span> | ||
8125 | <span class="json-property-range" title="Value limits"></span> | ||
8126 | </dt> | ||
8127 | </dl> | ||
8128 | </section> | ||
8129 | </div> | ||
8130 | <div class="doc-examples"> | ||
8131 | <section> | ||
8132 | <h5>Example</h5> | ||
8133 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
8134 | <span class="hljs-attr">"comment"</span>: { | ||
8135 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
8136 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
8137 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | ||
8138 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | ||
8139 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | ||
8140 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | ||
8141 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
8142 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
8143 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | ||
8144 | <span class="hljs-attr">"account"</span>: { | ||
8145 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | ||
8146 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | ||
8147 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | ||
8148 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | ||
8149 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
8150 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | ||
8151 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | ||
8152 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | ||
8153 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
8154 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | ||
8155 | <span class="hljs-attr">"avatar"</span>: { | ||
8156 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | ||
8157 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | ||
8158 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | ||
8159 | } | ||
8160 | } | ||
8161 | } | ||
8162 | } | ||
8163 | </code></pre> | ||
8164 | <!-- </div> --> | ||
8165 | </section> | ||
8166 | </div> | ||
8167 | </div> | ||
8168 | </div> | ||
8169 | <div id="definition-AddUser" class="definition panel" data-traverse-target="definition-AddUser"> | ||
8170 | <h2 class="panel-title"> | ||
8171 | <a name="/definitions/AddUser"></a>AddUser: | ||
8172 | <!-- <span class="json-property-type"> | ||
8173 | <span class="json-property-type">object</span> | ||
8174 | <span class="json-property-range" title="Value limits"></span> | ||
8175 | |||
8176 | |||
8177 | </span> --> | ||
8178 | </h2> | ||
8179 | <div class="doc-row"> | ||
8180 | <div class="doc-copy"> | ||
8181 | <section class="json-schema-properties"> | ||
8182 | <dl> | ||
8183 | <dt data-property-name="username" class="has-description"> | ||
8184 | <span class="json-property-name">username:</span> | ||
8185 | <span class="json-property-type">string</span> | ||
8186 | <span class="json-property-range" title="Value limits"></span> | ||
8187 | <span class="json-property-required"></span> | ||
8188 | </dt> | ||
8189 | <dd> | ||
8190 | <p>The user username </p> | ||
8191 | </dd> | ||
8192 | <dt data-property-name="password" class="has-description"> | ||
8193 | <span class="json-property-name">password:</span> | ||
8194 | <span class="json-property-type">string</span> | ||
8195 | <span class="json-property-range" title="Value limits"></span> | ||
8196 | <span class="json-property-required"></span> | ||
8197 | </dt> | ||
8198 | <dd> | ||
8199 | <p>The user password </p> | ||
8200 | </dd> | ||
8201 | <dt data-property-name="email" class="has-description"> | ||
8202 | <span class="json-property-name">email:</span> | ||
8203 | <span class="json-property-type">string</span> | ||
8204 | <span class="json-property-range" title="Value limits"></span> | ||
8205 | <span class="json-property-required"></span> | ||
8206 | </dt> | ||
8207 | <dd> | ||
8208 | <p>The user email </p> | ||
8209 | </dd> | ||
8210 | <dt data-property-name="videoQuota" class="has-description"> | ||
8211 | <span class="json-property-name">videoQuota:</span> | ||
8212 | <span class="json-property-type">string</span> | ||
8213 | <span class="json-property-range" title="Value limits"></span> | ||
8214 | <span class="json-property-required"></span> | ||
8215 | </dt> | ||
8216 | <dd> | ||
8217 | <p>The user videoQuota </p> | ||
8218 | </dd> | ||
8219 | <dt data-property-name="role" class="has-description"> | ||
8220 | <span class="json-property-name">role:</span> | ||
8221 | <span class="json-property-type">string</span> | ||
8222 | <span class="json-property-range" title="Value limits"></span> | ||
8223 | <span class="json-property-required"></span> | ||
8224 | </dt> | ||
8225 | <dd> | ||
8226 | <p>The user role </p> | ||
8227 | </dd> | ||
8228 | </dl> | ||
8229 | </section> | ||
8230 | </div> | ||
8231 | <div class="doc-examples"> | ||
8232 | <section> | ||
8233 | <h5>Example</h5> | ||
8234 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
8235 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | ||
8236 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | ||
8237 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | ||
8238 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | ||
8239 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | ||
8240 | } | ||
8241 | </code></pre> | ||
8242 | <!-- </div> --> | ||
8243 | </section> | ||
8244 | </div> | ||
8245 | </div> | ||
8246 | </div> | ||
8247 | <div id="definition-UpdateUser" class="definition panel" data-traverse-target="definition-UpdateUser"> | ||
8248 | <h2 class="panel-title"> | ||
8249 | <a name="/definitions/UpdateUser"></a>UpdateUser: | ||
8250 | <!-- <span class="json-property-type"> | ||
8251 | <span class="json-property-type">object</span> | ||
8252 | <span class="json-property-range" title="Value limits"></span> | ||
8253 | |||
8254 | |||
8255 | </span> --> | ||
8256 | </h2> | ||
8257 | <div class="doc-row"> | ||
8258 | <div class="doc-copy"> | ||
8259 | <section class="json-schema-properties"> | ||
8260 | <dl> | ||
8261 | <dt data-property-name="id" class="has-description"> | ||
8262 | <span class="json-property-name">id:</span> | ||
8263 | <span class="json-property-type">string</span> | ||
8264 | <span class="json-property-range" title="Value limits"></span> | ||
8265 | <span class="json-property-required"></span> | ||
8266 | </dt> | ||
8267 | <dd> | ||
8268 | <p>The user id </p> | ||
8269 | </dd> | ||
8270 | <dt data-property-name="email" class="has-description"> | ||
8271 | <span class="json-property-name">email:</span> | ||
8272 | <span class="json-property-type">string</span> | ||
8273 | <span class="json-property-range" title="Value limits"></span> | ||
8274 | <span class="json-property-required"></span> | ||
8275 | </dt> | ||
8276 | <dd> | ||
8277 | <p>The updated email of the user </p> | ||
8278 | </dd> | ||
8279 | <dt data-property-name="videoQuota" class="has-description"> | ||
8280 | <span class="json-property-name">videoQuota:</span> | ||
8281 | <span class="json-property-type">string</span> | ||
8282 | <span class="json-property-range" title="Value limits"></span> | ||
8283 | <span class="json-property-required"></span> | ||
8284 | </dt> | ||
8285 | <dd> | ||
8286 | <p>The updated videoQuota of the user </p> | ||
8287 | </dd> | ||
8288 | <dt data-property-name="role" class="has-description"> | ||
8289 | <span class="json-property-name">role:</span> | ||
8290 | <span class="json-property-type">string</span> | ||
8291 | <span class="json-property-range" title="Value limits"></span> | ||
8292 | <span class="json-property-required"></span> | ||
8293 | </dt> | ||
8294 | <dd> | ||
8295 | <p>The updated role of the user </p> | ||
8296 | </dd> | ||
8297 | </dl> | ||
8298 | </section> | ||
8299 | </div> | ||
8300 | <div class="doc-examples"> | ||
8301 | <section> | ||
8302 | <h5>Example</h5> | ||
8303 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
8304 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
8305 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | ||
8306 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | ||
8307 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | ||
8308 | } | ||
8309 | </code></pre> | ||
8310 | <!-- </div> --> | ||
8311 | </section> | ||
8312 | </div> | ||
8313 | </div> | ||
8314 | </div> | ||
8315 | <div id="definition-UpdateMe" class="definition panel" data-traverse-target="definition-UpdateMe"> | ||
8316 | <h2 class="panel-title"> | ||
8317 | <a name="/definitions/UpdateMe"></a>UpdateMe: | ||
8318 | <!-- <span class="json-property-type"> | ||
8319 | <span class="json-property-type">object</span> | ||
8320 | <span class="json-property-range" title="Value limits"></span> | ||
8321 | |||
8322 | |||
8323 | </span> --> | ||
8324 | </h2> | ||
8325 | <div class="doc-row"> | ||
8326 | <div class="doc-copy"> | ||
8327 | <section class="json-schema-properties"> | ||
8328 | <dl> | ||
8329 | <dt data-property-name="password" class="has-description"> | ||
8330 | <span class="json-property-name">password:</span> | ||
8331 | <span class="json-property-type">string</span> | ||
8332 | <span class="json-property-range" title="Value limits"></span> | ||
8333 | <span class="json-property-required"></span> | ||
8334 | </dt> | ||
8335 | <dd> | ||
8336 | <p>Your new password </p> | ||
8337 | </dd> | ||
8338 | <dt data-property-name="email" class="has-description"> | ||
8339 | <span class="json-property-name">email:</span> | ||
8340 | <span class="json-property-type">string</span> | ||
8341 | <span class="json-property-range" title="Value limits"></span> | ||
8342 | <span class="json-property-required"></span> | ||
8343 | </dt> | ||
8344 | <dd> | ||
8345 | <p>Your new email </p> | ||
8346 | </dd> | ||
8347 | <dt data-property-name="displayNSFW" class="has-description"> | ||
8348 | <span class="json-property-name">displayNSFW:</span> | ||
8349 | <span class="json-property-type">string</span> | ||
8350 | <span class="json-property-range" title="Value limits"></span> | ||
8351 | <span class="json-property-required"></span> | ||
8352 | </dt> | ||
8353 | <dd> | ||
8354 | <p>Your new displayNSFW </p> | ||
8355 | </dd> | ||
8356 | <dt data-property-name="autoPlayVideo" class="has-description"> | ||
8357 | <span class="json-property-name">autoPlayVideo:</span> | ||
8358 | <span class="json-property-type">string</span> | ||
8359 | <span class="json-property-range" title="Value limits"></span> | ||
8360 | <span class="json-property-required"></span> | ||
8361 | </dt> | ||
8362 | <dd> | ||
8363 | <p>Your new autoPlayVideo </p> | ||
8364 | </dd> | ||
8365 | </dl> | ||
8366 | </section> | ||
8367 | </div> | ||
8368 | <div class="doc-examples"> | ||
8369 | <section> | ||
8370 | <h5>Example</h5> | ||
8371 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
8372 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | ||
8373 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | ||
8374 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>, | ||
8375 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span> | ||
8376 | } | ||
8377 | </code></pre> | ||
8378 | <!-- </div> --> | ||
8379 | </section> | ||
8380 | </div> | ||
8381 | </div> | ||
8382 | </div> | ||
8383 | <div id="definition-GetMeVideoRating" class="definition panel" data-traverse-target="definition-GetMeVideoRating"> | ||
8384 | <h2 class="panel-title"> | ||
8385 | <a name="/definitions/GetMeVideoRating"></a>GetMeVideoRating: | ||
8386 | <!-- <span class="json-property-type"> | ||
8387 | <span class="json-property-type">object</span> | ||
8388 | <span class="json-property-range" title="Value limits"></span> | ||
8389 | |||
8390 | |||
8391 | </span> --> | ||
8392 | </h2> | ||
8393 | <div class="doc-row"> | ||
8394 | <div class="doc-copy"> | ||
8395 | <section class="json-schema-properties"> | ||
8396 | <dl> | ||
8397 | <dt data-property-name="id" class="has-description"> | ||
8398 | <span class="json-property-name">id:</span> | ||
8399 | <span class="json-property-type">string</span> | ||
8400 | <span class="json-property-range" title="Value limits"></span> | ||
8401 | <span class="json-property-required"></span> | ||
8402 | </dt> | ||
8403 | <dd> | ||
8404 | <p>Id of the video </p> | ||
8405 | </dd> | ||
8406 | <dt data-property-name="rating" class="has-description"> | ||
8407 | <span class="json-property-name">rating:</span> | ||
8408 | <span class="json-property-type">number</span> | ||
8409 | <span class="json-property-range" title="Value limits"></span> | ||
8410 | <span class="json-property-required"></span> | ||
8411 | </dt> | ||
8412 | <dd> | ||
8413 | <p>Rating of the video </p> | ||
8414 | </dd> | ||
8415 | </dl> | ||
8416 | </section> | ||
8417 | </div> | ||
8418 | <div class="doc-examples"> | ||
8419 | <section> | ||
8420 | <h5>Example</h5> | ||
8421 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
8422 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | ||
8423 | <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span> | ||
8424 | } | ||
8425 | </code></pre> | ||
8426 | <!-- </div> --> | ||
8427 | </section> | ||
8428 | </div> | ||
8429 | </div> | ||
8430 | </div> | ||
8431 | <div id="definition-RegisterUser" class="definition panel" data-traverse-target="definition-RegisterUser"> | ||
8432 | <h2 class="panel-title"> | ||
8433 | <a name="/definitions/RegisterUser"></a>RegisterUser: | ||
8434 | <!-- <span class="json-property-type"> | ||
8435 | <span class="json-property-type">object</span> | ||
8436 | <span class="json-property-range" title="Value limits"></span> | ||
8437 | |||
8438 | |||
8439 | </span> --> | ||
8440 | </h2> | ||
8441 | <div class="doc-row"> | ||
8442 | <div class="doc-copy"> | ||
8443 | <section class="json-schema-properties"> | ||
8444 | <dl> | ||
8445 | <dt data-property-name="username" class="has-description"> | ||
8446 | <span class="json-property-name">username:</span> | ||
8447 | <span class="json-property-type">string</span> | ||
8448 | <span class="json-property-range" title="Value limits"></span> | ||
8449 | <span class="json-property-required"></span> | ||
8450 | </dt> | ||
8451 | <dd> | ||
8452 | <p>The username of the user </p> | ||
8453 | </dd> | ||
8454 | <dt data-property-name="password" class="has-description"> | ||
8455 | <span class="json-property-name">password:</span> | ||
8456 | <span class="json-property-type">string</span> | ||
8457 | <span class="json-property-range" title="Value limits"></span> | ||
8458 | <span class="json-property-required"></span> | ||
8459 | </dt> | ||
8460 | <dd> | ||
8461 | <p>The password of the user </p> | ||
8462 | </dd> | ||
8463 | <dt data-property-name="email" class="has-description"> | ||
8464 | <span class="json-property-name">email:</span> | ||
8465 | <span class="json-property-type">string</span> | ||
8466 | <span class="json-property-range" title="Value limits"></span> | ||
8467 | <span class="json-property-required"></span> | ||
8468 | </dt> | ||
8469 | <dd> | ||
8470 | <p>The email of the user </p> | ||
8471 | </dd> | ||
8472 | </dl> | ||
8473 | </section> | ||
8474 | </div> | ||
8475 | <div class="doc-examples"> | ||
8476 | <section> | ||
8477 | <h5>Example</h5> | ||
8478 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
8479 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | ||
8480 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | ||
8481 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span> | ||
8482 | } | ||
8483 | </code></pre> | ||
8484 | <!-- </div> --> | ||
8485 | </section> | ||
8486 | </div> | ||
8487 | </div> | ||
8488 | </div> | ||
8489 | <div id="definition-VideoChannelInput" class="definition panel" data-traverse-target="definition-VideoChannelInput"> | ||
8490 | <h2 class="panel-title"> | ||
8491 | <a name="/definitions/VideoChannelInput"></a>VideoChannelInput: | ||
8492 | <!-- <span class="json-property-type"> | ||
8493 | <span class="json-property-type">object</span> | ||
8494 | <span class="json-property-range" title="Value limits"></span> | ||
8495 | |||
8496 | |||
8497 | </span> --> | ||
8498 | </h2> | ||
8499 | <div class="doc-row"> | ||
8500 | <div class="doc-copy"> | ||
8501 | <section class="json-schema-properties"> | ||
8502 | <dl> | ||
8503 | <dt data-property-name="name"> | ||
8504 | <span class="json-property-name">name:</span> | ||
8505 | <span class="json-property-type">string</span> | ||
8506 | <span class="json-property-range" title="Value limits"></span> | ||
8507 | </dt> | ||
8508 | <dt data-property-name="description"> | ||
8509 | <span class="json-property-name">description:</span> | ||
8510 | <span class="json-property-type">string</span> | ||
8511 | <span class="json-property-range" title="Value limits"></span> | ||
8512 | </dt> | ||
8513 | </dl> | ||
8514 | </section> | ||
8515 | </div> | ||
8516 | <div class="doc-examples"> | ||
8517 | <section> | ||
8518 | <h5>Example</h5> | ||
8519 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
8520 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | ||
8521 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | ||
8522 | } | ||
8523 | </code></pre> | ||
8524 | <!-- </div> --> | ||
8525 | </section> | ||
8526 | </div> | ||
8527 | </div> | ||
8528 | </div> | ||
8529 | <div class="doc-row no-margin"> | ||
8530 | <div class="doc-copy doc-separator"> | ||
8531 | <a class="powered-by" href="https://sourcey.com/spectacle">Documentation by | ||
8532 | <span>Spectacle</span> | ||
8533 | </a> | ||
8534 | </div> | ||
8535 | </div> | ||
8536 | </article> | ||
8537 | </div> | ||
8538 | </div> | ||
8539 | </body> | ||
8540 | </html> \ No newline at end of file | ||