]>
Commit | Line | Data |
---|---|---|
5e1c08eb C |
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>API Reference</h5> | |
21 | <a href="#introduction">Introduction</a> | |
22 | <h5>Operations</h5> | |
23 | <section> | |
24 | <a href="#tag-Accounts">Accounts</a> | |
25 | <ul> | |
26 | <li> | |
27 | <a href="#operation--accounts--id--get"> GET /accounts/{id} </a> | |
28 | </li> | |
29 | <li> | |
30 | <a href="#operation--accounts-get"> GET /accounts </a> | |
31 | </li> | |
32 | </ul> | |
33 | </section> | |
34 | <section> | |
35 | <a href="#tag-Config">Config</a> | |
36 | <ul> | |
37 | <li> | |
38 | <a href="#operation--config-get"> GET /config </a> | |
39 | </li> | |
40 | </ul> | |
41 | </section> | |
42 | <section> | |
43 | <a href="#tag-Job">Job</a> | |
44 | <ul> | |
45 | <li> | |
46 | <a href="#operation--jobs-get"> GET /jobs </a> | |
47 | </li> | |
48 | </ul> | |
49 | </section> | |
50 | <section> | |
51 | <a href="#tag-ServerFollowing">ServerFollowing</a> | |
52 | <ul> | |
53 | <li> | |
54 | <a href="#operation--server-following--host--delete"> DELETE /server/following/{host} </a> | |
55 | </li> | |
56 | <li> | |
57 | <a href="#operation--server-followers-get"> GET /server/followers </a> | |
58 | </li> | |
59 | <li> | |
60 | <a href="#operation--server-following-get"> GET /server/following </a> | |
61 | </li> | |
62 | <li> | |
63 | <a href="#operation--server-following-post"> POST /server/following </a> | |
64 | </li> | |
65 | </ul> | |
66 | </section> | |
67 | <section> | |
68 | <a href="#tag-User">User</a> | |
69 | <ul> | |
70 | <li> | |
71 | <a href="#operation--users-post"> POST /users </a> | |
72 | </li> | |
73 | <li> | |
74 | <a href="#operation--users-get"> GET /users </a> | |
75 | </li> | |
76 | <li> | |
77 | <a href="#operation--users--id--delete"> DELETE /users/{id} </a> | |
78 | </li> | |
79 | <li> | |
80 | <a href="#operation--users--id--get"> GET /users/{id} </a> | |
81 | </li> | |
82 | <li> | |
83 | <a href="#operation--users--id--put"> PUT /users/{id} </a> | |
84 | </li> | |
85 | <li> | |
86 | <a href="#operation--users-me-get"> GET /users/me </a> | |
87 | </li> | |
88 | <li> | |
89 | <a href="#operation--users-me-put"> PUT /users/me </a> | |
90 | </li> | |
91 | <li> | |
92 | <a href="#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used </a> | |
93 | </li> | |
94 | <li> | |
95 | <a href="#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating </a> | |
96 | </li> | |
97 | <li> | |
98 | <a href="#operation--users-me-videos-get"> GET /users/me/videos </a> | |
99 | </li> | |
100 | <li> | |
101 | <a href="#operation--users-register-post"> POST /users/register </a> | |
102 | </li> | |
103 | <li> | |
104 | <a href="#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick </a> | |
105 | </li> | |
106 | </ul> | |
107 | </section> | |
108 | <section> | |
109 | <a href="#tag-Video">Video</a> | |
110 | <ul> | |
111 | <li> | |
112 | <a href="#operation--video-get"> GET /video </a> | |
113 | </li> | |
114 | <li> | |
115 | <a href="#operation--video-categories-get"> GET /video/categories </a> | |
116 | </li> | |
117 | <li> | |
118 | <a href="#operation--video-licences-get"> GET /video/licences </a> | |
119 | </li> | |
120 | <li> | |
121 | <a href="#operation--video-languages-get"> GET /video/languages </a> | |
122 | </li> | |
123 | <li> | |
124 | <a href="#operation--video-privacies-get"> GET /video/privacies </a> | |
125 | </li> | |
126 | <li> | |
127 | <a href="#operation--video-search-get"> GET /video/search </a> | |
128 | </li> | |
129 | <li> | |
130 | <a href="#operation--video--id--put"> PUT /video/{id} </a> | |
131 | </li> | |
132 | <li> | |
133 | <a href="#operation--video--id--get"> GET /video/{id} </a> | |
134 | </li> | |
135 | <li> | |
136 | <a href="#operation--video--id--delete"> DELETE /video/{id} </a> | |
137 | </li> | |
138 | <li> | |
139 | <a href="#operation--video--id--description-get"> GET /video/{id}/description </a> | |
140 | </li> | |
141 | <li> | |
142 | <a href="#operation--video--id--views-post"> POST /video/{id}/views </a> | |
143 | </li> | |
144 | <li> | |
145 | <a href="#operation--video-upload-post"> POST /video/upload </a> | |
146 | </li> | |
147 | </ul> | |
148 | </section> | |
149 | <section> | |
150 | <a href="#tag-VideoAbuse">VideoAbuse</a> | |
151 | <ul> | |
152 | <li> | |
153 | <a href="#operation--video-abuse-get"> GET /video/abuse </a> | |
154 | </li> | |
155 | <li> | |
156 | <a href="#operation--video--id--abuse-post"> POST /video/{id}/abuse </a> | |
157 | </li> | |
158 | </ul> | |
159 | </section> | |
160 | <section> | |
161 | <a href="#tag-VideoBlacklist">VideoBlacklist</a> | |
162 | <ul> | |
163 | <li> | |
164 | <a href="#operation--video--videoId--blacklist-post"> POST /video/{videoId}/blacklist </a> | |
165 | </li> | |
166 | <li> | |
167 | <a href="#operation--video--videoId--blacklist-delete"> DELETE /video/{videoId}/blacklist </a> | |
168 | </li> | |
169 | <li> | |
170 | <a href="#operation--video-blacklist-get"> GET /video/blacklist </a> | |
171 | </li> | |
172 | </ul> | |
173 | </section> | |
174 | <section> | |
175 | <a href="#tag-VideoChannel">VideoChannel</a> | |
176 | <ul> | |
177 | <li> | |
178 | <a href="#operation--video-channels-get"> GET /video/channels </a> | |
179 | </li> | |
180 | <li> | |
181 | <a href="#operation--video-channels-post"> POST /video/channels </a> | |
182 | </li> | |
183 | <li> | |
184 | <a href="#operation--video-channels--id--get"> GET /video/channels/{id} </a> | |
185 | </li> | |
186 | <li> | |
187 | <a href="#operation--video-channels--id--put"> PUT /video/channels/{id} </a> | |
188 | </li> | |
189 | <li> | |
190 | <a href="#operation--video-channels--id--delete"> DELETE /video/channels/{id} </a> | |
191 | </li> | |
192 | <li> | |
193 | <a href="#operation--video-accounts--accountId--channels-get"> GET /video/accounts/{accountId}/channels </a> | |
194 | </li> | |
195 | </ul> | |
196 | </section> | |
197 | <section> | |
198 | <a href="#tag-VideoComment">VideoComment</a> | |
199 | <ul> | |
200 | <li> | |
201 | <a href="#operation--video--videoId--comment-threads-get"> GET /video/{videoId}/comment-threads </a> | |
202 | </li> | |
203 | <li> | |
204 | <a href="#operation--video--videoId--comment-threads-post"> POST /video/{videoId}/comment-threads </a> | |
205 | </li> | |
206 | <li> | |
207 | <a href="#operation--video--videoId--comment-threads--threadId--get"> GET /video/{videoId}/comment-threads/{threadId} </a> | |
208 | </li> | |
209 | <li> | |
210 | <a href="#operation--video--videoId--comments--commentId--post"> POST /video/{videoId}/comments/{commentId} </a> | |
211 | </li> | |
212 | <li> | |
213 | <a href="#operation--video--videoId--comments--commentId--delete"> DELETE /video/{videoId}/comments/{commentId} </a> | |
214 | </li> | |
215 | </ul> | |
216 | </section> | |
217 | <section> | |
218 | <a href="#tag-VideoRate">VideoRate</a> | |
219 | <ul> | |
220 | <li> | |
221 | <a href="#operation--video--id--rate-put"> PUT /video/{id}/rate </a> | |
222 | </li> | |
223 | </ul> | |
224 | </section> | |
225 | <h5>Schema Definitions</h5> | |
226 | <a href="#definition-Video"> Video </a> | |
227 | <a href="#definition-VideoAbuse"> VideoAbuse </a> | |
228 | <a href="#definition-VideoBlacklist"> VideoBlacklist </a> | |
229 | <a href="#definition-VideoChannel"> VideoChannel </a> | |
230 | <a href="#definition-VideoComment"> VideoComment </a> | |
231 | <a href="#definition-VideoCommentThreadTree"> VideoCommentThreadTree </a> | |
232 | <a href="#definition-Avatar"> Avatar </a> | |
233 | <a href="#definition-Actor"> Actor </a> | |
234 | <a href="#definition-Account"> Account </a> | |
235 | <a href="#definition-User"> User </a> | |
236 | <a href="#definition-ServerConfig"> ServerConfig </a> | |
237 | <a href="#definition-Follow"> Follow </a> | |
238 | <a href="#definition-Job"> Job </a> | |
239 | <a href="#definition-AddUserResponse"> AddUserResponse </a> | |
240 | <a href="#definition-VideoUploadResponse"> VideoUploadResponse </a> | |
241 | <a href="#definition-AddUser"> AddUser </a> | |
242 | <a href="#definition-UpdateUser"> UpdateUser </a> | |
243 | <a href="#definition-UpdateMe"> UpdateMe </a> | |
244 | <a href="#definition-GetMeVideoRating"> GetMeVideoRating </a> | |
245 | <a href="#definition-RegisterUser"> RegisterUser </a> | |
246 | <a href="#definition-VideoChannelInput"> VideoChannelInput </a> | |
247 | </nav> | |
248 | </div> | |
249 | <div id="docs" class="row collapse expanded drawer" data-drawer> | |
250 | <button class="floating-menu-icon" type="button" data-drawer-slide="right"> | |
251 | <span class="hamburger"></span> | |
252 | </button> | |
253 | <div class="example-box doc-content"></div> | |
254 | <article> | |
255 | <div id="introduction" data-traverse-target="introduction"> | |
256 | <h1 class="doc-title">PeerTube | |
257 | <span>API Reference</span> | |
258 | </h1> | |
259 | <div class="doc-row"> | |
260 | <div class="doc-copy"> | |
261 | <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.</p> | |
262 | </div> | |
263 | <div class="doc-examples"> | |
264 | <section> | |
265 | <h5>Version: | |
266 | <span>0.0.15-alpha</span> | |
267 | </h5> | |
268 | </section> | |
269 | </div> | |
270 | </div> | |
271 | </div> | |
272 | <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1> | |
273 | <div id="operation--accounts--id--get" class="operation panel" data-traverse-target="operation--accounts--id--get"> | |
274 | <!-- <section class="operation-tags row"> --> | |
275 | <!-- <div class="doc-copy"> --> | |
276 | <div class="operation-tags"> | |
277 | <a class="label" href="#tag-Accounts">Accounts</a> | |
278 | <!----> | |
279 | </div> | |
280 | <!-- </div> --> | |
281 | <!-- </section> --> | |
282 | <h2 class="operation-title"> | |
283 | <span class="operation-name"> | |
284 | <span class="operation-name">GET</span> | |
285 | <span class="operation-path">/accounts/{id}</span> | |
286 | </span> | |
287 | </h2> | |
288 | <div class="doc-row"> | |
289 | <div class="doc-copy"> | |
290 | <section class="swagger-request-params"> | |
291 | <div class="prop-row prop-group"> | |
292 | <div class="prop-name"> | |
293 | <div class="prop-title">id</div> | |
294 | <span class="json-property-required"></span> | |
295 | </div> | |
296 | <div class="prop-value"> | |
297 | <p>The id of the account</p> | |
298 | </div> | |
299 | </div> | |
300 | <div class="prop-row prop-inner"> | |
301 | <div class="prop-name param-label">type</div> | |
302 | <div class="prop-value"> | |
303 | <span class="json-property-type">string</span> | |
304 | <span class="json-property-range" title="Value limits"></span> | |
305 | </div> | |
306 | </div> | |
307 | <div class="prop-row prop-inner"> | |
308 | <div class="prop-name param-label">in</div> | |
309 | <div class="prop-value">path</div> | |
310 | </div> | |
311 | </section> | |
312 | </div> | |
313 | <div class="doc-examples"></div> | |
314 | </div> | |
315 | <div class="doc-row"> | |
316 | <div class="doc-copy"> | |
317 | <section class="swagger-responses"> | |
318 | <div class="prop-row prop-group"> | |
319 | <div class="prop-name"> | |
320 | <div class="prop-title">200 OK</div> | |
321 | <div class="prop-ref"> | |
322 | <span class=""> | |
323 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
324 | </span> | |
325 | </div> | |
326 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
327 | </div> | |
328 | <div class="prop-value"> | |
329 | <p>successful operation</p> | |
330 | </div> | |
331 | </div> | |
332 | </section> | |
333 | </div> | |
334 | <div class="doc-examples"> | |
335 | <h5>Response Content-Types: | |
336 | <span>application/json</span> | |
337 | </h5> | |
338 | <section> | |
339 | <h5>Response Example | |
340 | <span>(200 OK)</span> | |
341 | </h5> | |
342 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
343 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
344 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
345 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
346 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
347 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
348 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
349 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
350 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
351 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
352 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
353 | <span class="hljs-attr">"avatar"</span>: { | |
354 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
355 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
356 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
357 | } | |
358 | } | |
359 | </code></pre> | |
360 | <!-- </div> --> | |
361 | </section> | |
362 | </div> | |
363 | </div> | |
364 | </div> | |
365 | <div id="operation--accounts-get" class="operation panel" data-traverse-target="operation--accounts-get"> | |
366 | <!-- <section class="operation-tags row"> --> | |
367 | <!-- <div class="doc-copy"> --> | |
368 | <div class="operation-tags"> | |
369 | <a class="label" href="#tag-Accounts">Accounts</a> | |
370 | <!----> | |
371 | </div> | |
372 | <!-- </div> --> | |
373 | <!-- </section> --> | |
374 | <h2 class="operation-title"> | |
375 | <span class="operation-name"> | |
376 | <span class="operation-name">GET</span> | |
377 | <span class="operation-path">/accounts</span> | |
378 | </span> | |
379 | </h2> | |
380 | <div class="doc-row"> | |
381 | <div class="doc-copy"> </div> | |
382 | <div class="doc-examples"></div> | |
383 | </div> | |
384 | <div class="doc-row"> | |
385 | <div class="doc-copy"> | |
386 | <section class="swagger-responses"> | |
387 | <div class="prop-row prop-group"> | |
388 | <div class="prop-name"> | |
389 | <div class="prop-title">200 OK</div> | |
390 | <div class="prop-ref"> | |
391 | <span class="json-schema-ref-array"> | |
392 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
393 | </span> | |
394 | </div> | |
395 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
396 | </div> | |
397 | <div class="prop-value"> | |
398 | <p>successful operation</p> | |
399 | </div> | |
400 | </div> | |
401 | </section> | |
402 | </div> | |
403 | <div class="doc-examples"> | |
404 | <h5>Response Content-Types: | |
405 | <span>application/json</span> | |
406 | </h5> | |
407 | <section> | |
408 | <h5>Response Example | |
409 | <span>(200 OK)</span> | |
410 | </h5> | |
411 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
412 | { | |
413 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
414 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
415 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
416 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
417 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
418 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
419 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
420 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
421 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
422 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
423 | <span class="hljs-attr">"avatar"</span>: { | |
424 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
425 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
426 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
427 | } | |
428 | } | |
429 | ] | |
430 | </code></pre> | |
431 | <!-- </div> --> | |
432 | </section> | |
433 | </div> | |
434 | </div> | |
435 | </div> | |
436 | <h1 id="tag-Config" class="swagger-summary-tag" data-traverse-target="tag-Config">Config</h1> | |
437 | <div id="operation--config-get" class="operation panel" data-traverse-target="operation--config-get"> | |
438 | <!-- <section class="operation-tags row"> --> | |
439 | <!-- <div class="doc-copy"> --> | |
440 | <div class="operation-tags"> | |
441 | <a class="label" href="#tag-Config">Config</a> | |
442 | <!----> | |
443 | </div> | |
444 | <!-- </div> --> | |
445 | <!-- </section> --> | |
446 | <h2 class="operation-title"> | |
447 | <span class="operation-name"> | |
448 | <span class="operation-name">GET</span> | |
449 | <span class="operation-path">/config</span> | |
450 | </span> | |
451 | </h2> | |
452 | <div class="doc-row"> | |
453 | <div class="doc-copy"> </div> | |
454 | <div class="doc-examples"></div> | |
455 | </div> | |
456 | <div class="doc-row"> | |
457 | <div class="doc-copy"> | |
458 | <section class="swagger-responses"> | |
459 | <div class="prop-row prop-group"> | |
460 | <div class="prop-name"> | |
461 | <div class="prop-title">200 OK</div> | |
462 | <div class="prop-ref"> | |
463 | <span class=""> | |
464 | <a class="json-schema-ref" href="#/definitions/ServerConfig">ServerConfig</a> | |
465 | </span> | |
466 | </div> | |
467 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
468 | </div> | |
469 | <div class="prop-value"> | |
470 | <p>successful operation</p> | |
471 | </div> | |
472 | </div> | |
473 | </section> | |
474 | </div> | |
475 | <div class="doc-examples"> | |
476 | <h5>Response Content-Types: | |
477 | <span>application/json</span> | |
478 | </h5> | |
479 | <section> | |
480 | <h5>Response Example | |
481 | <span>(200 OK)</span> | |
482 | </h5> | |
483 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
484 | <span class="hljs-attr">"signup"</span>: { | |
485 | <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span> | |
486 | }, | |
487 | <span class="hljs-attr">"transcoding"</span>: { | |
488 | <span class="hljs-attr">"enabledResolutions"</span>: [ | |
489 | <span class="hljs-string">"number"</span> | |
490 | ] | |
491 | }, | |
492 | <span class="hljs-attr">"avatar"</span>: { | |
493 | <span class="hljs-attr">"file"</span>: { | |
494 | <span class="hljs-attr">"size"</span>: { | |
495 | <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span> | |
496 | } | |
497 | }, | |
498 | <span class="hljs-attr">"extensions"</span>: [ | |
499 | <span class="hljs-string">"string"</span> | |
500 | ] | |
501 | }, | |
502 | <span class="hljs-attr">"video"</span>: { | |
503 | <span class="hljs-attr">"file"</span>: { | |
504 | <span class="hljs-attr">"extensions"</span>: [ | |
505 | <span class="hljs-string">"string"</span> | |
506 | ] | |
507 | } | |
508 | } | |
509 | } | |
510 | </code></pre> | |
511 | <!-- </div> --> | |
512 | </section> | |
513 | </div> | |
514 | </div> | |
515 | </div> | |
516 | <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1> | |
517 | <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get"> | |
518 | <!-- <section class="operation-tags row"> --> | |
519 | <!-- <div class="doc-copy"> --> | |
520 | <div class="operation-tags"> | |
521 | <a class="label" href="#tag-Job">Job</a> | |
522 | <!----> | |
523 | </div> | |
524 | <!-- </div> --> | |
525 | <!-- </section> --> | |
526 | <h2 class="operation-title"> | |
527 | <span class="operation-name"> | |
528 | <span class="operation-name">GET</span> | |
529 | <span class="operation-path">/jobs</span> | |
530 | </span> | |
531 | </h2> | |
532 | <div class="doc-row"> | |
533 | <div class="doc-copy"> </div> | |
534 | <div class="doc-examples"></div> | |
535 | </div> | |
536 | <div class="doc-row"> | |
537 | <div class="doc-copy"> | |
538 | <section class="swagger-responses"> | |
539 | <div class="prop-row prop-group"> | |
540 | <div class="prop-name"> | |
541 | <div class="prop-title">200 OK</div> | |
542 | <div class="prop-ref"> | |
543 | <span class="json-schema-ref-array"> | |
544 | <a class="json-schema-ref" href="#/definitions/Job">Job</a> | |
545 | </span> | |
546 | </div> | |
547 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
548 | </div> | |
549 | <div class="prop-value"> | |
550 | <p>successful operation</p> | |
551 | </div> | |
552 | </div> | |
553 | </section> | |
554 | </div> | |
555 | <div class="doc-examples"> | |
556 | <h5>Response Content-Types: | |
557 | <span>application/json</span> | |
558 | </h5> | |
559 | <section> | |
560 | <h5>Response Example | |
561 | <span>(200 OK)</span> | |
562 | </h5> | |
563 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
564 | { | |
565 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
566 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
567 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>, | |
568 | <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>, | |
569 | <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>, | |
570 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
571 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
572 | } | |
573 | ] | |
574 | </code></pre> | |
575 | <!-- </div> --> | |
576 | </section> | |
577 | </div> | |
578 | </div> | |
579 | </div> | |
580 | <h1 id="tag-ServerFollowing" class="swagger-summary-tag" data-traverse-target="tag-ServerFollowing">ServerFollowing</h1> | |
581 | <div id="operation--server-following--host--delete" class="operation panel" data-traverse-target="operation--server-following--host--delete"> | |
582 | <!-- <section class="operation-tags row"> --> | |
583 | <!-- <div class="doc-copy"> --> | |
584 | <div class="operation-tags"> | |
585 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
586 | <!----> | |
587 | </div> | |
588 | <!-- </div> --> | |
589 | <!-- </section> --> | |
590 | <h2 class="operation-title"> | |
591 | <span class="operation-name"> | |
592 | <span class="operation-name">DELETE</span> | |
593 | <span class="operation-path">/server/following/{host}</span> | |
594 | </span> | |
595 | </h2> | |
596 | <div class="doc-row"> | |
597 | <div class="doc-copy"> | |
598 | <section class="swagger-request-params"> | |
599 | <div class="prop-row prop-group"> | |
600 | <div class="prop-name"> | |
601 | <div class="prop-title">host</div> | |
602 | <span class="json-property-required"></span> | |
603 | </div> | |
604 | <div class="prop-value"> | |
605 | <p>The host to unfollow </p> | |
606 | </div> | |
607 | </div> | |
608 | <div class="prop-row prop-inner"> | |
609 | <div class="prop-name param-label">type</div> | |
610 | <div class="prop-value"> | |
611 | <span class="json-property-type">string</span> | |
612 | <span class="json-property-range" title="Value limits"></span> | |
613 | </div> | |
614 | </div> | |
615 | <div class="prop-row prop-inner"> | |
616 | <div class="prop-name param-label">in</div> | |
617 | <div class="prop-value">path</div> | |
618 | </div> | |
619 | </section> | |
620 | </div> | |
621 | <div class="doc-examples"></div> | |
622 | </div> | |
623 | <div class="doc-row"> | |
624 | <div class="doc-copy"> | |
625 | <section class="swagger-responses"> | |
626 | <div class="prop-row prop-group"> | |
627 | <div class="prop-name"> | |
628 | <div class="prop-title">201 Created</div> | |
629 | </div> | |
630 | <div class="prop-value"> | |
631 | <p>successful operation</p> | |
632 | </div> | |
633 | </div> | |
634 | </section> | |
635 | </div> | |
636 | <div class="doc-examples"> | |
637 | <h5>Response Content-Types: | |
638 | <span>application/json</span> | |
639 | </h5> | |
640 | </div> | |
641 | </div> | |
642 | </div> | |
643 | <div id="operation--server-followers-get" class="operation panel" data-traverse-target="operation--server-followers-get"> | |
644 | <!-- <section class="operation-tags row"> --> | |
645 | <!-- <div class="doc-copy"> --> | |
646 | <div class="operation-tags"> | |
647 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
648 | <!----> | |
649 | </div> | |
650 | <!-- </div> --> | |
651 | <!-- </section> --> | |
652 | <h2 class="operation-title"> | |
653 | <span class="operation-name"> | |
654 | <span class="operation-name">GET</span> | |
655 | <span class="operation-path">/server/followers</span> | |
656 | </span> | |
657 | </h2> | |
658 | <div class="doc-row"> | |
659 | <div class="doc-copy"> </div> | |
660 | <div class="doc-examples"></div> | |
661 | </div> | |
662 | <div class="doc-row"> | |
663 | <div class="doc-copy"> | |
664 | <section class="swagger-responses"> | |
665 | <div class="prop-row prop-group"> | |
666 | <div class="prop-name"> | |
667 | <div class="prop-title">200 OK</div> | |
668 | <div class="prop-ref"> | |
669 | <span class="json-schema-ref-array"> | |
670 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
671 | </span> | |
672 | </div> | |
673 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
674 | </div> | |
675 | <div class="prop-value"> | |
676 | <p>successful operation</p> | |
677 | </div> | |
678 | </div> | |
679 | </section> | |
680 | </div> | |
681 | <div class="doc-examples"> | |
682 | <h5>Response Content-Types: | |
683 | <span>application/json</span> | |
684 | </h5> | |
685 | <section> | |
686 | <h5>Response Example | |
687 | <span>(200 OK)</span> | |
688 | </h5> | |
689 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
690 | { | |
691 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
692 | <span class="hljs-attr">"follower"</span>: { | |
693 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
694 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
695 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
696 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
697 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
698 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
699 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
700 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
701 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
702 | <span class="hljs-attr">"avatar"</span>: { | |
703 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
704 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
705 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
706 | } | |
707 | }, | |
708 | <span class="hljs-attr">"following"</span>: { | |
709 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
710 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
711 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
712 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
713 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
714 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
715 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
716 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
717 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
718 | <span class="hljs-attr">"avatar"</span>: { | |
719 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
720 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
721 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
722 | } | |
723 | }, | |
724 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
725 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
726 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
727 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
728 | } | |
729 | ] | |
730 | </code></pre> | |
731 | <!-- </div> --> | |
732 | </section> | |
733 | </div> | |
734 | </div> | |
735 | </div> | |
736 | <div id="operation--server-following-get" class="operation panel" data-traverse-target="operation--server-following-get"> | |
737 | <!-- <section class="operation-tags row"> --> | |
738 | <!-- <div class="doc-copy"> --> | |
739 | <div class="operation-tags"> | |
740 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
741 | <!----> | |
742 | </div> | |
743 | <!-- </div> --> | |
744 | <!-- </section> --> | |
745 | <h2 class="operation-title"> | |
746 | <span class="operation-name"> | |
747 | <span class="operation-name">GET</span> | |
748 | <span class="operation-path">/server/following</span> | |
749 | </span> | |
750 | </h2> | |
751 | <div class="doc-row"> | |
752 | <div class="doc-copy"> </div> | |
753 | <div class="doc-examples"></div> | |
754 | </div> | |
755 | <div class="doc-row"> | |
756 | <div class="doc-copy"> | |
757 | <section class="swagger-responses"> | |
758 | <div class="prop-row prop-group"> | |
759 | <div class="prop-name"> | |
760 | <div class="prop-title">200 OK</div> | |
761 | <div class="prop-ref"> | |
762 | <span class="json-schema-ref-array"> | |
763 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
764 | </span> | |
765 | </div> | |
766 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
767 | </div> | |
768 | <div class="prop-value"> | |
769 | <p>successful operation</p> | |
770 | </div> | |
771 | </div> | |
772 | </section> | |
773 | </div> | |
774 | <div class="doc-examples"> | |
775 | <h5>Response Content-Types: | |
776 | <span>application/json</span> | |
777 | </h5> | |
778 | <section> | |
779 | <h5>Response Example | |
780 | <span>(200 OK)</span> | |
781 | </h5> | |
782 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
783 | { | |
784 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
785 | <span class="hljs-attr">"follower"</span>: { | |
786 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
787 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
788 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
789 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
790 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
791 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
792 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
793 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
794 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
795 | <span class="hljs-attr">"avatar"</span>: { | |
796 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
797 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
798 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
799 | } | |
800 | }, | |
801 | <span class="hljs-attr">"following"</span>: { | |
802 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
803 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
804 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
805 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
806 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
807 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
808 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
809 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
810 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
811 | <span class="hljs-attr">"avatar"</span>: { | |
812 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
813 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
814 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
815 | } | |
816 | }, | |
817 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
818 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
819 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
820 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
821 | } | |
822 | ] | |
823 | </code></pre> | |
824 | <!-- </div> --> | |
825 | </section> | |
826 | </div> | |
827 | </div> | |
828 | </div> | |
829 | <div id="operation--server-following-post" class="operation panel" data-traverse-target="operation--server-following-post"> | |
830 | <!-- <section class="operation-tags row"> --> | |
831 | <!-- <div class="doc-copy"> --> | |
832 | <div class="operation-tags"> | |
833 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
834 | <!----> | |
835 | </div> | |
836 | <!-- </div> --> | |
837 | <!-- </section> --> | |
838 | <h2 class="operation-title"> | |
839 | <span class="operation-name"> | |
840 | <span class="operation-name">POST</span> | |
841 | <span class="operation-path">/server/following</span> | |
842 | </span> | |
843 | </h2> | |
844 | <div class="doc-row"> | |
845 | <div class="doc-copy"> | |
846 | <section class="swagger-request-body"> | |
847 | <div class="prop-row"> | |
848 | <div class="prop-name"> | |
849 | <div class="swagger-request-model"> | |
850 | <span class=""> | |
851 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
852 | </span> | |
853 | </div> | |
854 | </div> | |
855 | <div class="prop-value columns small-6"> | |
856 | <!-- <div class="swagger-request-description"> -->undefined | |
857 | <!-- </div> --> | |
858 | </div> | |
859 | </div> | |
860 | </section> | |
861 | </div> | |
862 | <div class="doc-examples"> | |
863 | <section> | |
864 | <h5>Request Content-Types: | |
865 | <span>application/json</span> | |
866 | </h5> | |
867 | <h5>Request Example</h5> | |
868 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
869 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
870 | <span class="hljs-attr">"follower"</span>: { | |
871 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
872 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
873 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
874 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
875 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
876 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
877 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
878 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
879 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
880 | <span class="hljs-attr">"avatar"</span>: { | |
881 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
882 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
883 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
884 | } | |
885 | }, | |
886 | <span class="hljs-attr">"following"</span>: { | |
887 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
888 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
889 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
890 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
891 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
892 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
893 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
894 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
895 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
896 | <span class="hljs-attr">"avatar"</span>: { | |
897 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
898 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
899 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
900 | } | |
901 | }, | |
902 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
903 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
904 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
905 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
906 | } | |
907 | </code></pre> | |
908 | <!-- </div> --> | |
909 | </section> | |
910 | </div> | |
911 | </div> | |
912 | <div class="doc-row"> | |
913 | <div class="doc-copy"> | |
914 | <section class="swagger-responses"> | |
915 | <div class="prop-row prop-group"> | |
916 | <div class="prop-name"> | |
917 | <div class="prop-title">204 No Content</div> | |
918 | </div> | |
919 | <div class="prop-value"> | |
920 | <p>successful operation</p> | |
921 | </div> | |
922 | </div> | |
923 | </section> | |
924 | </div> | |
925 | <div class="doc-examples"> | |
926 | <h5>Response Content-Types: | |
927 | <span>application/json</span> | |
928 | </h5> | |
929 | </div> | |
930 | </div> | |
931 | </div> | |
932 | <h1 id="tag-User" class="swagger-summary-tag" data-traverse-target="tag-User">User</h1> | |
933 | <div id="operation--users-post" class="operation panel" data-traverse-target="operation--users-post"> | |
934 | <!-- <section class="operation-tags row"> --> | |
935 | <!-- <div class="doc-copy"> --> | |
936 | <div class="operation-tags"> | |
937 | <a class="label" href="#tag-User">User</a> | |
938 | <!----> | |
939 | </div> | |
940 | <!-- </div> --> | |
941 | <!-- </section> --> | |
942 | <h2 class="operation-title"> | |
943 | <span class="operation-name"> | |
944 | <span class="operation-name">POST</span> | |
945 | <span class="operation-path">/users</span> | |
946 | </span> | |
947 | </h2> | |
948 | <div class="doc-row"> | |
949 | <div class="doc-copy"> | |
950 | <section class="swagger-request-body"> | |
951 | <div class="prop-row"> | |
952 | <div class="prop-name"> | |
953 | <div class="swagger-request-model"> | |
954 | <span class=""> | |
955 | <a class="json-schema-ref" href="#/definitions/AddUser">AddUser</a> | |
956 | </span> | |
957 | </div> | |
958 | </div> | |
959 | <div class="prop-value columns small-6"> | |
960 | <!-- <div class="swagger-request-description"> -->undefined | |
961 | <!-- </div> --> | |
962 | </div> | |
963 | </div> | |
964 | </section> | |
965 | </div> | |
966 | <div class="doc-examples"> | |
967 | <section> | |
968 | <h5>Request Content-Types: | |
969 | <span>application/json</span> | |
970 | </h5> | |
971 | <h5>Request Example</h5> | |
972 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
973 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
974 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
975 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
976 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
977 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
978 | } | |
979 | </code></pre> | |
980 | <!-- </div> --> | |
981 | </section> | |
982 | </div> | |
983 | </div> | |
984 | <div class="doc-row"> | |
985 | <div class="doc-copy"> | |
986 | <section class="swagger-responses"> | |
987 | <div class="prop-row prop-group"> | |
988 | <div class="prop-name"> | |
989 | <div class="prop-title">200 OK</div> | |
990 | <div class="prop-ref"> | |
991 | <span class=""> | |
992 | <a class="json-schema-ref" href="#/definitions/AddUserResponse">AddUserResponse</a> | |
993 | </span> | |
994 | </div> | |
995 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
996 | </div> | |
997 | <div class="prop-value"> | |
998 | <p>successful operation</p> | |
999 | </div> | |
1000 | </div> | |
1001 | </section> | |
1002 | </div> | |
1003 | <div class="doc-examples"> | |
1004 | <h5>Response Content-Types: | |
1005 | <span>application/json</span> | |
1006 | </h5> | |
1007 | <section> | |
1008 | <h5>Response Example | |
1009 | <span>(200 OK)</span> | |
1010 | </h5> | |
1011 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1012 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1013 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
1014 | } | |
1015 | </code></pre> | |
1016 | <!-- </div> --> | |
1017 | </section> | |
1018 | </div> | |
1019 | </div> | |
1020 | </div> | |
1021 | <div id="operation--users-get" class="operation panel" data-traverse-target="operation--users-get"> | |
1022 | <!-- <section class="operation-tags row"> --> | |
1023 | <!-- <div class="doc-copy"> --> | |
1024 | <div class="operation-tags"> | |
1025 | <a class="label" href="#tag-User">User</a> | |
1026 | <!----> | |
1027 | </div> | |
1028 | <!-- </div> --> | |
1029 | <!-- </section> --> | |
1030 | <h2 class="operation-title"> | |
1031 | <span class="operation-name"> | |
1032 | <span class="operation-name">GET</span> | |
1033 | <span class="operation-path">/users</span> | |
1034 | </span> | |
1035 | </h2> | |
1036 | <div class="doc-row"> | |
1037 | <div class="doc-copy"> </div> | |
1038 | <div class="doc-examples"></div> | |
1039 | </div> | |
1040 | <div class="doc-row"> | |
1041 | <div class="doc-copy"> | |
1042 | <section class="swagger-responses"> | |
1043 | <div class="prop-row prop-group"> | |
1044 | <div class="prop-name"> | |
1045 | <div class="prop-title">200 OK</div> | |
1046 | <div class="prop-ref"> | |
1047 | <span class="json-schema-ref-array"> | |
1048 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
1049 | </span> | |
1050 | </div> | |
1051 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1052 | </div> | |
1053 | <div class="prop-value"> | |
1054 | <p>successful operation</p> | |
1055 | </div> | |
1056 | </div> | |
1057 | </section> | |
1058 | </div> | |
1059 | <div class="doc-examples"> | |
1060 | <h5>Response Content-Types: | |
1061 | <span>application/json</span> | |
1062 | </h5> | |
1063 | <section> | |
1064 | <h5>Response Example | |
1065 | <span>(200 OK)</span> | |
1066 | </h5> | |
1067 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
1068 | { | |
1069 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1070 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
1071 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1072 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
1073 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
1074 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
1075 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
1076 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1077 | <span class="hljs-attr">"account"</span>: { | |
1078 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1079 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1080 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1081 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1082 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1083 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1084 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1085 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1086 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1087 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1088 | <span class="hljs-attr">"avatar"</span>: { | |
1089 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1090 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1091 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1092 | } | |
1093 | }, | |
1094 | <span class="hljs-attr">"videoChannels"</span>: [ | |
1095 | { | |
1096 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1097 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
1098 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1099 | <span class="hljs-attr">"owner"</span>: { | |
1100 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1101 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
1102 | }, | |
1103 | <span class="hljs-attr">"videos"</span>: [ | |
1104 | { | |
1105 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1106 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1107 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
1108 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1109 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1110 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
1111 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
1112 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
1113 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
1114 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
1115 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
1116 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
1117 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
1118 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1119 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1120 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
1121 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
1122 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
1123 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
1124 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
1125 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
1126 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
1127 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
1128 | } | |
1129 | ] | |
1130 | } | |
1131 | ] | |
1132 | } | |
1133 | ] | |
1134 | </code></pre> | |
1135 | <!-- </div> --> | |
1136 | </section> | |
1137 | </div> | |
1138 | </div> | |
1139 | </div> | |
1140 | <div id="operation--users--id--delete" class="operation panel" data-traverse-target="operation--users--id--delete"> | |
1141 | <!-- <section class="operation-tags row"> --> | |
1142 | <!-- <div class="doc-copy"> --> | |
1143 | <div class="operation-tags"> | |
1144 | <a class="label" href="#tag-User">User</a> | |
1145 | <!----> | |
1146 | </div> | |
1147 | <!-- </div> --> | |
1148 | <!-- </section> --> | |
1149 | <h2 class="operation-title"> | |
1150 | <span class="operation-name"> | |
1151 | <span class="operation-name">DELETE</span> | |
1152 | <span class="operation-path">/users/{id}</span> | |
1153 | </span> | |
1154 | </h2> | |
1155 | <div class="doc-row"> | |
1156 | <div class="doc-copy"> | |
1157 | <section class="swagger-request-params"> | |
1158 | <div class="prop-row prop-group"> | |
1159 | <div class="prop-name"> | |
1160 | <div class="prop-title">id</div> | |
1161 | <span class="json-property-required"></span> | |
1162 | </div> | |
1163 | <div class="prop-value"> | |
1164 | <p>The user id </p> | |
1165 | </div> | |
1166 | </div> | |
1167 | <div class="prop-row prop-inner"> | |
1168 | <div class="prop-name param-label">type</div> | |
1169 | <div class="prop-value"> | |
1170 | <span class="json-property-type">string</span> | |
1171 | <span class="json-property-range" title="Value limits"></span> | |
1172 | </div> | |
1173 | </div> | |
1174 | <div class="prop-row prop-inner"> | |
1175 | <div class="prop-name param-label">in</div> | |
1176 | <div class="prop-value">path</div> | |
1177 | </div> | |
1178 | </section> | |
1179 | </div> | |
1180 | <div class="doc-examples"></div> | |
1181 | </div> | |
1182 | <div class="doc-row"> | |
1183 | <div class="doc-copy"> | |
1184 | <section class="swagger-responses"> | |
1185 | <div class="prop-row prop-group"> | |
1186 | <div class="prop-name"> | |
1187 | <div class="prop-title">204 No Content</div> | |
1188 | </div> | |
1189 | <div class="prop-value"> | |
1190 | <p>successful operation</p> | |
1191 | </div> | |
1192 | </div> | |
1193 | </section> | |
1194 | </div> | |
1195 | <div class="doc-examples"> | |
1196 | <h5>Response Content-Types: | |
1197 | <span>application/json</span> | |
1198 | </h5> | |
1199 | </div> | |
1200 | </div> | |
1201 | </div> | |
1202 | <div id="operation--users--id--get" class="operation panel" data-traverse-target="operation--users--id--get"> | |
1203 | <!-- <section class="operation-tags row"> --> | |
1204 | <!-- <div class="doc-copy"> --> | |
1205 | <div class="operation-tags"> | |
1206 | <a class="label" href="#tag-User">User</a> | |
1207 | <!----> | |
1208 | </div> | |
1209 | <!-- </div> --> | |
1210 | <!-- </section> --> | |
1211 | <h2 class="operation-title"> | |
1212 | <span class="operation-name"> | |
1213 | <span class="operation-name">GET</span> | |
1214 | <span class="operation-path">/users/{id}</span> | |
1215 | </span> | |
1216 | </h2> | |
1217 | <div class="doc-row"> | |
1218 | <div class="doc-copy"> | |
1219 | <section class="swagger-request-params"> | |
1220 | <div class="prop-row prop-group"> | |
1221 | <div class="prop-name"> | |
1222 | <div class="prop-title">id</div> | |
1223 | <span class="json-property-required"></span> | |
1224 | </div> | |
1225 | <div class="prop-value"> | |
1226 | <p>The user id </p> | |
1227 | </div> | |
1228 | </div> | |
1229 | <div class="prop-row prop-inner"> | |
1230 | <div class="prop-name param-label">type</div> | |
1231 | <div class="prop-value"> | |
1232 | <span class="json-property-type">string</span> | |
1233 | <span class="json-property-range" title="Value limits"></span> | |
1234 | </div> | |
1235 | </div> | |
1236 | <div class="prop-row prop-inner"> | |
1237 | <div class="prop-name param-label">in</div> | |
1238 | <div class="prop-value">path</div> | |
1239 | </div> | |
1240 | </section> | |
1241 | </div> | |
1242 | <div class="doc-examples"></div> | |
1243 | </div> | |
1244 | <div class="doc-row"> | |
1245 | <div class="doc-copy"> | |
1246 | <section class="swagger-responses"> | |
1247 | <div class="prop-row prop-group"> | |
1248 | <div class="prop-name"> | |
1249 | <div class="prop-title">200 OK</div> | |
1250 | <div class="prop-ref"> | |
1251 | <span class=""> | |
1252 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
1253 | </span> | |
1254 | </div> | |
1255 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1256 | </div> | |
1257 | <div class="prop-value"> | |
1258 | <p>successful operation</p> | |
1259 | </div> | |
1260 | </div> | |
1261 | </section> | |
1262 | </div> | |
1263 | <div class="doc-examples"> | |
1264 | <h5>Response Content-Types: | |
1265 | <span>application/json</span> | |
1266 | </h5> | |
1267 | <section> | |
1268 | <h5>Response Example | |
1269 | <span>(200 OK)</span> | |
1270 | </h5> | |
1271 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1272 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1273 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
1274 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1275 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
1276 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
1277 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
1278 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
1279 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1280 | <span class="hljs-attr">"account"</span>: { | |
1281 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1282 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1283 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1284 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1285 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1286 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1287 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1288 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1289 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1290 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1291 | <span class="hljs-attr">"avatar"</span>: { | |
1292 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1293 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1294 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1295 | } | |
1296 | }, | |
1297 | <span class="hljs-attr">"videoChannels"</span>: [ | |
1298 | { | |
1299 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1300 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
1301 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1302 | <span class="hljs-attr">"owner"</span>: { | |
1303 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1304 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
1305 | }, | |
1306 | <span class="hljs-attr">"videos"</span>: [ | |
1307 | { | |
1308 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1309 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1310 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
1311 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1312 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1313 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
1314 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
1315 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
1316 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
1317 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
1318 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
1319 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
1320 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
1321 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1322 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1323 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
1324 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
1325 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
1326 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
1327 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
1328 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
1329 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
1330 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
1331 | } | |
1332 | ] | |
1333 | } | |
1334 | ] | |
1335 | } | |
1336 | </code></pre> | |
1337 | <!-- </div> --> | |
1338 | </section> | |
1339 | </div> | |
1340 | </div> | |
1341 | </div> | |
1342 | <div id="operation--users--id--put" class="operation panel" data-traverse-target="operation--users--id--put"> | |
1343 | <!-- <section class="operation-tags row"> --> | |
1344 | <!-- <div class="doc-copy"> --> | |
1345 | <div class="operation-tags"> | |
1346 | <a class="label" href="#tag-User">User</a> | |
1347 | <!----> | |
1348 | </div> | |
1349 | <!-- </div> --> | |
1350 | <!-- </section> --> | |
1351 | <h2 class="operation-title"> | |
1352 | <span class="operation-name"> | |
1353 | <span class="operation-name">PUT</span> | |
1354 | <span class="operation-path">/users/{id}</span> | |
1355 | </span> | |
1356 | </h2> | |
1357 | <div class="doc-row"> | |
1358 | <div class="doc-copy"> | |
1359 | <section class="swagger-request-body"> | |
1360 | <div class="prop-row"> | |
1361 | <div class="prop-name"> | |
1362 | <div class="swagger-request-model"> | |
1363 | <span class=""> | |
1364 | <a class="json-schema-ref" href="#/definitions/UpdateUser">UpdateUser</a> | |
1365 | </span> | |
1366 | </div> | |
1367 | </div> | |
1368 | <div class="prop-value columns small-6"> | |
1369 | <!-- <div class="swagger-request-description"> -->undefined | |
1370 | <!-- </div> --> | |
1371 | </div> | |
1372 | </div> | |
1373 | </section> | |
1374 | <section class="swagger-request-params"> | |
1375 | <div class="prop-row prop-group"> | |
1376 | <div class="prop-name"> | |
1377 | <div class="prop-title">id</div> | |
1378 | <span class="json-property-required"></span> | |
1379 | </div> | |
1380 | <div class="prop-value"> | |
1381 | <p>The user id </p> | |
1382 | </div> | |
1383 | </div> | |
1384 | <div class="prop-row prop-inner"> | |
1385 | <div class="prop-name param-label">type</div> | |
1386 | <div class="prop-value"> | |
1387 | <span class="json-property-type">string</span> | |
1388 | <span class="json-property-range" title="Value limits"></span> | |
1389 | </div> | |
1390 | </div> | |
1391 | <div class="prop-row prop-inner"> | |
1392 | <div class="prop-name param-label">in</div> | |
1393 | <div class="prop-value">path</div> | |
1394 | </div> | |
1395 | </section> | |
1396 | </div> | |
1397 | <div class="doc-examples"> | |
1398 | <section> | |
1399 | <h5>Request Content-Types: | |
1400 | <span>application/json</span> | |
1401 | </h5> | |
1402 | <h5>Request Example</h5> | |
1403 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1404 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
1405 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1406 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
1407 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
1408 | } | |
1409 | </code></pre> | |
1410 | <!-- </div> --> | |
1411 | </section> | |
1412 | </div> | |
1413 | </div> | |
1414 | <div class="doc-row"> | |
1415 | <div class="doc-copy"> | |
1416 | <section class="swagger-responses"> | |
1417 | <div class="prop-row prop-group"> | |
1418 | <div class="prop-name"> | |
1419 | <div class="prop-title">204 No Content</div> | |
1420 | </div> | |
1421 | <div class="prop-value"> | |
1422 | <p>successful operation</p> | |
1423 | </div> | |
1424 | </div> | |
1425 | </section> | |
1426 | </div> | |
1427 | <div class="doc-examples"> | |
1428 | <h5>Response Content-Types: | |
1429 | <span>application/json</span> | |
1430 | </h5> | |
1431 | </div> | |
1432 | </div> | |
1433 | </div> | |
1434 | <div id="operation--users-me-get" class="operation panel" data-traverse-target="operation--users-me-get"> | |
1435 | <!-- <section class="operation-tags row"> --> | |
1436 | <!-- <div class="doc-copy"> --> | |
1437 | <div class="operation-tags"> | |
1438 | <a class="label" href="#tag-User">User</a> | |
1439 | <!----> | |
1440 | </div> | |
1441 | <!-- </div> --> | |
1442 | <!-- </section> --> | |
1443 | <h2 class="operation-title"> | |
1444 | <span class="operation-name"> | |
1445 | <span class="operation-name">GET</span> | |
1446 | <span class="operation-path">/users/me</span> | |
1447 | </span> | |
1448 | </h2> | |
1449 | <div class="doc-row"> | |
1450 | <div class="doc-copy"> </div> | |
1451 | <div class="doc-examples"></div> | |
1452 | </div> | |
1453 | <div class="doc-row"> | |
1454 | <div class="doc-copy"> | |
1455 | <section class="swagger-responses"> | |
1456 | <div class="prop-row prop-group"> | |
1457 | <div class="prop-name"> | |
1458 | <div class="prop-title">200 OK</div> | |
1459 | <div class="prop-ref"> | |
1460 | <span class="json-schema-ref-array"> | |
1461 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
1462 | </span> | |
1463 | </div> | |
1464 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1465 | </div> | |
1466 | <div class="prop-value"> | |
1467 | <p>successful operation</p> | |
1468 | </div> | |
1469 | </div> | |
1470 | </section> | |
1471 | </div> | |
1472 | <div class="doc-examples"> | |
1473 | <h5>Response Content-Types: | |
1474 | <span>application/json</span> | |
1475 | </h5> | |
1476 | <section> | |
1477 | <h5>Response Example | |
1478 | <span>(200 OK)</span> | |
1479 | </h5> | |
1480 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
1481 | { | |
1482 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1483 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
1484 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1485 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
1486 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
1487 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
1488 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
1489 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1490 | <span class="hljs-attr">"account"</span>: { | |
1491 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1492 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1493 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1494 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1495 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1496 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1497 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1498 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1499 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1500 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1501 | <span class="hljs-attr">"avatar"</span>: { | |
1502 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1503 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1504 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1505 | } | |
1506 | }, | |
1507 | <span class="hljs-attr">"videoChannels"</span>: [ | |
1508 | { | |
1509 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1510 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
1511 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1512 | <span class="hljs-attr">"owner"</span>: { | |
1513 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1514 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
1515 | }, | |
1516 | <span class="hljs-attr">"videos"</span>: [ | |
1517 | { | |
1518 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1519 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1520 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
1521 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1522 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1523 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
1524 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
1525 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
1526 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
1527 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
1528 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
1529 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
1530 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
1531 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1532 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1533 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
1534 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
1535 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
1536 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
1537 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
1538 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
1539 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
1540 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
1541 | } | |
1542 | ] | |
1543 | } | |
1544 | ] | |
1545 | } | |
1546 | ] | |
1547 | </code></pre> | |
1548 | <!-- </div> --> | |
1549 | </section> | |
1550 | </div> | |
1551 | </div> | |
1552 | </div> | |
1553 | <div id="operation--users-me-put" class="operation panel" data-traverse-target="operation--users-me-put"> | |
1554 | <!-- <section class="operation-tags row"> --> | |
1555 | <!-- <div class="doc-copy"> --> | |
1556 | <div class="operation-tags"> | |
1557 | <a class="label" href="#tag-User">User</a> | |
1558 | <!----> | |
1559 | </div> | |
1560 | <!-- </div> --> | |
1561 | <!-- </section> --> | |
1562 | <h2 class="operation-title"> | |
1563 | <span class="operation-name"> | |
1564 | <span class="operation-name">PUT</span> | |
1565 | <span class="operation-path">/users/me</span> | |
1566 | </span> | |
1567 | </h2> | |
1568 | <div class="doc-row"> | |
1569 | <div class="doc-copy"> | |
1570 | <section class="swagger-request-body"> | |
1571 | <div class="prop-row"> | |
1572 | <div class="prop-name"> | |
1573 | <div class="swagger-request-model"> | |
1574 | <span class=""> | |
1575 | <a class="json-schema-ref" href="#/definitions/UpdateMe">UpdateMe</a> | |
1576 | </span> | |
1577 | </div> | |
1578 | </div> | |
1579 | <div class="prop-value columns small-6"> | |
1580 | <!-- <div class="swagger-request-description"> -->undefined | |
1581 | <!-- </div> --> | |
1582 | </div> | |
1583 | </div> | |
1584 | </section> | |
1585 | </div> | |
1586 | <div class="doc-examples"> | |
1587 | <section> | |
1588 | <h5>Request Content-Types: | |
1589 | <span>application/json</span> | |
1590 | </h5> | |
1591 | <h5>Request Example</h5> | |
1592 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1593 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
1594 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1595 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>, | |
1596 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span> | |
1597 | } | |
1598 | </code></pre> | |
1599 | <!-- </div> --> | |
1600 | </section> | |
1601 | </div> | |
1602 | </div> | |
1603 | <div class="doc-row"> | |
1604 | <div class="doc-copy"> | |
1605 | <section class="swagger-responses"> | |
1606 | <div class="prop-row prop-group"> | |
1607 | <div class="prop-name"> | |
1608 | <div class="prop-title">204 No Content</div> | |
1609 | </div> | |
1610 | <div class="prop-value"> | |
1611 | <p>successful operation</p> | |
1612 | </div> | |
1613 | </div> | |
1614 | </section> | |
1615 | </div> | |
1616 | <div class="doc-examples"> | |
1617 | <h5>Response Content-Types: | |
1618 | <span>application/json</span> | |
1619 | </h5> | |
1620 | </div> | |
1621 | </div> | |
1622 | </div> | |
1623 | <div id="operation--users-me-video-quota-used-get" class="operation panel" data-traverse-target="operation--users-me-video-quota-used-get"> | |
1624 | <!-- <section class="operation-tags row"> --> | |
1625 | <!-- <div class="doc-copy"> --> | |
1626 | <div class="operation-tags"> | |
1627 | <a class="label" href="#tag-User">User</a> | |
1628 | <!----> | |
1629 | </div> | |
1630 | <!-- </div> --> | |
1631 | <!-- </section> --> | |
1632 | <h2 class="operation-title"> | |
1633 | <span class="operation-name"> | |
1634 | <span class="operation-name">GET</span> | |
1635 | <span class="operation-path">/users/me/video-quota-used</span> | |
1636 | </span> | |
1637 | </h2> | |
1638 | <div class="doc-row"> | |
1639 | <div class="doc-copy"> </div> | |
1640 | <div class="doc-examples"></div> | |
1641 | </div> | |
1642 | <div class="doc-row"> | |
1643 | <div class="doc-copy"> | |
1644 | <section class="swagger-responses"> | |
1645 | <div class="prop-row prop-group"> | |
1646 | <div class="prop-name"> | |
1647 | <div class="prop-title">200 OK</div> | |
1648 | <div class="prop-ref"></div> | |
1649 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1650 | </div> | |
1651 | <div class="prop-value"> | |
1652 | <p>successful operation</p> | |
1653 | </div> | |
1654 | </div> | |
1655 | </section> | |
1656 | </div> | |
1657 | <div class="doc-examples"> | |
1658 | <h5>Response Content-Types: | |
1659 | <span>application/json</span> | |
1660 | </h5> | |
1661 | <section> | |
1662 | <h5>Response Example | |
1663 | <span>(200 OK)</span> | |
1664 | </h5> | |
1665 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"number"</span> | |
1666 | </code></pre> | |
1667 | <!-- </div> --> | |
1668 | </section> | |
1669 | </div> | |
1670 | </div> | |
1671 | </div> | |
1672 | <div id="operation--users-me-videos--videoId--rating-get" class="operation panel" data-traverse-target="operation--users-me-videos--videoId--rating-get"> | |
1673 | <!-- <section class="operation-tags row"> --> | |
1674 | <!-- <div class="doc-copy"> --> | |
1675 | <div class="operation-tags"> | |
1676 | <a class="label" href="#tag-User">User</a> | |
1677 | <!----> | |
1678 | </div> | |
1679 | <!-- </div> --> | |
1680 | <!-- </section> --> | |
1681 | <h2 class="operation-title"> | |
1682 | <span class="operation-name"> | |
1683 | <span class="operation-name">GET</span> | |
1684 | <span class="operation-path">/users/me/videos/{videoId}/rating</span> | |
1685 | </span> | |
1686 | </h2> | |
1687 | <div class="doc-row"> | |
1688 | <div class="doc-copy"> | |
1689 | <section class="swagger-request-params"> | |
1690 | <div class="prop-row prop-group"> | |
1691 | <div class="prop-name"> | |
1692 | <div class="prop-title">videoId</div> | |
1693 | <span class="json-property-required"></span> | |
1694 | </div> | |
1695 | <div class="prop-value"> | |
1696 | <p>The video id </p> | |
1697 | </div> | |
1698 | </div> | |
1699 | <div class="prop-row prop-inner"> | |
1700 | <div class="prop-name param-label">type</div> | |
1701 | <div class="prop-value"> | |
1702 | <span class="json-property-type">string</span> | |
1703 | <span class="json-property-range" title="Value limits"></span> | |
1704 | </div> | |
1705 | </div> | |
1706 | <div class="prop-row prop-inner"> | |
1707 | <div class="prop-name param-label">in</div> | |
1708 | <div class="prop-value">path</div> | |
1709 | </div> | |
1710 | </section> | |
1711 | </div> | |
1712 | <div class="doc-examples"></div> | |
1713 | </div> | |
1714 | <div class="doc-row"> | |
1715 | <div class="doc-copy"> | |
1716 | <section class="swagger-responses"> | |
1717 | <div class="prop-row prop-group"> | |
1718 | <div class="prop-name"> | |
1719 | <div class="prop-title">200 OK</div> | |
1720 | <div class="prop-ref"> | |
1721 | <span class=""> | |
1722 | <a class="json-schema-ref" href="#/definitions/GetMeVideoRating">GetMeVideoRating</a> | |
1723 | </span> | |
1724 | </div> | |
1725 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1726 | </div> | |
1727 | <div class="prop-value"> | |
1728 | <p>successful operation</p> | |
1729 | </div> | |
1730 | </div> | |
1731 | </section> | |
1732 | </div> | |
1733 | <div class="doc-examples"> | |
1734 | <h5>Response Content-Types: | |
1735 | <span>application/json</span> | |
1736 | </h5> | |
1737 | <section> | |
1738 | <h5>Response Example | |
1739 | <span>(200 OK)</span> | |
1740 | </h5> | |
1741 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1742 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
1743 | <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span> | |
1744 | } | |
1745 | </code></pre> | |
1746 | <!-- </div> --> | |
1747 | </section> | |
1748 | </div> | |
1749 | </div> | |
1750 | </div> | |
1751 | <div id="operation--users-me-videos-get" class="operation panel" data-traverse-target="operation--users-me-videos-get"> | |
1752 | <!-- <section class="operation-tags row"> --> | |
1753 | <!-- <div class="doc-copy"> --> | |
1754 | <div class="operation-tags"> | |
1755 | <a class="label" href="#tag-User">User</a> | |
1756 | <!----> | |
1757 | </div> | |
1758 | <!-- </div> --> | |
1759 | <!-- </section> --> | |
1760 | <h2 class="operation-title"> | |
1761 | <span class="operation-name"> | |
1762 | <span class="operation-name">GET</span> | |
1763 | <span class="operation-path">/users/me/videos</span> | |
1764 | </span> | |
1765 | </h2> | |
1766 | <div class="doc-row"> | |
1767 | <div class="doc-copy"> </div> | |
1768 | <div class="doc-examples"></div> | |
1769 | </div> | |
1770 | <div class="doc-row"> | |
1771 | <div class="doc-copy"> | |
1772 | <section class="swagger-responses"> | |
1773 | <div class="prop-row prop-group"> | |
1774 | <div class="prop-name"> | |
1775 | <div class="prop-title">200 OK</div> | |
1776 | <div class="prop-ref"> | |
1777 | <span class="json-schema-ref-array"> | |
1778 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
1779 | </span> | |
1780 | </div> | |
1781 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1782 | </div> | |
1783 | <div class="prop-value"> | |
1784 | <p>successful operation</p> | |
1785 | </div> | |
1786 | </div> | |
1787 | </section> | |
1788 | </div> | |
1789 | <div class="doc-examples"> | |
1790 | <h5>Response Content-Types: | |
1791 | <span>application/json</span> | |
1792 | </h5> | |
1793 | <section> | |
1794 | <h5>Response Example | |
1795 | <span>(200 OK)</span> | |
1796 | </h5> | |
1797 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
1798 | { | |
1799 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1800 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1801 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
1802 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1803 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1804 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
1805 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
1806 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
1807 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
1808 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
1809 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
1810 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
1811 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
1812 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
1813 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1814 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
1815 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
1816 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
1817 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
1818 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
1819 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
1820 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
1821 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
1822 | } | |
1823 | ] | |
1824 | </code></pre> | |
1825 | <!-- </div> --> | |
1826 | </section> | |
1827 | </div> | |
1828 | </div> | |
1829 | </div> | |
1830 | <div id="operation--users-register-post" class="operation panel" data-traverse-target="operation--users-register-post"> | |
1831 | <!-- <section class="operation-tags row"> --> | |
1832 | <!-- <div class="doc-copy"> --> | |
1833 | <div class="operation-tags"> | |
1834 | <a class="label" href="#tag-User">User</a> | |
1835 | <!----> | |
1836 | </div> | |
1837 | <!-- </div> --> | |
1838 | <!-- </section> --> | |
1839 | <h2 class="operation-title"> | |
1840 | <span class="operation-name"> | |
1841 | <span class="operation-name">POST</span> | |
1842 | <span class="operation-path">/users/register</span> | |
1843 | </span> | |
1844 | </h2> | |
1845 | <div class="doc-row"> | |
1846 | <div class="doc-copy"> | |
1847 | <section class="swagger-request-body"> | |
1848 | <div class="prop-row"> | |
1849 | <div class="prop-name"> | |
1850 | <div class="swagger-request-model"> | |
1851 | <span class=""> | |
1852 | <a class="json-schema-ref" href="#/definitions/RegisterUser">RegisterUser</a> | |
1853 | </span> | |
1854 | </div> | |
1855 | </div> | |
1856 | <div class="prop-value columns small-6"> | |
1857 | <!-- <div class="swagger-request-description"> -->undefined | |
1858 | <!-- </div> --> | |
1859 | </div> | |
1860 | </div> | |
1861 | </section> | |
1862 | </div> | |
1863 | <div class="doc-examples"> | |
1864 | <section> | |
1865 | <h5>Request Content-Types: | |
1866 | <span>application/json</span> | |
1867 | </h5> | |
1868 | <h5>Request Example</h5> | |
1869 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1870 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
1871 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
1872 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span> | |
1873 | } | |
1874 | </code></pre> | |
1875 | <!-- </div> --> | |
1876 | </section> | |
1877 | </div> | |
1878 | </div> | |
1879 | <div class="doc-row"> | |
1880 | <div class="doc-copy"> | |
1881 | <section class="swagger-responses"> | |
1882 | <div class="prop-row prop-group"> | |
1883 | <div class="prop-name"> | |
1884 | <div class="prop-title">204 No Content</div> | |
1885 | </div> | |
1886 | <div class="prop-value"> | |
1887 | <p>successful operation</p> | |
1888 | </div> | |
1889 | </div> | |
1890 | </section> | |
1891 | </div> | |
1892 | <div class="doc-examples"> | |
1893 | <h5>Response Content-Types: | |
1894 | <span>application/json</span> | |
1895 | </h5> | |
1896 | </div> | |
1897 | </div> | |
1898 | </div> | |
1899 | <div id="operation--users-me-avatar-pick-post" class="operation panel" data-traverse-target="operation--users-me-avatar-pick-post"> | |
1900 | <!-- <section class="operation-tags row"> --> | |
1901 | <!-- <div class="doc-copy"> --> | |
1902 | <div class="operation-tags"> | |
1903 | <a class="label" href="#tag-User">User</a> | |
1904 | <!----> | |
1905 | </div> | |
1906 | <!-- </div> --> | |
1907 | <!-- </section> --> | |
1908 | <h2 class="operation-title"> | |
1909 | <span class="operation-name"> | |
1910 | <span class="operation-name">POST</span> | |
1911 | <span class="operation-path">/users/me/avatar/pick</span> | |
1912 | </span> | |
1913 | </h2> | |
1914 | <div class="doc-row"> | |
1915 | <div class="doc-copy"> | |
1916 | <section class="swagger-request-params"> | |
1917 | <div class="prop-row prop-group"> | |
1918 | <div class="prop-name"> | |
1919 | <div class="prop-title">avatarfile</div> | |
1920 | </div> | |
1921 | <div class="prop-value"> | |
1922 | <p>The file to upload.</p> | |
1923 | </div> | |
1924 | </div> | |
1925 | <div class="prop-row prop-inner"> | |
1926 | <div class="prop-name param-label">type</div> | |
1927 | <div class="prop-value"> | |
1928 | <span class="json-property-type">file</span> | |
1929 | <span class="json-property-range" title="Value limits"></span> | |
1930 | </div> | |
1931 | </div> | |
1932 | <div class="prop-row prop-inner"> | |
1933 | <div class="prop-name param-label">in</div> | |
1934 | <div class="prop-value">formData</div> | |
1935 | </div> | |
1936 | </section> | |
1937 | </div> | |
1938 | <div class="doc-examples"></div> | |
1939 | </div> | |
1940 | <div class="doc-row"> | |
1941 | <div class="doc-copy"> | |
1942 | <section class="swagger-responses"> | |
1943 | <div class="prop-row prop-group"> | |
1944 | <div class="prop-name"> | |
1945 | <div class="prop-title">200 OK</div> | |
1946 | <div class="prop-ref"> | |
1947 | <span class=""> | |
1948 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | |
1949 | </span> | |
1950 | </div> | |
1951 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1952 | </div> | |
1953 | <div class="prop-value"> | |
1954 | <p>successful operation</p> | |
1955 | </div> | |
1956 | </div> | |
1957 | </section> | |
1958 | </div> | |
1959 | <div class="doc-examples"> | |
1960 | <h5>Response Content-Types: | |
1961 | <span>application/json</span> | |
1962 | </h5> | |
1963 | <section> | |
1964 | <h5>Response Example | |
1965 | <span>(200 OK)</span> | |
1966 | </h5> | |
1967 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1968 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1969 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1970 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1971 | } | |
1972 | </code></pre> | |
1973 | <!-- </div> --> | |
1974 | </section> | |
1975 | </div> | |
1976 | </div> | |
1977 | </div> | |
1978 | <h1 id="tag-Video" class="swagger-summary-tag" data-traverse-target="tag-Video">Video</h1> | |
1979 | <div id="operation--video-get" class="operation panel" data-traverse-target="operation--video-get"> | |
1980 | <!-- <section class="operation-tags row"> --> | |
1981 | <!-- <div class="doc-copy"> --> | |
1982 | <div class="operation-tags"> | |
1983 | <a class="label" href="#tag-Video">Video</a> | |
1984 | <!----> | |
1985 | </div> | |
1986 | <!-- </div> --> | |
1987 | <!-- </section> --> | |
1988 | <h2 class="operation-title"> | |
1989 | <span class="operation-name"> | |
1990 | <span class="operation-name">GET</span> | |
1991 | <span class="operation-path">/video</span> | |
1992 | </span> | |
1993 | </h2> | |
1994 | <div class="doc-row"> | |
1995 | <div class="doc-copy"> </div> | |
1996 | <div class="doc-examples"></div> | |
1997 | </div> | |
1998 | <div class="doc-row"> | |
1999 | <div class="doc-copy"> | |
2000 | <section class="swagger-responses"> | |
2001 | <div class="prop-row prop-group"> | |
2002 | <div class="prop-name"> | |
2003 | <div class="prop-title">200 OK</div> | |
2004 | <div class="prop-ref"> | |
2005 | <span class="json-schema-ref-array"> | |
2006 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
2007 | </span> | |
2008 | </div> | |
2009 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2010 | </div> | |
2011 | <div class="prop-value"> | |
2012 | <p>successful operation</p> | |
2013 | </div> | |
2014 | </div> | |
2015 | </section> | |
2016 | </div> | |
2017 | <div class="doc-examples"> | |
2018 | <h5>Response Content-Types: | |
2019 | <span>application/json</span> | |
2020 | </h5> | |
2021 | <section> | |
2022 | <h5>Response Example | |
2023 | <span>(200 OK)</span> | |
2024 | </h5> | |
2025 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2026 | { | |
2027 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2028 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
2029 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
2030 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
2031 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
2032 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
2033 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
2034 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
2035 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
2036 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
2037 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
2038 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
2039 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
2040 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
2041 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
2042 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
2043 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
2044 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
2045 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
2046 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
2047 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
2048 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
2049 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
2050 | } | |
2051 | ] | |
2052 | </code></pre> | |
2053 | <!-- </div> --> | |
2054 | </section> | |
2055 | </div> | |
2056 | </div> | |
2057 | </div> | |
2058 | <div id="operation--video-categories-get" class="operation panel" data-traverse-target="operation--video-categories-get"> | |
2059 | <!-- <section class="operation-tags row"> --> | |
2060 | <!-- <div class="doc-copy"> --> | |
2061 | <div class="operation-tags"> | |
2062 | <a class="label" href="#tag-Video">Video</a> | |
2063 | <!----> | |
2064 | </div> | |
2065 | <!-- </div> --> | |
2066 | <!-- </section> --> | |
2067 | <h2 class="operation-title"> | |
2068 | <span class="operation-name"> | |
2069 | <span class="operation-name">GET</span> | |
2070 | <span class="operation-path">/video/categories</span> | |
2071 | </span> | |
2072 | </h2> | |
2073 | <div class="doc-row"> | |
2074 | <div class="doc-copy"> </div> | |
2075 | <div class="doc-examples"></div> | |
2076 | </div> | |
2077 | <div class="doc-row"> | |
2078 | <div class="doc-copy"> | |
2079 | <section class="swagger-responses"> | |
2080 | <div class="prop-row prop-group"> | |
2081 | <div class="prop-name"> | |
2082 | <div class="prop-title">200 OK</div> | |
2083 | <div class="prop-ref"></div> | |
2084 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2085 | </div> | |
2086 | <div class="prop-value"> | |
2087 | <p>successful operation</p> | |
2088 | </div> | |
2089 | </div> | |
2090 | </section> | |
2091 | </div> | |
2092 | <div class="doc-examples"> | |
2093 | <h5>Response Content-Types: | |
2094 | <span>application/json</span> | |
2095 | </h5> | |
2096 | <section> | |
2097 | <h5>Response Example | |
2098 | <span>(200 OK)</span> | |
2099 | </h5> | |
2100 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2101 | <span class="hljs-string">"string"</span> | |
2102 | ] | |
2103 | </code></pre> | |
2104 | <!-- </div> --> | |
2105 | </section> | |
2106 | </div> | |
2107 | </div> | |
2108 | </div> | |
2109 | <div id="operation--video-licences-get" class="operation panel" data-traverse-target="operation--video-licences-get"> | |
2110 | <!-- <section class="operation-tags row"> --> | |
2111 | <!-- <div class="doc-copy"> --> | |
2112 | <div class="operation-tags"> | |
2113 | <a class="label" href="#tag-Video">Video</a> | |
2114 | <!----> | |
2115 | </div> | |
2116 | <!-- </div> --> | |
2117 | <!-- </section> --> | |
2118 | <h2 class="operation-title"> | |
2119 | <span class="operation-name"> | |
2120 | <span class="operation-name">GET</span> | |
2121 | <span class="operation-path">/video/licences</span> | |
2122 | </span> | |
2123 | </h2> | |
2124 | <div class="doc-row"> | |
2125 | <div class="doc-copy"> </div> | |
2126 | <div class="doc-examples"></div> | |
2127 | </div> | |
2128 | <div class="doc-row"> | |
2129 | <div class="doc-copy"> | |
2130 | <section class="swagger-responses"> | |
2131 | <div class="prop-row prop-group"> | |
2132 | <div class="prop-name"> | |
2133 | <div class="prop-title">200 OK</div> | |
2134 | <div class="prop-ref"></div> | |
2135 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2136 | </div> | |
2137 | <div class="prop-value"> | |
2138 | <p>successful operation</p> | |
2139 | </div> | |
2140 | </div> | |
2141 | </section> | |
2142 | </div> | |
2143 | <div class="doc-examples"> | |
2144 | <h5>Response Content-Types: | |
2145 | <span>application/json</span> | |
2146 | </h5> | |
2147 | <section> | |
2148 | <h5>Response Example | |
2149 | <span>(200 OK)</span> | |
2150 | </h5> | |
2151 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2152 | <span class="hljs-string">"string"</span> | |
2153 | ] | |
2154 | </code></pre> | |
2155 | <!-- </div> --> | |
2156 | </section> | |
2157 | </div> | |
2158 | </div> | |
2159 | </div> | |
2160 | <div id="operation--video-languages-get" class="operation panel" data-traverse-target="operation--video-languages-get"> | |
2161 | <!-- <section class="operation-tags row"> --> | |
2162 | <!-- <div class="doc-copy"> --> | |
2163 | <div class="operation-tags"> | |
2164 | <a class="label" href="#tag-Video">Video</a> | |
2165 | <!----> | |
2166 | </div> | |
2167 | <!-- </div> --> | |
2168 | <!-- </section> --> | |
2169 | <h2 class="operation-title"> | |
2170 | <span class="operation-name"> | |
2171 | <span class="operation-name">GET</span> | |
2172 | <span class="operation-path">/video/languages</span> | |
2173 | </span> | |
2174 | </h2> | |
2175 | <div class="doc-row"> | |
2176 | <div class="doc-copy"> </div> | |
2177 | <div class="doc-examples"></div> | |
2178 | </div> | |
2179 | <div class="doc-row"> | |
2180 | <div class="doc-copy"> | |
2181 | <section class="swagger-responses"> | |
2182 | <div class="prop-row prop-group"> | |
2183 | <div class="prop-name"> | |
2184 | <div class="prop-title">200 OK</div> | |
2185 | <div class="prop-ref"></div> | |
2186 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2187 | </div> | |
2188 | <div class="prop-value"> | |
2189 | <p>successful operation</p> | |
2190 | </div> | |
2191 | </div> | |
2192 | </section> | |
2193 | </div> | |
2194 | <div class="doc-examples"> | |
2195 | <h5>Response Content-Types: | |
2196 | <span>application/json</span> | |
2197 | </h5> | |
2198 | <section> | |
2199 | <h5>Response Example | |
2200 | <span>(200 OK)</span> | |
2201 | </h5> | |
2202 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2203 | <span class="hljs-string">"string"</span> | |
2204 | ] | |
2205 | </code></pre> | |
2206 | <!-- </div> --> | |
2207 | </section> | |
2208 | </div> | |
2209 | </div> | |
2210 | </div> | |
2211 | <div id="operation--video-privacies-get" class="operation panel" data-traverse-target="operation--video-privacies-get"> | |
2212 | <!-- <section class="operation-tags row"> --> | |
2213 | <!-- <div class="doc-copy"> --> | |
2214 | <div class="operation-tags"> | |
2215 | <a class="label" href="#tag-Video">Video</a> | |
2216 | <!----> | |
2217 | </div> | |
2218 | <!-- </div> --> | |
2219 | <!-- </section> --> | |
2220 | <h2 class="operation-title"> | |
2221 | <span class="operation-name"> | |
2222 | <span class="operation-name">GET</span> | |
2223 | <span class="operation-path">/video/privacies</span> | |
2224 | </span> | |
2225 | </h2> | |
2226 | <div class="doc-row"> | |
2227 | <div class="doc-copy"> </div> | |
2228 | <div class="doc-examples"></div> | |
2229 | </div> | |
2230 | <div class="doc-row"> | |
2231 | <div class="doc-copy"> | |
2232 | <section class="swagger-responses"> | |
2233 | <div class="prop-row prop-group"> | |
2234 | <div class="prop-name"> | |
2235 | <div class="prop-title">200 OK</div> | |
2236 | <div class="prop-ref"></div> | |
2237 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2238 | </div> | |
2239 | <div class="prop-value"> | |
2240 | <p>successful operation</p> | |
2241 | </div> | |
2242 | </div> | |
2243 | </section> | |
2244 | </div> | |
2245 | <div class="doc-examples"> | |
2246 | <h5>Response Content-Types: | |
2247 | <span>application/json</span> | |
2248 | </h5> | |
2249 | <section> | |
2250 | <h5>Response Example | |
2251 | <span>(200 OK)</span> | |
2252 | </h5> | |
2253 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2254 | <span class="hljs-string">"string"</span> | |
2255 | ] | |
2256 | </code></pre> | |
2257 | <!-- </div> --> | |
2258 | </section> | |
2259 | </div> | |
2260 | </div> | |
2261 | </div> | |
2262 | <div id="operation--video-search-get" class="operation panel" data-traverse-target="operation--video-search-get"> | |
2263 | <!-- <section class="operation-tags row"> --> | |
2264 | <!-- <div class="doc-copy"> --> | |
2265 | <div class="operation-tags"> | |
2266 | <a class="label" href="#tag-Video">Video</a> | |
2267 | <!----> | |
2268 | </div> | |
2269 | <!-- </div> --> | |
2270 | <!-- </section> --> | |
2271 | <h2 class="operation-title"> | |
2272 | <span class="operation-name"> | |
2273 | <span class="operation-name">GET</span> | |
2274 | <span class="operation-path">/video/search</span> | |
2275 | </span> | |
2276 | </h2> | |
2277 | <div class="doc-row"> | |
2278 | <div class="doc-copy"> </div> | |
2279 | <div class="doc-examples"></div> | |
2280 | </div> | |
2281 | <div class="doc-row"> | |
2282 | <div class="doc-copy"> | |
2283 | <section class="swagger-responses"> | |
2284 | <div class="prop-row prop-group"> | |
2285 | <div class="prop-name"> | |
2286 | <div class="prop-title">200 OK</div> | |
2287 | <div class="prop-ref"> | |
2288 | <span class="json-schema-ref-array"> | |
2289 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
2290 | </span> | |
2291 | </div> | |
2292 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2293 | </div> | |
2294 | <div class="prop-value"> | |
2295 | <p>successful operation</p> | |
2296 | </div> | |
2297 | </div> | |
2298 | </section> | |
2299 | </div> | |
2300 | <div class="doc-examples"> | |
2301 | <h5>Response Content-Types: | |
2302 | <span>application/json</span> | |
2303 | </h5> | |
2304 | <section> | |
2305 | <h5>Response Example | |
2306 | <span>(200 OK)</span> | |
2307 | </h5> | |
2308 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2309 | { | |
2310 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2311 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
2312 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
2313 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
2314 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
2315 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
2316 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
2317 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
2318 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
2319 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
2320 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
2321 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
2322 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
2323 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
2324 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
2325 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
2326 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
2327 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
2328 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
2329 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
2330 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
2331 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
2332 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
2333 | } | |
2334 | ] | |
2335 | </code></pre> | |
2336 | <!-- </div> --> | |
2337 | </section> | |
2338 | </div> | |
2339 | </div> | |
2340 | </div> | |
2341 | <div id="operation--video--id--put" class="operation panel" data-traverse-target="operation--video--id--put"> | |
2342 | <!-- <section class="operation-tags row"> --> | |
2343 | <!-- <div class="doc-copy"> --> | |
2344 | <div class="operation-tags"> | |
2345 | <a class="label" href="#tag-Video">Video</a> | |
2346 | <!----> | |
2347 | </div> | |
2348 | <!-- </div> --> | |
2349 | <!-- </section> --> | |
2350 | <h2 class="operation-title"> | |
2351 | <span class="operation-name"> | |
2352 | <span class="operation-name">PUT</span> | |
2353 | <span class="operation-path">/video/{id}</span> | |
2354 | </span> | |
2355 | </h2> | |
2356 | <div class="doc-row"> | |
2357 | <div class="doc-copy"> | |
2358 | <section class="swagger-request-params"> | |
2359 | <div class="prop-row prop-group"> | |
2360 | <div class="prop-name"> | |
2361 | <div class="prop-title">id</div> | |
2362 | <span class="json-property-required"></span> | |
2363 | </div> | |
2364 | <div class="prop-value"> | |
2365 | <p>The video id </p> | |
2366 | </div> | |
2367 | </div> | |
2368 | <div class="prop-row prop-inner"> | |
2369 | <div class="prop-name param-label">type</div> | |
2370 | <div class="prop-value"> | |
2371 | <span class="json-property-type">string</span> | |
2372 | <span class="json-property-range" title="Value limits"></span> | |
2373 | </div> | |
2374 | </div> | |
2375 | <div class="prop-row prop-inner"> | |
2376 | <div class="prop-name param-label">in</div> | |
2377 | <div class="prop-value">path</div> | |
2378 | </div> | |
2379 | </section> | |
2380 | </div> | |
2381 | <div class="doc-examples"></div> | |
2382 | </div> | |
2383 | <div class="doc-row"> | |
2384 | <div class="doc-copy"> | |
2385 | <section class="swagger-responses"> | |
2386 | <div class="prop-row prop-group"> | |
2387 | <div class="prop-name"> | |
2388 | <div class="prop-title">200 OK</div> | |
2389 | <div class="prop-ref"> | |
2390 | <span class=""> | |
2391 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
2392 | </span> | |
2393 | </div> | |
2394 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2395 | </div> | |
2396 | <div class="prop-value"> | |
2397 | <p>successful operation</p> | |
2398 | </div> | |
2399 | </div> | |
2400 | </section> | |
2401 | </div> | |
2402 | <div class="doc-examples"> | |
2403 | <h5>Response Content-Types: | |
2404 | <span>application/json</span> | |
2405 | </h5> | |
2406 | <section> | |
2407 | <h5>Response Example | |
2408 | <span>(200 OK)</span> | |
2409 | </h5> | |
2410 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
2411 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2412 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
2413 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
2414 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
2415 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
2416 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
2417 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
2418 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
2419 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
2420 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
2421 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
2422 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
2423 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
2424 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
2425 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
2426 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
2427 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
2428 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
2429 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
2430 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
2431 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
2432 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
2433 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
2434 | } | |
2435 | </code></pre> | |
2436 | <!-- </div> --> | |
2437 | </section> | |
2438 | </div> | |
2439 | </div> | |
2440 | </div> | |
2441 | <div id="operation--video--id--get" class="operation panel" data-traverse-target="operation--video--id--get"> | |
2442 | <!-- <section class="operation-tags row"> --> | |
2443 | <!-- <div class="doc-copy"> --> | |
2444 | <div class="operation-tags"> | |
2445 | <a class="label" href="#tag-Video">Video</a> | |
2446 | <!----> | |
2447 | </div> | |
2448 | <!-- </div> --> | |
2449 | <!-- </section> --> | |
2450 | <h2 class="operation-title"> | |
2451 | <span class="operation-name"> | |
2452 | <span class="operation-name">GET</span> | |
2453 | <span class="operation-path">/video/{id}</span> | |
2454 | </span> | |
2455 | </h2> | |
2456 | <div class="doc-row"> | |
2457 | <div class="doc-copy"> | |
2458 | <section class="swagger-request-params"> | |
2459 | <div class="prop-row prop-group"> | |
2460 | <div class="prop-name"> | |
2461 | <div class="prop-title">id</div> | |
2462 | <span class="json-property-required"></span> | |
2463 | </div> | |
2464 | <div class="prop-value"> | |
2465 | <p>The video id </p> | |
2466 | </div> | |
2467 | </div> | |
2468 | <div class="prop-row prop-inner"> | |
2469 | <div class="prop-name param-label">type</div> | |
2470 | <div class="prop-value"> | |
2471 | <span class="json-property-type">string</span> | |
2472 | <span class="json-property-range" title="Value limits"></span> | |
2473 | </div> | |
2474 | </div> | |
2475 | <div class="prop-row prop-inner"> | |
2476 | <div class="prop-name param-label">in</div> | |
2477 | <div class="prop-value">path</div> | |
2478 | </div> | |
2479 | </section> | |
2480 | </div> | |
2481 | <div class="doc-examples"></div> | |
2482 | </div> | |
2483 | <div class="doc-row"> | |
2484 | <div class="doc-copy"> | |
2485 | <section class="swagger-responses"> | |
2486 | <div class="prop-row prop-group"> | |
2487 | <div class="prop-name"> | |
2488 | <div class="prop-title">200 OK</div> | |
2489 | <div class="prop-ref"> | |
2490 | <span class=""> | |
2491 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
2492 | </span> | |
2493 | </div> | |
2494 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2495 | </div> | |
2496 | <div class="prop-value"> | |
2497 | <p>successful operation</p> | |
2498 | </div> | |
2499 | </div> | |
2500 | </section> | |
2501 | </div> | |
2502 | <div class="doc-examples"> | |
2503 | <h5>Response Content-Types: | |
2504 | <span>application/json</span> | |
2505 | </h5> | |
2506 | <section> | |
2507 | <h5>Response Example | |
2508 | <span>(200 OK)</span> | |
2509 | </h5> | |
2510 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
2511 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2512 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
2513 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
2514 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
2515 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
2516 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
2517 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
2518 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
2519 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
2520 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
2521 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
2522 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
2523 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
2524 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
2525 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
2526 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
2527 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
2528 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
2529 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
2530 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
2531 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
2532 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
2533 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
2534 | } | |
2535 | </code></pre> | |
2536 | <!-- </div> --> | |
2537 | </section> | |
2538 | </div> | |
2539 | </div> | |
2540 | </div> | |
2541 | <div id="operation--video--id--delete" class="operation panel" data-traverse-target="operation--video--id--delete"> | |
2542 | <!-- <section class="operation-tags row"> --> | |
2543 | <!-- <div class="doc-copy"> --> | |
2544 | <div class="operation-tags"> | |
2545 | <a class="label" href="#tag-Video">Video</a> | |
2546 | <!----> | |
2547 | </div> | |
2548 | <!-- </div> --> | |
2549 | <!-- </section> --> | |
2550 | <h2 class="operation-title"> | |
2551 | <span class="operation-name"> | |
2552 | <span class="operation-name">DELETE</span> | |
2553 | <span class="operation-path">/video/{id}</span> | |
2554 | </span> | |
2555 | </h2> | |
2556 | <div class="doc-row"> | |
2557 | <div class="doc-copy"> | |
2558 | <section class="swagger-request-params"> | |
2559 | <div class="prop-row prop-group"> | |
2560 | <div class="prop-name"> | |
2561 | <div class="prop-title">id</div> | |
2562 | <span class="json-property-required"></span> | |
2563 | </div> | |
2564 | <div class="prop-value"> | |
2565 | <p>The video id </p> | |
2566 | </div> | |
2567 | </div> | |
2568 | <div class="prop-row prop-inner"> | |
2569 | <div class="prop-name param-label">type</div> | |
2570 | <div class="prop-value"> | |
2571 | <span class="json-property-type">string</span> | |
2572 | <span class="json-property-range" title="Value limits"></span> | |
2573 | </div> | |
2574 | </div> | |
2575 | <div class="prop-row prop-inner"> | |
2576 | <div class="prop-name param-label">in</div> | |
2577 | <div class="prop-value">path</div> | |
2578 | </div> | |
2579 | </section> | |
2580 | </div> | |
2581 | <div class="doc-examples"></div> | |
2582 | </div> | |
2583 | <div class="doc-row"> | |
2584 | <div class="doc-copy"> | |
2585 | <section class="swagger-responses"> | |
2586 | <div class="prop-row prop-group"> | |
2587 | <div class="prop-name"> | |
2588 | <div class="prop-title">204 No Content</div> | |
2589 | </div> | |
2590 | <div class="prop-value"> | |
2591 | <p>successful operation</p> | |
2592 | </div> | |
2593 | </div> | |
2594 | </section> | |
2595 | </div> | |
2596 | <div class="doc-examples"> | |
2597 | <h5>Response Content-Types: | |
2598 | <span>application/json</span> | |
2599 | </h5> | |
2600 | </div> | |
2601 | </div> | |
2602 | </div> | |
2603 | <div id="operation--video--id--description-get" class="operation panel" data-traverse-target="operation--video--id--description-get"> | |
2604 | <!-- <section class="operation-tags row"> --> | |
2605 | <!-- <div class="doc-copy"> --> | |
2606 | <div class="operation-tags"> | |
2607 | <a class="label" href="#tag-Video">Video</a> | |
2608 | <!----> | |
2609 | </div> | |
2610 | <!-- </div> --> | |
2611 | <!-- </section> --> | |
2612 | <h2 class="operation-title"> | |
2613 | <span class="operation-name"> | |
2614 | <span class="operation-name">GET</span> | |
2615 | <span class="operation-path">/video/{id}/description</span> | |
2616 | </span> | |
2617 | </h2> | |
2618 | <div class="doc-row"> | |
2619 | <div class="doc-copy"> | |
2620 | <section class="swagger-request-params"> | |
2621 | <div class="prop-row prop-group"> | |
2622 | <div class="prop-name"> | |
2623 | <div class="prop-title">id</div> | |
2624 | <span class="json-property-required"></span> | |
2625 | </div> | |
2626 | <div class="prop-value"> | |
2627 | <p>The video id </p> | |
2628 | </div> | |
2629 | </div> | |
2630 | <div class="prop-row prop-inner"> | |
2631 | <div class="prop-name param-label">type</div> | |
2632 | <div class="prop-value"> | |
2633 | <span class="json-property-type">string</span> | |
2634 | <span class="json-property-range" title="Value limits"></span> | |
2635 | </div> | |
2636 | </div> | |
2637 | <div class="prop-row prop-inner"> | |
2638 | <div class="prop-name param-label">in</div> | |
2639 | <div class="prop-value">path</div> | |
2640 | </div> | |
2641 | </section> | |
2642 | </div> | |
2643 | <div class="doc-examples"></div> | |
2644 | </div> | |
2645 | <div class="doc-row"> | |
2646 | <div class="doc-copy"> | |
2647 | <section class="swagger-responses"> | |
2648 | <div class="prop-row prop-group"> | |
2649 | <div class="prop-name"> | |
2650 | <div class="prop-title">200 OK</div> | |
2651 | <div class="prop-ref"></div> | |
2652 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2653 | </div> | |
2654 | <div class="prop-value"> | |
2655 | <p>successful operation</p> | |
2656 | </div> | |
2657 | </div> | |
2658 | </section> | |
2659 | </div> | |
2660 | <div class="doc-examples"> | |
2661 | <h5>Response Content-Types: | |
2662 | <span>application/json</span> | |
2663 | </h5> | |
2664 | <section> | |
2665 | <h5>Response Example | |
2666 | <span>(200 OK)</span> | |
2667 | </h5> | |
2668 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"string"</span> | |
2669 | </code></pre> | |
2670 | <!-- </div> --> | |
2671 | </section> | |
2672 | </div> | |
2673 | </div> | |
2674 | </div> | |
2675 | <div id="operation--video--id--views-post" class="operation panel" data-traverse-target="operation--video--id--views-post"> | |
2676 | <!-- <section class="operation-tags row"> --> | |
2677 | <!-- <div class="doc-copy"> --> | |
2678 | <div class="operation-tags"> | |
2679 | <a class="label" href="#tag-Video">Video</a> | |
2680 | <!----> | |
2681 | </div> | |
2682 | <!-- </div> --> | |
2683 | <!-- </section> --> | |
2684 | <h2 class="operation-title"> | |
2685 | <span class="operation-name"> | |
2686 | <span class="operation-name">POST</span> | |
2687 | <span class="operation-path">/video/{id}/views</span> | |
2688 | </span> | |
2689 | </h2> | |
2690 | <div class="doc-row"> | |
2691 | <div class="doc-copy"> | |
2692 | <section class="swagger-request-params"> | |
2693 | <div class="prop-row prop-group"> | |
2694 | <div class="prop-name"> | |
2695 | <div class="prop-title">id</div> | |
2696 | <span class="json-property-required"></span> | |
2697 | </div> | |
2698 | <div class="prop-value"> | |
2699 | <p>The video id </p> | |
2700 | </div> | |
2701 | </div> | |
2702 | <div class="prop-row prop-inner"> | |
2703 | <div class="prop-name param-label">type</div> | |
2704 | <div class="prop-value"> | |
2705 | <span class="json-property-type">string</span> | |
2706 | <span class="json-property-range" title="Value limits"></span> | |
2707 | </div> | |
2708 | </div> | |
2709 | <div class="prop-row prop-inner"> | |
2710 | <div class="prop-name param-label">in</div> | |
2711 | <div class="prop-value">path</div> | |
2712 | </div> | |
2713 | </section> | |
2714 | </div> | |
2715 | <div class="doc-examples"></div> | |
2716 | </div> | |
2717 | <div class="doc-row"> | |
2718 | <div class="doc-copy"> | |
2719 | <section class="swagger-responses"> | |
2720 | <div class="prop-row prop-group"> | |
2721 | <div class="prop-name"> | |
2722 | <div class="prop-title">204 No Content</div> | |
2723 | </div> | |
2724 | <div class="prop-value"> | |
2725 | <p>successful operation</p> | |
2726 | </div> | |
2727 | </div> | |
2728 | </section> | |
2729 | </div> | |
2730 | <div class="doc-examples"> | |
2731 | <h5>Response Content-Types: | |
2732 | <span>application/json</span> | |
2733 | </h5> | |
2734 | </div> | |
2735 | </div> | |
2736 | </div> | |
2737 | <div id="operation--video-upload-post" class="operation panel" data-traverse-target="operation--video-upload-post"> | |
2738 | <!-- <section class="operation-tags row"> --> | |
2739 | <!-- <div class="doc-copy"> --> | |
2740 | <div class="operation-tags"> | |
2741 | <a class="label" href="#tag-Video">Video</a> | |
2742 | <!----> | |
2743 | </div> | |
2744 | <!-- </div> --> | |
2745 | <!-- </section> --> | |
2746 | <h2 class="operation-title"> | |
2747 | <span class="operation-name"> | |
2748 | <span class="operation-name">POST</span> | |
2749 | <span class="operation-path">/video/upload</span> | |
2750 | </span> | |
2751 | </h2> | |
2752 | <div class="doc-row"> | |
2753 | <div class="doc-copy"> | |
2754 | <section class="swagger-request-params"> | |
2755 | <div class="prop-row prop-group"> | |
2756 | <div class="prop-name"> | |
2757 | <div class="prop-title">videofile</div> | |
2758 | </div> | |
2759 | <div class="prop-value"> | |
2760 | <p>The file to upload.</p> | |
2761 | </div> | |
2762 | </div> | |
2763 | <div class="prop-row prop-inner"> | |
2764 | <div class="prop-name param-label">type</div> | |
2765 | <div class="prop-value"> | |
2766 | <span class="json-property-type">file</span> | |
2767 | <span class="json-property-range" title="Value limits"></span> | |
2768 | </div> | |
2769 | </div> | |
2770 | <div class="prop-row prop-inner"> | |
2771 | <div class="prop-name param-label">in</div> | |
2772 | <div class="prop-value">formData</div> | |
2773 | </div> | |
2774 | </section> | |
2775 | </div> | |
2776 | <div class="doc-examples"></div> | |
2777 | </div> | |
2778 | <div class="doc-row"> | |
2779 | <div class="doc-copy"> | |
2780 | <section class="swagger-responses"> | |
2781 | <div class="prop-row prop-group"> | |
2782 | <div class="prop-name"> | |
2783 | <div class="prop-title">200 OK</div> | |
2784 | <div class="prop-ref"> | |
2785 | <span class=""> | |
2786 | <a class="json-schema-ref" href="#/definitions/VideoUploadResponse">VideoUploadResponse</a> | |
2787 | </span> | |
2788 | </div> | |
2789 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2790 | </div> | |
2791 | <div class="prop-value"> | |
2792 | <p>successful operation</p> | |
2793 | </div> | |
2794 | </div> | |
2795 | </section> | |
2796 | </div> | |
2797 | <div class="doc-examples"> | |
2798 | <h5>Response Content-Types: | |
2799 | <span>application/json</span> | |
2800 | </h5> | |
2801 | <section> | |
2802 | <h5>Response Example | |
2803 | <span>(200 OK)</span> | |
2804 | </h5> | |
2805 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
2806 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2807 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
2808 | } | |
2809 | </code></pre> | |
2810 | <!-- </div> --> | |
2811 | </section> | |
2812 | </div> | |
2813 | </div> | |
2814 | </div> | |
2815 | <h1 id="tag-VideoAbuse" class="swagger-summary-tag" data-traverse-target="tag-VideoAbuse">VideoAbuse</h1> | |
2816 | <div id="operation--video-abuse-get" class="operation panel" data-traverse-target="operation--video-abuse-get"> | |
2817 | <!-- <section class="operation-tags row"> --> | |
2818 | <!-- <div class="doc-copy"> --> | |
2819 | <div class="operation-tags"> | |
2820 | <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> | |
2821 | <!----> | |
2822 | </div> | |
2823 | <!-- </div> --> | |
2824 | <!-- </section> --> | |
2825 | <h2 class="operation-title"> | |
2826 | <span class="operation-name"> | |
2827 | <span class="operation-name">GET</span> | |
2828 | <span class="operation-path">/video/abuse</span> | |
2829 | </span> | |
2830 | </h2> | |
2831 | <div class="doc-row"> | |
2832 | <div class="doc-copy"> </div> | |
2833 | <div class="doc-examples"></div> | |
2834 | </div> | |
2835 | <div class="doc-row"> | |
2836 | <div class="doc-copy"> | |
2837 | <section class="swagger-responses"> | |
2838 | <div class="prop-row prop-group"> | |
2839 | <div class="prop-name"> | |
2840 | <div class="prop-title">200 OK</div> | |
2841 | <div class="prop-ref"> | |
2842 | <span class="json-schema-ref-array"> | |
2843 | <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a> | |
2844 | </span> | |
2845 | </div> | |
2846 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2847 | </div> | |
2848 | <div class="prop-value"> | |
2849 | <p>successful operation</p> | |
2850 | </div> | |
2851 | </div> | |
2852 | </section> | |
2853 | </div> | |
2854 | <div class="doc-examples"> | |
2855 | <h5>Response Content-Types: | |
2856 | <span>application/json</span> | |
2857 | </h5> | |
2858 | <section> | |
2859 | <h5>Response Example | |
2860 | <span>(200 OK)</span> | |
2861 | </h5> | |
2862 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2863 | { | |
2864 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2865 | <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>, | |
2866 | <span class="hljs-attr">"reporterUsername"</span>: <span class="hljs-string">"string"</span>, | |
2867 | <span class="hljs-attr">"reporterServerHost"</span>: <span class="hljs-string">"string"</span>, | |
2868 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
2869 | <span class="hljs-attr">"videoUUID"</span>: <span class="hljs-string">"string"</span>, | |
2870 | <span class="hljs-attr">"videoName"</span>: <span class="hljs-string">"string"</span>, | |
2871 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span> | |
2872 | } | |
2873 | ] | |
2874 | </code></pre> | |
2875 | <!-- </div> --> | |
2876 | </section> | |
2877 | </div> | |
2878 | </div> | |
2879 | </div> | |
2880 | <div id="operation--video--id--abuse-post" class="operation panel" data-traverse-target="operation--video--id--abuse-post"> | |
2881 | <!-- <section class="operation-tags row"> --> | |
2882 | <!-- <div class="doc-copy"> --> | |
2883 | <div class="operation-tags"> | |
2884 | <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> | |
2885 | <!----> | |
2886 | </div> | |
2887 | <!-- </div> --> | |
2888 | <!-- </section> --> | |
2889 | <h2 class="operation-title"> | |
2890 | <span class="operation-name"> | |
2891 | <span class="operation-name">POST</span> | |
2892 | <span class="operation-path">/video/{id}/abuse</span> | |
2893 | </span> | |
2894 | </h2> | |
2895 | <div class="doc-row"> | |
2896 | <div class="doc-copy"> | |
2897 | <section class="swagger-request-params"> | |
2898 | <div class="prop-row prop-group"> | |
2899 | <div class="prop-name"> | |
2900 | <div class="prop-title">id</div> | |
2901 | <span class="json-property-required"></span> | |
2902 | </div> | |
2903 | <div class="prop-value"> | |
2904 | <p>The video id </p> | |
2905 | </div> | |
2906 | </div> | |
2907 | <div class="prop-row prop-inner"> | |
2908 | <div class="prop-name param-label">type</div> | |
2909 | <div class="prop-value"> | |
2910 | <span class="json-property-type">string</span> | |
2911 | <span class="json-property-range" title="Value limits"></span> | |
2912 | </div> | |
2913 | </div> | |
2914 | <div class="prop-row prop-inner"> | |
2915 | <div class="prop-name param-label">in</div> | |
2916 | <div class="prop-value">path</div> | |
2917 | </div> | |
2918 | </section> | |
2919 | </div> | |
2920 | <div class="doc-examples"></div> | |
2921 | </div> | |
2922 | <div class="doc-row"> | |
2923 | <div class="doc-copy"> | |
2924 | <section class="swagger-responses"> | |
2925 | <div class="prop-row prop-group"> | |
2926 | <div class="prop-name"> | |
2927 | <div class="prop-title">204 No Content</div> | |
2928 | </div> | |
2929 | <div class="prop-value"> | |
2930 | <p>successful operation</p> | |
2931 | </div> | |
2932 | </div> | |
2933 | </section> | |
2934 | </div> | |
2935 | <div class="doc-examples"> | |
2936 | <h5>Response Content-Types: | |
2937 | <span>application/json</span> | |
2938 | </h5> | |
2939 | </div> | |
2940 | </div> | |
2941 | </div> | |
2942 | <h1 id="tag-VideoBlacklist" class="swagger-summary-tag" data-traverse-target="tag-VideoBlacklist">VideoBlacklist</h1> | |
2943 | <div id="operation--video--videoId--blacklist-post" class="operation panel" data-traverse-target="operation--video--videoId--blacklist-post"> | |
2944 | <!-- <section class="operation-tags row"> --> | |
2945 | <!-- <div class="doc-copy"> --> | |
2946 | <div class="operation-tags"> | |
2947 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | |
2948 | <!----> | |
2949 | </div> | |
2950 | <!-- </div> --> | |
2951 | <!-- </section> --> | |
2952 | <h2 class="operation-title"> | |
2953 | <span class="operation-name"> | |
2954 | <span class="operation-name">POST</span> | |
2955 | <span class="operation-path">/video/{videoId}/blacklist</span> | |
2956 | </span> | |
2957 | </h2> | |
2958 | <div class="doc-row"> | |
2959 | <div class="doc-copy"> | |
2960 | <section class="swagger-request-params"> | |
2961 | <div class="prop-row prop-group"> | |
2962 | <div class="prop-name"> | |
2963 | <div class="prop-title">videoId</div> | |
2964 | <span class="json-property-required"></span> | |
2965 | </div> | |
2966 | <div class="prop-value"> | |
2967 | <p>The video id </p> | |
2968 | </div> | |
2969 | </div> | |
2970 | <div class="prop-row prop-inner"> | |
2971 | <div class="prop-name param-label">type</div> | |
2972 | <div class="prop-value"> | |
2973 | <span class="json-property-type">string</span> | |
2974 | <span class="json-property-range" title="Value limits"></span> | |
2975 | </div> | |
2976 | </div> | |
2977 | <div class="prop-row prop-inner"> | |
2978 | <div class="prop-name param-label">in</div> | |
2979 | <div class="prop-value">path</div> | |
2980 | </div> | |
2981 | </section> | |
2982 | </div> | |
2983 | <div class="doc-examples"></div> | |
2984 | </div> | |
2985 | <div class="doc-row"> | |
2986 | <div class="doc-copy"> | |
2987 | <section class="swagger-responses"> | |
2988 | <div class="prop-row prop-group"> | |
2989 | <div class="prop-name"> | |
2990 | <div class="prop-title">204 No Content</div> | |
2991 | </div> | |
2992 | <div class="prop-value"> | |
2993 | <p>successful operation</p> | |
2994 | </div> | |
2995 | </div> | |
2996 | </section> | |
2997 | </div> | |
2998 | <div class="doc-examples"> | |
2999 | <h5>Response Content-Types: | |
3000 | <span>application/json</span> | |
3001 | </h5> | |
3002 | </div> | |
3003 | </div> | |
3004 | </div> | |
3005 | <div id="operation--video--videoId--blacklist-delete" class="operation panel" data-traverse-target="operation--video--videoId--blacklist-delete"> | |
3006 | <!-- <section class="operation-tags row"> --> | |
3007 | <!-- <div class="doc-copy"> --> | |
3008 | <div class="operation-tags"> | |
3009 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | |
3010 | <!----> | |
3011 | </div> | |
3012 | <!-- </div> --> | |
3013 | <!-- </section> --> | |
3014 | <h2 class="operation-title"> | |
3015 | <span class="operation-name"> | |
3016 | <span class="operation-name">DELETE</span> | |
3017 | <span class="operation-path">/video/{videoId}/blacklist</span> | |
3018 | </span> | |
3019 | </h2> | |
3020 | <div class="doc-row"> | |
3021 | <div class="doc-copy"> | |
3022 | <section class="swagger-request-params"> | |
3023 | <div class="prop-row prop-group"> | |
3024 | <div class="prop-name"> | |
3025 | <div class="prop-title">videoId</div> | |
3026 | <span class="json-property-required"></span> | |
3027 | </div> | |
3028 | <div class="prop-value"> | |
3029 | <p>The video id </p> | |
3030 | </div> | |
3031 | </div> | |
3032 | <div class="prop-row prop-inner"> | |
3033 | <div class="prop-name param-label">type</div> | |
3034 | <div class="prop-value"> | |
3035 | <span class="json-property-type">string</span> | |
3036 | <span class="json-property-range" title="Value limits"></span> | |
3037 | </div> | |
3038 | </div> | |
3039 | <div class="prop-row prop-inner"> | |
3040 | <div class="prop-name param-label">in</div> | |
3041 | <div class="prop-value">path</div> | |
3042 | </div> | |
3043 | </section> | |
3044 | </div> | |
3045 | <div class="doc-examples"></div> | |
3046 | </div> | |
3047 | <div class="doc-row"> | |
3048 | <div class="doc-copy"> | |
3049 | <section class="swagger-responses"> | |
3050 | <div class="prop-row prop-group"> | |
3051 | <div class="prop-name"> | |
3052 | <div class="prop-title">204 No Content</div> | |
3053 | </div> | |
3054 | <div class="prop-value"> | |
3055 | <p>successful operation</p> | |
3056 | </div> | |
3057 | </div> | |
3058 | </section> | |
3059 | </div> | |
3060 | <div class="doc-examples"> | |
3061 | <h5>Response Content-Types: | |
3062 | <span>application/json</span> | |
3063 | </h5> | |
3064 | </div> | |
3065 | </div> | |
3066 | </div> | |
3067 | <div id="operation--video-blacklist-get" class="operation panel" data-traverse-target="operation--video-blacklist-get"> | |
3068 | <!-- <section class="operation-tags row"> --> | |
3069 | <!-- <div class="doc-copy"> --> | |
3070 | <div class="operation-tags"> | |
3071 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | |
3072 | <!----> | |
3073 | </div> | |
3074 | <!-- </div> --> | |
3075 | <!-- </section> --> | |
3076 | <h2 class="operation-title"> | |
3077 | <span class="operation-name"> | |
3078 | <span class="operation-name">GET</span> | |
3079 | <span class="operation-path">/video/blacklist</span> | |
3080 | </span> | |
3081 | </h2> | |
3082 | <div class="doc-row"> | |
3083 | <div class="doc-copy"> </div> | |
3084 | <div class="doc-examples"></div> | |
3085 | </div> | |
3086 | <div class="doc-row"> | |
3087 | <div class="doc-copy"> | |
3088 | <section class="swagger-responses"> | |
3089 | <div class="prop-row prop-group"> | |
3090 | <div class="prop-name"> | |
3091 | <div class="prop-title">200 OK</div> | |
3092 | <div class="prop-ref"> | |
3093 | <span class="json-schema-ref-array"> | |
3094 | <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a> | |
3095 | </span> | |
3096 | </div> | |
3097 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3098 | </div> | |
3099 | <div class="prop-value"> | |
3100 | <p>successful operation</p> | |
3101 | </div> | |
3102 | </div> | |
3103 | </section> | |
3104 | </div> | |
3105 | <div class="doc-examples"> | |
3106 | <h5>Response Content-Types: | |
3107 | <span>application/json</span> | |
3108 | </h5> | |
3109 | <section> | |
3110 | <h5>Response Example | |
3111 | <span>(200 OK)</span> | |
3112 | </h5> | |
3113 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
3114 | { | |
3115 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3116 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
3117 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3118 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3119 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3120 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
3121 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
3122 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
3123 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
3124 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
3125 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
3126 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
3127 | } | |
3128 | ] | |
3129 | </code></pre> | |
3130 | <!-- </div> --> | |
3131 | </section> | |
3132 | </div> | |
3133 | </div> | |
3134 | </div> | |
3135 | <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1> | |
3136 | <div id="operation--video-channels-get" class="operation panel" data-traverse-target="operation--video-channels-get"> | |
3137 | <!-- <section class="operation-tags row"> --> | |
3138 | <!-- <div class="doc-copy"> --> | |
3139 | <div class="operation-tags"> | |
3140 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
3141 | <!----> | |
3142 | </div> | |
3143 | <!-- </div> --> | |
3144 | <!-- </section> --> | |
3145 | <h2 class="operation-title"> | |
3146 | <span class="operation-name"> | |
3147 | <span class="operation-name">GET</span> | |
3148 | <span class="operation-path">/video/channels</span> | |
3149 | </span> | |
3150 | </h2> | |
3151 | <div class="doc-row"> | |
3152 | <div class="doc-copy"> </div> | |
3153 | <div class="doc-examples"></div> | |
3154 | </div> | |
3155 | <div class="doc-row"> | |
3156 | <div class="doc-copy"> | |
3157 | <section class="swagger-responses"> | |
3158 | <div class="prop-row prop-group"> | |
3159 | <div class="prop-name"> | |
3160 | <div class="prop-title">200 OK</div> | |
3161 | <div class="prop-ref"> | |
3162 | <span class="json-schema-ref-array"> | |
3163 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
3164 | </span> | |
3165 | </div> | |
3166 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3167 | </div> | |
3168 | <div class="prop-value"> | |
3169 | <p>successful operation</p> | |
3170 | </div> | |
3171 | </div> | |
3172 | </section> | |
3173 | </div> | |
3174 | <div class="doc-examples"> | |
3175 | <h5>Response Content-Types: | |
3176 | <span>application/json</span> | |
3177 | </h5> | |
3178 | <section> | |
3179 | <h5>Response Example | |
3180 | <span>(200 OK)</span> | |
3181 | </h5> | |
3182 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
3183 | { | |
3184 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
3185 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
3186 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
3187 | <span class="hljs-attr">"owner"</span>: { | |
3188 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3189 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
3190 | }, | |
3191 | <span class="hljs-attr">"videos"</span>: [ | |
3192 | { | |
3193 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3194 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
3195 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
3196 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3197 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3198 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
3199 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
3200 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
3201 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
3202 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
3203 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
3204 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
3205 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
3206 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
3207 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3208 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
3209 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
3210 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
3211 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
3212 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
3213 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
3214 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
3215 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
3216 | } | |
3217 | ] | |
3218 | } | |
3219 | ] | |
3220 | </code></pre> | |
3221 | <!-- </div> --> | |
3222 | </section> | |
3223 | </div> | |
3224 | </div> | |
3225 | </div> | |
3226 | <div id="operation--video-channels-post" class="operation panel" data-traverse-target="operation--video-channels-post"> | |
3227 | <!-- <section class="operation-tags row"> --> | |
3228 | <!-- <div class="doc-copy"> --> | |
3229 | <div class="operation-tags"> | |
3230 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
3231 | <!----> | |
3232 | </div> | |
3233 | <!-- </div> --> | |
3234 | <!-- </section> --> | |
3235 | <h2 class="operation-title"> | |
3236 | <span class="operation-name"> | |
3237 | <span class="operation-name">POST</span> | |
3238 | <span class="operation-path">/video/channels</span> | |
3239 | </span> | |
3240 | </h2> | |
3241 | <div class="doc-row"> | |
3242 | <div class="doc-copy"> | |
3243 | <section class="swagger-request-body"> | |
3244 | <div class="prop-row"> | |
3245 | <div class="prop-name"> | |
3246 | <div class="swagger-request-model"> | |
3247 | <span class=""> | |
3248 | <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a> | |
3249 | </span> | |
3250 | </div> | |
3251 | </div> | |
3252 | <div class="prop-value columns small-6"> | |
3253 | <!-- <div class="swagger-request-description"> -->undefined | |
3254 | <!-- </div> --> | |
3255 | </div> | |
3256 | </div> | |
3257 | </section> | |
3258 | </div> | |
3259 | <div class="doc-examples"> | |
3260 | <section> | |
3261 | <h5>Request Content-Types: | |
3262 | <span>application/json</span> | |
3263 | </h5> | |
3264 | <h5>Request Example</h5> | |
3265 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
3266 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3267 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
3268 | } | |
3269 | </code></pre> | |
3270 | <!-- </div> --> | |
3271 | </section> | |
3272 | </div> | |
3273 | </div> | |
3274 | <div class="doc-row"> | |
3275 | <div class="doc-copy"> | |
3276 | <section class="swagger-responses"> | |
3277 | <div class="prop-row prop-group"> | |
3278 | <div class="prop-name"> | |
3279 | <div class="prop-title">204 No Content</div> | |
3280 | </div> | |
3281 | <div class="prop-value"> | |
3282 | <p>successful operation</p> | |
3283 | </div> | |
3284 | </div> | |
3285 | </section> | |
3286 | </div> | |
3287 | <div class="doc-examples"> | |
3288 | <h5>Response Content-Types: | |
3289 | <span>application/json</span> | |
3290 | </h5> | |
3291 | </div> | |
3292 | </div> | |
3293 | </div> | |
3294 | <div id="operation--video-channels--id--get" class="operation panel" data-traverse-target="operation--video-channels--id--get"> | |
3295 | <!-- <section class="operation-tags row"> --> | |
3296 | <!-- <div class="doc-copy"> --> | |
3297 | <div class="operation-tags"> | |
3298 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
3299 | <!----> | |
3300 | </div> | |
3301 | <!-- </div> --> | |
3302 | <!-- </section> --> | |
3303 | <h2 class="operation-title"> | |
3304 | <span class="operation-name"> | |
3305 | <span class="operation-name">GET</span> | |
3306 | <span class="operation-path">/video/channels/{id}</span> | |
3307 | </span> | |
3308 | </h2> | |
3309 | <div class="doc-row"> | |
3310 | <div class="doc-copy"> | |
3311 | <section class="swagger-request-params"> | |
3312 | <div class="prop-row prop-group"> | |
3313 | <div class="prop-name"> | |
3314 | <div class="prop-title">id</div> | |
3315 | <span class="json-property-required"></span> | |
3316 | </div> | |
3317 | <div class="prop-value"> | |
3318 | <p>The video id </p> | |
3319 | </div> | |
3320 | </div> | |
3321 | <div class="prop-row prop-inner"> | |
3322 | <div class="prop-name param-label">type</div> | |
3323 | <div class="prop-value"> | |
3324 | <span class="json-property-type">string</span> | |
3325 | <span class="json-property-range" title="Value limits"></span> | |
3326 | </div> | |
3327 | </div> | |
3328 | <div class="prop-row prop-inner"> | |
3329 | <div class="prop-name param-label">in</div> | |
3330 | <div class="prop-value">path</div> | |
3331 | </div> | |
3332 | </section> | |
3333 | </div> | |
3334 | <div class="doc-examples"></div> | |
3335 | </div> | |
3336 | <div class="doc-row"> | |
3337 | <div class="doc-copy"> | |
3338 | <section class="swagger-responses"> | |
3339 | <div class="prop-row prop-group"> | |
3340 | <div class="prop-name"> | |
3341 | <div class="prop-title">200 OK</div> | |
3342 | <div class="prop-ref"> | |
3343 | <span class=""> | |
3344 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
3345 | </span> | |
3346 | </div> | |
3347 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3348 | </div> | |
3349 | <div class="prop-value"> | |
3350 | <p>successful operation</p> | |
3351 | </div> | |
3352 | </div> | |
3353 | </section> | |
3354 | </div> | |
3355 | <div class="doc-examples"> | |
3356 | <h5>Response Content-Types: | |
3357 | <span>application/json</span> | |
3358 | </h5> | |
3359 | <section> | |
3360 | <h5>Response Example | |
3361 | <span>(200 OK)</span> | |
3362 | </h5> | |
3363 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
3364 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
3365 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
3366 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
3367 | <span class="hljs-attr">"owner"</span>: { | |
3368 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3369 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
3370 | }, | |
3371 | <span class="hljs-attr">"videos"</span>: [ | |
3372 | { | |
3373 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3374 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
3375 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
3376 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3377 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3378 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
3379 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
3380 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
3381 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
3382 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
3383 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
3384 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
3385 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
3386 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
3387 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3388 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
3389 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
3390 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
3391 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
3392 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
3393 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
3394 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
3395 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
3396 | } | |
3397 | ] | |
3398 | } | |
3399 | </code></pre> | |
3400 | <!-- </div> --> | |
3401 | </section> | |
3402 | </div> | |
3403 | </div> | |
3404 | </div> | |
3405 | <div id="operation--video-channels--id--put" class="operation panel" data-traverse-target="operation--video-channels--id--put"> | |
3406 | <!-- <section class="operation-tags row"> --> | |
3407 | <!-- <div class="doc-copy"> --> | |
3408 | <div class="operation-tags"> | |
3409 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
3410 | <!----> | |
3411 | </div> | |
3412 | <!-- </div> --> | |
3413 | <!-- </section> --> | |
3414 | <h2 class="operation-title"> | |
3415 | <span class="operation-name"> | |
3416 | <span class="operation-name">PUT</span> | |
3417 | <span class="operation-path">/video/channels/{id}</span> | |
3418 | </span> | |
3419 | </h2> | |
3420 | <div class="doc-row"> | |
3421 | <div class="doc-copy"> | |
3422 | <section class="swagger-request-body"> | |
3423 | <div class="prop-row"> | |
3424 | <div class="prop-name"> | |
3425 | <div class="swagger-request-model"> | |
3426 | <span class=""> | |
3427 | <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a> | |
3428 | </span> | |
3429 | </div> | |
3430 | </div> | |
3431 | <div class="prop-value columns small-6"> | |
3432 | <!-- <div class="swagger-request-description"> -->undefined | |
3433 | <!-- </div> --> | |
3434 | </div> | |
3435 | </div> | |
3436 | </section> | |
3437 | <section class="swagger-request-params"> | |
3438 | <div class="prop-row prop-group"> | |
3439 | <div class="prop-name"> | |
3440 | <div class="prop-title">id</div> | |
3441 | <span class="json-property-required"></span> | |
3442 | </div> | |
3443 | <div class="prop-value"> | |
3444 | <p>The video id </p> | |
3445 | </div> | |
3446 | </div> | |
3447 | <div class="prop-row prop-inner"> | |
3448 | <div class="prop-name param-label">type</div> | |
3449 | <div class="prop-value"> | |
3450 | <span class="json-property-type">string</span> | |
3451 | <span class="json-property-range" title="Value limits"></span> | |
3452 | </div> | |
3453 | </div> | |
3454 | <div class="prop-row prop-inner"> | |
3455 | <div class="prop-name param-label">in</div> | |
3456 | <div class="prop-value">path</div> | |
3457 | </div> | |
3458 | </section> | |
3459 | </div> | |
3460 | <div class="doc-examples"> | |
3461 | <section> | |
3462 | <h5>Request Content-Types: | |
3463 | <span>application/json</span> | |
3464 | </h5> | |
3465 | <h5>Request Example</h5> | |
3466 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
3467 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3468 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
3469 | } | |
3470 | </code></pre> | |
3471 | <!-- </div> --> | |
3472 | </section> | |
3473 | </div> | |
3474 | </div> | |
3475 | <div class="doc-row"> | |
3476 | <div class="doc-copy"> | |
3477 | <section class="swagger-responses"> | |
3478 | <div class="prop-row prop-group"> | |
3479 | <div class="prop-name"> | |
3480 | <div class="prop-title">204 No Content</div> | |
3481 | </div> | |
3482 | <div class="prop-value"> | |
3483 | <p>successful operation</p> | |
3484 | </div> | |
3485 | </div> | |
3486 | </section> | |
3487 | </div> | |
3488 | <div class="doc-examples"> | |
3489 | <h5>Response Content-Types: | |
3490 | <span>application/json</span> | |
3491 | </h5> | |
3492 | </div> | |
3493 | </div> | |
3494 | </div> | |
3495 | <div id="operation--video-channels--id--delete" class="operation panel" data-traverse-target="operation--video-channels--id--delete"> | |
3496 | <!-- <section class="operation-tags row"> --> | |
3497 | <!-- <div class="doc-copy"> --> | |
3498 | <div class="operation-tags"> | |
3499 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
3500 | <!----> | |
3501 | </div> | |
3502 | <!-- </div> --> | |
3503 | <!-- </section> --> | |
3504 | <h2 class="operation-title"> | |
3505 | <span class="operation-name"> | |
3506 | <span class="operation-name">DELETE</span> | |
3507 | <span class="operation-path">/video/channels/{id}</span> | |
3508 | </span> | |
3509 | </h2> | |
3510 | <div class="doc-row"> | |
3511 | <div class="doc-copy"> | |
3512 | <section class="swagger-request-params"> | |
3513 | <div class="prop-row prop-group"> | |
3514 | <div class="prop-name"> | |
3515 | <div class="prop-title">id</div> | |
3516 | <span class="json-property-required"></span> | |
3517 | </div> | |
3518 | <div class="prop-value"> | |
3519 | <p>The video id </p> | |
3520 | </div> | |
3521 | </div> | |
3522 | <div class="prop-row prop-inner"> | |
3523 | <div class="prop-name param-label">type</div> | |
3524 | <div class="prop-value"> | |
3525 | <span class="json-property-type">string</span> | |
3526 | <span class="json-property-range" title="Value limits"></span> | |
3527 | </div> | |
3528 | </div> | |
3529 | <div class="prop-row prop-inner"> | |
3530 | <div class="prop-name param-label">in</div> | |
3531 | <div class="prop-value">path</div> | |
3532 | </div> | |
3533 | </section> | |
3534 | </div> | |
3535 | <div class="doc-examples"></div> | |
3536 | </div> | |
3537 | <div class="doc-row"> | |
3538 | <div class="doc-copy"> | |
3539 | <section class="swagger-responses"> | |
3540 | <div class="prop-row prop-group"> | |
3541 | <div class="prop-name"> | |
3542 | <div class="prop-title">204 No Content</div> | |
3543 | </div> | |
3544 | <div class="prop-value"> | |
3545 | <p>successful operation</p> | |
3546 | </div> | |
3547 | </div> | |
3548 | </section> | |
3549 | </div> | |
3550 | <div class="doc-examples"> | |
3551 | <h5>Response Content-Types: | |
3552 | <span>application/json</span> | |
3553 | </h5> | |
3554 | </div> | |
3555 | </div> | |
3556 | </div> | |
3557 | <div id="operation--video-accounts--accountId--channels-get" class="operation panel" data-traverse-target="operation--video-accounts--accountId--channels-get"> | |
3558 | <!-- <section class="operation-tags row"> --> | |
3559 | <!-- <div class="doc-copy"> --> | |
3560 | <div class="operation-tags"> | |
3561 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
3562 | <!----> | |
3563 | </div> | |
3564 | <!-- </div> --> | |
3565 | <!-- </section> --> | |
3566 | <h2 class="operation-title"> | |
3567 | <span class="operation-name"> | |
3568 | <span class="operation-name">GET</span> | |
3569 | <span class="operation-path">/video/accounts/{accountId}/channels</span> | |
3570 | </span> | |
3571 | </h2> | |
3572 | <div class="doc-row"> | |
3573 | <div class="doc-copy"> | |
3574 | <section class="swagger-request-params"> | |
3575 | <div class="prop-row prop-group"> | |
3576 | <div class="prop-name"> | |
3577 | <div class="prop-title">accountId</div> | |
3578 | <span class="json-property-required"></span> | |
3579 | </div> | |
3580 | <div class="prop-value"> | |
3581 | <p>The account id </p> | |
3582 | </div> | |
3583 | </div> | |
3584 | <div class="prop-row prop-inner"> | |
3585 | <div class="prop-name param-label">type</div> | |
3586 | <div class="prop-value"> | |
3587 | <span class="json-property-type">string</span> | |
3588 | <span class="json-property-range" title="Value limits"></span> | |
3589 | </div> | |
3590 | </div> | |
3591 | <div class="prop-row prop-inner"> | |
3592 | <div class="prop-name param-label">in</div> | |
3593 | <div class="prop-value">path</div> | |
3594 | </div> | |
3595 | </section> | |
3596 | </div> | |
3597 | <div class="doc-examples"></div> | |
3598 | </div> | |
3599 | <div class="doc-row"> | |
3600 | <div class="doc-copy"> | |
3601 | <section class="swagger-responses"> | |
3602 | <div class="prop-row prop-group"> | |
3603 | <div class="prop-name"> | |
3604 | <div class="prop-title">200 OK</div> | |
3605 | <div class="prop-ref"> | |
3606 | <span class="json-schema-ref-array"> | |
3607 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
3608 | </span> | |
3609 | </div> | |
3610 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3611 | </div> | |
3612 | <div class="prop-value"> | |
3613 | <p>successful operation</p> | |
3614 | </div> | |
3615 | </div> | |
3616 | </section> | |
3617 | </div> | |
3618 | <div class="doc-examples"> | |
3619 | <h5>Response Content-Types: | |
3620 | <span>application/json</span> | |
3621 | </h5> | |
3622 | <section> | |
3623 | <h5>Response Example | |
3624 | <span>(200 OK)</span> | |
3625 | </h5> | |
3626 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
3627 | { | |
3628 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
3629 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
3630 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
3631 | <span class="hljs-attr">"owner"</span>: { | |
3632 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3633 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
3634 | }, | |
3635 | <span class="hljs-attr">"videos"</span>: [ | |
3636 | { | |
3637 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3638 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
3639 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
3640 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3641 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3642 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
3643 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
3644 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
3645 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
3646 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
3647 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</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">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
3653 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
3654 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
3655 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
3656 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
3657 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
3658 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
3659 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
3660 | } | |
3661 | ] | |
3662 | } | |
3663 | ] | |
3664 | </code></pre> | |
3665 | <!-- </div> --> | |
3666 | </section> | |
3667 | </div> | |
3668 | </div> | |
3669 | </div> | |
3670 | <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1> | |
3671 | <div id="operation--video--videoId--comment-threads-get" class="operation panel" data-traverse-target="operation--video--videoId--comment-threads-get"> | |
3672 | <!-- <section class="operation-tags row"> --> | |
3673 | <!-- <div class="doc-copy"> --> | |
3674 | <div class="operation-tags"> | |
3675 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
3676 | <!----> | |
3677 | </div> | |
3678 | <!-- </div> --> | |
3679 | <!-- </section> --> | |
3680 | <h2 class="operation-title"> | |
3681 | <span class="operation-name"> | |
3682 | <span class="operation-name">GET</span> | |
3683 | <span class="operation-path">/video/{videoId}/comment-threads</span> | |
3684 | </span> | |
3685 | </h2> | |
3686 | <div class="doc-row"> | |
3687 | <div class="doc-copy"> | |
3688 | <section class="swagger-request-params"> | |
3689 | <div class="prop-row prop-group"> | |
3690 | <div class="prop-name"> | |
3691 | <div class="prop-title">videoId</div> | |
3692 | <span class="json-property-required"></span> | |
3693 | </div> | |
3694 | <div class="prop-value"> | |
3695 | <p>The video id </p> | |
3696 | </div> | |
3697 | </div> | |
3698 | <div class="prop-row prop-inner"> | |
3699 | <div class="prop-name param-label">type</div> | |
3700 | <div class="prop-value"> | |
3701 | <span class="json-property-type">string</span> | |
3702 | <span class="json-property-range" title="Value limits"></span> | |
3703 | </div> | |
3704 | </div> | |
3705 | <div class="prop-row prop-inner"> | |
3706 | <div class="prop-name param-label">in</div> | |
3707 | <div class="prop-value">path</div> | |
3708 | </div> | |
3709 | </section> | |
3710 | </div> | |
3711 | <div class="doc-examples"></div> | |
3712 | </div> | |
3713 | <div class="doc-row"> | |
3714 | <div class="doc-copy"> | |
3715 | <section class="swagger-responses"> | |
3716 | <div class="prop-row prop-group"> | |
3717 | <div class="prop-name"> | |
3718 | <div class="prop-title">200 OK</div> | |
3719 | <div class="prop-ref"> | |
3720 | <span class=""> | |
3721 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
3722 | </span> | |
3723 | </div> | |
3724 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3725 | </div> | |
3726 | <div class="prop-value"> | |
3727 | <p>successful operation</p> | |
3728 | </div> | |
3729 | </div> | |
3730 | </section> | |
3731 | </div> | |
3732 | <div class="doc-examples"> | |
3733 | <h5>Response Content-Types: | |
3734 | <span>application/json</span> | |
3735 | </h5> | |
3736 | <section> | |
3737 | <h5>Response Example | |
3738 | <span>(200 OK)</span> | |
3739 | </h5> | |
3740 | <!-- <div class="hljs"> --> | |
3741 | <!-- </div> --> | |
3742 | </section> | |
3743 | </div> | |
3744 | </div> | |
3745 | </div> | |
3746 | <div id="operation--video--videoId--comment-threads-post" class="operation panel" data-traverse-target="operation--video--videoId--comment-threads-post"> | |
3747 | <!-- <section class="operation-tags row"> --> | |
3748 | <!-- <div class="doc-copy"> --> | |
3749 | <div class="operation-tags"> | |
3750 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
3751 | <!----> | |
3752 | </div> | |
3753 | <!-- </div> --> | |
3754 | <!-- </section> --> | |
3755 | <h2 class="operation-title"> | |
3756 | <span class="operation-name"> | |
3757 | <span class="operation-name">POST</span> | |
3758 | <span class="operation-path">/video/{videoId}/comment-threads</span> | |
3759 | </span> | |
3760 | </h2> | |
3761 | <div class="doc-row"> | |
3762 | <div class="doc-copy"> | |
3763 | <section class="swagger-request-params"> | |
3764 | <div class="prop-row prop-group"> | |
3765 | <div class="prop-name"> | |
3766 | <div class="prop-title">videoId</div> | |
3767 | <span class="json-property-required"></span> | |
3768 | </div> | |
3769 | <div class="prop-value"> | |
3770 | <p>The video id </p> | |
3771 | </div> | |
3772 | </div> | |
3773 | <div class="prop-row prop-inner"> | |
3774 | <div class="prop-name param-label">type</div> | |
3775 | <div class="prop-value"> | |
3776 | <span class="json-property-type">string</span> | |
3777 | <span class="json-property-range" title="Value limits"></span> | |
3778 | </div> | |
3779 | </div> | |
3780 | <div class="prop-row prop-inner"> | |
3781 | <div class="prop-name param-label">in</div> | |
3782 | <div class="prop-value">path</div> | |
3783 | </div> | |
3784 | </section> | |
3785 | </div> | |
3786 | <div class="doc-examples"></div> | |
3787 | </div> | |
3788 | <div class="doc-row"> | |
3789 | <div class="doc-copy"> | |
3790 | <section class="swagger-responses"> | |
3791 | <div class="prop-row prop-group"> | |
3792 | <div class="prop-name"> | |
3793 | <div class="prop-title">200 OK</div> | |
3794 | </div> | |
3795 | <div class="prop-value"> | |
3796 | <p>successful operation</p> | |
3797 | </div> | |
3798 | </div> | |
3799 | </section> | |
3800 | </div> | |
3801 | <div class="doc-examples"> | |
3802 | <h5>Response Content-Types: | |
3803 | <span>application/json</span> | |
3804 | </h5> | |
3805 | </div> | |
3806 | </div> | |
3807 | </div> | |
3808 | <div id="operation--video--videoId--comment-threads--threadId--get" class="operation panel" data-traverse-target="operation--video--videoId--comment-threads--threadId--get"> | |
3809 | <!-- <section class="operation-tags row"> --> | |
3810 | <!-- <div class="doc-copy"> --> | |
3811 | <div class="operation-tags"> | |
3812 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
3813 | <!----> | |
3814 | </div> | |
3815 | <!-- </div> --> | |
3816 | <!-- </section> --> | |
3817 | <h2 class="operation-title"> | |
3818 | <span class="operation-name"> | |
3819 | <span class="operation-name">GET</span> | |
3820 | <span class="operation-path">/video/{videoId}/comment-threads/{threadId}</span> | |
3821 | </span> | |
3822 | </h2> | |
3823 | <div class="doc-row"> | |
3824 | <div class="doc-copy"> | |
3825 | <section class="swagger-request-params"> | |
3826 | <div class="prop-row prop-group"> | |
3827 | <div class="prop-name"> | |
3828 | <div class="prop-title">videoId</div> | |
3829 | <span class="json-property-required"></span> | |
3830 | </div> | |
3831 | <div class="prop-value"> | |
3832 | <p>The video id </p> | |
3833 | </div> | |
3834 | </div> | |
3835 | <div class="prop-row prop-inner"> | |
3836 | <div class="prop-name param-label">type</div> | |
3837 | <div class="prop-value"> | |
3838 | <span class="json-property-type">string</span> | |
3839 | <span class="json-property-range" title="Value limits"></span> | |
3840 | </div> | |
3841 | </div> | |
3842 | <div class="prop-row prop-inner"> | |
3843 | <div class="prop-name param-label">in</div> | |
3844 | <div class="prop-value">path</div> | |
3845 | </div> | |
3846 | <div class="prop-row prop-group"> | |
3847 | <div class="prop-name"> | |
3848 | <div class="prop-title">threadId</div> | |
3849 | <span class="json-property-required"></span> | |
3850 | </div> | |
3851 | <div class="prop-value"> | |
3852 | <p>The thread id </p> | |
3853 | </div> | |
3854 | </div> | |
3855 | <div class="prop-row prop-inner"> | |
3856 | <div class="prop-name param-label">type</div> | |
3857 | <div class="prop-value"> | |
3858 | <span class="json-property-type">string</span> | |
3859 | <span class="json-property-range" title="Value limits"></span> | |
3860 | </div> | |
3861 | </div> | |
3862 | <div class="prop-row prop-inner"> | |
3863 | <div class="prop-name param-label">in</div> | |
3864 | <div class="prop-value">path</div> | |
3865 | </div> | |
3866 | </section> | |
3867 | </div> | |
3868 | <div class="doc-examples"></div> | |
3869 | </div> | |
3870 | <div class="doc-row"> | |
3871 | <div class="doc-copy"> | |
3872 | <section class="swagger-responses"> | |
3873 | <div class="prop-row prop-group"> | |
3874 | <div class="prop-name"> | |
3875 | <div class="prop-title">200 OK</div> | |
3876 | <div class="prop-ref"> | |
3877 | <span class=""> | |
3878 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
3879 | </span> | |
3880 | </div> | |
3881 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3882 | </div> | |
3883 | <div class="prop-value"> | |
3884 | <p>successful operation</p> | |
3885 | </div> | |
3886 | </div> | |
3887 | </section> | |
3888 | </div> | |
3889 | <div class="doc-examples"> | |
3890 | <h5>Response Content-Types: | |
3891 | <span>application/json</span> | |
3892 | </h5> | |
3893 | <section> | |
3894 | <h5>Response Example | |
3895 | <span>(200 OK)</span> | |
3896 | </h5> | |
3897 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
3898 | <span class="hljs-attr">"comment"</span>: { | |
3899 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3900 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
3901 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
3902 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
3903 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
3904 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
3905 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3906 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3907 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
3908 | <span class="hljs-attr">"account"</span>: { | |
3909 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
3910 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3911 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
3912 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
3913 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3914 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
3915 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
3916 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
3917 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3918 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3919 | <span class="hljs-attr">"avatar"</span>: { | |
3920 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
3921 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3922 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
3923 | } | |
3924 | } | |
3925 | }, | |
3926 | <span class="hljs-attr">"children"</span>: [ | |
3927 | { | |
3928 | <span class="hljs-attr">"comment"</span>: { | |
3929 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3930 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
3931 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
3932 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
3933 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
3934 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
3935 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3936 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3937 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
3938 | <span class="hljs-attr">"account"</span>: { | |
3939 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
3940 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3941 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
3942 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
3943 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3944 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
3945 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
3946 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
3947 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3948 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3949 | <span class="hljs-attr">"avatar"</span>: { | |
3950 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
3951 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3952 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
3953 | } | |
3954 | } | |
3955 | }, | |
3956 | <span class="hljs-attr">"children"</span>: [ | |
3957 | { | |
3958 | <span class="hljs-attr">"comment"</span>: { | |
3959 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3960 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
3961 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
3962 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
3963 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
3964 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
3965 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3966 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3967 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
3968 | <span class="hljs-attr">"account"</span>: { | |
3969 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3970 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
3971 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
3972 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3973 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
3974 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
3975 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
3976 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3977 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3978 | <span class="hljs-attr">"avatar"</span>: { | |
3979 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
3980 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3981 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
3982 | } | |
3983 | } | |
3984 | } | |
3985 | } | |
3986 | ] | |
3987 | } | |
3988 | ] | |
3989 | } | |
3990 | </code></pre> | |
3991 | <!-- </div> --> | |
3992 | </section> | |
3993 | </div> | |
3994 | </div> | |
3995 | </div> | |
3996 | <div id="operation--video--videoId--comments--commentId--post" class="operation panel" data-traverse-target="operation--video--videoId--comments--commentId--post"> | |
3997 | <!-- <section class="operation-tags row"> --> | |
3998 | <!-- <div class="doc-copy"> --> | |
3999 | <div class="operation-tags"> | |
4000 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
4001 | <!----> | |
4002 | </div> | |
4003 | <!-- </div> --> | |
4004 | <!-- </section> --> | |
4005 | <h2 class="operation-title"> | |
4006 | <span class="operation-name"> | |
4007 | <span class="operation-name">POST</span> | |
4008 | <span class="operation-path">/video/{videoId}/comments/{commentId}</span> | |
4009 | </span> | |
4010 | </h2> | |
4011 | <div class="doc-row"> | |
4012 | <div class="doc-copy"> | |
4013 | <section class="swagger-request-params"> | |
4014 | <div class="prop-row prop-group"> | |
4015 | <div class="prop-name"> | |
4016 | <div class="prop-title">videoId</div> | |
4017 | <span class="json-property-required"></span> | |
4018 | </div> | |
4019 | <div class="prop-value"> | |
4020 | <p>The video id </p> | |
4021 | </div> | |
4022 | </div> | |
4023 | <div class="prop-row prop-inner"> | |
4024 | <div class="prop-name param-label">type</div> | |
4025 | <div class="prop-value"> | |
4026 | <span class="json-property-type">string</span> | |
4027 | <span class="json-property-range" title="Value limits"></span> | |
4028 | </div> | |
4029 | </div> | |
4030 | <div class="prop-row prop-inner"> | |
4031 | <div class="prop-name param-label">in</div> | |
4032 | <div class="prop-value">path</div> | |
4033 | </div> | |
4034 | <div class="prop-row prop-group"> | |
4035 | <div class="prop-name"> | |
4036 | <div class="prop-title">commentId</div> | |
4037 | <span class="json-property-required"></span> | |
4038 | </div> | |
4039 | <div class="prop-value"> | |
4040 | <p>The comment id </p> | |
4041 | </div> | |
4042 | </div> | |
4043 | <div class="prop-row prop-inner"> | |
4044 | <div class="prop-name param-label">type</div> | |
4045 | <div class="prop-value"> | |
4046 | <span class="json-property-type">string</span> | |
4047 | <span class="json-property-range" title="Value limits"></span> | |
4048 | </div> | |
4049 | </div> | |
4050 | <div class="prop-row prop-inner"> | |
4051 | <div class="prop-name param-label">in</div> | |
4052 | <div class="prop-value">path</div> | |
4053 | </div> | |
4054 | </section> | |
4055 | </div> | |
4056 | <div class="doc-examples"></div> | |
4057 | </div> | |
4058 | <div class="doc-row"> | |
4059 | <div class="doc-copy"> | |
4060 | <section class="swagger-responses"> | |
4061 | <div class="prop-row prop-group"> | |
4062 | <div class="prop-name"> | |
4063 | <div class="prop-title">200 OK</div> | |
4064 | </div> | |
4065 | <div class="prop-value"> | |
4066 | <p>successful operation</p> | |
4067 | </div> | |
4068 | </div> | |
4069 | </section> | |
4070 | </div> | |
4071 | <div class="doc-examples"> | |
4072 | <h5>Response Content-Types: | |
4073 | <span>application/json</span> | |
4074 | </h5> | |
4075 | </div> | |
4076 | </div> | |
4077 | </div> | |
4078 | <div id="operation--video--videoId--comments--commentId--delete" class="operation panel" data-traverse-target="operation--video--videoId--comments--commentId--delete"> | |
4079 | <!-- <section class="operation-tags row"> --> | |
4080 | <!-- <div class="doc-copy"> --> | |
4081 | <div class="operation-tags"> | |
4082 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
4083 | <!----> | |
4084 | </div> | |
4085 | <!-- </div> --> | |
4086 | <!-- </section> --> | |
4087 | <h2 class="operation-title"> | |
4088 | <span class="operation-name"> | |
4089 | <span class="operation-name">DELETE</span> | |
4090 | <span class="operation-path">/video/{videoId}/comments/{commentId}</span> | |
4091 | </span> | |
4092 | </h2> | |
4093 | <div class="doc-row"> | |
4094 | <div class="doc-copy"> | |
4095 | <section class="swagger-request-params"> | |
4096 | <div class="prop-row prop-group"> | |
4097 | <div class="prop-name"> | |
4098 | <div class="prop-title">videoId</div> | |
4099 | <span class="json-property-required"></span> | |
4100 | </div> | |
4101 | <div class="prop-value"> | |
4102 | <p>The video id </p> | |
4103 | </div> | |
4104 | </div> | |
4105 | <div class="prop-row prop-inner"> | |
4106 | <div class="prop-name param-label">type</div> | |
4107 | <div class="prop-value"> | |
4108 | <span class="json-property-type">string</span> | |
4109 | <span class="json-property-range" title="Value limits"></span> | |
4110 | </div> | |
4111 | </div> | |
4112 | <div class="prop-row prop-inner"> | |
4113 | <div class="prop-name param-label">in</div> | |
4114 | <div class="prop-value">path</div> | |
4115 | </div> | |
4116 | <div class="prop-row prop-group"> | |
4117 | <div class="prop-name"> | |
4118 | <div class="prop-title">commentId</div> | |
4119 | <span class="json-property-required"></span> | |
4120 | </div> | |
4121 | <div class="prop-value"> | |
4122 | <p>The comment id </p> | |
4123 | </div> | |
4124 | </div> | |
4125 | <div class="prop-row prop-inner"> | |
4126 | <div class="prop-name param-label">type</div> | |
4127 | <div class="prop-value"> | |
4128 | <span class="json-property-type">string</span> | |
4129 | <span class="json-property-range" title="Value limits"></span> | |
4130 | </div> | |
4131 | </div> | |
4132 | <div class="prop-row prop-inner"> | |
4133 | <div class="prop-name param-label">in</div> | |
4134 | <div class="prop-value">path</div> | |
4135 | </div> | |
4136 | </section> | |
4137 | </div> | |
4138 | <div class="doc-examples"></div> | |
4139 | </div> | |
4140 | <div class="doc-row"> | |
4141 | <div class="doc-copy"> | |
4142 | <section class="swagger-responses"> | |
4143 | <div class="prop-row prop-group"> | |
4144 | <div class="prop-name"> | |
4145 | <div class="prop-title">204 No Content</div> | |
4146 | </div> | |
4147 | <div class="prop-value"> | |
4148 | <p>successful operation</p> | |
4149 | </div> | |
4150 | </div> | |
4151 | </section> | |
4152 | </div> | |
4153 | <div class="doc-examples"> | |
4154 | <h5>Response Content-Types: | |
4155 | <span>application/json</span> | |
4156 | </h5> | |
4157 | </div> | |
4158 | </div> | |
4159 | </div> | |
4160 | <h1 id="tag-VideoRate" class="swagger-summary-tag" data-traverse-target="tag-VideoRate">VideoRate</h1> | |
4161 | <div id="operation--video--id--rate-put" class="operation panel" data-traverse-target="operation--video--id--rate-put"> | |
4162 | <!-- <section class="operation-tags row"> --> | |
4163 | <!-- <div class="doc-copy"> --> | |
4164 | <div class="operation-tags"> | |
4165 | <a class="label" href="#tag-VideoRate">VideoRate</a> | |
4166 | <!----> | |
4167 | </div> | |
4168 | <!-- </div> --> | |
4169 | <!-- </section> --> | |
4170 | <h2 class="operation-title"> | |
4171 | <span class="operation-name"> | |
4172 | <span class="operation-name">PUT</span> | |
4173 | <span class="operation-path">/video/{id}/rate</span> | |
4174 | </span> | |
4175 | </h2> | |
4176 | <div class="doc-row"> | |
4177 | <div class="doc-copy"> | |
4178 | <section class="swagger-request-params"> | |
4179 | <div class="prop-row prop-group"> | |
4180 | <div class="prop-name"> | |
4181 | <div class="prop-title">id</div> | |
4182 | <span class="json-property-required"></span> | |
4183 | </div> | |
4184 | <div class="prop-value"> | |
4185 | <p>The video id </p> | |
4186 | </div> | |
4187 | </div> | |
4188 | <div class="prop-row prop-inner"> | |
4189 | <div class="prop-name param-label">type</div> | |
4190 | <div class="prop-value"> | |
4191 | <span class="json-property-type">string</span> | |
4192 | <span class="json-property-range" title="Value limits"></span> | |
4193 | </div> | |
4194 | </div> | |
4195 | <div class="prop-row prop-inner"> | |
4196 | <div class="prop-name param-label">in</div> | |
4197 | <div class="prop-value">path</div> | |
4198 | </div> | |
4199 | </section> | |
4200 | </div> | |
4201 | <div class="doc-examples"></div> | |
4202 | </div> | |
4203 | <div class="doc-row"> | |
4204 | <div class="doc-copy"> | |
4205 | <section class="swagger-responses"> | |
4206 | <div class="prop-row prop-group"> | |
4207 | <div class="prop-name"> | |
4208 | <div class="prop-title">204 No Content</div> | |
4209 | </div> | |
4210 | <div class="prop-value"> | |
4211 | <p>successful operation</p> | |
4212 | </div> | |
4213 | </div> | |
4214 | </section> | |
4215 | </div> | |
4216 | <div class="doc-examples"> | |
4217 | <h5>Response Content-Types: | |
4218 | <span>application/json</span> | |
4219 | </h5> | |
4220 | </div> | |
4221 | </div> | |
4222 | </div> | |
4223 | <h1>Schema Definitions</h1> | |
4224 | <div id="definition-Video" class="definition panel" data-traverse-target="definition-Video"> | |
4225 | <h2 class="panel-title"> | |
4226 | <a name="/definitions/Video"></a>Video: | |
4227 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
4228 | <span class="json-property-range" title="Value limits"></span> | |
4229 | ||
4230 | ||
4231 | </span> --> | |
4232 | </h2> | |
4233 | <div class="doc-row"> | |
4234 | <div class="doc-copy"> | |
4235 | <section class="json-schema-properties"> | |
4236 | <dl> | |
4237 | <dt data-property-name="id"> | |
4238 | <span class="json-property-name">id:</span> | |
4239 | <span class="json-property-type">number</span> | |
4240 | <span class="json-property-range" title="Value limits"></span> | |
4241 | </dt> | |
4242 | <dt data-property-name="uuid"> | |
4243 | <span class="json-property-name">uuid:</span> | |
4244 | <span class="json-property-type">string</span> | |
4245 | <span class="json-property-range" title="Value limits"></span> | |
4246 | </dt> | |
4247 | <dt data-property-name="accountName"> | |
4248 | <span class="json-property-name">accountName:</span> | |
4249 | <span class="json-property-type">string</span> | |
4250 | <span class="json-property-range" title="Value limits"></span> | |
4251 | </dt> | |
4252 | <dt data-property-name="createdAt"> | |
4253 | <span class="json-property-name">createdAt:</span> | |
4254 | <span class="json-property-type">string</span> | |
4255 | <span class="json-property-range" title="Value limits"></span> | |
4256 | </dt> | |
4257 | <dt data-property-name="updatedAt"> | |
4258 | <span class="json-property-name">updatedAt:</span> | |
4259 | <span class="json-property-type">string</span> | |
4260 | <span class="json-property-range" title="Value limits"></span> | |
4261 | </dt> | |
4262 | <dt data-property-name="categoryLabel"> | |
4263 | <span class="json-property-name">categoryLabel:</span> | |
4264 | <span class="json-property-type">string</span> | |
4265 | <span class="json-property-range" title="Value limits"></span> | |
4266 | </dt> | |
4267 | <dt data-property-name="category"> | |
4268 | <span class="json-property-name">category:</span> | |
4269 | <span class="json-property-type">number</span> | |
4270 | <span class="json-property-range" title="Value limits"></span> | |
4271 | </dt> | |
4272 | <dt data-property-name="licenceLabel"> | |
4273 | <span class="json-property-name">licenceLabel:</span> | |
4274 | <span class="json-property-type">string</span> | |
4275 | <span class="json-property-range" title="Value limits"></span> | |
4276 | </dt> | |
4277 | <dt data-property-name="licence"> | |
4278 | <span class="json-property-name">licence:</span> | |
4279 | <span class="json-property-type">number</span> | |
4280 | <span class="json-property-range" title="Value limits"></span> | |
4281 | </dt> | |
4282 | <dt data-property-name="languageLabel"> | |
4283 | <span class="json-property-name">languageLabel:</span> | |
4284 | <span class="json-property-type">string</span> | |
4285 | <span class="json-property-range" title="Value limits"></span> | |
4286 | </dt> | |
4287 | <dt data-property-name="language"> | |
4288 | <span class="json-property-name">language:</span> | |
4289 | <span class="json-property-type">number</span> | |
4290 | <span class="json-property-range" title="Value limits"></span> | |
4291 | </dt> | |
4292 | <dt data-property-name="description"> | |
4293 | <span class="json-property-name">description:</span> | |
4294 | <span class="json-property-type">string</span> | |
4295 | <span class="json-property-range" title="Value limits"></span> | |
4296 | </dt> | |
4297 | <dt data-property-name="duration"> | |
4298 | <span class="json-property-name">duration:</span> | |
4299 | <span class="json-property-type">number</span> | |
4300 | <span class="json-property-range" title="Value limits"></span> | |
4301 | </dt> | |
4302 | <dt data-property-name="isLocal"> | |
4303 | <span class="json-property-name">isLocal:</span> | |
4304 | <span class="json-property-type">boolean</span> | |
4305 | <span class="json-property-range" title="Value limits"></span> | |
4306 | </dt> | |
4307 | <dt data-property-name="name"> | |
4308 | <span class="json-property-name">name:</span> | |
4309 | <span class="json-property-type">string</span> | |
4310 | <span class="json-property-range" title="Value limits"></span> | |
4311 | </dt> | |
4312 | <dt data-property-name="serverHost"> | |
4313 | <span class="json-property-name">serverHost:</span> | |
4314 | <span class="json-property-type">string</span> | |
4315 | <span class="json-property-range" title="Value limits"></span> | |
4316 | </dt> | |
4317 | <dt data-property-name="thumbnailPath"> | |
4318 | <span class="json-property-name">thumbnailPath:</span> | |
4319 | <span class="json-property-type">string</span> | |
4320 | <span class="json-property-range" title="Value limits"></span> | |
4321 | </dt> | |
4322 | <dt data-property-name="previewPath"> | |
4323 | <span class="json-property-name">previewPath:</span> | |
4324 | <span class="json-property-type">string</span> | |
4325 | <span class="json-property-range" title="Value limits"></span> | |
4326 | </dt> | |
4327 | <dt data-property-name="embedPath"> | |
4328 | <span class="json-property-name">embedPath:</span> | |
4329 | <span class="json-property-type">string</span> | |
4330 | <span class="json-property-range" title="Value limits"></span> | |
4331 | </dt> | |
4332 | <dt data-property-name="views"> | |
4333 | <span class="json-property-name">views:</span> | |
4334 | <span class="json-property-type">number</span> | |
4335 | <span class="json-property-range" title="Value limits"></span> | |
4336 | </dt> | |
4337 | <dt data-property-name="likes"> | |
4338 | <span class="json-property-name">likes:</span> | |
4339 | <span class="json-property-type">number</span> | |
4340 | <span class="json-property-range" title="Value limits"></span> | |
4341 | </dt> | |
4342 | <dt data-property-name="dislikes"> | |
4343 | <span class="json-property-name">dislikes:</span> | |
4344 | <span class="json-property-type">number</span> | |
4345 | <span class="json-property-range" title="Value limits"></span> | |
4346 | </dt> | |
4347 | <dt data-property-name="nsfw"> | |
4348 | <span class="json-property-name">nsfw:</span> | |
4349 | <span class="json-property-type">boolean</span> | |
4350 | <span class="json-property-range" title="Value limits"></span> | |
4351 | </dt> | |
4352 | </dl> | |
4353 | </section> | |
4354 | </div> | |
4355 | <div class="doc-examples"> | |
4356 | <section> | |
4357 | <h5>Example</h5> | |
4358 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4359 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4360 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4361 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
4362 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4363 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4364 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
4365 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
4366 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
4367 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
4368 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
4369 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
4370 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
4371 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
4372 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
4373 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4374 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
4375 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
4376 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
4377 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
4378 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
4379 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
4380 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
4381 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
4382 | } | |
4383 | </code></pre> | |
4384 | <!-- </div> --> | |
4385 | </section> | |
4386 | </div> | |
4387 | </div> | |
4388 | </div> | |
4389 | <div id="definition-VideoAbuse" class="definition panel" data-traverse-target="definition-VideoAbuse"> | |
4390 | <h2 class="panel-title"> | |
4391 | <a name="/definitions/VideoAbuse"></a>VideoAbuse: | |
4392 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
4393 | <span class="json-property-range" title="Value limits"></span> | |
4394 | ||
4395 | ||
4396 | </span> --> | |
4397 | </h2> | |
4398 | <div class="doc-row"> | |
4399 | <div class="doc-copy"> | |
4400 | <section class="json-schema-properties"> | |
4401 | <dl> | |
4402 | <dt data-property-name="id"> | |
4403 | <span class="json-property-name">id:</span> | |
4404 | <span class="json-property-type">number</span> | |
4405 | <span class="json-property-range" title="Value limits"></span> | |
4406 | </dt> | |
4407 | <dt data-property-name="reason"> | |
4408 | <span class="json-property-name">reason:</span> | |
4409 | <span class="json-property-type">string</span> | |
4410 | <span class="json-property-range" title="Value limits"></span> | |
4411 | </dt> | |
4412 | <dt data-property-name="reporterUsername"> | |
4413 | <span class="json-property-name">reporterUsername:</span> | |
4414 | <span class="json-property-type">string</span> | |
4415 | <span class="json-property-range" title="Value limits"></span> | |
4416 | </dt> | |
4417 | <dt data-property-name="reporterServerHost"> | |
4418 | <span class="json-property-name">reporterServerHost:</span> | |
4419 | <span class="json-property-type">string</span> | |
4420 | <span class="json-property-range" title="Value limits"></span> | |
4421 | </dt> | |
4422 | <dt data-property-name="videoId"> | |
4423 | <span class="json-property-name">videoId:</span> | |
4424 | <span class="json-property-type">number</span> | |
4425 | <span class="json-property-range" title="Value limits"></span> | |
4426 | </dt> | |
4427 | <dt data-property-name="videoUUID"> | |
4428 | <span class="json-property-name">videoUUID:</span> | |
4429 | <span class="json-property-type">string</span> | |
4430 | <span class="json-property-range" title="Value limits"></span> | |
4431 | </dt> | |
4432 | <dt data-property-name="videoName"> | |
4433 | <span class="json-property-name">videoName:</span> | |
4434 | <span class="json-property-type">string</span> | |
4435 | <span class="json-property-range" title="Value limits"></span> | |
4436 | </dt> | |
4437 | <dt data-property-name="createdAt"> | |
4438 | <span class="json-property-name">createdAt:</span> | |
4439 | <span class="json-property-type">string</span> | |
4440 | <span class="json-property-range" title="Value limits"></span> | |
4441 | </dt> | |
4442 | </dl> | |
4443 | </section> | |
4444 | </div> | |
4445 | <div class="doc-examples"> | |
4446 | <section> | |
4447 | <h5>Example</h5> | |
4448 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4449 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4450 | <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>, | |
4451 | <span class="hljs-attr">"reporterUsername"</span>: <span class="hljs-string">"string"</span>, | |
4452 | <span class="hljs-attr">"reporterServerHost"</span>: <span class="hljs-string">"string"</span>, | |
4453 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4454 | <span class="hljs-attr">"videoUUID"</span>: <span class="hljs-string">"string"</span>, | |
4455 | <span class="hljs-attr">"videoName"</span>: <span class="hljs-string">"string"</span>, | |
4456 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span> | |
4457 | } | |
4458 | </code></pre> | |
4459 | <!-- </div> --> | |
4460 | </section> | |
4461 | </div> | |
4462 | </div> | |
4463 | </div> | |
4464 | <div id="definition-VideoBlacklist" class="definition panel" data-traverse-target="definition-VideoBlacklist"> | |
4465 | <h2 class="panel-title"> | |
4466 | <a name="/definitions/VideoBlacklist"></a>VideoBlacklist: | |
4467 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
4468 | <span class="json-property-range" title="Value limits"></span> | |
4469 | ||
4470 | ||
4471 | </span> --> | |
4472 | </h2> | |
4473 | <div class="doc-row"> | |
4474 | <div class="doc-copy"> | |
4475 | <section class="json-schema-properties"> | |
4476 | <dl> | |
4477 | <dt data-property-name="id"> | |
4478 | <span class="json-property-name">id:</span> | |
4479 | <span class="json-property-type">number</span> | |
4480 | <span class="json-property-range" title="Value limits"></span> | |
4481 | </dt> | |
4482 | <dt data-property-name="videoId"> | |
4483 | <span class="json-property-name">videoId:</span> | |
4484 | <span class="json-property-type">number</span> | |
4485 | <span class="json-property-range" title="Value limits"></span> | |
4486 | </dt> | |
4487 | <dt data-property-name="createdAt"> | |
4488 | <span class="json-property-name">createdAt:</span> | |
4489 | <span class="json-property-type">string</span> | |
4490 | <span class="json-property-range" title="Value limits"></span> | |
4491 | </dt> | |
4492 | <dt data-property-name="updatedAt"> | |
4493 | <span class="json-property-name">updatedAt:</span> | |
4494 | <span class="json-property-type">string</span> | |
4495 | <span class="json-property-range" title="Value limits"></span> | |
4496 | </dt> | |
4497 | <dt data-property-name="name"> | |
4498 | <span class="json-property-name">name:</span> | |
4499 | <span class="json-property-type">string</span> | |
4500 | <span class="json-property-range" title="Value limits"></span> | |
4501 | </dt> | |
4502 | <dt data-property-name="uuid"> | |
4503 | <span class="json-property-name">uuid:</span> | |
4504 | <span class="json-property-type">string</span> | |
4505 | <span class="json-property-range" title="Value limits"></span> | |
4506 | </dt> | |
4507 | <dt data-property-name="description"> | |
4508 | <span class="json-property-name">description:</span> | |
4509 | <span class="json-property-type">string</span> | |
4510 | <span class="json-property-range" title="Value limits"></span> | |
4511 | </dt> | |
4512 | <dt data-property-name="duration"> | |
4513 | <span class="json-property-name">duration:</span> | |
4514 | <span class="json-property-type">number</span> | |
4515 | <span class="json-property-range" title="Value limits"></span> | |
4516 | </dt> | |
4517 | <dt data-property-name="views"> | |
4518 | <span class="json-property-name">views:</span> | |
4519 | <span class="json-property-type">number</span> | |
4520 | <span class="json-property-range" title="Value limits"></span> | |
4521 | </dt> | |
4522 | <dt data-property-name="likes"> | |
4523 | <span class="json-property-name">likes:</span> | |
4524 | <span class="json-property-type">number</span> | |
4525 | <span class="json-property-range" title="Value limits"></span> | |
4526 | </dt> | |
4527 | <dt data-property-name="dislikes"> | |
4528 | <span class="json-property-name">dislikes:</span> | |
4529 | <span class="json-property-type">number</span> | |
4530 | <span class="json-property-range" title="Value limits"></span> | |
4531 | </dt> | |
4532 | <dt data-property-name="nsfw"> | |
4533 | <span class="json-property-name">nsfw:</span> | |
4534 | <span class="json-property-type">boolean</span> | |
4535 | <span class="json-property-range" title="Value limits"></span> | |
4536 | </dt> | |
4537 | </dl> | |
4538 | </section> | |
4539 | </div> | |
4540 | <div class="doc-examples"> | |
4541 | <section> | |
4542 | <h5>Example</h5> | |
4543 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4544 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4545 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4546 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4547 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4548 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4549 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4550 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
4551 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
4552 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
4553 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
4554 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
4555 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
4556 | } | |
4557 | </code></pre> | |
4558 | <!-- </div> --> | |
4559 | </section> | |
4560 | </div> | |
4561 | </div> | |
4562 | </div> | |
4563 | <div id="definition-VideoChannel" class="definition panel" data-traverse-target="definition-VideoChannel"> | |
4564 | <h2 class="panel-title"> | |
4565 | <a name="/definitions/VideoChannel"></a>VideoChannel: | |
4566 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
4567 | <span class="json-property-range" title="Value limits"></span> | |
4568 | ||
4569 | ||
4570 | </span> --> | |
4571 | </h2> | |
4572 | <div class="doc-row"> | |
4573 | <div class="doc-copy"> | |
4574 | <section class="json-schema-properties"> | |
4575 | <dl> | |
4576 | <dt data-property-name="displayName"> | |
4577 | <span class="json-property-name">displayName:</span> | |
4578 | <span class="json-property-type">string</span> | |
4579 | <span class="json-property-range" title="Value limits"></span> | |
4580 | </dt> | |
4581 | <dt data-property-name="description"> | |
4582 | <span class="json-property-name">description:</span> | |
4583 | <span class="json-property-type">string</span> | |
4584 | <span class="json-property-range" title="Value limits"></span> | |
4585 | </dt> | |
4586 | <dt data-property-name="isLocal"> | |
4587 | <span class="json-property-name">isLocal:</span> | |
4588 | <span class="json-property-type">boolean</span> | |
4589 | <span class="json-property-range" title="Value limits"></span> | |
4590 | </dt> | |
4591 | <dt data-property-name="owner"> | |
4592 | <span class="json-property-name">owner:</span> | |
4593 | <span class="json-property-type">object</span> | |
4594 | <span class="json-property-range" title="Value limits"></span> | |
4595 | </dt> | |
4596 | <dt data-property-name="videos"> | |
4597 | <span class="json-property-name">videos:</span> | |
4598 | <span class="json-property-type"> | |
4599 | <span class="json-schema-ref-array"> | |
4600 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
4601 | </span> | |
4602 | </span> | |
4603 | <span class="json-property-range" title="Value limits"></span> | |
4604 | </dt> | |
4605 | </dl> | |
4606 | </section> | |
4607 | </div> | |
4608 | <div class="doc-examples"> | |
4609 | <section> | |
4610 | <h5>Example</h5> | |
4611 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4612 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4613 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
4614 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
4615 | <span class="hljs-attr">"owner"</span>: { | |
4616 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4617 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
4618 | }, | |
4619 | <span class="hljs-attr">"videos"</span>: [ | |
4620 | { | |
4621 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4622 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4623 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
4624 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4625 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4626 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
4627 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
4628 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
4629 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
4630 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
4631 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
4632 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
4633 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
4634 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
4635 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4636 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
4637 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
4638 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
4639 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
4640 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
4641 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
4642 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
4643 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
4644 | } | |
4645 | ] | |
4646 | } | |
4647 | </code></pre> | |
4648 | <!-- </div> --> | |
4649 | </section> | |
4650 | </div> | |
4651 | </div> | |
4652 | </div> | |
4653 | <div id="definition-VideoComment" class="definition panel" data-traverse-target="definition-VideoComment"> | |
4654 | <h2 class="panel-title"> | |
4655 | <a name="/definitions/VideoComment"></a>VideoComment: | |
4656 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
4657 | <span class="json-property-range" title="Value limits"></span> | |
4658 | ||
4659 | ||
4660 | </span> --> | |
4661 | </h2> | |
4662 | <div class="doc-row"> | |
4663 | <div class="doc-copy"> | |
4664 | <section class="json-schema-properties"> | |
4665 | <dl> | |
4666 | <dt data-property-name="id"> | |
4667 | <span class="json-property-name">id:</span> | |
4668 | <span class="json-property-type">number</span> | |
4669 | <span class="json-property-range" title="Value limits"></span> | |
4670 | </dt> | |
4671 | <dt data-property-name="url"> | |
4672 | <span class="json-property-name">url:</span> | |
4673 | <span class="json-property-type">string</span> | |
4674 | <span class="json-property-range" title="Value limits"></span> | |
4675 | </dt> | |
4676 | <dt data-property-name="text"> | |
4677 | <span class="json-property-name">text:</span> | |
4678 | <span class="json-property-type">string</span> | |
4679 | <span class="json-property-range" title="Value limits"></span> | |
4680 | </dt> | |
4681 | <dt data-property-name="threadId"> | |
4682 | <span class="json-property-name">threadId:</span> | |
4683 | <span class="json-property-type">number</span> | |
4684 | <span class="json-property-range" title="Value limits"></span> | |
4685 | </dt> | |
4686 | <dt data-property-name="inReplyToCommentId"> | |
4687 | <span class="json-property-name">inReplyToCommentId:</span> | |
4688 | <span class="json-property-type">number</span> | |
4689 | <span class="json-property-range" title="Value limits"></span> | |
4690 | </dt> | |
4691 | <dt data-property-name="videoId"> | |
4692 | <span class="json-property-name">videoId:</span> | |
4693 | <span class="json-property-type">number</span> | |
4694 | <span class="json-property-range" title="Value limits"></span> | |
4695 | </dt> | |
4696 | <dt data-property-name="createdAt"> | |
4697 | <span class="json-property-name">createdAt:</span> | |
4698 | <span class="json-property-type">string</span> | |
4699 | <span class="json-property-range" title="Value limits"></span> | |
4700 | </dt> | |
4701 | <dt data-property-name="updatedAt"> | |
4702 | <span class="json-property-name">updatedAt:</span> | |
4703 | <span class="json-property-type">string</span> | |
4704 | <span class="json-property-range" title="Value limits"></span> | |
4705 | </dt> | |
4706 | <dt data-property-name="totalReplies"> | |
4707 | <span class="json-property-name">totalReplies:</span> | |
4708 | <span class="json-property-type">number</span> | |
4709 | <span class="json-property-range" title="Value limits"></span> | |
4710 | </dt> | |
4711 | <dt data-property-name="account"> | |
4712 | <span class="json-property-name">account:</span> | |
4713 | <span class="json-property-type"> | |
4714 | <span class=""> | |
4715 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
4716 | </span> | |
4717 | </span> | |
4718 | <span class="json-property-range" title="Value limits"></span> | |
4719 | </dt> | |
4720 | </dl> | |
4721 | </section> | |
4722 | </div> | |
4723 | <div class="doc-examples"> | |
4724 | <section> | |
4725 | <h5>Example</h5> | |
4726 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4727 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4728 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4729 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
4730 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
4731 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
4732 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4733 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4734 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4735 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
4736 | <span class="hljs-attr">"account"</span>: { | |
4737 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4738 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4739 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4740 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4741 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4742 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
4743 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
4744 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
4745 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4746 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4747 | <span class="hljs-attr">"avatar"</span>: { | |
4748 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
4749 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4750 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
4751 | } | |
4752 | } | |
4753 | } | |
4754 | </code></pre> | |
4755 | <!-- </div> --> | |
4756 | </section> | |
4757 | </div> | |
4758 | </div> | |
4759 | </div> | |
4760 | <div id="definition-VideoCommentThreadTree" class="definition panel" data-traverse-target="definition-VideoCommentThreadTree"> | |
4761 | <h2 class="panel-title"> | |
4762 | <a name="/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree: | |
4763 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
4764 | <span class="json-property-range" title="Value limits"></span> | |
4765 | ||
4766 | ||
4767 | </span> --> | |
4768 | </h2> | |
4769 | <div class="doc-row"> | |
4770 | <div class="doc-copy"> | |
4771 | <section class="json-schema-properties"> | |
4772 | <dl> | |
4773 | <dt data-property-name="comment"> | |
4774 | <span class="json-property-name">comment:</span> | |
4775 | <span class="json-property-type"> | |
4776 | <span class=""> | |
4777 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
4778 | </span> | |
4779 | </span> | |
4780 | <span class="json-property-range" title="Value limits"></span> | |
4781 | </dt> | |
4782 | <dt data-property-name="children"> | |
4783 | <span class="json-property-name">children:</span> | |
4784 | <span class="json-property-type"> | |
4785 | <span class="json-schema-ref-array"> | |
4786 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
4787 | </span> | |
4788 | </span> | |
4789 | <span class="json-property-range" title="Value limits"></span> | |
4790 | </dt> | |
4791 | </dl> | |
4792 | </section> | |
4793 | </div> | |
4794 | <div class="doc-examples"> | |
4795 | <section> | |
4796 | <h5>Example</h5> | |
4797 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4798 | <span class="hljs-attr">"comment"</span>: { | |
4799 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4800 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4801 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
4802 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
4803 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
4804 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4805 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4806 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4807 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
4808 | <span class="hljs-attr">"account"</span>: { | |
4809 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4810 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4811 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4812 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4813 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4814 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
4815 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
4816 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
4817 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4818 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4819 | <span class="hljs-attr">"avatar"</span>: { | |
4820 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
4821 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4822 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
4823 | } | |
4824 | } | |
4825 | }, | |
4826 | <span class="hljs-attr">"children"</span>: [ | |
4827 | { | |
4828 | <span class="hljs-attr">"comment"</span>: { | |
4829 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4830 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4831 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
4832 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
4833 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
4834 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4835 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4836 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4837 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
4838 | <span class="hljs-attr">"account"</span>: { | |
4839 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4840 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4841 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4842 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4843 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4844 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
4845 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
4846 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
4847 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4848 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4849 | <span class="hljs-attr">"avatar"</span>: { | |
4850 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
4851 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4852 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
4853 | } | |
4854 | } | |
4855 | }, | |
4856 | <span class="hljs-attr">"children"</span>: [ | |
4857 | { | |
4858 | <span class="hljs-attr">"comment"</span>: { | |
4859 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4860 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4861 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
4862 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
4863 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
4864 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4865 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4866 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4867 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
4868 | <span class="hljs-attr">"account"</span>: { | |
4869 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4870 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4871 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4872 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4873 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4874 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
4875 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
4876 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
4877 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4878 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4879 | <span class="hljs-attr">"avatar"</span>: { | |
4880 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
4881 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4882 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
4883 | } | |
4884 | } | |
4885 | } | |
4886 | } | |
4887 | ] | |
4888 | } | |
4889 | ] | |
4890 | } | |
4891 | </code></pre> | |
4892 | <!-- </div> --> | |
4893 | </section> | |
4894 | </div> | |
4895 | </div> | |
4896 | </div> | |
4897 | <div id="definition-Avatar" class="definition panel" data-traverse-target="definition-Avatar"> | |
4898 | <h2 class="panel-title"> | |
4899 | <a name="/definitions/Avatar"></a>Avatar: | |
4900 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
4901 | <span class="json-property-range" title="Value limits"></span> | |
4902 | ||
4903 | ||
4904 | </span> --> | |
4905 | </h2> | |
4906 | <div class="doc-row"> | |
4907 | <div class="doc-copy"> | |
4908 | <section class="json-schema-properties"> | |
4909 | <dl> | |
4910 | <dt data-property-name="path"> | |
4911 | <span class="json-property-name">path:</span> | |
4912 | <span class="json-property-type">string</span> | |
4913 | <span class="json-property-range" title="Value limits"></span> | |
4914 | </dt> | |
4915 | <dt data-property-name="createdAt"> | |
4916 | <span class="json-property-name">createdAt:</span> | |
4917 | <span class="json-property-type">string</span> | |
4918 | <span class="json-property-range" title="Value limits"></span> | |
4919 | </dt> | |
4920 | <dt data-property-name="updatedAt"> | |
4921 | <span class="json-property-name">updatedAt:</span> | |
4922 | <span class="json-property-type">string</span> | |
4923 | <span class="json-property-range" title="Value limits"></span> | |
4924 | </dt> | |
4925 | </dl> | |
4926 | </section> | |
4927 | </div> | |
4928 | <div class="doc-examples"> | |
4929 | <section> | |
4930 | <h5>Example</h5> | |
4931 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4932 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
4933 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4934 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
4935 | } | |
4936 | </code></pre> | |
4937 | <!-- </div> --> | |
4938 | </section> | |
4939 | </div> | |
4940 | </div> | |
4941 | </div> | |
4942 | <div id="definition-Actor" class="definition panel" data-traverse-target="definition-Actor"> | |
4943 | <h2 class="panel-title"> | |
4944 | <a name="/definitions/Actor"></a>Actor: | |
4945 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
4946 | <span class="json-property-range" title="Value limits"></span> | |
4947 | ||
4948 | ||
4949 | </span> --> | |
4950 | </h2> | |
4951 | <div class="doc-row"> | |
4952 | <div class="doc-copy"> | |
4953 | <section class="json-schema-properties"> | |
4954 | <dl> | |
4955 | <dt data-property-name="id"> | |
4956 | <span class="json-property-name">id:</span> | |
4957 | <span class="json-property-type">number</span> | |
4958 | <span class="json-property-range" title="Value limits"></span> | |
4959 | </dt> | |
4960 | <dt data-property-name="uuid"> | |
4961 | <span class="json-property-name">uuid:</span> | |
4962 | <span class="json-property-type">string</span> | |
4963 | <span class="json-property-range" title="Value limits"></span> | |
4964 | </dt> | |
4965 | <dt data-property-name="url"> | |
4966 | <span class="json-property-name">url:</span> | |
4967 | <span class="json-property-type">string</span> | |
4968 | <span class="json-property-range" title="Value limits"></span> | |
4969 | </dt> | |
4970 | <dt data-property-name="name"> | |
4971 | <span class="json-property-name">name:</span> | |
4972 | <span class="json-property-type">string</span> | |
4973 | <span class="json-property-range" title="Value limits"></span> | |
4974 | </dt> | |
4975 | <dt data-property-name="host"> | |
4976 | <span class="json-property-name">host:</span> | |
4977 | <span class="json-property-type">string</span> | |
4978 | <span class="json-property-range" title="Value limits"></span> | |
4979 | </dt> | |
4980 | <dt data-property-name="followingCount"> | |
4981 | <span class="json-property-name">followingCount:</span> | |
4982 | <span class="json-property-type">number</span> | |
4983 | <span class="json-property-range" title="Value limits"></span> | |
4984 | </dt> | |
4985 | <dt data-property-name="followersCount"> | |
4986 | <span class="json-property-name">followersCount:</span> | |
4987 | <span class="json-property-type">number</span> | |
4988 | <span class="json-property-range" title="Value limits"></span> | |
4989 | </dt> | |
4990 | <dt data-property-name="createdAt"> | |
4991 | <span class="json-property-name">createdAt:</span> | |
4992 | <span class="json-property-type">string</span> | |
4993 | <span class="json-property-range" title="Value limits"></span> | |
4994 | </dt> | |
4995 | <dt data-property-name="updatedAt"> | |
4996 | <span class="json-property-name">updatedAt:</span> | |
4997 | <span class="json-property-type">string</span> | |
4998 | <span class="json-property-range" title="Value limits"></span> | |
4999 | </dt> | |
5000 | <dt data-property-name="avatar"> | |
5001 | <span class="json-property-name">avatar:</span> | |
5002 | <span class="json-property-type"> | |
5003 | <span class=""> | |
5004 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | |
5005 | </span> | |
5006 | </span> | |
5007 | <span class="json-property-range" title="Value limits"></span> | |
5008 | </dt> | |
5009 | </dl> | |
5010 | </section> | |
5011 | </div> | |
5012 | <div class="doc-examples"> | |
5013 | <section> | |
5014 | <h5>Example</h5> | |
5015 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5016 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5017 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5018 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5019 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5020 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5021 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5022 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5023 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5024 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5025 | <span class="hljs-attr">"avatar"</span>: { | |
5026 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5027 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5028 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5029 | } | |
5030 | } | |
5031 | </code></pre> | |
5032 | <!-- </div> --> | |
5033 | </section> | |
5034 | </div> | |
5035 | </div> | |
5036 | </div> | |
5037 | <div id="definition-Account" class="definition panel" data-traverse-target="definition-Account"> | |
5038 | <h2 class="panel-title"> | |
5039 | <a name="/definitions/Account"></a>Account: | |
5040 | <!-- <span class="json-property-type"><span class="json-property-type"></span> | |
5041 | <span class="json-property-range" title="Value limits"></span> | |
5042 | ||
5043 | ||
5044 | </span> --> | |
5045 | </h2> | |
5046 | <div class="doc-row"> | |
5047 | <div class="doc-copy"> | |
5048 | <section class="json-schema-allOf"> | |
5049 | <section class="json-schema-allOf-inherited"> | |
5050 | <ul> | |
5051 | <span class=""> | |
5052 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
5053 | </span> | |
5054 | </ul> | |
5055 | </section> | |
5056 | <section class="json-schema-allOf-additional"> | |
5057 | <section class="json-schema-properties"> | |
5058 | <dl> | |
5059 | <dt data-property-name="displayName"> | |
5060 | <span class="json-property-name">displayName:</span> | |
5061 | <span class="json-property-type">string</span> | |
5062 | <span class="json-property-range" title="Value limits"></span> | |
5063 | </dt> | |
5064 | </dl> | |
5065 | </section> | |
5066 | </section> | |
5067 | </section> | |
5068 | </div> | |
5069 | <div class="doc-examples"> | |
5070 | <section> | |
5071 | <h5>Example</h5> | |
5072 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5073 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5074 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5075 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5076 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5077 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5078 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5079 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5080 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5081 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5082 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5083 | <span class="hljs-attr">"avatar"</span>: { | |
5084 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5085 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5086 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5087 | } | |
5088 | } | |
5089 | </code></pre> | |
5090 | <!-- </div> --> | |
5091 | </section> | |
5092 | </div> | |
5093 | </div> | |
5094 | </div> | |
5095 | <div id="definition-User" class="definition panel" data-traverse-target="definition-User"> | |
5096 | <h2 class="panel-title"> | |
5097 | <a name="/definitions/User"></a>User: | |
5098 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5099 | <span class="json-property-range" title="Value limits"></span> | |
5100 | ||
5101 | ||
5102 | </span> --> | |
5103 | </h2> | |
5104 | <div class="doc-row"> | |
5105 | <div class="doc-copy"> | |
5106 | <section class="json-schema-properties"> | |
5107 | <dl> | |
5108 | <dt data-property-name="id"> | |
5109 | <span class="json-property-name">id:</span> | |
5110 | <span class="json-property-type">number</span> | |
5111 | <span class="json-property-range" title="Value limits"></span> | |
5112 | </dt> | |
5113 | <dt data-property-name="username"> | |
5114 | <span class="json-property-name">username:</span> | |
5115 | <span class="json-property-type">string</span> | |
5116 | <span class="json-property-range" title="Value limits"></span> | |
5117 | </dt> | |
5118 | <dt data-property-name="email"> | |
5119 | <span class="json-property-name">email:</span> | |
5120 | <span class="json-property-type">string</span> | |
5121 | <span class="json-property-range" title="Value limits"></span> | |
5122 | </dt> | |
5123 | <dt data-property-name="displayNSFW"> | |
5124 | <span class="json-property-name">displayNSFW:</span> | |
5125 | <span class="json-property-type">boolean</span> | |
5126 | <span class="json-property-range" title="Value limits"></span> | |
5127 | </dt> | |
5128 | <dt data-property-name="autoPlayVideo"> | |
5129 | <span class="json-property-name">autoPlayVideo:</span> | |
5130 | <span class="json-property-type">boolean</span> | |
5131 | <span class="json-property-range" title="Value limits"></span> | |
5132 | </dt> | |
5133 | <dt data-property-name="role"> | |
5134 | <span class="json-property-name">role:</span> | |
5135 | <span class="json-property-type">string</span> | |
5136 | <span class="json-property-enum" title="Possible values"> | |
5137 | <span class="json-property-enum-item">User</span>, | |
5138 | <span class="json-property-enum-item">Moderator</span>, | |
5139 | <span class="json-property-enum-item">Administrator</span> | |
5140 | </span> | |
5141 | <span class="json-property-range" title="Value limits"></span> | |
5142 | </dt> | |
5143 | <dt data-property-name="videoQuota"> | |
5144 | <span class="json-property-name">videoQuota:</span> | |
5145 | <span class="json-property-type">number</span> | |
5146 | <span class="json-property-range" title="Value limits"></span> | |
5147 | </dt> | |
5148 | <dt data-property-name="createdAt"> | |
5149 | <span class="json-property-name">createdAt:</span> | |
5150 | <span class="json-property-type">string</span> | |
5151 | <span class="json-property-range" title="Value limits"></span> | |
5152 | </dt> | |
5153 | <dt data-property-name="account"> | |
5154 | <span class="json-property-name">account:</span> | |
5155 | <span class="json-property-type"> | |
5156 | <span class=""> | |
5157 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
5158 | </span> | |
5159 | </span> | |
5160 | <span class="json-property-range" title="Value limits"></span> | |
5161 | </dt> | |
5162 | <dt data-property-name="videoChannels"> | |
5163 | <span class="json-property-name">videoChannels:</span> | |
5164 | <span class="json-property-type"> | |
5165 | <span class="json-schema-ref-array"> | |
5166 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
5167 | </span> | |
5168 | </span> | |
5169 | <span class="json-property-range" title="Value limits"></span> | |
5170 | </dt> | |
5171 | </dl> | |
5172 | </section> | |
5173 | </div> | |
5174 | <div class="doc-examples"> | |
5175 | <section> | |
5176 | <h5>Example</h5> | |
5177 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5178 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5179 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
5180 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
5181 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
5182 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
5183 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
5184 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
5185 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5186 | <span class="hljs-attr">"account"</span>: { | |
5187 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5188 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5189 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5190 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5191 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5192 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5193 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5194 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5195 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5196 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5197 | <span class="hljs-attr">"avatar"</span>: { | |
5198 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5199 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5200 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5201 | } | |
5202 | }, | |
5203 | <span class="hljs-attr">"videoChannels"</span>: [ | |
5204 | { | |
5205 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5206 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
5207 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
5208 | <span class="hljs-attr">"owner"</span>: { | |
5209 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5210 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
5211 | }, | |
5212 | <span class="hljs-attr">"videos"</span>: [ | |
5213 | { | |
5214 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5215 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5216 | <span class="hljs-attr">"accountName"</span>: <span class="hljs-string">"string"</span>, | |
5217 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5218 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5219 | <span class="hljs-attr">"categoryLabel"</span>: <span class="hljs-string">"string"</span>, | |
5220 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"number"</span>, | |
5221 | <span class="hljs-attr">"licenceLabel"</span>: <span class="hljs-string">"string"</span>, | |
5222 | <span class="hljs-attr">"licence"</span>: <span class="hljs-string">"number"</span>, | |
5223 | <span class="hljs-attr">"languageLabel"</span>: <span class="hljs-string">"string"</span>, | |
5224 | <span class="hljs-attr">"language"</span>: <span class="hljs-string">"number"</span>, | |
5225 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
5226 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
5227 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
5228 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5229 | <span class="hljs-attr">"serverHost"</span>: <span class="hljs-string">"string"</span>, | |
5230 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
5231 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
5232 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
5233 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
5234 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
5235 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
5236 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
5237 | } | |
5238 | ] | |
5239 | } | |
5240 | ] | |
5241 | } | |
5242 | </code></pre> | |
5243 | <!-- </div> --> | |
5244 | </section> | |
5245 | </div> | |
5246 | </div> | |
5247 | </div> | |
5248 | <div id="definition-ServerConfig" class="definition panel" data-traverse-target="definition-ServerConfig"> | |
5249 | <h2 class="panel-title"> | |
5250 | <a name="/definitions/ServerConfig"></a>ServerConfig: | |
5251 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5252 | <span class="json-property-range" title="Value limits"></span> | |
5253 | ||
5254 | ||
5255 | </span> --> | |
5256 | </h2> | |
5257 | <div class="doc-row"> | |
5258 | <div class="doc-copy"> | |
5259 | <section class="json-schema-properties"> | |
5260 | <dl> | |
5261 | <dt data-property-name="signup"> | |
5262 | <span class="json-property-name">signup:</span> | |
5263 | <span class="json-property-type">object</span> | |
5264 | <span class="json-property-range" title="Value limits"></span> | |
5265 | </dt> | |
5266 | <dt data-property-name="transcoding"> | |
5267 | <span class="json-property-name">transcoding:</span> | |
5268 | <span class="json-property-type">object</span> | |
5269 | <span class="json-property-range" title="Value limits"></span> | |
5270 | </dt> | |
5271 | <dt data-property-name="avatar"> | |
5272 | <span class="json-property-name">avatar:</span> | |
5273 | <span class="json-property-type">object</span> | |
5274 | <span class="json-property-range" title="Value limits"></span> | |
5275 | </dt> | |
5276 | <dt data-property-name="video"> | |
5277 | <span class="json-property-name">video:</span> | |
5278 | <span class="json-property-type">object</span> | |
5279 | <span class="json-property-range" title="Value limits"></span> | |
5280 | </dt> | |
5281 | </dl> | |
5282 | </section> | |
5283 | </div> | |
5284 | <div class="doc-examples"> | |
5285 | <section> | |
5286 | <h5>Example</h5> | |
5287 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5288 | <span class="hljs-attr">"signup"</span>: { | |
5289 | <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span> | |
5290 | }, | |
5291 | <span class="hljs-attr">"transcoding"</span>: { | |
5292 | <span class="hljs-attr">"enabledResolutions"</span>: [ | |
5293 | <span class="hljs-string">"number"</span> | |
5294 | ] | |
5295 | }, | |
5296 | <span class="hljs-attr">"avatar"</span>: { | |
5297 | <span class="hljs-attr">"file"</span>: { | |
5298 | <span class="hljs-attr">"size"</span>: { | |
5299 | <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span> | |
5300 | } | |
5301 | }, | |
5302 | <span class="hljs-attr">"extensions"</span>: [ | |
5303 | <span class="hljs-string">"string"</span> | |
5304 | ] | |
5305 | }, | |
5306 | <span class="hljs-attr">"video"</span>: { | |
5307 | <span class="hljs-attr">"file"</span>: { | |
5308 | <span class="hljs-attr">"extensions"</span>: [ | |
5309 | <span class="hljs-string">"string"</span> | |
5310 | ] | |
5311 | } | |
5312 | } | |
5313 | } | |
5314 | </code></pre> | |
5315 | <!-- </div> --> | |
5316 | </section> | |
5317 | </div> | |
5318 | </div> | |
5319 | </div> | |
5320 | <div id="definition-Follow" class="definition panel" data-traverse-target="definition-Follow"> | |
5321 | <h2 class="panel-title"> | |
5322 | <a name="/definitions/Follow"></a>Follow: | |
5323 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5324 | <span class="json-property-range" title="Value limits"></span> | |
5325 | ||
5326 | ||
5327 | </span> --> | |
5328 | </h2> | |
5329 | <div class="doc-row"> | |
5330 | <div class="doc-copy"> | |
5331 | <section class="json-schema-properties"> | |
5332 | <dl> | |
5333 | <dt data-property-name="id"> | |
5334 | <span class="json-property-name">id:</span> | |
5335 | <span class="json-property-type">number</span> | |
5336 | <span class="json-property-range" title="Value limits"></span> | |
5337 | </dt> | |
5338 | <dt data-property-name="follower"> | |
5339 | <span class="json-property-name">follower:</span> | |
5340 | <span class="json-property-type"> | |
5341 | <span class=""> | |
5342 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
5343 | </span> | |
5344 | </span> | |
5345 | <span class="json-property-range" title="Value limits"></span> | |
5346 | </dt> | |
5347 | <dt data-property-name="following"> | |
5348 | <span class="json-property-name">following:</span> | |
5349 | <span class="json-property-type"> | |
5350 | <span class=""> | |
5351 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
5352 | </span> | |
5353 | </span> | |
5354 | <span class="json-property-range" title="Value limits"></span> | |
5355 | </dt> | |
5356 | <dt data-property-name="score"> | |
5357 | <span class="json-property-name">score:</span> | |
5358 | <span class="json-property-type">number</span> | |
5359 | <span class="json-property-range" title="Value limits"></span> | |
5360 | </dt> | |
5361 | <dt data-property-name="state"> | |
5362 | <span class="json-property-name">state:</span> | |
5363 | <span class="json-property-type">string</span> | |
5364 | <span class="json-property-enum" title="Possible values"> | |
5365 | <span class="json-property-enum-item">pending</span>, | |
5366 | <span class="json-property-enum-item">accepted</span> | |
5367 | </span> | |
5368 | <span class="json-property-range" title="Value limits"></span> | |
5369 | </dt> | |
5370 | <dt data-property-name="createdAt"> | |
5371 | <span class="json-property-name">createdAt:</span> | |
5372 | <span class="json-property-type">string</span> | |
5373 | <span class="json-property-range" title="Value limits"></span> | |
5374 | </dt> | |
5375 | <dt data-property-name="updatedAt"> | |
5376 | <span class="json-property-name">updatedAt:</span> | |
5377 | <span class="json-property-type">string</span> | |
5378 | <span class="json-property-range" title="Value limits"></span> | |
5379 | </dt> | |
5380 | </dl> | |
5381 | </section> | |
5382 | </div> | |
5383 | <div class="doc-examples"> | |
5384 | <section> | |
5385 | <h5>Example</h5> | |
5386 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5387 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5388 | <span class="hljs-attr">"follower"</span>: { | |
5389 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5390 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5391 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5392 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5393 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5394 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5395 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5396 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5397 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5398 | <span class="hljs-attr">"avatar"</span>: { | |
5399 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5400 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5401 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5402 | } | |
5403 | }, | |
5404 | <span class="hljs-attr">"following"</span>: { | |
5405 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5406 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5407 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5408 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5409 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5410 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5411 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5412 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5413 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5414 | <span class="hljs-attr">"avatar"</span>: { | |
5415 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5416 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5417 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5418 | } | |
5419 | }, | |
5420 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
5421 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
5422 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5423 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5424 | } | |
5425 | </code></pre> | |
5426 | <!-- </div> --> | |
5427 | </section> | |
5428 | </div> | |
5429 | </div> | |
5430 | </div> | |
5431 | <div id="definition-Job" class="definition panel" data-traverse-target="definition-Job"> | |
5432 | <h2 class="panel-title"> | |
5433 | <a name="/definitions/Job"></a>Job: | |
5434 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5435 | <span class="json-property-range" title="Value limits"></span> | |
5436 | ||
5437 | ||
5438 | </span> --> | |
5439 | </h2> | |
5440 | <div class="doc-row"> | |
5441 | <div class="doc-copy"> | |
5442 | <section class="json-schema-properties"> | |
5443 | <dl> | |
5444 | <dt data-property-name="id"> | |
5445 | <span class="json-property-name">id:</span> | |
5446 | <span class="json-property-type">number</span> | |
5447 | <span class="json-property-range" title="Value limits"></span> | |
5448 | </dt> | |
5449 | <dt data-property-name="state"> | |
5450 | <span class="json-property-name">state:</span> | |
5451 | <span class="json-property-type">string</span> | |
5452 | <span class="json-property-enum" title="Possible values"> | |
5453 | <span class="json-property-enum-item">pending</span>, | |
5454 | <span class="json-property-enum-item">processing</span>, | |
5455 | <span class="json-property-enum-item">error</span>, | |
5456 | <span class="json-property-enum-item">success</span> | |
5457 | </span> | |
5458 | <span class="json-property-range" title="Value limits"></span> | |
5459 | </dt> | |
5460 | <dt data-property-name="category"> | |
5461 | <span class="json-property-name">category:</span> | |
5462 | <span class="json-property-type">string</span> | |
5463 | <span class="json-property-enum" title="Possible values"> | |
5464 | <span class="json-property-enum-item">transcoding</span>, | |
5465 | <span class="json-property-enum-item">activitypub-http</span> | |
5466 | </span> | |
5467 | <span class="json-property-range" title="Value limits"></span> | |
5468 | </dt> | |
5469 | <dt data-property-name="handlerName"> | |
5470 | <span class="json-property-name">handlerName:</span> | |
5471 | <span class="json-property-type">string</span> | |
5472 | <span class="json-property-range" title="Value limits"></span> | |
5473 | </dt> | |
5474 | <dt data-property-name="handlerInputData"> | |
5475 | <span class="json-property-name">handlerInputData:</span> | |
5476 | <span class="json-property-type">string</span> | |
5477 | <span class="json-property-range" title="Value limits"></span> | |
5478 | </dt> | |
5479 | <dt data-property-name="createdAt"> | |
5480 | <span class="json-property-name">createdAt:</span> | |
5481 | <span class="json-property-type">string</span> | |
5482 | <span class="json-property-range" title="Value limits"></span> | |
5483 | </dt> | |
5484 | <dt data-property-name="updatedAt"> | |
5485 | <span class="json-property-name">updatedAt:</span> | |
5486 | <span class="json-property-type">string</span> | |
5487 | <span class="json-property-range" title="Value limits"></span> | |
5488 | </dt> | |
5489 | </dl> | |
5490 | </section> | |
5491 | </div> | |
5492 | <div class="doc-examples"> | |
5493 | <section> | |
5494 | <h5>Example</h5> | |
5495 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5496 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5497 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
5498 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>, | |
5499 | <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>, | |
5500 | <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>, | |
5501 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5502 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5503 | } | |
5504 | </code></pre> | |
5505 | <!-- </div> --> | |
5506 | </section> | |
5507 | </div> | |
5508 | </div> | |
5509 | </div> | |
5510 | <div id="definition-AddUserResponse" class="definition panel" data-traverse-target="definition-AddUserResponse"> | |
5511 | <h2 class="panel-title"> | |
5512 | <a name="/definitions/AddUserResponse"></a>AddUserResponse: | |
5513 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5514 | <span class="json-property-range" title="Value limits"></span> | |
5515 | ||
5516 | ||
5517 | </span> --> | |
5518 | </h2> | |
5519 | <div class="doc-row"> | |
5520 | <div class="doc-copy"> | |
5521 | <section class="json-schema-properties"> | |
5522 | <dl> | |
5523 | <dt data-property-name="id"> | |
5524 | <span class="json-property-name">id:</span> | |
5525 | <span class="json-property-type">number</span> | |
5526 | <span class="json-property-range" title="Value limits"></span> | |
5527 | </dt> | |
5528 | <dt data-property-name="uuid"> | |
5529 | <span class="json-property-name">uuid:</span> | |
5530 | <span class="json-property-type">string</span> | |
5531 | <span class="json-property-range" title="Value limits"></span> | |
5532 | </dt> | |
5533 | </dl> | |
5534 | </section> | |
5535 | </div> | |
5536 | <div class="doc-examples"> | |
5537 | <section> | |
5538 | <h5>Example</h5> | |
5539 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5540 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5541 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
5542 | } | |
5543 | </code></pre> | |
5544 | <!-- </div> --> | |
5545 | </section> | |
5546 | </div> | |
5547 | </div> | |
5548 | </div> | |
5549 | <div id="definition-VideoUploadResponse" class="definition panel" data-traverse-target="definition-VideoUploadResponse"> | |
5550 | <h2 class="panel-title"> | |
5551 | <a name="/definitions/VideoUploadResponse"></a>VideoUploadResponse: | |
5552 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5553 | <span class="json-property-range" title="Value limits"></span> | |
5554 | ||
5555 | ||
5556 | </span> --> | |
5557 | </h2> | |
5558 | <div class="doc-row"> | |
5559 | <div class="doc-copy"> | |
5560 | <section class="json-schema-properties"> | |
5561 | <dl> | |
5562 | <dt data-property-name="id"> | |
5563 | <span class="json-property-name">id:</span> | |
5564 | <span class="json-property-type">number</span> | |
5565 | <span class="json-property-range" title="Value limits"></span> | |
5566 | </dt> | |
5567 | <dt data-property-name="uuid"> | |
5568 | <span class="json-property-name">uuid:</span> | |
5569 | <span class="json-property-type">string</span> | |
5570 | <span class="json-property-range" title="Value limits"></span> | |
5571 | </dt> | |
5572 | </dl> | |
5573 | </section> | |
5574 | </div> | |
5575 | <div class="doc-examples"> | |
5576 | <section> | |
5577 | <h5>Example</h5> | |
5578 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5579 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5580 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
5581 | } | |
5582 | </code></pre> | |
5583 | <!-- </div> --> | |
5584 | </section> | |
5585 | </div> | |
5586 | </div> | |
5587 | </div> | |
5588 | <div id="definition-AddUser" class="definition panel" data-traverse-target="definition-AddUser"> | |
5589 | <h2 class="panel-title"> | |
5590 | <a name="/definitions/AddUser"></a>AddUser: | |
5591 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5592 | <span class="json-property-range" title="Value limits"></span> | |
5593 | ||
5594 | ||
5595 | </span> --> | |
5596 | </h2> | |
5597 | <div class="doc-row"> | |
5598 | <div class="doc-copy"> | |
5599 | <section class="json-schema-properties"> | |
5600 | <dl> | |
5601 | <dt data-property-name="username" class="has-description"> | |
5602 | <span class="json-property-name">username:</span> | |
5603 | <span class="json-property-type">string</span> | |
5604 | <span class="json-property-range" title="Value limits"></span> | |
5605 | <span class="json-property-required"></span> | |
5606 | </dt> | |
5607 | <dd> | |
5608 | <p>The user username </p> | |
5609 | </dd> | |
5610 | <dt data-property-name="password" class="has-description"> | |
5611 | <span class="json-property-name">password:</span> | |
5612 | <span class="json-property-type">string</span> | |
5613 | <span class="json-property-range" title="Value limits"></span> | |
5614 | <span class="json-property-required"></span> | |
5615 | </dt> | |
5616 | <dd> | |
5617 | <p>The user password </p> | |
5618 | </dd> | |
5619 | <dt data-property-name="email" class="has-description"> | |
5620 | <span class="json-property-name">email:</span> | |
5621 | <span class="json-property-type">string</span> | |
5622 | <span class="json-property-range" title="Value limits"></span> | |
5623 | <span class="json-property-required"></span> | |
5624 | </dt> | |
5625 | <dd> | |
5626 | <p>The user email </p> | |
5627 | </dd> | |
5628 | <dt data-property-name="videoQuota" class="has-description"> | |
5629 | <span class="json-property-name">videoQuota:</span> | |
5630 | <span class="json-property-type">string</span> | |
5631 | <span class="json-property-range" title="Value limits"></span> | |
5632 | <span class="json-property-required"></span> | |
5633 | </dt> | |
5634 | <dd> | |
5635 | <p>The user videoQuota </p> | |
5636 | </dd> | |
5637 | <dt data-property-name="role" class="has-description"> | |
5638 | <span class="json-property-name">role:</span> | |
5639 | <span class="json-property-type">string</span> | |
5640 | <span class="json-property-range" title="Value limits"></span> | |
5641 | <span class="json-property-required"></span> | |
5642 | </dt> | |
5643 | <dd> | |
5644 | <p>The user role </p> | |
5645 | </dd> | |
5646 | </dl> | |
5647 | </section> | |
5648 | </div> | |
5649 | <div class="doc-examples"> | |
5650 | <section> | |
5651 | <h5>Example</h5> | |
5652 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5653 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
5654 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
5655 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
5656 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
5657 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
5658 | } | |
5659 | </code></pre> | |
5660 | <!-- </div> --> | |
5661 | </section> | |
5662 | </div> | |
5663 | </div> | |
5664 | </div> | |
5665 | <div id="definition-UpdateUser" class="definition panel" data-traverse-target="definition-UpdateUser"> | |
5666 | <h2 class="panel-title"> | |
5667 | <a name="/definitions/UpdateUser"></a>UpdateUser: | |
5668 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5669 | <span class="json-property-range" title="Value limits"></span> | |
5670 | ||
5671 | ||
5672 | </span> --> | |
5673 | </h2> | |
5674 | <div class="doc-row"> | |
5675 | <div class="doc-copy"> | |
5676 | <section class="json-schema-properties"> | |
5677 | <dl> | |
5678 | <dt data-property-name="id" class="has-description"> | |
5679 | <span class="json-property-name">id:</span> | |
5680 | <span class="json-property-type">string</span> | |
5681 | <span class="json-property-range" title="Value limits"></span> | |
5682 | <span class="json-property-required"></span> | |
5683 | </dt> | |
5684 | <dd> | |
5685 | <p>The user id </p> | |
5686 | </dd> | |
5687 | <dt data-property-name="email" class="has-description"> | |
5688 | <span class="json-property-name">email:</span> | |
5689 | <span class="json-property-type">string</span> | |
5690 | <span class="json-property-range" title="Value limits"></span> | |
5691 | <span class="json-property-required"></span> | |
5692 | </dt> | |
5693 | <dd> | |
5694 | <p>The updated email of the user </p> | |
5695 | </dd> | |
5696 | <dt data-property-name="videoQuota" class="has-description"> | |
5697 | <span class="json-property-name">videoQuota:</span> | |
5698 | <span class="json-property-type">string</span> | |
5699 | <span class="json-property-range" title="Value limits"></span> | |
5700 | <span class="json-property-required"></span> | |
5701 | </dt> | |
5702 | <dd> | |
5703 | <p>The updated videoQuota of the user </p> | |
5704 | </dd> | |
5705 | <dt data-property-name="role" class="has-description"> | |
5706 | <span class="json-property-name">role:</span> | |
5707 | <span class="json-property-type">string</span> | |
5708 | <span class="json-property-range" title="Value limits"></span> | |
5709 | <span class="json-property-required"></span> | |
5710 | </dt> | |
5711 | <dd> | |
5712 | <p>The updated role of the user </p> | |
5713 | </dd> | |
5714 | </dl> | |
5715 | </section> | |
5716 | </div> | |
5717 | <div class="doc-examples"> | |
5718 | <section> | |
5719 | <h5>Example</h5> | |
5720 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5721 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
5722 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
5723 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
5724 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
5725 | } | |
5726 | </code></pre> | |
5727 | <!-- </div> --> | |
5728 | </section> | |
5729 | </div> | |
5730 | </div> | |
5731 | </div> | |
5732 | <div id="definition-UpdateMe" class="definition panel" data-traverse-target="definition-UpdateMe"> | |
5733 | <h2 class="panel-title"> | |
5734 | <a name="/definitions/UpdateMe"></a>UpdateMe: | |
5735 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5736 | <span class="json-property-range" title="Value limits"></span> | |
5737 | ||
5738 | ||
5739 | </span> --> | |
5740 | </h2> | |
5741 | <div class="doc-row"> | |
5742 | <div class="doc-copy"> | |
5743 | <section class="json-schema-properties"> | |
5744 | <dl> | |
5745 | <dt data-property-name="password" class="has-description"> | |
5746 | <span class="json-property-name">password:</span> | |
5747 | <span class="json-property-type">string</span> | |
5748 | <span class="json-property-range" title="Value limits"></span> | |
5749 | <span class="json-property-required"></span> | |
5750 | </dt> | |
5751 | <dd> | |
5752 | <p>Your new password </p> | |
5753 | </dd> | |
5754 | <dt data-property-name="email" class="has-description"> | |
5755 | <span class="json-property-name">email:</span> | |
5756 | <span class="json-property-type">string</span> | |
5757 | <span class="json-property-range" title="Value limits"></span> | |
5758 | <span class="json-property-required"></span> | |
5759 | </dt> | |
5760 | <dd> | |
5761 | <p>Your new email </p> | |
5762 | </dd> | |
5763 | <dt data-property-name="displayNSFW" class="has-description"> | |
5764 | <span class="json-property-name">displayNSFW:</span> | |
5765 | <span class="json-property-type">string</span> | |
5766 | <span class="json-property-range" title="Value limits"></span> | |
5767 | <span class="json-property-required"></span> | |
5768 | </dt> | |
5769 | <dd> | |
5770 | <p>Your new displayNSFW </p> | |
5771 | </dd> | |
5772 | <dt data-property-name="autoPlayVideo" class="has-description"> | |
5773 | <span class="json-property-name">autoPlayVideo:</span> | |
5774 | <span class="json-property-type">string</span> | |
5775 | <span class="json-property-range" title="Value limits"></span> | |
5776 | <span class="json-property-required"></span> | |
5777 | </dt> | |
5778 | <dd> | |
5779 | <p>Your new autoPlayVideo </p> | |
5780 | </dd> | |
5781 | </dl> | |
5782 | </section> | |
5783 | </div> | |
5784 | <div class="doc-examples"> | |
5785 | <section> | |
5786 | <h5>Example</h5> | |
5787 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5788 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
5789 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
5790 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>, | |
5791 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span> | |
5792 | } | |
5793 | </code></pre> | |
5794 | <!-- </div> --> | |
5795 | </section> | |
5796 | </div> | |
5797 | </div> | |
5798 | </div> | |
5799 | <div id="definition-GetMeVideoRating" class="definition panel" data-traverse-target="definition-GetMeVideoRating"> | |
5800 | <h2 class="panel-title"> | |
5801 | <a name="/definitions/GetMeVideoRating"></a>GetMeVideoRating: | |
5802 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5803 | <span class="json-property-range" title="Value limits"></span> | |
5804 | ||
5805 | ||
5806 | </span> --> | |
5807 | </h2> | |
5808 | <div class="doc-row"> | |
5809 | <div class="doc-copy"> | |
5810 | <section class="json-schema-properties"> | |
5811 | <dl> | |
5812 | <dt data-property-name="id" class="has-description"> | |
5813 | <span class="json-property-name">id:</span> | |
5814 | <span class="json-property-type">string</span> | |
5815 | <span class="json-property-range" title="Value limits"></span> | |
5816 | <span class="json-property-required"></span> | |
5817 | </dt> | |
5818 | <dd> | |
5819 | <p>Id of the video </p> | |
5820 | </dd> | |
5821 | <dt data-property-name="rating" class="has-description"> | |
5822 | <span class="json-property-name">rating:</span> | |
5823 | <span class="json-property-type">number</span> | |
5824 | <span class="json-property-range" title="Value limits"></span> | |
5825 | <span class="json-property-required"></span> | |
5826 | </dt> | |
5827 | <dd> | |
5828 | <p>Rating of the video </p> | |
5829 | </dd> | |
5830 | </dl> | |
5831 | </section> | |
5832 | </div> | |
5833 | <div class="doc-examples"> | |
5834 | <section> | |
5835 | <h5>Example</h5> | |
5836 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5837 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
5838 | <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span> | |
5839 | } | |
5840 | </code></pre> | |
5841 | <!-- </div> --> | |
5842 | </section> | |
5843 | </div> | |
5844 | </div> | |
5845 | </div> | |
5846 | <div id="definition-RegisterUser" class="definition panel" data-traverse-target="definition-RegisterUser"> | |
5847 | <h2 class="panel-title"> | |
5848 | <a name="/definitions/RegisterUser"></a>RegisterUser: | |
5849 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5850 | <span class="json-property-range" title="Value limits"></span> | |
5851 | ||
5852 | ||
5853 | </span> --> | |
5854 | </h2> | |
5855 | <div class="doc-row"> | |
5856 | <div class="doc-copy"> | |
5857 | <section class="json-schema-properties"> | |
5858 | <dl> | |
5859 | <dt data-property-name="username" class="has-description"> | |
5860 | <span class="json-property-name">username:</span> | |
5861 | <span class="json-property-type">string</span> | |
5862 | <span class="json-property-range" title="Value limits"></span> | |
5863 | <span class="json-property-required"></span> | |
5864 | </dt> | |
5865 | <dd> | |
5866 | <p>The username of the user </p> | |
5867 | </dd> | |
5868 | <dt data-property-name="password" class="has-description"> | |
5869 | <span class="json-property-name">password:</span> | |
5870 | <span class="json-property-type">string</span> | |
5871 | <span class="json-property-range" title="Value limits"></span> | |
5872 | <span class="json-property-required"></span> | |
5873 | </dt> | |
5874 | <dd> | |
5875 | <p>The password of the user </p> | |
5876 | </dd> | |
5877 | <dt data-property-name="email" class="has-description"> | |
5878 | <span class="json-property-name">email:</span> | |
5879 | <span class="json-property-type">string</span> | |
5880 | <span class="json-property-range" title="Value limits"></span> | |
5881 | <span class="json-property-required"></span> | |
5882 | </dt> | |
5883 | <dd> | |
5884 | <p>The email of the user </p> | |
5885 | </dd> | |
5886 | </dl> | |
5887 | </section> | |
5888 | </div> | |
5889 | <div class="doc-examples"> | |
5890 | <section> | |
5891 | <h5>Example</h5> | |
5892 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5893 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
5894 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
5895 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span> | |
5896 | } | |
5897 | </code></pre> | |
5898 | <!-- </div> --> | |
5899 | </section> | |
5900 | </div> | |
5901 | </div> | |
5902 | </div> | |
5903 | <div id="definition-VideoChannelInput" class="definition panel" data-traverse-target="definition-VideoChannelInput"> | |
5904 | <h2 class="panel-title"> | |
5905 | <a name="/definitions/VideoChannelInput"></a>VideoChannelInput: | |
5906 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
5907 | <span class="json-property-range" title="Value limits"></span> | |
5908 | ||
5909 | ||
5910 | </span> --> | |
5911 | </h2> | |
5912 | <div class="doc-row"> | |
5913 | <div class="doc-copy"> | |
5914 | <section class="json-schema-properties"> | |
5915 | <dl> | |
5916 | <dt data-property-name="name"> | |
5917 | <span class="json-property-name">name:</span> | |
5918 | <span class="json-property-type">string</span> | |
5919 | <span class="json-property-range" title="Value limits"></span> | |
5920 | </dt> | |
5921 | <dt data-property-name="description"> | |
5922 | <span class="json-property-name">description:</span> | |
5923 | <span class="json-property-type">string</span> | |
5924 | <span class="json-property-range" title="Value limits"></span> | |
5925 | </dt> | |
5926 | </dl> | |
5927 | </section> | |
5928 | </div> | |
5929 | <div class="doc-examples"> | |
5930 | <section> | |
5931 | <h5>Example</h5> | |
5932 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5933 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5934 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
5935 | } | |
5936 | </code></pre> | |
5937 | <!-- </div> --> | |
5938 | </section> | |
5939 | </div> | |
5940 | </div> | |
5941 | </div> | |
5942 | <div class="doc-row no-margin"> | |
5943 | <div class="doc-copy doc-separator"> | |
5944 | <a class="powered-by" href="https://sourcey.com/spectacle">Documentation by | |
5945 | <span>Spectacle</span> | |
5946 | </a> | |
5947 | </div> | |
5948 | </div> | |
5949 | </article> | |
5950 | </div> | |
5951 | </div> | |
5952 | </body> | |
5953 | </html> |