]>
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"> | |
228e84aa | 20 | <h5>Topics</h5> |
5e1c08eb | 21 | <a href="#introduction">Introduction</a> |
94ff4c23 | 22 | <a href="#authentication">Authentication</a> |
5e1c08eb C |
23 | <h5>Operations</h5> |
24 | <section> | |
25 | <a href="#tag-Accounts">Accounts</a> | |
26 | <ul> | |
27 | <li> | |
ad9e39fb | 28 | <a href="#operation--accounts--name--get"> GET /accounts/{name} </a> |
5e1c08eb | 29 | </li> |
cc918ac3 | 30 | <li> |
ad9e39fb | 31 | <a href="#operation--accounts--name--videos-get"> GET /accounts/{name}/videos </a> |
cc918ac3 | 32 | </li> |
5e1c08eb C |
33 | <li> |
34 | <a href="#operation--accounts-get"> GET /accounts </a> | |
35 | </li> | |
36 | </ul> | |
37 | </section> | |
38 | <section> | |
39 | <a href="#tag-Config">Config</a> | |
40 | <ul> | |
41 | <li> | |
42 | <a href="#operation--config-get"> GET /config </a> | |
43 | </li> | |
44 | </ul> | |
45 | </section> | |
48dce1c9 C |
46 | <section> |
47 | <a href="#tag-Feeds">Feeds</a> | |
48 | <ul> | |
49 | <li> | |
50 | <a href="#operation--feeds-videos.-format--get"> GET /feeds/videos.{format} </a> | |
51 | </li> | |
52 | </ul> | |
53 | </section> | |
5e1c08eb C |
54 | <section> |
55 | <a href="#tag-Job">Job</a> | |
56 | <ul> | |
57 | <li> | |
58 | <a href="#operation--jobs-get"> GET /jobs </a> | |
59 | </li> | |
60 | </ul> | |
61 | </section> | |
62 | <section> | |
63 | <a href="#tag-ServerFollowing">ServerFollowing</a> | |
64 | <ul> | |
65 | <li> | |
66 | <a href="#operation--server-following--host--delete"> DELETE /server/following/{host} </a> | |
67 | </li> | |
68 | <li> | |
69 | <a href="#operation--server-followers-get"> GET /server/followers </a> | |
70 | </li> | |
71 | <li> | |
72 | <a href="#operation--server-following-get"> GET /server/following </a> | |
73 | </li> | |
74 | <li> | |
75 | <a href="#operation--server-following-post"> POST /server/following </a> | |
76 | </li> | |
77 | </ul> | |
78 | </section> | |
79 | <section> | |
80 | <a href="#tag-User">User</a> | |
81 | <ul> | |
82 | <li> | |
83 | <a href="#operation--users-post"> POST /users </a> | |
84 | </li> | |
85 | <li> | |
86 | <a href="#operation--users-get"> GET /users </a> | |
87 | </li> | |
88 | <li> | |
89 | <a href="#operation--users--id--delete"> DELETE /users/{id} </a> | |
90 | </li> | |
91 | <li> | |
92 | <a href="#operation--users--id--get"> GET /users/{id} </a> | |
93 | </li> | |
94 | <li> | |
95 | <a href="#operation--users--id--put"> PUT /users/{id} </a> | |
96 | </li> | |
97 | <li> | |
98 | <a href="#operation--users-me-get"> GET /users/me </a> | |
99 | </li> | |
100 | <li> | |
101 | <a href="#operation--users-me-put"> PUT /users/me </a> | |
102 | </li> | |
103 | <li> | |
104 | <a href="#operation--users-me-video-quota-used-get"> GET /users/me/video-quota-used </a> | |
105 | </li> | |
106 | <li> | |
107 | <a href="#operation--users-me-videos--videoId--rating-get"> GET /users/me/videos/{videoId}/rating </a> | |
108 | </li> | |
109 | <li> | |
110 | <a href="#operation--users-me-videos-get"> GET /users/me/videos </a> | |
111 | </li> | |
112 | <li> | |
113 | <a href="#operation--users-register-post"> POST /users/register </a> | |
114 | </li> | |
115 | <li> | |
116 | <a href="#operation--users-me-avatar-pick-post"> POST /users/me/avatar/pick </a> | |
117 | </li> | |
118 | </ul> | |
119 | </section> | |
120 | <section> | |
121 | <a href="#tag-Video">Video</a> | |
122 | <ul> | |
123 | <li> | |
ab0ee6a1 | 124 | <a href="#operation--videos-get"> GET /videos </a> |
5e1c08eb C |
125 | </li> |
126 | <li> | |
ab0ee6a1 | 127 | <a href="#operation--videos-categories-get"> GET /videos/categories </a> |
5e1c08eb C |
128 | </li> |
129 | <li> | |
ab0ee6a1 | 130 | <a href="#operation--videos-licences-get"> GET /videos/licences </a> |
5e1c08eb C |
131 | </li> |
132 | <li> | |
ab0ee6a1 | 133 | <a href="#operation--videos-languages-get"> GET /videos/languages </a> |
5e1c08eb C |
134 | </li> |
135 | <li> | |
ab0ee6a1 | 136 | <a href="#operation--videos-privacies-get"> GET /videos/privacies </a> |
5e1c08eb C |
137 | </li> |
138 | <li> | |
ab0ee6a1 | 139 | <a href="#operation--videos-search-get"> GET /videos/search </a> |
5e1c08eb C |
140 | </li> |
141 | <li> | |
ab0ee6a1 | 142 | <a href="#operation--videos--id--put"> PUT /videos/{id} </a> |
5e1c08eb C |
143 | </li> |
144 | <li> | |
ab0ee6a1 | 145 | <a href="#operation--videos--id--get"> GET /videos/{id} </a> |
5e1c08eb C |
146 | </li> |
147 | <li> | |
ab0ee6a1 | 148 | <a href="#operation--videos--id--delete"> DELETE /videos/{id} </a> |
5e1c08eb C |
149 | </li> |
150 | <li> | |
ab0ee6a1 | 151 | <a href="#operation--videos--id--description-get"> GET /videos/{id}/description </a> |
5e1c08eb C |
152 | </li> |
153 | <li> | |
ab0ee6a1 | 154 | <a href="#operation--videos--id--views-post"> POST /videos/{id}/views </a> |
5e1c08eb C |
155 | </li> |
156 | <li> | |
ab0ee6a1 | 157 | <a href="#operation--videos-upload-post"> POST /videos/upload </a> |
5e1c08eb C |
158 | </li> |
159 | </ul> | |
160 | </section> | |
161 | <section> | |
162 | <a href="#tag-VideoAbuse">VideoAbuse</a> | |
163 | <ul> | |
164 | <li> | |
ab0ee6a1 | 165 | <a href="#operation--videos-abuse-get"> GET /videos/abuse </a> |
5e1c08eb C |
166 | </li> |
167 | <li> | |
ab0ee6a1 | 168 | <a href="#operation--videos--id--abuse-post"> POST /videos/{id}/abuse </a> |
5e1c08eb C |
169 | </li> |
170 | </ul> | |
171 | </section> | |
172 | <section> | |
173 | <a href="#tag-VideoBlacklist">VideoBlacklist</a> | |
174 | <ul> | |
175 | <li> | |
ab0ee6a1 | 176 | <a href="#operation--videos--videoId--blacklist-post"> POST /videos/{videoId}/blacklist </a> |
5e1c08eb C |
177 | </li> |
178 | <li> | |
ab0ee6a1 | 179 | <a href="#operation--videos--videoId--blacklist-delete"> DELETE /videos/{videoId}/blacklist </a> |
5e1c08eb C |
180 | </li> |
181 | <li> | |
ab0ee6a1 | 182 | <a href="#operation--videos-blacklist-get"> GET /videos/blacklist </a> |
5e1c08eb C |
183 | </li> |
184 | </ul> | |
185 | </section> | |
186 | <section> | |
187 | <a href="#tag-VideoChannel">VideoChannel</a> | |
188 | <ul> | |
189 | <li> | |
48dce1c9 | 190 | <a href="#operation--video-channels-get"> GET /video-channels </a> |
5e1c08eb C |
191 | </li> |
192 | <li> | |
cc918ac3 C |
193 | <a href="#operation--video-channels-post"> POST /video-channels </a> |
194 | </li> | |
195 | <li> | |
196 | <a href="#operation--video-channels--id--get"> GET /video-channels/{id} </a> | |
5e1c08eb C |
197 | </li> |
198 | <li> | |
cc918ac3 | 199 | <a href="#operation--video-channels--id--put"> PUT /video-channels/{id} </a> |
5e1c08eb C |
200 | </li> |
201 | <li> | |
cc918ac3 | 202 | <a href="#operation--video-channels--id--delete"> DELETE /video-channels/{id} </a> |
5e1c08eb C |
203 | </li> |
204 | <li> | |
cc918ac3 | 205 | <a href="#operation--video-channels--id--videos-get"> GET /video-channels/{id}/videos </a> |
5e1c08eb C |
206 | </li> |
207 | <li> | |
ad9e39fb | 208 | <a href="#operation--accounts--name--video-channels-get"> GET /accounts/{name}/video-channels </a> |
5e1c08eb C |
209 | </li> |
210 | </ul> | |
211 | </section> | |
212 | <section> | |
213 | <a href="#tag-VideoComment">VideoComment</a> | |
214 | <ul> | |
215 | <li> | |
ab0ee6a1 | 216 | <a href="#operation--videos--videoId--comment-threads-get"> GET /videos/{videoId}/comment-threads </a> |
5e1c08eb C |
217 | </li> |
218 | <li> | |
ab0ee6a1 | 219 | <a href="#operation--videos--videoId--comment-threads-post"> POST /videos/{videoId}/comment-threads </a> |
5e1c08eb C |
220 | </li> |
221 | <li> | |
ab0ee6a1 | 222 | <a href="#operation--videos--videoId--comment-threads--threadId--get"> GET /videos/{videoId}/comment-threads/{threadId} </a> |
5e1c08eb C |
223 | </li> |
224 | <li> | |
ab0ee6a1 | 225 | <a href="#operation--videos--videoId--comments--commentId--post"> POST /videos/{videoId}/comments/{commentId} </a> |
5e1c08eb C |
226 | </li> |
227 | <li> | |
ab0ee6a1 | 228 | <a href="#operation--videos--videoId--comments--commentId--delete"> DELETE /videos/{videoId}/comments/{commentId} </a> |
5e1c08eb C |
229 | </li> |
230 | </ul> | |
231 | </section> | |
232 | <section> | |
233 | <a href="#tag-VideoRate">VideoRate</a> | |
234 | <ul> | |
235 | <li> | |
ab0ee6a1 | 236 | <a href="#operation--videos--id--rate-put"> PUT /videos/{id}/rate </a> |
5e1c08eb C |
237 | </li> |
238 | </ul> | |
239 | </section> | |
240 | <h5>Schema Definitions</h5> | |
48dce1c9 C |
241 | <a href="#definition-VideoConstantNumber"> VideoConstantNumber </a> |
242 | <a href="#definition-VideoConstantString"> VideoConstantString </a> | |
61b66b36 | 243 | <a href="#definition-VideoPrivacy"> VideoPrivacy </a> |
5e1c08eb C |
244 | <a href="#definition-Video"> Video </a> |
245 | <a href="#definition-VideoAbuse"> VideoAbuse </a> | |
246 | <a href="#definition-VideoBlacklist"> VideoBlacklist </a> | |
247 | <a href="#definition-VideoChannel"> VideoChannel </a> | |
248 | <a href="#definition-VideoComment"> VideoComment </a> | |
249 | <a href="#definition-VideoCommentThreadTree"> VideoCommentThreadTree </a> | |
250 | <a href="#definition-Avatar"> Avatar </a> | |
251 | <a href="#definition-Actor"> Actor </a> | |
252 | <a href="#definition-Account"> Account </a> | |
253 | <a href="#definition-User"> User </a> | |
254 | <a href="#definition-ServerConfig"> ServerConfig </a> | |
255 | <a href="#definition-Follow"> Follow </a> | |
256 | <a href="#definition-Job"> Job </a> | |
257 | <a href="#definition-AddUserResponse"> AddUserResponse </a> | |
258 | <a href="#definition-VideoUploadResponse"> VideoUploadResponse </a> | |
ab0ee6a1 C |
259 | <a href="#definition-CommentThreadResponse"> CommentThreadResponse </a> |
260 | <a href="#definition-CommentThreadPostResponse"> CommentThreadPostResponse </a> | |
5e1c08eb C |
261 | <a href="#definition-AddUser"> AddUser </a> |
262 | <a href="#definition-UpdateUser"> UpdateUser </a> | |
263 | <a href="#definition-UpdateMe"> UpdateMe </a> | |
264 | <a href="#definition-GetMeVideoRating"> GetMeVideoRating </a> | |
265 | <a href="#definition-RegisterUser"> RegisterUser </a> | |
266 | <a href="#definition-VideoChannelInput"> VideoChannelInput </a> | |
bbe0f064 | 267 | <a href="#definition-ScheduleVideoUpdate"> ScheduleVideoUpdate </a> |
5e1c08eb C |
268 | </nav> |
269 | </div> | |
270 | <div id="docs" class="row collapse expanded drawer" data-drawer> | |
271 | <button class="floating-menu-icon" type="button" data-drawer-slide="right"> | |
272 | <span class="hamburger"></span> | |
273 | </button> | |
274 | <div class="example-box doc-content"></div> | |
275 | <article> | |
228e84aa C |
276 | <h1 class="doc-title">PeerTube |
277 | <span>API Reference</span> | |
278 | </h1> | |
5e1c08eb | 279 | <div id="introduction" data-traverse-target="introduction"> |
5e1c08eb C |
280 | <div class="doc-row"> |
281 | <div class="doc-copy"> | |
282 | <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.</p> | |
283 | </div> | |
284 | <div class="doc-examples"> | |
285 | <section> | |
ea65a476 C |
286 | <h5>API Endpoint</h5> |
287 | <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre> | |
288 | <!-- </div> --> | |
289 | <h5>Schemes: | |
290 | <span>https</span> | |
291 | </h5> | |
5e1c08eb | 292 | <h5>Version: |
164e6c87 | 293 | <span>1.0.0-beta</span> |
5e1c08eb C |
294 | </h5> |
295 | </section> | |
296 | </div> | |
297 | </div> | |
298 | </div> | |
94ff4c23 C |
299 | <!-- <h1 id="security" data-traverse-target="security">Security</h1> --> |
300 | <h1 id="authentication" data-traverse-target="authentication">Authentication</h1> | |
301 | <div id="security-definition-OAuth2" class="panel"> | |
302 | <div class="doc-row"> | |
303 | <div class="doc-copy"> | |
304 | <h3 class="security-definition-title"> | |
305 | <span class="security-name">OAuth2</span> | |
306 | <span class="swagger-security-definition-oauth2"></span> | |
307 | </h3> | |
308 | <section class="security-definition-description"> | |
309 | <p>In the header: | |
310 | <em>Authorization: Bearer mytoken</em> | |
311 | </p> | |
312 | </section> | |
313 | <section class="swagger-security-definition-properties"> | |
314 | <div class="prop-row security-definition-property"> | |
315 | <div class="prop-name"> | |
316 | <div class="prop-title security-definition-property-name">type</div> | |
317 | </div> | |
318 | <div class="prop-value security-definition-property-type"> oauth2 </div> | |
319 | </div> | |
320 | <div class="prop-row security-definition-property"> | |
321 | <div class="prop-name"> | |
322 | <div class="prop-title security-definition-property-name">flow</div> | |
323 | </div> | |
324 | <div class="prop-value security-definition-property-type"> password </div> | |
325 | </div> | |
326 | <div class="prop-row security-definition-property"> | |
327 | <div class="prop-name"> | |
328 | <div class="prop-title security-definition-property-name">tokenUrl</div> | |
329 | </div> | |
330 | <div class="prop-value security-definition-property-type"> https://peertube.example.com/api/v1/users/token </div> | |
331 | </div> | |
332 | </section> | |
333 | </div> | |
334 | </div> | |
335 | </div> | |
5e1c08eb | 336 | <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1> |
ad9e39fb | 337 | <div id="operation--accounts--name--get" class="operation panel" data-traverse-target="operation--accounts--name--get"> |
5e1c08eb C |
338 | <!-- <section class="operation-tags row"> --> |
339 | <!-- <div class="doc-copy"> --> | |
340 | <div class="operation-tags"> | |
341 | <a class="label" href="#tag-Accounts">Accounts</a> | |
342 | <!----> | |
343 | </div> | |
344 | <!-- </div> --> | |
345 | <!-- </section> --> | |
346 | <h2 class="operation-title"> | |
347 | <span class="operation-name"> | |
348 | <span class="operation-name">GET</span> | |
ad9e39fb | 349 | <span class="operation-path">/accounts/{name}</span> |
5e1c08eb C |
350 | </span> |
351 | </h2> | |
352 | <div class="doc-row"> | |
353 | <div class="doc-copy"> | |
354 | <section class="swagger-request-params"> | |
355 | <div class="prop-row prop-group"> | |
356 | <div class="prop-name"> | |
ad9e39fb | 357 | <div class="prop-title">name</div> |
5e1c08eb | 358 | <span class="json-property-required"></span> |
228e84aa C |
359 | <div class="prop-subtitle"> in path </div> |
360 | <div class="prop-subtitle"> | |
361 | <span class="json-property-type">string</span> | |
362 | <span class="json-property-range" title="Value limits"></span> | |
363 | </div> | |
5e1c08eb C |
364 | </div> |
365 | <div class="prop-value"> | |
ad9e39fb C |
366 | <p>The name of the account (chocobozzz or |
367 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | |
5e1c08eb C |
368 | </div> |
369 | </div> | |
ab0ee6a1 C |
370 | <div class="prop-row prop-group"> |
371 | <div class="prop-name"> | |
372 | <div class="prop-title">start</div> | |
228e84aa C |
373 | <div class="prop-subtitle"> in query </div> |
374 | <div class="prop-subtitle"> | |
375 | <span class="json-property-type">number</span> | |
376 | <span class="json-property-range" title="Value limits"></span> | |
377 | </div> | |
ab0ee6a1 C |
378 | </div> |
379 | <div class="prop-value"> | |
380 | <p>starting page</p> | |
381 | </div> | |
382 | </div> | |
ab0ee6a1 C |
383 | <div class="prop-row prop-group"> |
384 | <div class="prop-name"> | |
385 | <div class="prop-title">stop</div> | |
228e84aa C |
386 | <div class="prop-subtitle"> in query </div> |
387 | <div class="prop-subtitle"> | |
388 | <span class="json-property-type">number</span> | |
389 | <span class="json-property-range" title="Value limits"></span> | |
390 | </div> | |
ab0ee6a1 C |
391 | </div> |
392 | <div class="prop-value"> | |
f209b32a | 393 | <p>stopping page</p> |
ab0ee6a1 C |
394 | </div> |
395 | </div> | |
ab0ee6a1 C |
396 | <div class="prop-row prop-group"> |
397 | <div class="prop-name"> | |
398 | <div class="prop-title">sort</div> | |
228e84aa C |
399 | <div class="prop-subtitle"> in query </div> |
400 | <div class="prop-subtitle"> | |
401 | <span class="json-property-type">number</span> | |
402 | <span class="json-property-range" title="Value limits"></span> | |
403 | </div> | |
ab0ee6a1 C |
404 | </div> |
405 | <div class="prop-value"> | |
406 | <p>sorting</p> | |
407 | </div> | |
408 | </div> | |
5e1c08eb C |
409 | </section> |
410 | </div> | |
411 | <div class="doc-examples"></div> | |
412 | </div> | |
413 | <div class="doc-row"> | |
414 | <div class="doc-copy"> | |
415 | <section class="swagger-responses"> | |
416 | <div class="prop-row prop-group"> | |
417 | <div class="prop-name"> | |
418 | <div class="prop-title">200 OK</div> | |
419 | <div class="prop-ref"> | |
420 | <span class=""> | |
421 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
422 | </span> | |
423 | </div> | |
424 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
425 | </div> | |
426 | <div class="prop-value"> | |
427 | <p>successful operation</p> | |
428 | </div> | |
429 | </div> | |
430 | </section> | |
431 | </div> | |
432 | <div class="doc-examples"> | |
433 | <h5>Response Content-Types: | |
434 | <span>application/json</span> | |
435 | </h5> | |
436 | <section> | |
437 | <h5>Response Example | |
438 | <span>(200 OK)</span> | |
439 | </h5> | |
440 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
441 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
442 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
443 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
444 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
445 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
446 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
447 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
448 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
449 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
450 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
451 | <span class="hljs-attr">"avatar"</span>: { | |
452 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
453 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
454 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
455 | } | |
456 | } | |
cc918ac3 C |
457 | </code></pre> |
458 | <!-- </div> --> | |
459 | </section> | |
460 | </div> | |
461 | </div> | |
462 | </div> | |
ad9e39fb | 463 | <div id="operation--accounts--name--videos-get" class="operation panel" data-traverse-target="operation--accounts--name--videos-get"> |
cc918ac3 C |
464 | <!-- <section class="operation-tags row"> --> |
465 | <!-- <div class="doc-copy"> --> | |
466 | <div class="operation-tags"> | |
467 | <a class="label" href="#tag-Accounts">Accounts</a> | |
468 | <!----> | |
469 | </div> | |
470 | <!-- </div> --> | |
471 | <!-- </section> --> | |
472 | <h2 class="operation-title"> | |
473 | <span class="operation-name"> | |
474 | <span class="operation-name">GET</span> | |
ad9e39fb | 475 | <span class="operation-path">/accounts/{name}/videos</span> |
cc918ac3 C |
476 | </span> |
477 | </h2> | |
478 | <div class="doc-row"> | |
479 | <div class="doc-copy"> | |
480 | <section class="swagger-request-params"> | |
481 | <div class="prop-row prop-group"> | |
482 | <div class="prop-name"> | |
ad9e39fb | 483 | <div class="prop-title">name</div> |
cc918ac3 C |
484 | <span class="json-property-required"></span> |
485 | <div class="prop-subtitle"> in path </div> | |
486 | <div class="prop-subtitle"> | |
487 | <span class="json-property-type">string</span> | |
488 | <span class="json-property-range" title="Value limits"></span> | |
489 | </div> | |
490 | </div> | |
491 | <div class="prop-value"> | |
ad9e39fb C |
492 | <p>The name of the account (chocobozzz or |
493 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | |
cc918ac3 C |
494 | </div> |
495 | </div> | |
496 | </section> | |
497 | </div> | |
498 | <div class="doc-examples"></div> | |
499 | </div> | |
500 | <div class="doc-row"> | |
501 | <div class="doc-copy"> | |
502 | <section class="swagger-responses"> | |
503 | <div class="prop-row prop-group"> | |
504 | <div class="prop-name"> | |
505 | <div class="prop-title">200 OK</div> | |
506 | <div class="prop-ref"> | |
507 | <span class=""> | |
508 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
509 | </span> | |
510 | </div> | |
511 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
512 | </div> | |
513 | <div class="prop-value"> | |
514 | <p>successful operation</p> | |
515 | </div> | |
516 | </div> | |
517 | </section> | |
518 | </div> | |
519 | <div class="doc-examples"> | |
520 | <h5>Response Content-Types: | |
521 | <span>application/json</span> | |
522 | </h5> | |
523 | <section> | |
524 | <h5>Response Example | |
525 | <span>(200 OK)</span> | |
526 | </h5> | |
527 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
528 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
529 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
530 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
531 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
532 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
533 | <span class="hljs-attr">"category"</span>: { | |
534 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
535 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
536 | }, | |
537 | <span class="hljs-attr">"licence"</span>: { | |
538 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
539 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
540 | }, | |
541 | <span class="hljs-attr">"language"</span>: { | |
542 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
543 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
544 | }, | |
545 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
546 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
547 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
548 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
549 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
550 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
551 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
552 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
553 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
554 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
555 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
556 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
557 | <span class="hljs-attr">"account"</span>: { | |
558 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
559 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
560 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
561 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
562 | <span class="hljs-attr">"avatar"</span>: { | |
563 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
564 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
565 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
566 | } | |
567 | } | |
568 | } | |
5e1c08eb C |
569 | </code></pre> |
570 | <!-- </div> --> | |
571 | </section> | |
572 | </div> | |
573 | </div> | |
574 | </div> | |
575 | <div id="operation--accounts-get" class="operation panel" data-traverse-target="operation--accounts-get"> | |
576 | <!-- <section class="operation-tags row"> --> | |
577 | <!-- <div class="doc-copy"> --> | |
578 | <div class="operation-tags"> | |
579 | <a class="label" href="#tag-Accounts">Accounts</a> | |
580 | <!----> | |
581 | </div> | |
582 | <!-- </div> --> | |
583 | <!-- </section> --> | |
584 | <h2 class="operation-title"> | |
585 | <span class="operation-name"> | |
586 | <span class="operation-name">GET</span> | |
587 | <span class="operation-path">/accounts</span> | |
588 | </span> | |
589 | </h2> | |
590 | <div class="doc-row"> | |
591 | <div class="doc-copy"> </div> | |
592 | <div class="doc-examples"></div> | |
593 | </div> | |
594 | <div class="doc-row"> | |
595 | <div class="doc-copy"> | |
596 | <section class="swagger-responses"> | |
597 | <div class="prop-row prop-group"> | |
598 | <div class="prop-name"> | |
599 | <div class="prop-title">200 OK</div> | |
600 | <div class="prop-ref"> | |
601 | <span class="json-schema-ref-array"> | |
602 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
603 | </span> | |
604 | </div> | |
605 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
606 | </div> | |
607 | <div class="prop-value"> | |
608 | <p>successful operation</p> | |
609 | </div> | |
610 | </div> | |
228e84aa C |
611 | <div class="prop-row prop-inner"> |
612 | <div class="prop-name">type</div> | |
613 | <div class="prop-value"> | |
614 | <span class="json-property-type"> | |
615 | <span class="json-schema-ref-array"> | |
616 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
617 | </span> | |
618 | </span> | |
619 | <span class="json-property-range" title="Value limits"></span> | |
620 | </div> | |
621 | </div> | |
5e1c08eb C |
622 | </section> |
623 | </div> | |
624 | <div class="doc-examples"> | |
625 | <h5>Response Content-Types: | |
626 | <span>application/json</span> | |
627 | </h5> | |
628 | <section> | |
629 | <h5>Response Example | |
630 | <span>(200 OK)</span> | |
631 | </h5> | |
632 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
633 | { | |
634 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
635 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
636 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
637 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
638 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
639 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
640 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
641 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
642 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
643 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
644 | <span class="hljs-attr">"avatar"</span>: { | |
645 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
646 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
647 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
648 | } | |
649 | } | |
650 | ] | |
651 | </code></pre> | |
652 | <!-- </div> --> | |
653 | </section> | |
654 | </div> | |
655 | </div> | |
656 | </div> | |
657 | <h1 id="tag-Config" class="swagger-summary-tag" data-traverse-target="tag-Config">Config</h1> | |
658 | <div id="operation--config-get" class="operation panel" data-traverse-target="operation--config-get"> | |
659 | <!-- <section class="operation-tags row"> --> | |
660 | <!-- <div class="doc-copy"> --> | |
661 | <div class="operation-tags"> | |
662 | <a class="label" href="#tag-Config">Config</a> | |
663 | <!----> | |
664 | </div> | |
665 | <!-- </div> --> | |
666 | <!-- </section> --> | |
667 | <h2 class="operation-title"> | |
668 | <span class="operation-name"> | |
669 | <span class="operation-name">GET</span> | |
670 | <span class="operation-path">/config</span> | |
671 | </span> | |
672 | </h2> | |
673 | <div class="doc-row"> | |
674 | <div class="doc-copy"> </div> | |
675 | <div class="doc-examples"></div> | |
676 | </div> | |
677 | <div class="doc-row"> | |
678 | <div class="doc-copy"> | |
679 | <section class="swagger-responses"> | |
680 | <div class="prop-row prop-group"> | |
681 | <div class="prop-name"> | |
682 | <div class="prop-title">200 OK</div> | |
683 | <div class="prop-ref"> | |
684 | <span class=""> | |
685 | <a class="json-schema-ref" href="#/definitions/ServerConfig">ServerConfig</a> | |
686 | </span> | |
687 | </div> | |
688 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
689 | </div> | |
690 | <div class="prop-value"> | |
691 | <p>successful operation</p> | |
692 | </div> | |
693 | </div> | |
694 | </section> | |
695 | </div> | |
696 | <div class="doc-examples"> | |
697 | <h5>Response Content-Types: | |
698 | <span>application/json</span> | |
699 | </h5> | |
700 | <section> | |
701 | <h5>Response Example | |
702 | <span>(200 OK)</span> | |
703 | </h5> | |
704 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
705 | <span class="hljs-attr">"signup"</span>: { | |
706 | <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span> | |
707 | }, | |
708 | <span class="hljs-attr">"transcoding"</span>: { | |
709 | <span class="hljs-attr">"enabledResolutions"</span>: [ | |
710 | <span class="hljs-string">"number"</span> | |
711 | ] | |
712 | }, | |
713 | <span class="hljs-attr">"avatar"</span>: { | |
714 | <span class="hljs-attr">"file"</span>: { | |
715 | <span class="hljs-attr">"size"</span>: { | |
716 | <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span> | |
717 | } | |
718 | }, | |
719 | <span class="hljs-attr">"extensions"</span>: [ | |
720 | <span class="hljs-string">"string"</span> | |
721 | ] | |
722 | }, | |
723 | <span class="hljs-attr">"video"</span>: { | |
724 | <span class="hljs-attr">"file"</span>: { | |
725 | <span class="hljs-attr">"extensions"</span>: [ | |
726 | <span class="hljs-string">"string"</span> | |
727 | ] | |
728 | } | |
729 | } | |
730 | } | |
731 | </code></pre> | |
732 | <!-- </div> --> | |
733 | </section> | |
734 | </div> | |
735 | </div> | |
736 | </div> | |
48dce1c9 C |
737 | <h1 id="tag-Feeds" class="swagger-summary-tag" data-traverse-target="tag-Feeds">Feeds</h1> |
738 | <div id="operation--feeds-videos.-format--get" class="operation panel" data-traverse-target="operation--feeds-videos.-format--get"> | |
739 | <!-- <section class="operation-tags row"> --> | |
740 | <!-- <div class="doc-copy"> --> | |
741 | <div class="operation-tags"> | |
742 | <a class="label" href="#tag-Feeds">Feeds</a> | |
743 | <!----> | |
744 | </div> | |
745 | <!-- </div> --> | |
746 | <!-- </section> --> | |
747 | <h2 class="operation-title"> | |
748 | <span class="operation-name"> | |
749 | <span class="operation-name">GET</span> | |
750 | <span class="operation-path">/feeds/videos.{format}</span> | |
751 | </span> | |
752 | </h2> | |
753 | <div class="doc-row"> | |
754 | <div class="doc-copy"> | |
755 | <section class="swagger-request-params"> | |
756 | <div class="prop-row prop-group"> | |
757 | <div class="prop-name"> | |
758 | <div class="prop-title">format</div> | |
759 | <span class="json-property-required"></span> | |
760 | <div class="prop-subtitle"> in path </div> | |
761 | <div class="prop-subtitle"> | |
762 | <span class="json-property-type">string</span> | |
763 | <span class="json-property-enum" title="Possible values"> | |
764 | <span class="json-property-enum-item json-property-enum-default-value">xml</span>, | |
765 | <span class="json-property-enum-item">atom</span>, | |
766 | <span class="json-property-enum-item">json</span> | |
767 | </span> | |
768 | <span class="json-property-range" title="Value limits"></span> | |
769 | <span class="json-property-default-value" title="Default value">xml</span> | |
770 | </div> | |
771 | </div> | |
772 | <div class="prop-value"> | |
773 | <p>The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0</p> | |
774 | </div> | |
775 | </div> | |
776 | <div class="prop-row prop-group"> | |
777 | <div class="prop-name"> | |
778 | <div class="prop-title">accountId</div> | |
779 | <div class="prop-subtitle"> in query </div> | |
780 | <div class="prop-subtitle"> | |
781 | <span class="json-property-type">number</span> | |
782 | <span class="json-property-range" title="Value limits"></span> | |
783 | </div> | |
784 | </div> | |
785 | <div class="prop-value"> | |
786 | <p>The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds</p> | |
787 | </div> | |
788 | </div> | |
789 | <div class="prop-row prop-group"> | |
790 | <div class="prop-name"> | |
791 | <div class="prop-title">accountName</div> | |
792 | <div class="prop-subtitle"> in query </div> | |
793 | <div class="prop-subtitle"> | |
794 | <span class="json-property-type">string</span> | |
795 | <span class="json-property-range" title="Value limits"></span> | |
796 | </div> | |
797 | </div> | |
798 | <div class="prop-value"> | |
799 | <p>The name of the local account to filter to</p> | |
800 | </div> | |
801 | </div> | |
802 | </section> | |
803 | </div> | |
804 | <div class="doc-examples"></div> | |
805 | </div> | |
806 | <div class="doc-row"> | |
807 | <div class="doc-copy"> | |
808 | <section class="swagger-responses"> | |
809 | <div class="prop-row prop-group"> | |
810 | <div class="prop-name"> | |
811 | <div class="prop-title">200 OK</div> | |
812 | </div> | |
813 | <div class="prop-value"> | |
814 | <p>successful operation</p> | |
815 | </div> | |
816 | </div> | |
817 | </section> | |
818 | </div> | |
819 | <div class="doc-examples"> | |
820 | <h5>Response Content-Types: | |
821 | <span>application/atom+xml, application/rss+xml, application/json</span> | |
822 | </h5> | |
823 | </div> | |
824 | </div> | |
825 | </div> | |
5e1c08eb C |
826 | <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1> |
827 | <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get"> | |
828 | <!-- <section class="operation-tags row"> --> | |
829 | <!-- <div class="doc-copy"> --> | |
830 | <div class="operation-tags"> | |
831 | <a class="label" href="#tag-Job">Job</a> | |
832 | <!----> | |
833 | </div> | |
834 | <!-- </div> --> | |
835 | <!-- </section> --> | |
836 | <h2 class="operation-title"> | |
837 | <span class="operation-name"> | |
838 | <span class="operation-name">GET</span> | |
839 | <span class="operation-path">/jobs</span> | |
840 | </span> | |
841 | </h2> | |
842 | <div class="doc-row"> | |
ab0ee6a1 C |
843 | <div class="doc-copy"> |
844 | <section class="swagger-request-params"> | |
845 | <div class="prop-row prop-group"> | |
846 | <div class="prop-name"> | |
847 | <div class="prop-title">state</div> | |
848 | <span class="json-property-required"></span> | |
228e84aa C |
849 | <div class="prop-subtitle"> in path </div> |
850 | <div class="prop-subtitle"> | |
851 | <span class="json-property-type">string</span> | |
852 | <span class="json-property-range" title="Value limits"></span> | |
853 | </div> | |
ab0ee6a1 C |
854 | </div> |
855 | <div class="prop-value"> | |
856 | <p>The id of the account</p> | |
857 | </div> | |
858 | </div> | |
ab0ee6a1 C |
859 | <div class="prop-row prop-group"> |
860 | <div class="prop-name"> | |
861 | <div class="prop-title">start</div> | |
228e84aa C |
862 | <div class="prop-subtitle"> in query </div> |
863 | <div class="prop-subtitle"> | |
864 | <span class="json-property-type">number</span> | |
865 | <span class="json-property-range" title="Value limits"></span> | |
866 | </div> | |
ab0ee6a1 C |
867 | </div> |
868 | <div class="prop-value"> | |
869 | <p>starting page</p> | |
870 | </div> | |
871 | </div> | |
ab0ee6a1 C |
872 | <div class="prop-row prop-group"> |
873 | <div class="prop-name"> | |
874 | <div class="prop-title">count</div> | |
228e84aa C |
875 | <div class="prop-subtitle"> in query </div> |
876 | <div class="prop-subtitle"> | |
877 | <span class="json-property-type">number</span> | |
878 | <span class="json-property-range" title="Value limits"></span> | |
879 | </div> | |
ab0ee6a1 C |
880 | </div> |
881 | <div class="prop-value"> | |
882 | <p class="no-description">(no description)</p> | |
883 | </div> | |
884 | </div> | |
ab0ee6a1 C |
885 | <div class="prop-row prop-group"> |
886 | <div class="prop-name"> | |
887 | <div class="prop-title">sort</div> | |
228e84aa C |
888 | <div class="prop-subtitle"> in query </div> |
889 | <div class="prop-subtitle"> | |
890 | <span class="json-property-type">number</span> | |
891 | <span class="json-property-range" title="Value limits"></span> | |
892 | </div> | |
ab0ee6a1 C |
893 | </div> |
894 | <div class="prop-value"> | |
895 | <p>sorting</p> | |
896 | </div> | |
897 | </div> | |
ab0ee6a1 C |
898 | </section> |
899 | </div> | |
5e1c08eb C |
900 | <div class="doc-examples"></div> |
901 | </div> | |
902 | <div class="doc-row"> | |
903 | <div class="doc-copy"> | |
904 | <section class="swagger-responses"> | |
905 | <div class="prop-row prop-group"> | |
906 | <div class="prop-name"> | |
907 | <div class="prop-title">200 OK</div> | |
908 | <div class="prop-ref"> | |
909 | <span class="json-schema-ref-array"> | |
910 | <a class="json-schema-ref" href="#/definitions/Job">Job</a> | |
911 | </span> | |
912 | </div> | |
913 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
914 | </div> | |
915 | <div class="prop-value"> | |
916 | <p>successful operation</p> | |
917 | </div> | |
918 | </div> | |
228e84aa C |
919 | <div class="prop-row prop-inner"> |
920 | <div class="prop-name">type</div> | |
921 | <div class="prop-value"> | |
922 | <span class="json-property-type"> | |
923 | <span class="json-schema-ref-array"> | |
924 | <a class="json-schema-ref" href="#/definitions/Job">Job</a> | |
925 | </span> | |
926 | </span> | |
927 | <span class="json-property-range" title="Value limits"></span> | |
928 | </div> | |
929 | </div> | |
5e1c08eb C |
930 | </section> |
931 | </div> | |
932 | <div class="doc-examples"> | |
933 | <h5>Response Content-Types: | |
934 | <span>application/json</span> | |
935 | </h5> | |
936 | <section> | |
937 | <h5>Response Example | |
938 | <span>(200 OK)</span> | |
939 | </h5> | |
940 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
941 | { | |
942 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
943 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
944 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>, | |
945 | <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>, | |
946 | <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>, | |
947 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
948 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
949 | } | |
950 | ] | |
951 | </code></pre> | |
952 | <!-- </div> --> | |
953 | </section> | |
954 | </div> | |
955 | </div> | |
94ff4c23 C |
956 | <div class="doc-row"> |
957 | <div class="doc-copy"> | |
958 | <section class="swagger-request-security"> | |
959 | <table class="table"> | |
960 | <thead> | |
961 | <tr> | |
962 | <th class="swagger-request-security-schema"></th> | |
963 | <th class="swagger-request-security-scopes"></th> | |
964 | </tr> | |
965 | </thead> | |
966 | <tbody> | |
967 | <tr> | |
968 | <td> | |
969 | <a href="#security-definition-OAuth2">OAuth2</a> | |
970 | </td> | |
971 | <td> </td> | |
972 | </tr> | |
973 | </tbody> | |
974 | </table> | |
975 | </section> | |
976 | </div> | |
977 | </div> | |
5e1c08eb C |
978 | </div> |
979 | <h1 id="tag-ServerFollowing" class="swagger-summary-tag" data-traverse-target="tag-ServerFollowing">ServerFollowing</h1> | |
980 | <div id="operation--server-following--host--delete" class="operation panel" data-traverse-target="operation--server-following--host--delete"> | |
981 | <!-- <section class="operation-tags row"> --> | |
982 | <!-- <div class="doc-copy"> --> | |
983 | <div class="operation-tags"> | |
984 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
985 | <!----> | |
986 | </div> | |
987 | <!-- </div> --> | |
988 | <!-- </section> --> | |
989 | <h2 class="operation-title"> | |
990 | <span class="operation-name"> | |
991 | <span class="operation-name">DELETE</span> | |
992 | <span class="operation-path">/server/following/{host}</span> | |
993 | </span> | |
994 | </h2> | |
995 | <div class="doc-row"> | |
996 | <div class="doc-copy"> | |
997 | <section class="swagger-request-params"> | |
998 | <div class="prop-row prop-group"> | |
999 | <div class="prop-name"> | |
1000 | <div class="prop-title">host</div> | |
1001 | <span class="json-property-required"></span> | |
228e84aa C |
1002 | <div class="prop-subtitle"> in path </div> |
1003 | <div class="prop-subtitle"> | |
1004 | <span class="json-property-type">string</span> | |
1005 | <span class="json-property-range" title="Value limits"></span> | |
1006 | </div> | |
5e1c08eb C |
1007 | </div> |
1008 | <div class="prop-value"> | |
1009 | <p>The host to unfollow </p> | |
1010 | </div> | |
1011 | </div> | |
5e1c08eb C |
1012 | </section> |
1013 | </div> | |
1014 | <div class="doc-examples"></div> | |
1015 | </div> | |
1016 | <div class="doc-row"> | |
1017 | <div class="doc-copy"> | |
1018 | <section class="swagger-responses"> | |
1019 | <div class="prop-row prop-group"> | |
1020 | <div class="prop-name"> | |
1021 | <div class="prop-title">201 Created</div> | |
1022 | </div> | |
1023 | <div class="prop-value"> | |
1024 | <p>successful operation</p> | |
1025 | </div> | |
1026 | </div> | |
1027 | </section> | |
1028 | </div> | |
1029 | <div class="doc-examples"> | |
1030 | <h5>Response Content-Types: | |
1031 | <span>application/json</span> | |
1032 | </h5> | |
1033 | </div> | |
1034 | </div> | |
94ff4c23 C |
1035 | <div class="doc-row"> |
1036 | <div class="doc-copy"> | |
1037 | <section class="swagger-request-security"> | |
1038 | <table class="table"> | |
1039 | <thead> | |
1040 | <tr> | |
1041 | <th class="swagger-request-security-schema"></th> | |
1042 | <th class="swagger-request-security-scopes"></th> | |
1043 | </tr> | |
1044 | </thead> | |
1045 | <tbody> | |
1046 | <tr> | |
1047 | <td> | |
1048 | <a href="#security-definition-OAuth2">OAuth2</a> | |
1049 | </td> | |
1050 | <td> </td> | |
1051 | </tr> | |
1052 | </tbody> | |
1053 | </table> | |
1054 | </section> | |
1055 | </div> | |
1056 | </div> | |
5e1c08eb C |
1057 | </div> |
1058 | <div id="operation--server-followers-get" class="operation panel" data-traverse-target="operation--server-followers-get"> | |
1059 | <!-- <section class="operation-tags row"> --> | |
1060 | <!-- <div class="doc-copy"> --> | |
1061 | <div class="operation-tags"> | |
1062 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
1063 | <!----> | |
1064 | </div> | |
1065 | <!-- </div> --> | |
1066 | <!-- </section> --> | |
1067 | <h2 class="operation-title"> | |
1068 | <span class="operation-name"> | |
1069 | <span class="operation-name">GET</span> | |
1070 | <span class="operation-path">/server/followers</span> | |
1071 | </span> | |
1072 | </h2> | |
1073 | <div class="doc-row"> | |
ab0ee6a1 C |
1074 | <div class="doc-copy"> |
1075 | <section class="swagger-request-params"> | |
1076 | <div class="prop-row prop-group"> | |
1077 | <div class="prop-name"> | |
1078 | <div class="prop-title">start</div> | |
228e84aa C |
1079 | <div class="prop-subtitle"> in query </div> |
1080 | <div class="prop-subtitle"> | |
1081 | <span class="json-property-type">number</span> | |
1082 | <span class="json-property-range" title="Value limits"></span> | |
1083 | </div> | |
ab0ee6a1 C |
1084 | </div> |
1085 | <div class="prop-value"> | |
1086 | <p>starting page</p> | |
1087 | </div> | |
1088 | </div> | |
ab0ee6a1 C |
1089 | <div class="prop-row prop-group"> |
1090 | <div class="prop-name"> | |
1091 | <div class="prop-title">stop</div> | |
228e84aa C |
1092 | <div class="prop-subtitle"> in query </div> |
1093 | <div class="prop-subtitle"> | |
1094 | <span class="json-property-type">number</span> | |
1095 | <span class="json-property-range" title="Value limits"></span> | |
1096 | </div> | |
ab0ee6a1 C |
1097 | </div> |
1098 | <div class="prop-value"> | |
f209b32a | 1099 | <p>stopping page</p> |
ab0ee6a1 C |
1100 | </div> |
1101 | </div> | |
ab0ee6a1 C |
1102 | <div class="prop-row prop-group"> |
1103 | <div class="prop-name"> | |
1104 | <div class="prop-title">sort</div> | |
228e84aa C |
1105 | <div class="prop-subtitle"> in query </div> |
1106 | <div class="prop-subtitle"> | |
1107 | <span class="json-property-type">number</span> | |
1108 | <span class="json-property-range" title="Value limits"></span> | |
1109 | </div> | |
ab0ee6a1 C |
1110 | </div> |
1111 | <div class="prop-value"> | |
1112 | <p>sorting</p> | |
1113 | </div> | |
1114 | </div> | |
ab0ee6a1 C |
1115 | </section> |
1116 | </div> | |
5e1c08eb C |
1117 | <div class="doc-examples"></div> |
1118 | </div> | |
1119 | <div class="doc-row"> | |
1120 | <div class="doc-copy"> | |
1121 | <section class="swagger-responses"> | |
1122 | <div class="prop-row prop-group"> | |
1123 | <div class="prop-name"> | |
1124 | <div class="prop-title">200 OK</div> | |
1125 | <div class="prop-ref"> | |
1126 | <span class="json-schema-ref-array"> | |
1127 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
1128 | </span> | |
1129 | </div> | |
1130 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1131 | </div> | |
1132 | <div class="prop-value"> | |
1133 | <p>successful operation</p> | |
1134 | </div> | |
1135 | </div> | |
228e84aa C |
1136 | <div class="prop-row prop-inner"> |
1137 | <div class="prop-name">type</div> | |
1138 | <div class="prop-value"> | |
1139 | <span class="json-property-type"> | |
1140 | <span class="json-schema-ref-array"> | |
1141 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
1142 | </span> | |
1143 | </span> | |
1144 | <span class="json-property-range" title="Value limits"></span> | |
1145 | </div> | |
1146 | </div> | |
5e1c08eb C |
1147 | </section> |
1148 | </div> | |
1149 | <div class="doc-examples"> | |
1150 | <h5>Response Content-Types: | |
1151 | <span>application/json</span> | |
1152 | </h5> | |
1153 | <section> | |
1154 | <h5>Response Example | |
1155 | <span>(200 OK)</span> | |
1156 | </h5> | |
1157 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
1158 | { | |
1159 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1160 | <span class="hljs-attr">"follower"</span>: { | |
1161 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1162 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1163 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1164 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1165 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1166 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1167 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1168 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1169 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1170 | <span class="hljs-attr">"avatar"</span>: { | |
1171 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1172 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1173 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1174 | } | |
1175 | }, | |
1176 | <span class="hljs-attr">"following"</span>: { | |
1177 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1178 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1179 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1180 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1181 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1182 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1183 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1184 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1185 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1186 | <span class="hljs-attr">"avatar"</span>: { | |
1187 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1188 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1189 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1190 | } | |
1191 | }, | |
1192 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
1193 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
1194 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1195 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1196 | } | |
1197 | ] | |
1198 | </code></pre> | |
1199 | <!-- </div> --> | |
1200 | </section> | |
1201 | </div> | |
1202 | </div> | |
1203 | </div> | |
1204 | <div id="operation--server-following-get" class="operation panel" data-traverse-target="operation--server-following-get"> | |
1205 | <!-- <section class="operation-tags row"> --> | |
1206 | <!-- <div class="doc-copy"> --> | |
1207 | <div class="operation-tags"> | |
1208 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
1209 | <!----> | |
1210 | </div> | |
1211 | <!-- </div> --> | |
1212 | <!-- </section> --> | |
1213 | <h2 class="operation-title"> | |
1214 | <span class="operation-name"> | |
1215 | <span class="operation-name">GET</span> | |
1216 | <span class="operation-path">/server/following</span> | |
1217 | </span> | |
1218 | </h2> | |
1219 | <div class="doc-row"> | |
ab0ee6a1 C |
1220 | <div class="doc-copy"> |
1221 | <section class="swagger-request-params"> | |
1222 | <div class="prop-row prop-group"> | |
1223 | <div class="prop-name"> | |
1224 | <div class="prop-title">start</div> | |
228e84aa C |
1225 | <div class="prop-subtitle"> in query </div> |
1226 | <div class="prop-subtitle"> | |
1227 | <span class="json-property-type">number</span> | |
1228 | <span class="json-property-range" title="Value limits"></span> | |
1229 | </div> | |
ab0ee6a1 C |
1230 | </div> |
1231 | <div class="prop-value"> | |
1232 | <p>starting page</p> | |
1233 | </div> | |
1234 | </div> | |
ab0ee6a1 C |
1235 | <div class="prop-row prop-group"> |
1236 | <div class="prop-name"> | |
1237 | <div class="prop-title">stop</div> | |
228e84aa C |
1238 | <div class="prop-subtitle"> in query </div> |
1239 | <div class="prop-subtitle"> | |
1240 | <span class="json-property-type">number</span> | |
1241 | <span class="json-property-range" title="Value limits"></span> | |
1242 | </div> | |
ab0ee6a1 C |
1243 | </div> |
1244 | <div class="prop-value"> | |
f209b32a | 1245 | <p>stopping page</p> |
ab0ee6a1 C |
1246 | </div> |
1247 | </div> | |
ab0ee6a1 C |
1248 | <div class="prop-row prop-group"> |
1249 | <div class="prop-name"> | |
1250 | <div class="prop-title">sort</div> | |
228e84aa C |
1251 | <div class="prop-subtitle"> in query </div> |
1252 | <div class="prop-subtitle"> | |
1253 | <span class="json-property-type">number</span> | |
1254 | <span class="json-property-range" title="Value limits"></span> | |
1255 | </div> | |
ab0ee6a1 C |
1256 | </div> |
1257 | <div class="prop-value"> | |
1258 | <p>sorting</p> | |
1259 | </div> | |
1260 | </div> | |
ab0ee6a1 C |
1261 | </section> |
1262 | </div> | |
5e1c08eb C |
1263 | <div class="doc-examples"></div> |
1264 | </div> | |
1265 | <div class="doc-row"> | |
1266 | <div class="doc-copy"> | |
1267 | <section class="swagger-responses"> | |
1268 | <div class="prop-row prop-group"> | |
1269 | <div class="prop-name"> | |
1270 | <div class="prop-title">200 OK</div> | |
1271 | <div class="prop-ref"> | |
1272 | <span class="json-schema-ref-array"> | |
1273 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
1274 | </span> | |
1275 | </div> | |
1276 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1277 | </div> | |
1278 | <div class="prop-value"> | |
1279 | <p>successful operation</p> | |
1280 | </div> | |
1281 | </div> | |
228e84aa C |
1282 | <div class="prop-row prop-inner"> |
1283 | <div class="prop-name">type</div> | |
1284 | <div class="prop-value"> | |
1285 | <span class="json-property-type"> | |
1286 | <span class="json-schema-ref-array"> | |
1287 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
1288 | </span> | |
1289 | </span> | |
1290 | <span class="json-property-range" title="Value limits"></span> | |
1291 | </div> | |
1292 | </div> | |
5e1c08eb C |
1293 | </section> |
1294 | </div> | |
1295 | <div class="doc-examples"> | |
1296 | <h5>Response Content-Types: | |
1297 | <span>application/json</span> | |
1298 | </h5> | |
1299 | <section> | |
1300 | <h5>Response Example | |
1301 | <span>(200 OK)</span> | |
1302 | </h5> | |
1303 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
1304 | { | |
1305 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1306 | <span class="hljs-attr">"follower"</span>: { | |
1307 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1308 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1309 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1310 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1311 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1312 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1313 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1314 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1315 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1316 | <span class="hljs-attr">"avatar"</span>: { | |
1317 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1318 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1319 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1320 | } | |
1321 | }, | |
1322 | <span class="hljs-attr">"following"</span>: { | |
1323 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1324 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1325 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1326 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1327 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1328 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1329 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1330 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1331 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1332 | <span class="hljs-attr">"avatar"</span>: { | |
1333 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1334 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1335 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1336 | } | |
1337 | }, | |
1338 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
1339 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
1340 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1341 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1342 | } | |
1343 | ] | |
1344 | </code></pre> | |
1345 | <!-- </div> --> | |
1346 | </section> | |
1347 | </div> | |
1348 | </div> | |
1349 | </div> | |
1350 | <div id="operation--server-following-post" class="operation panel" data-traverse-target="operation--server-following-post"> | |
1351 | <!-- <section class="operation-tags row"> --> | |
1352 | <!-- <div class="doc-copy"> --> | |
1353 | <div class="operation-tags"> | |
1354 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
1355 | <!----> | |
1356 | </div> | |
1357 | <!-- </div> --> | |
1358 | <!-- </section> --> | |
1359 | <h2 class="operation-title"> | |
1360 | <span class="operation-name"> | |
1361 | <span class="operation-name">POST</span> | |
1362 | <span class="operation-path">/server/following</span> | |
1363 | </span> | |
1364 | </h2> | |
1365 | <div class="doc-row"> | |
1366 | <div class="doc-copy"> | |
1367 | <section class="swagger-request-body"> | |
1368 | <div class="prop-row"> | |
1369 | <div class="prop-name"> | |
1370 | <div class="swagger-request-model"> | |
1371 | <span class=""> | |
1372 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
1373 | </span> | |
1374 | </div> | |
1375 | </div> | |
1376 | <div class="prop-value columns small-6"> | |
228e84aa C |
1377 | <!-- <div class="swagger-request-description"> --> |
1378 | <p>undefined</p> | |
5e1c08eb C |
1379 | <!-- </div> --> |
1380 | </div> | |
1381 | </div> | |
1382 | </section> | |
1383 | </div> | |
1384 | <div class="doc-examples"> | |
1385 | <section> | |
1386 | <h5>Request Content-Types: | |
1387 | <span>application/json</span> | |
1388 | </h5> | |
1389 | <h5>Request Example</h5> | |
1390 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1391 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1392 | <span class="hljs-attr">"follower"</span>: { | |
1393 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1394 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1395 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1396 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1397 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1398 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1399 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1400 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1401 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1402 | <span class="hljs-attr">"avatar"</span>: { | |
1403 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1404 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1405 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1406 | } | |
1407 | }, | |
1408 | <span class="hljs-attr">"following"</span>: { | |
1409 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1410 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1411 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1412 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1413 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1414 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1415 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1416 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1417 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1418 | <span class="hljs-attr">"avatar"</span>: { | |
1419 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1420 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1421 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1422 | } | |
1423 | }, | |
1424 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
1425 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
1426 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1427 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1428 | } | |
1429 | </code></pre> | |
1430 | <!-- </div> --> | |
1431 | </section> | |
1432 | </div> | |
1433 | </div> | |
1434 | <div class="doc-row"> | |
1435 | <div class="doc-copy"> | |
1436 | <section class="swagger-responses"> | |
1437 | <div class="prop-row prop-group"> | |
1438 | <div class="prop-name"> | |
1439 | <div class="prop-title">204 No Content</div> | |
1440 | </div> | |
1441 | <div class="prop-value"> | |
1442 | <p>successful operation</p> | |
1443 | </div> | |
1444 | </div> | |
1445 | </section> | |
1446 | </div> | |
1447 | <div class="doc-examples"> | |
1448 | <h5>Response Content-Types: | |
1449 | <span>application/json</span> | |
1450 | </h5> | |
1451 | </div> | |
1452 | </div> | |
94ff4c23 C |
1453 | <div class="doc-row"> |
1454 | <div class="doc-copy"> | |
1455 | <section class="swagger-request-security"> | |
1456 | <table class="table"> | |
1457 | <thead> | |
1458 | <tr> | |
1459 | <th class="swagger-request-security-schema"></th> | |
1460 | <th class="swagger-request-security-scopes"></th> | |
1461 | </tr> | |
1462 | </thead> | |
1463 | <tbody> | |
1464 | <tr> | |
1465 | <td> | |
1466 | <a href="#security-definition-OAuth2">OAuth2</a> | |
1467 | </td> | |
1468 | <td> </td> | |
1469 | </tr> | |
1470 | </tbody> | |
1471 | </table> | |
1472 | </section> | |
1473 | </div> | |
1474 | </div> | |
5e1c08eb C |
1475 | </div> |
1476 | <h1 id="tag-User" class="swagger-summary-tag" data-traverse-target="tag-User">User</h1> | |
1477 | <div id="operation--users-post" class="operation panel" data-traverse-target="operation--users-post"> | |
1478 | <!-- <section class="operation-tags row"> --> | |
1479 | <!-- <div class="doc-copy"> --> | |
1480 | <div class="operation-tags"> | |
1481 | <a class="label" href="#tag-User">User</a> | |
1482 | <!----> | |
1483 | </div> | |
1484 | <!-- </div> --> | |
1485 | <!-- </section> --> | |
1486 | <h2 class="operation-title"> | |
1487 | <span class="operation-name"> | |
1488 | <span class="operation-name">POST</span> | |
1489 | <span class="operation-path">/users</span> | |
1490 | </span> | |
1491 | </h2> | |
1492 | <div class="doc-row"> | |
1493 | <div class="doc-copy"> | |
1494 | <section class="swagger-request-body"> | |
1495 | <div class="prop-row"> | |
1496 | <div class="prop-name"> | |
1497 | <div class="swagger-request-model"> | |
1498 | <span class=""> | |
1499 | <a class="json-schema-ref" href="#/definitions/AddUser">AddUser</a> | |
1500 | </span> | |
1501 | </div> | |
1502 | </div> | |
1503 | <div class="prop-value columns small-6"> | |
61b66b36 C |
1504 | <!-- <div class="swagger-request-description"> --> |
1505 | <p>User to create</p> | |
5e1c08eb C |
1506 | <!-- </div> --> |
1507 | </div> | |
1508 | </div> | |
1509 | </section> | |
1510 | </div> | |
1511 | <div class="doc-examples"> | |
1512 | <section> | |
1513 | <h5>Request Content-Types: | |
1514 | <span>application/json</span> | |
1515 | </h5> | |
1516 | <h5>Request Example</h5> | |
1517 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1518 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
1519 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
1520 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1521 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
1522 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
1523 | } | |
1524 | </code></pre> | |
1525 | <!-- </div> --> | |
1526 | </section> | |
1527 | </div> | |
1528 | </div> | |
1529 | <div class="doc-row"> | |
1530 | <div class="doc-copy"> | |
1531 | <section class="swagger-responses"> | |
1532 | <div class="prop-row prop-group"> | |
1533 | <div class="prop-name"> | |
1534 | <div class="prop-title">200 OK</div> | |
1535 | <div class="prop-ref"> | |
1536 | <span class=""> | |
1537 | <a class="json-schema-ref" href="#/definitions/AddUserResponse">AddUserResponse</a> | |
1538 | </span> | |
1539 | </div> | |
1540 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1541 | </div> | |
1542 | <div class="prop-value"> | |
1543 | <p>successful operation</p> | |
1544 | </div> | |
1545 | </div> | |
1546 | </section> | |
1547 | </div> | |
1548 | <div class="doc-examples"> | |
1549 | <h5>Response Content-Types: | |
1550 | <span>application/json</span> | |
1551 | </h5> | |
1552 | <section> | |
1553 | <h5>Response Example | |
1554 | <span>(200 OK)</span> | |
1555 | </h5> | |
1556 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1557 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1558 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
1559 | } | |
1560 | </code></pre> | |
1561 | <!-- </div> --> | |
1562 | </section> | |
1563 | </div> | |
1564 | </div> | |
94ff4c23 C |
1565 | <div class="doc-row"> |
1566 | <div class="doc-copy"> | |
1567 | <section class="swagger-request-security"> | |
1568 | <table class="table"> | |
1569 | <thead> | |
1570 | <tr> | |
1571 | <th class="swagger-request-security-schema"></th> | |
1572 | <th class="swagger-request-security-scopes"></th> | |
1573 | </tr> | |
1574 | </thead> | |
1575 | <tbody> | |
1576 | <tr> | |
1577 | <td> | |
1578 | <a href="#security-definition-OAuth2">OAuth2</a> | |
1579 | </td> | |
1580 | <td> </td> | |
1581 | </tr> | |
1582 | </tbody> | |
1583 | </table> | |
1584 | </section> | |
1585 | </div> | |
1586 | </div> | |
5e1c08eb C |
1587 | </div> |
1588 | <div id="operation--users-get" class="operation panel" data-traverse-target="operation--users-get"> | |
1589 | <!-- <section class="operation-tags row"> --> | |
1590 | <!-- <div class="doc-copy"> --> | |
1591 | <div class="operation-tags"> | |
1592 | <a class="label" href="#tag-User">User</a> | |
1593 | <!----> | |
1594 | </div> | |
1595 | <!-- </div> --> | |
1596 | <!-- </section> --> | |
1597 | <h2 class="operation-title"> | |
1598 | <span class="operation-name"> | |
1599 | <span class="operation-name">GET</span> | |
1600 | <span class="operation-path">/users</span> | |
1601 | </span> | |
1602 | </h2> | |
1603 | <div class="doc-row"> | |
ab0ee6a1 C |
1604 | <div class="doc-copy"> |
1605 | <section class="swagger-request-params"> | |
1606 | <div class="prop-row prop-group"> | |
1607 | <div class="prop-name"> | |
1608 | <div class="prop-title">start</div> | |
228e84aa C |
1609 | <div class="prop-subtitle"> in query </div> |
1610 | <div class="prop-subtitle"> | |
1611 | <span class="json-property-type">number</span> | |
1612 | <span class="json-property-range" title="Value limits"></span> | |
1613 | </div> | |
ab0ee6a1 C |
1614 | </div> |
1615 | <div class="prop-value"> | |
1616 | <p>starting page</p> | |
1617 | </div> | |
1618 | </div> | |
ab0ee6a1 C |
1619 | <div class="prop-row prop-group"> |
1620 | <div class="prop-name"> | |
1621 | <div class="prop-title">stop</div> | |
228e84aa C |
1622 | <div class="prop-subtitle"> in query </div> |
1623 | <div class="prop-subtitle"> | |
1624 | <span class="json-property-type">number</span> | |
1625 | <span class="json-property-range" title="Value limits"></span> | |
1626 | </div> | |
ab0ee6a1 C |
1627 | </div> |
1628 | <div class="prop-value"> | |
f209b32a | 1629 | <p>stopping page</p> |
ab0ee6a1 C |
1630 | </div> |
1631 | </div> | |
ab0ee6a1 C |
1632 | <div class="prop-row prop-group"> |
1633 | <div class="prop-name"> | |
1634 | <div class="prop-title">sort</div> | |
228e84aa C |
1635 | <div class="prop-subtitle"> in query </div> |
1636 | <div class="prop-subtitle"> | |
1637 | <span class="json-property-type">number</span> | |
1638 | <span class="json-property-range" title="Value limits"></span> | |
1639 | </div> | |
ab0ee6a1 C |
1640 | </div> |
1641 | <div class="prop-value"> | |
1642 | <p>sorting</p> | |
1643 | </div> | |
1644 | </div> | |
ab0ee6a1 C |
1645 | </section> |
1646 | </div> | |
5e1c08eb C |
1647 | <div class="doc-examples"></div> |
1648 | </div> | |
1649 | <div class="doc-row"> | |
1650 | <div class="doc-copy"> | |
1651 | <section class="swagger-responses"> | |
1652 | <div class="prop-row prop-group"> | |
1653 | <div class="prop-name"> | |
1654 | <div class="prop-title">200 OK</div> | |
1655 | <div class="prop-ref"> | |
1656 | <span class="json-schema-ref-array"> | |
1657 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
1658 | </span> | |
1659 | </div> | |
1660 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1661 | </div> | |
1662 | <div class="prop-value"> | |
1663 | <p>successful operation</p> | |
1664 | </div> | |
1665 | </div> | |
228e84aa C |
1666 | <div class="prop-row prop-inner"> |
1667 | <div class="prop-name">type</div> | |
1668 | <div class="prop-value"> | |
1669 | <span class="json-property-type"> | |
1670 | <span class="json-schema-ref-array"> | |
1671 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
1672 | </span> | |
1673 | </span> | |
1674 | <span class="json-property-range" title="Value limits"></span> | |
1675 | </div> | |
1676 | </div> | |
5e1c08eb C |
1677 | </section> |
1678 | </div> | |
1679 | <div class="doc-examples"> | |
1680 | <h5>Response Content-Types: | |
1681 | <span>application/json</span> | |
1682 | </h5> | |
1683 | <section> | |
1684 | <h5>Response Example | |
1685 | <span>(200 OK)</span> | |
1686 | </h5> | |
1687 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
1688 | { | |
1689 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1690 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
1691 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1692 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
1693 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
1694 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
1695 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
1696 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1697 | <span class="hljs-attr">"account"</span>: { | |
1698 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1699 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1700 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1701 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1702 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1703 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1704 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1705 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1706 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1707 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1708 | <span class="hljs-attr">"avatar"</span>: { | |
1709 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1710 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1711 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1712 | } | |
1713 | }, | |
1714 | <span class="hljs-attr">"videoChannels"</span>: [ | |
1715 | { | |
1716 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1717 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
1718 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
cc918ac3 C |
1719 | <span class="hljs-attr">"ownerAccount"</span>: { |
1720 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5e1c08eb | 1721 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
cc918ac3 | 1722 | } |
5e1c08eb C |
1723 | } |
1724 | ] | |
1725 | } | |
1726 | ] | |
1727 | </code></pre> | |
1728 | <!-- </div> --> | |
1729 | </section> | |
1730 | </div> | |
1731 | </div> | |
94ff4c23 C |
1732 | <div class="doc-row"> |
1733 | <div class="doc-copy"> | |
1734 | <section class="swagger-request-security"> | |
1735 | <table class="table"> | |
1736 | <thead> | |
1737 | <tr> | |
1738 | <th class="swagger-request-security-schema"></th> | |
1739 | <th class="swagger-request-security-scopes"></th> | |
1740 | </tr> | |
1741 | </thead> | |
1742 | <tbody> | |
1743 | <tr> | |
1744 | <td> | |
1745 | <a href="#security-definition-OAuth2">OAuth2</a> | |
1746 | </td> | |
1747 | <td> </td> | |
1748 | </tr> | |
1749 | </tbody> | |
1750 | </table> | |
1751 | </section> | |
1752 | </div> | |
1753 | </div> | |
5e1c08eb C |
1754 | </div> |
1755 | <div id="operation--users--id--delete" class="operation panel" data-traverse-target="operation--users--id--delete"> | |
1756 | <!-- <section class="operation-tags row"> --> | |
1757 | <!-- <div class="doc-copy"> --> | |
1758 | <div class="operation-tags"> | |
1759 | <a class="label" href="#tag-User">User</a> | |
1760 | <!----> | |
1761 | </div> | |
1762 | <!-- </div> --> | |
1763 | <!-- </section> --> | |
1764 | <h2 class="operation-title"> | |
1765 | <span class="operation-name"> | |
1766 | <span class="operation-name">DELETE</span> | |
1767 | <span class="operation-path">/users/{id}</span> | |
1768 | </span> | |
1769 | </h2> | |
1770 | <div class="doc-row"> | |
1771 | <div class="doc-copy"> | |
1772 | <section class="swagger-request-params"> | |
1773 | <div class="prop-row prop-group"> | |
1774 | <div class="prop-name"> | |
1775 | <div class="prop-title">id</div> | |
1776 | <span class="json-property-required"></span> | |
228e84aa C |
1777 | <div class="prop-subtitle"> in path </div> |
1778 | <div class="prop-subtitle"> | |
1779 | <span class="json-property-type">string</span> | |
1780 | <span class="json-property-range" title="Value limits"></span> | |
1781 | </div> | |
5e1c08eb C |
1782 | </div> |
1783 | <div class="prop-value"> | |
1784 | <p>The user id </p> | |
1785 | </div> | |
1786 | </div> | |
5e1c08eb C |
1787 | </section> |
1788 | </div> | |
1789 | <div class="doc-examples"></div> | |
1790 | </div> | |
1791 | <div class="doc-row"> | |
1792 | <div class="doc-copy"> | |
1793 | <section class="swagger-responses"> | |
1794 | <div class="prop-row prop-group"> | |
1795 | <div class="prop-name"> | |
1796 | <div class="prop-title">204 No Content</div> | |
1797 | </div> | |
1798 | <div class="prop-value"> | |
1799 | <p>successful operation</p> | |
1800 | </div> | |
1801 | </div> | |
1802 | </section> | |
1803 | </div> | |
1804 | <div class="doc-examples"> | |
1805 | <h5>Response Content-Types: | |
1806 | <span>application/json</span> | |
1807 | </h5> | |
1808 | </div> | |
1809 | </div> | |
94ff4c23 C |
1810 | <div class="doc-row"> |
1811 | <div class="doc-copy"> | |
1812 | <section class="swagger-request-security"> | |
1813 | <table class="table"> | |
1814 | <thead> | |
1815 | <tr> | |
1816 | <th class="swagger-request-security-schema"></th> | |
1817 | <th class="swagger-request-security-scopes"></th> | |
1818 | </tr> | |
1819 | </thead> | |
1820 | <tbody> | |
1821 | <tr> | |
1822 | <td> | |
1823 | <a href="#security-definition-OAuth2">OAuth2</a> | |
1824 | </td> | |
1825 | <td> </td> | |
1826 | </tr> | |
1827 | </tbody> | |
1828 | </table> | |
1829 | </section> | |
1830 | </div> | |
1831 | </div> | |
5e1c08eb C |
1832 | </div> |
1833 | <div id="operation--users--id--get" class="operation panel" data-traverse-target="operation--users--id--get"> | |
1834 | <!-- <section class="operation-tags row"> --> | |
1835 | <!-- <div class="doc-copy"> --> | |
1836 | <div class="operation-tags"> | |
1837 | <a class="label" href="#tag-User">User</a> | |
1838 | <!----> | |
1839 | </div> | |
1840 | <!-- </div> --> | |
1841 | <!-- </section> --> | |
1842 | <h2 class="operation-title"> | |
1843 | <span class="operation-name"> | |
1844 | <span class="operation-name">GET</span> | |
1845 | <span class="operation-path">/users/{id}</span> | |
1846 | </span> | |
1847 | </h2> | |
1848 | <div class="doc-row"> | |
1849 | <div class="doc-copy"> | |
1850 | <section class="swagger-request-params"> | |
1851 | <div class="prop-row prop-group"> | |
1852 | <div class="prop-name"> | |
1853 | <div class="prop-title">id</div> | |
1854 | <span class="json-property-required"></span> | |
228e84aa C |
1855 | <div class="prop-subtitle"> in path </div> |
1856 | <div class="prop-subtitle"> | |
1857 | <span class="json-property-type">string</span> | |
1858 | <span class="json-property-range" title="Value limits"></span> | |
1859 | </div> | |
5e1c08eb C |
1860 | </div> |
1861 | <div class="prop-value"> | |
1862 | <p>The user id </p> | |
1863 | </div> | |
1864 | </div> | |
5e1c08eb C |
1865 | </section> |
1866 | </div> | |
1867 | <div class="doc-examples"></div> | |
1868 | </div> | |
1869 | <div class="doc-row"> | |
1870 | <div class="doc-copy"> | |
1871 | <section class="swagger-responses"> | |
1872 | <div class="prop-row prop-group"> | |
1873 | <div class="prop-name"> | |
1874 | <div class="prop-title">200 OK</div> | |
1875 | <div class="prop-ref"> | |
1876 | <span class=""> | |
1877 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
1878 | </span> | |
1879 | </div> | |
1880 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
1881 | </div> | |
1882 | <div class="prop-value"> | |
1883 | <p>successful operation</p> | |
1884 | </div> | |
1885 | </div> | |
1886 | </section> | |
1887 | </div> | |
1888 | <div class="doc-examples"> | |
1889 | <h5>Response Content-Types: | |
1890 | <span>application/json</span> | |
1891 | </h5> | |
1892 | <section> | |
1893 | <h5>Response Example | |
1894 | <span>(200 OK)</span> | |
1895 | </h5> | |
1896 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
1897 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1898 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
1899 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
1900 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
1901 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
1902 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
1903 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
1904 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1905 | <span class="hljs-attr">"account"</span>: { | |
1906 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1907 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
1908 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
1909 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
1910 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
1911 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
1912 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
1913 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
1914 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1915 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
1916 | <span class="hljs-attr">"avatar"</span>: { | |
1917 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
1918 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
1919 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
1920 | } | |
1921 | }, | |
1922 | <span class="hljs-attr">"videoChannels"</span>: [ | |
1923 | { | |
1924 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
1925 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
1926 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
cc918ac3 C |
1927 | <span class="hljs-attr">"ownerAccount"</span>: { |
1928 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5e1c08eb | 1929 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
cc918ac3 | 1930 | } |
5e1c08eb C |
1931 | } |
1932 | ] | |
1933 | } | |
1934 | </code></pre> | |
1935 | <!-- </div> --> | |
1936 | </section> | |
1937 | </div> | |
1938 | </div> | |
94ff4c23 C |
1939 | <div class="doc-row"> |
1940 | <div class="doc-copy"> | |
1941 | <section class="swagger-request-security"> | |
1942 | <table class="table"> | |
1943 | <thead> | |
1944 | <tr> | |
1945 | <th class="swagger-request-security-schema"></th> | |
1946 | <th class="swagger-request-security-scopes"></th> | |
1947 | </tr> | |
1948 | </thead> | |
1949 | <tbody> | |
1950 | <tr> | |
1951 | <td> | |
1952 | <a href="#security-definition-OAuth2">OAuth2</a> | |
1953 | </td> | |
1954 | <td> </td> | |
1955 | </tr> | |
1956 | </tbody> | |
1957 | </table> | |
1958 | </section> | |
1959 | </div> | |
1960 | </div> | |
5e1c08eb C |
1961 | </div> |
1962 | <div id="operation--users--id--put" class="operation panel" data-traverse-target="operation--users--id--put"> | |
1963 | <!-- <section class="operation-tags row"> --> | |
1964 | <!-- <div class="doc-copy"> --> | |
1965 | <div class="operation-tags"> | |
1966 | <a class="label" href="#tag-User">User</a> | |
1967 | <!----> | |
1968 | </div> | |
1969 | <!-- </div> --> | |
1970 | <!-- </section> --> | |
1971 | <h2 class="operation-title"> | |
1972 | <span class="operation-name"> | |
1973 | <span class="operation-name">PUT</span> | |
1974 | <span class="operation-path">/users/{id}</span> | |
1975 | </span> | |
1976 | </h2> | |
1977 | <div class="doc-row"> | |
1978 | <div class="doc-copy"> | |
1979 | <section class="swagger-request-body"> | |
1980 | <div class="prop-row"> | |
1981 | <div class="prop-name"> | |
1982 | <div class="swagger-request-model"> | |
1983 | <span class=""> | |
1984 | <a class="json-schema-ref" href="#/definitions/UpdateUser">UpdateUser</a> | |
1985 | </span> | |
1986 | </div> | |
1987 | </div> | |
1988 | <div class="prop-value columns small-6"> | |
228e84aa C |
1989 | <!-- <div class="swagger-request-description"> --> |
1990 | <p>undefined</p> | |
5e1c08eb C |
1991 | <!-- </div> --> |
1992 | </div> | |
1993 | </div> | |
1994 | </section> | |
1995 | <section class="swagger-request-params"> | |
1996 | <div class="prop-row prop-group"> | |
1997 | <div class="prop-name"> | |
1998 | <div class="prop-title">id</div> | |
1999 | <span class="json-property-required"></span> | |
228e84aa C |
2000 | <div class="prop-subtitle"> in path </div> |
2001 | <div class="prop-subtitle"> | |
2002 | <span class="json-property-type">string</span> | |
2003 | <span class="json-property-range" title="Value limits"></span> | |
2004 | </div> | |
5e1c08eb C |
2005 | </div> |
2006 | <div class="prop-value"> | |
2007 | <p>The user id </p> | |
2008 | </div> | |
2009 | </div> | |
5e1c08eb C |
2010 | </section> |
2011 | </div> | |
2012 | <div class="doc-examples"> | |
2013 | <section> | |
2014 | <h5>Request Content-Types: | |
2015 | <span>application/json</span> | |
2016 | </h5> | |
2017 | <h5>Request Example</h5> | |
2018 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
2019 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
2020 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
2021 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
2022 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
2023 | } | |
2024 | </code></pre> | |
2025 | <!-- </div> --> | |
2026 | </section> | |
2027 | </div> | |
2028 | </div> | |
2029 | <div class="doc-row"> | |
2030 | <div class="doc-copy"> | |
2031 | <section class="swagger-responses"> | |
2032 | <div class="prop-row prop-group"> | |
2033 | <div class="prop-name"> | |
2034 | <div class="prop-title">204 No Content</div> | |
2035 | </div> | |
2036 | <div class="prop-value"> | |
2037 | <p>successful operation</p> | |
2038 | </div> | |
2039 | </div> | |
2040 | </section> | |
2041 | </div> | |
2042 | <div class="doc-examples"> | |
2043 | <h5>Response Content-Types: | |
2044 | <span>application/json</span> | |
2045 | </h5> | |
2046 | </div> | |
2047 | </div> | |
94ff4c23 C |
2048 | <div class="doc-row"> |
2049 | <div class="doc-copy"> | |
2050 | <section class="swagger-request-security"> | |
2051 | <table class="table"> | |
2052 | <thead> | |
2053 | <tr> | |
2054 | <th class="swagger-request-security-schema"></th> | |
2055 | <th class="swagger-request-security-scopes"></th> | |
2056 | </tr> | |
2057 | </thead> | |
2058 | <tbody> | |
2059 | <tr> | |
2060 | <td> | |
2061 | <a href="#security-definition-OAuth2">OAuth2</a> | |
2062 | </td> | |
2063 | <td> </td> | |
2064 | </tr> | |
2065 | </tbody> | |
2066 | </table> | |
2067 | </section> | |
2068 | </div> | |
2069 | </div> | |
5e1c08eb C |
2070 | </div> |
2071 | <div id="operation--users-me-get" class="operation panel" data-traverse-target="operation--users-me-get"> | |
2072 | <!-- <section class="operation-tags row"> --> | |
2073 | <!-- <div class="doc-copy"> --> | |
2074 | <div class="operation-tags"> | |
2075 | <a class="label" href="#tag-User">User</a> | |
2076 | <!----> | |
2077 | </div> | |
2078 | <!-- </div> --> | |
2079 | <!-- </section> --> | |
2080 | <h2 class="operation-title"> | |
2081 | <span class="operation-name"> | |
2082 | <span class="operation-name">GET</span> | |
2083 | <span class="operation-path">/users/me</span> | |
2084 | </span> | |
2085 | </h2> | |
2086 | <div class="doc-row"> | |
2087 | <div class="doc-copy"> </div> | |
2088 | <div class="doc-examples"></div> | |
2089 | </div> | |
2090 | <div class="doc-row"> | |
2091 | <div class="doc-copy"> | |
2092 | <section class="swagger-responses"> | |
2093 | <div class="prop-row prop-group"> | |
2094 | <div class="prop-name"> | |
2095 | <div class="prop-title">200 OK</div> | |
2096 | <div class="prop-ref"> | |
2097 | <span class="json-schema-ref-array"> | |
2098 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
2099 | </span> | |
2100 | </div> | |
2101 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2102 | </div> | |
2103 | <div class="prop-value"> | |
2104 | <p>successful operation</p> | |
2105 | </div> | |
2106 | </div> | |
228e84aa C |
2107 | <div class="prop-row prop-inner"> |
2108 | <div class="prop-name">type</div> | |
2109 | <div class="prop-value"> | |
2110 | <span class="json-property-type"> | |
2111 | <span class="json-schema-ref-array"> | |
2112 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
2113 | </span> | |
2114 | </span> | |
2115 | <span class="json-property-range" title="Value limits"></span> | |
2116 | </div> | |
2117 | </div> | |
5e1c08eb C |
2118 | </section> |
2119 | </div> | |
2120 | <div class="doc-examples"> | |
2121 | <h5>Response Content-Types: | |
2122 | <span>application/json</span> | |
2123 | </h5> | |
2124 | <section> | |
2125 | <h5>Response Example | |
2126 | <span>(200 OK)</span> | |
2127 | </h5> | |
2128 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2129 | { | |
2130 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2131 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
2132 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
2133 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
2134 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
2135 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
2136 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
2137 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
2138 | <span class="hljs-attr">"account"</span>: { | |
2139 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
2140 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2141 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
2142 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
2143 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
2144 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
2145 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
2146 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
2147 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
2148 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
2149 | <span class="hljs-attr">"avatar"</span>: { | |
2150 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
2151 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
2152 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
2153 | } | |
2154 | }, | |
2155 | <span class="hljs-attr">"videoChannels"</span>: [ | |
2156 | { | |
2157 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
2158 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
2159 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
cc918ac3 C |
2160 | <span class="hljs-attr">"ownerAccount"</span>: { |
2161 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5e1c08eb | 2162 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
cc918ac3 | 2163 | } |
5e1c08eb C |
2164 | } |
2165 | ] | |
2166 | } | |
2167 | ] | |
2168 | </code></pre> | |
2169 | <!-- </div> --> | |
2170 | </section> | |
2171 | </div> | |
2172 | </div> | |
94ff4c23 C |
2173 | <div class="doc-row"> |
2174 | <div class="doc-copy"> | |
2175 | <section class="swagger-request-security"> | |
2176 | <table class="table"> | |
2177 | <thead> | |
2178 | <tr> | |
2179 | <th class="swagger-request-security-schema"></th> | |
2180 | <th class="swagger-request-security-scopes"></th> | |
2181 | </tr> | |
2182 | </thead> | |
2183 | <tbody> | |
2184 | <tr> | |
2185 | <td> | |
2186 | <a href="#security-definition-OAuth2">OAuth2</a> | |
2187 | </td> | |
2188 | <td> </td> | |
2189 | </tr> | |
2190 | </tbody> | |
2191 | </table> | |
2192 | </section> | |
2193 | </div> | |
2194 | </div> | |
5e1c08eb C |
2195 | </div> |
2196 | <div id="operation--users-me-put" class="operation panel" data-traverse-target="operation--users-me-put"> | |
2197 | <!-- <section class="operation-tags row"> --> | |
2198 | <!-- <div class="doc-copy"> --> | |
2199 | <div class="operation-tags"> | |
2200 | <a class="label" href="#tag-User">User</a> | |
2201 | <!----> | |
2202 | </div> | |
2203 | <!-- </div> --> | |
2204 | <!-- </section> --> | |
2205 | <h2 class="operation-title"> | |
2206 | <span class="operation-name"> | |
2207 | <span class="operation-name">PUT</span> | |
2208 | <span class="operation-path">/users/me</span> | |
2209 | </span> | |
2210 | </h2> | |
2211 | <div class="doc-row"> | |
2212 | <div class="doc-copy"> | |
2213 | <section class="swagger-request-body"> | |
2214 | <div class="prop-row"> | |
2215 | <div class="prop-name"> | |
2216 | <div class="swagger-request-model"> | |
2217 | <span class=""> | |
2218 | <a class="json-schema-ref" href="#/definitions/UpdateMe">UpdateMe</a> | |
2219 | </span> | |
2220 | </div> | |
2221 | </div> | |
2222 | <div class="prop-value columns small-6"> | |
228e84aa C |
2223 | <!-- <div class="swagger-request-description"> --> |
2224 | <p>undefined</p> | |
5e1c08eb C |
2225 | <!-- </div> --> |
2226 | </div> | |
2227 | </div> | |
2228 | </section> | |
2229 | </div> | |
2230 | <div class="doc-examples"> | |
2231 | <section> | |
2232 | <h5>Request Content-Types: | |
2233 | <span>application/json</span> | |
2234 | </h5> | |
2235 | <h5>Request Example</h5> | |
2236 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
2237 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
2238 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
2239 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>, | |
2240 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span> | |
2241 | } | |
2242 | </code></pre> | |
2243 | <!-- </div> --> | |
2244 | </section> | |
2245 | </div> | |
2246 | </div> | |
2247 | <div class="doc-row"> | |
2248 | <div class="doc-copy"> | |
2249 | <section class="swagger-responses"> | |
2250 | <div class="prop-row prop-group"> | |
2251 | <div class="prop-name"> | |
2252 | <div class="prop-title">204 No Content</div> | |
2253 | </div> | |
2254 | <div class="prop-value"> | |
2255 | <p>successful operation</p> | |
2256 | </div> | |
2257 | </div> | |
2258 | </section> | |
2259 | </div> | |
2260 | <div class="doc-examples"> | |
2261 | <h5>Response Content-Types: | |
2262 | <span>application/json</span> | |
2263 | </h5> | |
2264 | </div> | |
2265 | </div> | |
94ff4c23 C |
2266 | <div class="doc-row"> |
2267 | <div class="doc-copy"> | |
2268 | <section class="swagger-request-security"> | |
2269 | <table class="table"> | |
2270 | <thead> | |
2271 | <tr> | |
2272 | <th class="swagger-request-security-schema"></th> | |
2273 | <th class="swagger-request-security-scopes"></th> | |
2274 | </tr> | |
2275 | </thead> | |
2276 | <tbody> | |
2277 | <tr> | |
2278 | <td> | |
2279 | <a href="#security-definition-OAuth2">OAuth2</a> | |
2280 | </td> | |
2281 | <td> </td> | |
2282 | </tr> | |
2283 | </tbody> | |
2284 | </table> | |
2285 | </section> | |
2286 | </div> | |
2287 | </div> | |
5e1c08eb C |
2288 | </div> |
2289 | <div id="operation--users-me-video-quota-used-get" class="operation panel" data-traverse-target="operation--users-me-video-quota-used-get"> | |
2290 | <!-- <section class="operation-tags row"> --> | |
2291 | <!-- <div class="doc-copy"> --> | |
2292 | <div class="operation-tags"> | |
2293 | <a class="label" href="#tag-User">User</a> | |
2294 | <!----> | |
2295 | </div> | |
2296 | <!-- </div> --> | |
2297 | <!-- </section> --> | |
2298 | <h2 class="operation-title"> | |
2299 | <span class="operation-name"> | |
2300 | <span class="operation-name">GET</span> | |
2301 | <span class="operation-path">/users/me/video-quota-used</span> | |
2302 | </span> | |
2303 | </h2> | |
2304 | <div class="doc-row"> | |
2305 | <div class="doc-copy"> </div> | |
2306 | <div class="doc-examples"></div> | |
2307 | </div> | |
2308 | <div class="doc-row"> | |
2309 | <div class="doc-copy"> | |
2310 | <section class="swagger-responses"> | |
2311 | <div class="prop-row prop-group"> | |
2312 | <div class="prop-name"> | |
2313 | <div class="prop-title">200 OK</div> | |
2314 | <div class="prop-ref"></div> | |
2315 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2316 | </div> | |
2317 | <div class="prop-value"> | |
2318 | <p>successful operation</p> | |
2319 | </div> | |
2320 | </div> | |
228e84aa C |
2321 | <div class="prop-row prop-inner"> |
2322 | <div class="prop-name">type</div> | |
2323 | <div class="prop-value"> | |
2324 | <span class="json-property-type">number</span> | |
2325 | <span class="json-property-range" title="Value limits"></span> | |
2326 | </div> | |
2327 | </div> | |
5e1c08eb C |
2328 | </section> |
2329 | </div> | |
2330 | <div class="doc-examples"> | |
2331 | <h5>Response Content-Types: | |
2332 | <span>application/json</span> | |
2333 | </h5> | |
2334 | <section> | |
2335 | <h5>Response Example | |
2336 | <span>(200 OK)</span> | |
2337 | </h5> | |
2338 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"number"</span> | |
2339 | </code></pre> | |
2340 | <!-- </div> --> | |
2341 | </section> | |
2342 | </div> | |
2343 | </div> | |
94ff4c23 C |
2344 | <div class="doc-row"> |
2345 | <div class="doc-copy"> | |
2346 | <section class="swagger-request-security"> | |
2347 | <table class="table"> | |
2348 | <thead> | |
2349 | <tr> | |
2350 | <th class="swagger-request-security-schema"></th> | |
2351 | <th class="swagger-request-security-scopes"></th> | |
2352 | </tr> | |
2353 | </thead> | |
2354 | <tbody> | |
2355 | <tr> | |
2356 | <td> | |
2357 | <a href="#security-definition-OAuth2">OAuth2</a> | |
2358 | </td> | |
2359 | <td> </td> | |
2360 | </tr> | |
2361 | </tbody> | |
2362 | </table> | |
2363 | </section> | |
2364 | </div> | |
2365 | </div> | |
5e1c08eb C |
2366 | </div> |
2367 | <div id="operation--users-me-videos--videoId--rating-get" class="operation panel" data-traverse-target="operation--users-me-videos--videoId--rating-get"> | |
2368 | <!-- <section class="operation-tags row"> --> | |
2369 | <!-- <div class="doc-copy"> --> | |
2370 | <div class="operation-tags"> | |
2371 | <a class="label" href="#tag-User">User</a> | |
2372 | <!----> | |
2373 | </div> | |
2374 | <!-- </div> --> | |
2375 | <!-- </section> --> | |
2376 | <h2 class="operation-title"> | |
2377 | <span class="operation-name"> | |
2378 | <span class="operation-name">GET</span> | |
2379 | <span class="operation-path">/users/me/videos/{videoId}/rating</span> | |
2380 | </span> | |
2381 | </h2> | |
2382 | <div class="doc-row"> | |
2383 | <div class="doc-copy"> | |
2384 | <section class="swagger-request-params"> | |
2385 | <div class="prop-row prop-group"> | |
2386 | <div class="prop-name"> | |
2387 | <div class="prop-title">videoId</div> | |
2388 | <span class="json-property-required"></span> | |
228e84aa C |
2389 | <div class="prop-subtitle"> in path </div> |
2390 | <div class="prop-subtitle"> | |
2391 | <span class="json-property-type">string</span> | |
2392 | <span class="json-property-range" title="Value limits"></span> | |
2393 | </div> | |
5e1c08eb C |
2394 | </div> |
2395 | <div class="prop-value"> | |
2396 | <p>The video id </p> | |
2397 | </div> | |
2398 | </div> | |
5e1c08eb C |
2399 | </section> |
2400 | </div> | |
2401 | <div class="doc-examples"></div> | |
2402 | </div> | |
2403 | <div class="doc-row"> | |
2404 | <div class="doc-copy"> | |
2405 | <section class="swagger-responses"> | |
2406 | <div class="prop-row prop-group"> | |
2407 | <div class="prop-name"> | |
2408 | <div class="prop-title">200 OK</div> | |
2409 | <div class="prop-ref"> | |
2410 | <span class=""> | |
2411 | <a class="json-schema-ref" href="#/definitions/GetMeVideoRating">GetMeVideoRating</a> | |
2412 | </span> | |
2413 | </div> | |
2414 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2415 | </div> | |
2416 | <div class="prop-value"> | |
2417 | <p>successful operation</p> | |
2418 | </div> | |
2419 | </div> | |
2420 | </section> | |
2421 | </div> | |
2422 | <div class="doc-examples"> | |
2423 | <h5>Response Content-Types: | |
2424 | <span>application/json</span> | |
2425 | </h5> | |
2426 | <section> | |
2427 | <h5>Response Example | |
2428 | <span>(200 OK)</span> | |
2429 | </h5> | |
2430 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
2431 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
2432 | <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span> | |
2433 | } | |
2434 | </code></pre> | |
2435 | <!-- </div> --> | |
2436 | </section> | |
2437 | </div> | |
2438 | </div> | |
94ff4c23 C |
2439 | <div class="doc-row"> |
2440 | <div class="doc-copy"> | |
2441 | <section class="swagger-request-security"> | |
2442 | <table class="table"> | |
2443 | <thead> | |
2444 | <tr> | |
2445 | <th class="swagger-request-security-schema"></th> | |
2446 | <th class="swagger-request-security-scopes"></th> | |
2447 | </tr> | |
2448 | </thead> | |
2449 | <tbody> | |
2450 | <tr> | |
2451 | <td> | |
2452 | <a href="#security-definition-OAuth2">OAuth2</a> | |
2453 | </td> | |
2454 | <td> </td> | |
2455 | </tr> | |
2456 | </tbody> | |
2457 | </table> | |
2458 | </section> | |
2459 | </div> | |
2460 | </div> | |
5e1c08eb C |
2461 | </div> |
2462 | <div id="operation--users-me-videos-get" class="operation panel" data-traverse-target="operation--users-me-videos-get"> | |
2463 | <!-- <section class="operation-tags row"> --> | |
2464 | <!-- <div class="doc-copy"> --> | |
2465 | <div class="operation-tags"> | |
2466 | <a class="label" href="#tag-User">User</a> | |
2467 | <!----> | |
2468 | </div> | |
2469 | <!-- </div> --> | |
2470 | <!-- </section> --> | |
2471 | <h2 class="operation-title"> | |
2472 | <span class="operation-name"> | |
2473 | <span class="operation-name">GET</span> | |
2474 | <span class="operation-path">/users/me/videos</span> | |
2475 | </span> | |
2476 | </h2> | |
2477 | <div class="doc-row"> | |
ab0ee6a1 C |
2478 | <div class="doc-copy"> |
2479 | <section class="swagger-request-params"> | |
2480 | <div class="prop-row prop-group"> | |
2481 | <div class="prop-name"> | |
2482 | <div class="prop-title">start</div> | |
228e84aa C |
2483 | <div class="prop-subtitle"> in query </div> |
2484 | <div class="prop-subtitle"> | |
2485 | <span class="json-property-type">number</span> | |
2486 | <span class="json-property-range" title="Value limits"></span> | |
2487 | </div> | |
ab0ee6a1 C |
2488 | </div> |
2489 | <div class="prop-value"> | |
2490 | <p>starting page</p> | |
2491 | </div> | |
2492 | </div> | |
ab0ee6a1 C |
2493 | <div class="prop-row prop-group"> |
2494 | <div class="prop-name"> | |
2495 | <div class="prop-title">stop</div> | |
228e84aa C |
2496 | <div class="prop-subtitle"> in query </div> |
2497 | <div class="prop-subtitle"> | |
2498 | <span class="json-property-type">number</span> | |
2499 | <span class="json-property-range" title="Value limits"></span> | |
2500 | </div> | |
ab0ee6a1 C |
2501 | </div> |
2502 | <div class="prop-value"> | |
f209b32a | 2503 | <p>stopping page</p> |
ab0ee6a1 C |
2504 | </div> |
2505 | </div> | |
ab0ee6a1 C |
2506 | <div class="prop-row prop-group"> |
2507 | <div class="prop-name"> | |
2508 | <div class="prop-title">sort</div> | |
228e84aa C |
2509 | <div class="prop-subtitle"> in query </div> |
2510 | <div class="prop-subtitle"> | |
2511 | <span class="json-property-type">number</span> | |
2512 | <span class="json-property-range" title="Value limits"></span> | |
2513 | </div> | |
ab0ee6a1 C |
2514 | </div> |
2515 | <div class="prop-value"> | |
2516 | <p>sorting</p> | |
2517 | </div> | |
2518 | </div> | |
ab0ee6a1 C |
2519 | </section> |
2520 | </div> | |
5e1c08eb C |
2521 | <div class="doc-examples"></div> |
2522 | </div> | |
2523 | <div class="doc-row"> | |
2524 | <div class="doc-copy"> | |
2525 | <section class="swagger-responses"> | |
2526 | <div class="prop-row prop-group"> | |
2527 | <div class="prop-name"> | |
2528 | <div class="prop-title">200 OK</div> | |
2529 | <div class="prop-ref"> | |
2530 | <span class="json-schema-ref-array"> | |
2531 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
2532 | </span> | |
2533 | </div> | |
2534 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2535 | </div> | |
2536 | <div class="prop-value"> | |
2537 | <p>successful operation</p> | |
2538 | </div> | |
2539 | </div> | |
228e84aa C |
2540 | <div class="prop-row prop-inner"> |
2541 | <div class="prop-name">type</div> | |
2542 | <div class="prop-value"> | |
2543 | <span class="json-property-type"> | |
2544 | <span class="json-schema-ref-array"> | |
2545 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
2546 | </span> | |
2547 | </span> | |
2548 | <span class="json-property-range" title="Value limits"></span> | |
2549 | </div> | |
2550 | </div> | |
5e1c08eb C |
2551 | </section> |
2552 | </div> | |
2553 | <div class="doc-examples"> | |
2554 | <h5>Response Content-Types: | |
2555 | <span>application/json</span> | |
2556 | </h5> | |
2557 | <section> | |
2558 | <h5>Response Example | |
2559 | <span>(200 OK)</span> | |
2560 | </h5> | |
2561 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2562 | { | |
2563 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2564 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb | 2565 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
61b66b36 | 2566 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, |
5e1c08eb | 2567 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, |
5d00a3d7 C |
2568 | <span class="hljs-attr">"category"</span>: { |
2569 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2570 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2571 | }, | |
2572 | <span class="hljs-attr">"licence"</span>: { | |
2573 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2574 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2575 | }, | |
2576 | <span class="hljs-attr">"language"</span>: { | |
48dce1c9 | 2577 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
5d00a3d7 C |
2578 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
2579 | }, | |
61b66b36 | 2580 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
5e1c08eb C |
2581 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
2582 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
2583 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
2584 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
2585 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
2586 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
2587 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
2588 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
2589 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
2590 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
61b66b36 C |
2591 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, |
2592 | <span class="hljs-attr">"account"</span>: { | |
2593 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
2594 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
2595 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
2596 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
2597 | <span class="hljs-attr">"avatar"</span>: { | |
2598 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
2599 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
2600 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
2601 | } | |
2602 | } | |
5e1c08eb C |
2603 | } |
2604 | ] | |
2605 | </code></pre> | |
2606 | <!-- </div> --> | |
2607 | </section> | |
2608 | </div> | |
2609 | </div> | |
94ff4c23 C |
2610 | <div class="doc-row"> |
2611 | <div class="doc-copy"> | |
2612 | <section class="swagger-request-security"> | |
2613 | <table class="table"> | |
2614 | <thead> | |
2615 | <tr> | |
2616 | <th class="swagger-request-security-schema"></th> | |
2617 | <th class="swagger-request-security-scopes"></th> | |
2618 | </tr> | |
2619 | </thead> | |
2620 | <tbody> | |
2621 | <tr> | |
2622 | <td> | |
2623 | <a href="#security-definition-OAuth2">OAuth2</a> | |
2624 | </td> | |
2625 | <td> </td> | |
2626 | </tr> | |
2627 | </tbody> | |
2628 | </table> | |
2629 | </section> | |
2630 | </div> | |
2631 | </div> | |
5e1c08eb C |
2632 | </div> |
2633 | <div id="operation--users-register-post" class="operation panel" data-traverse-target="operation--users-register-post"> | |
2634 | <!-- <section class="operation-tags row"> --> | |
2635 | <!-- <div class="doc-copy"> --> | |
2636 | <div class="operation-tags"> | |
2637 | <a class="label" href="#tag-User">User</a> | |
2638 | <!----> | |
2639 | </div> | |
2640 | <!-- </div> --> | |
2641 | <!-- </section> --> | |
2642 | <h2 class="operation-title"> | |
2643 | <span class="operation-name"> | |
2644 | <span class="operation-name">POST</span> | |
2645 | <span class="operation-path">/users/register</span> | |
2646 | </span> | |
2647 | </h2> | |
2648 | <div class="doc-row"> | |
2649 | <div class="doc-copy"> | |
2650 | <section class="swagger-request-body"> | |
2651 | <div class="prop-row"> | |
2652 | <div class="prop-name"> | |
2653 | <div class="swagger-request-model"> | |
2654 | <span class=""> | |
2655 | <a class="json-schema-ref" href="#/definitions/RegisterUser">RegisterUser</a> | |
2656 | </span> | |
2657 | </div> | |
2658 | </div> | |
2659 | <div class="prop-value columns small-6"> | |
228e84aa C |
2660 | <!-- <div class="swagger-request-description"> --> |
2661 | <p>undefined</p> | |
5e1c08eb C |
2662 | <!-- </div> --> |
2663 | </div> | |
2664 | </div> | |
2665 | </section> | |
2666 | </div> | |
2667 | <div class="doc-examples"> | |
2668 | <section> | |
2669 | <h5>Request Content-Types: | |
2670 | <span>application/json</span> | |
2671 | </h5> | |
2672 | <h5>Request Example</h5> | |
2673 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
2674 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
2675 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
2676 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span> | |
2677 | } | |
2678 | </code></pre> | |
2679 | <!-- </div> --> | |
2680 | </section> | |
2681 | </div> | |
2682 | </div> | |
2683 | <div class="doc-row"> | |
2684 | <div class="doc-copy"> | |
2685 | <section class="swagger-responses"> | |
2686 | <div class="prop-row prop-group"> | |
2687 | <div class="prop-name"> | |
2688 | <div class="prop-title">204 No Content</div> | |
2689 | </div> | |
2690 | <div class="prop-value"> | |
2691 | <p>successful operation</p> | |
2692 | </div> | |
2693 | </div> | |
2694 | </section> | |
2695 | </div> | |
2696 | <div class="doc-examples"> | |
2697 | <h5>Response Content-Types: | |
2698 | <span>application/json</span> | |
2699 | </h5> | |
2700 | </div> | |
2701 | </div> | |
2702 | </div> | |
2703 | <div id="operation--users-me-avatar-pick-post" class="operation panel" data-traverse-target="operation--users-me-avatar-pick-post"> | |
2704 | <!-- <section class="operation-tags row"> --> | |
2705 | <!-- <div class="doc-copy"> --> | |
2706 | <div class="operation-tags"> | |
2707 | <a class="label" href="#tag-User">User</a> | |
2708 | <!----> | |
2709 | </div> | |
2710 | <!-- </div> --> | |
2711 | <!-- </section> --> | |
2712 | <h2 class="operation-title"> | |
2713 | <span class="operation-name"> | |
2714 | <span class="operation-name">POST</span> | |
2715 | <span class="operation-path">/users/me/avatar/pick</span> | |
2716 | </span> | |
2717 | </h2> | |
2718 | <div class="doc-row"> | |
2719 | <div class="doc-copy"> | |
2720 | <section class="swagger-request-params"> | |
2721 | <div class="prop-row prop-group"> | |
2722 | <div class="prop-name"> | |
2723 | <div class="prop-title">avatarfile</div> | |
228e84aa C |
2724 | <div class="prop-subtitle"> in formData </div> |
2725 | <div class="prop-subtitle"> | |
2726 | <span class="json-property-type">file</span> | |
2727 | <span class="json-property-range" title="Value limits"></span> | |
2728 | </div> | |
5e1c08eb C |
2729 | </div> |
2730 | <div class="prop-value"> | |
2731 | <p>The file to upload.</p> | |
2732 | </div> | |
2733 | </div> | |
5e1c08eb C |
2734 | </section> |
2735 | </div> | |
2736 | <div class="doc-examples"></div> | |
2737 | </div> | |
2738 | <div class="doc-row"> | |
2739 | <div class="doc-copy"> | |
2740 | <section class="swagger-responses"> | |
2741 | <div class="prop-row prop-group"> | |
2742 | <div class="prop-name"> | |
2743 | <div class="prop-title">200 OK</div> | |
2744 | <div class="prop-ref"> | |
2745 | <span class=""> | |
2746 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | |
2747 | </span> | |
2748 | </div> | |
2749 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2750 | </div> | |
2751 | <div class="prop-value"> | |
2752 | <p>successful operation</p> | |
2753 | </div> | |
2754 | </div> | |
2755 | </section> | |
2756 | </div> | |
2757 | <div class="doc-examples"> | |
2758 | <h5>Response Content-Types: | |
2759 | <span>application/json</span> | |
2760 | </h5> | |
2761 | <section> | |
2762 | <h5>Response Example | |
2763 | <span>(200 OK)</span> | |
2764 | </h5> | |
2765 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
2766 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
2767 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
2768 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
2769 | } | |
2770 | </code></pre> | |
2771 | <!-- </div> --> | |
2772 | </section> | |
2773 | </div> | |
ab0ee6a1 | 2774 | </div> |
94ff4c23 C |
2775 | <div class="doc-row"> |
2776 | <div class="doc-copy"> | |
2777 | <section class="swagger-request-security"> | |
2778 | <table class="table"> | |
2779 | <thead> | |
2780 | <tr> | |
2781 | <th class="swagger-request-security-schema"></th> | |
2782 | <th class="swagger-request-security-scopes"></th> | |
2783 | </tr> | |
2784 | </thead> | |
2785 | <tbody> | |
2786 | <tr> | |
2787 | <td> | |
2788 | <a href="#security-definition-OAuth2">OAuth2</a> | |
2789 | </td> | |
2790 | <td> </td> | |
2791 | </tr> | |
2792 | </tbody> | |
2793 | </table> | |
2794 | </section> | |
2795 | </div> | |
2796 | </div> | |
ab0ee6a1 C |
2797 | </div> |
2798 | <h1 id="tag-Video" class="swagger-summary-tag" data-traverse-target="tag-Video">Video</h1> | |
2799 | <div id="operation--videos-get" class="operation panel" data-traverse-target="operation--videos-get"> | |
2800 | <!-- <section class="operation-tags row"> --> | |
2801 | <!-- <div class="doc-copy"> --> | |
2802 | <div class="operation-tags"> | |
2803 | <a class="label" href="#tag-Video">Video</a> | |
2804 | <!----> | |
2805 | </div> | |
2806 | <!-- </div> --> | |
2807 | <!-- </section> --> | |
2808 | <h2 class="operation-title"> | |
2809 | <span class="operation-name"> | |
2810 | <span class="operation-name">GET</span> | |
2811 | <span class="operation-path">/videos</span> | |
2812 | </span> | |
2813 | </h2> | |
2814 | <div class="doc-row"> | |
2815 | <div class="doc-copy"> | |
2816 | <section class="swagger-request-params"> | |
2817 | <div class="prop-row prop-group"> | |
2818 | <div class="prop-name"> | |
2819 | <div class="prop-title">start</div> | |
228e84aa C |
2820 | <div class="prop-subtitle"> in query </div> |
2821 | <div class="prop-subtitle"> | |
2822 | <span class="json-property-type">number</span> | |
2823 | <span class="json-property-range" title="Value limits"></span> | |
2824 | </div> | |
ab0ee6a1 C |
2825 | </div> |
2826 | <div class="prop-value"> | |
2827 | <p>starting page</p> | |
2828 | </div> | |
2829 | </div> | |
ab0ee6a1 C |
2830 | <div class="prop-row prop-group"> |
2831 | <div class="prop-name"> | |
2832 | <div class="prop-title">stop</div> | |
228e84aa C |
2833 | <div class="prop-subtitle"> in query </div> |
2834 | <div class="prop-subtitle"> | |
2835 | <span class="json-property-type">number</span> | |
2836 | <span class="json-property-range" title="Value limits"></span> | |
2837 | </div> | |
ab0ee6a1 C |
2838 | </div> |
2839 | <div class="prop-value"> | |
f209b32a | 2840 | <p>stopping page</p> |
ab0ee6a1 C |
2841 | </div> |
2842 | </div> | |
ab0ee6a1 C |
2843 | <div class="prop-row prop-group"> |
2844 | <div class="prop-name"> | |
2845 | <div class="prop-title">sort</div> | |
228e84aa C |
2846 | <div class="prop-subtitle"> in query </div> |
2847 | <div class="prop-subtitle"> | |
2848 | <span class="json-property-type">number</span> | |
2849 | <span class="json-property-range" title="Value limits"></span> | |
2850 | </div> | |
ab0ee6a1 C |
2851 | </div> |
2852 | <div class="prop-value"> | |
2853 | <p>sorting</p> | |
2854 | </div> | |
2855 | </div> | |
ab0ee6a1 C |
2856 | </section> |
2857 | </div> | |
5e1c08eb C |
2858 | <div class="doc-examples"></div> |
2859 | </div> | |
2860 | <div class="doc-row"> | |
2861 | <div class="doc-copy"> | |
2862 | <section class="swagger-responses"> | |
2863 | <div class="prop-row prop-group"> | |
2864 | <div class="prop-name"> | |
2865 | <div class="prop-title">200 OK</div> | |
2866 | <div class="prop-ref"> | |
2867 | <span class="json-schema-ref-array"> | |
2868 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
2869 | </span> | |
2870 | </div> | |
2871 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2872 | </div> | |
2873 | <div class="prop-value"> | |
2874 | <p>successful operation</p> | |
2875 | </div> | |
2876 | </div> | |
228e84aa C |
2877 | <div class="prop-row prop-inner"> |
2878 | <div class="prop-name">type</div> | |
2879 | <div class="prop-value"> | |
2880 | <span class="json-property-type"> | |
2881 | <span class="json-schema-ref-array"> | |
2882 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
2883 | </span> | |
2884 | </span> | |
2885 | <span class="json-property-range" title="Value limits"></span> | |
2886 | </div> | |
2887 | </div> | |
5e1c08eb C |
2888 | </section> |
2889 | </div> | |
2890 | <div class="doc-examples"> | |
2891 | <h5>Response Content-Types: | |
2892 | <span>application/json</span> | |
2893 | </h5> | |
2894 | <section> | |
2895 | <h5>Response Example | |
2896 | <span>(200 OK)</span> | |
2897 | </h5> | |
2898 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2899 | { | |
2900 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2901 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb | 2902 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
61b66b36 | 2903 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, |
5e1c08eb | 2904 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, |
5d00a3d7 C |
2905 | <span class="hljs-attr">"category"</span>: { |
2906 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2907 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2908 | }, | |
2909 | <span class="hljs-attr">"licence"</span>: { | |
2910 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
2911 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
2912 | }, | |
2913 | <span class="hljs-attr">"language"</span>: { | |
48dce1c9 | 2914 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
5d00a3d7 C |
2915 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
2916 | }, | |
61b66b36 | 2917 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
5e1c08eb C |
2918 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
2919 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
2920 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
2921 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
2922 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
2923 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
2924 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
2925 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
2926 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
2927 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
61b66b36 C |
2928 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, |
2929 | <span class="hljs-attr">"account"</span>: { | |
2930 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
2931 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
2932 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
2933 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
2934 | <span class="hljs-attr">"avatar"</span>: { | |
2935 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
2936 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
2937 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
2938 | } | |
2939 | } | |
5e1c08eb C |
2940 | } |
2941 | ] | |
2942 | </code></pre> | |
2943 | <!-- </div> --> | |
2944 | </section> | |
2945 | </div> | |
2946 | </div> | |
2947 | </div> | |
ab0ee6a1 | 2948 | <div id="operation--videos-categories-get" class="operation panel" data-traverse-target="operation--videos-categories-get"> |
5e1c08eb C |
2949 | <!-- <section class="operation-tags row"> --> |
2950 | <!-- <div class="doc-copy"> --> | |
2951 | <div class="operation-tags"> | |
2952 | <a class="label" href="#tag-Video">Video</a> | |
2953 | <!----> | |
2954 | </div> | |
2955 | <!-- </div> --> | |
2956 | <!-- </section> --> | |
2957 | <h2 class="operation-title"> | |
2958 | <span class="operation-name"> | |
2959 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 2960 | <span class="operation-path">/videos/categories</span> |
5e1c08eb C |
2961 | </span> |
2962 | </h2> | |
2963 | <div class="doc-row"> | |
2964 | <div class="doc-copy"> </div> | |
2965 | <div class="doc-examples"></div> | |
2966 | </div> | |
2967 | <div class="doc-row"> | |
2968 | <div class="doc-copy"> | |
2969 | <section class="swagger-responses"> | |
2970 | <div class="prop-row prop-group"> | |
2971 | <div class="prop-name"> | |
2972 | <div class="prop-title">200 OK</div> | |
2973 | <div class="prop-ref"></div> | |
2974 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
2975 | </div> | |
2976 | <div class="prop-value"> | |
2977 | <p>successful operation</p> | |
2978 | </div> | |
2979 | </div> | |
228e84aa C |
2980 | <div class="prop-row prop-inner"> |
2981 | <div class="prop-name">type</div> | |
2982 | <div class="prop-value"> | |
2983 | <span class="json-property-type">string[]</span> | |
2984 | <span class="json-property-range" title="Value limits"></span> | |
2985 | </div> | |
2986 | </div> | |
5e1c08eb C |
2987 | </section> |
2988 | </div> | |
2989 | <div class="doc-examples"> | |
2990 | <h5>Response Content-Types: | |
2991 | <span>application/json</span> | |
2992 | </h5> | |
2993 | <section> | |
2994 | <h5>Response Example | |
2995 | <span>(200 OK)</span> | |
2996 | </h5> | |
2997 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
2998 | <span class="hljs-string">"string"</span> | |
2999 | ] | |
3000 | </code></pre> | |
3001 | <!-- </div> --> | |
3002 | </section> | |
3003 | </div> | |
3004 | </div> | |
3005 | </div> | |
ab0ee6a1 | 3006 | <div id="operation--videos-licences-get" class="operation panel" data-traverse-target="operation--videos-licences-get"> |
5e1c08eb C |
3007 | <!-- <section class="operation-tags row"> --> |
3008 | <!-- <div class="doc-copy"> --> | |
3009 | <div class="operation-tags"> | |
3010 | <a class="label" href="#tag-Video">Video</a> | |
3011 | <!----> | |
3012 | </div> | |
3013 | <!-- </div> --> | |
3014 | <!-- </section> --> | |
3015 | <h2 class="operation-title"> | |
3016 | <span class="operation-name"> | |
3017 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 3018 | <span class="operation-path">/videos/licences</span> |
5e1c08eb C |
3019 | </span> |
3020 | </h2> | |
3021 | <div class="doc-row"> | |
3022 | <div class="doc-copy"> </div> | |
3023 | <div class="doc-examples"></div> | |
3024 | </div> | |
3025 | <div class="doc-row"> | |
3026 | <div class="doc-copy"> | |
3027 | <section class="swagger-responses"> | |
3028 | <div class="prop-row prop-group"> | |
3029 | <div class="prop-name"> | |
3030 | <div class="prop-title">200 OK</div> | |
3031 | <div class="prop-ref"></div> | |
3032 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3033 | </div> | |
3034 | <div class="prop-value"> | |
3035 | <p>successful operation</p> | |
3036 | </div> | |
3037 | </div> | |
228e84aa C |
3038 | <div class="prop-row prop-inner"> |
3039 | <div class="prop-name">type</div> | |
3040 | <div class="prop-value"> | |
3041 | <span class="json-property-type">string[]</span> | |
3042 | <span class="json-property-range" title="Value limits"></span> | |
3043 | </div> | |
3044 | </div> | |
5e1c08eb C |
3045 | </section> |
3046 | </div> | |
3047 | <div class="doc-examples"> | |
3048 | <h5>Response Content-Types: | |
3049 | <span>application/json</span> | |
3050 | </h5> | |
3051 | <section> | |
3052 | <h5>Response Example | |
3053 | <span>(200 OK)</span> | |
3054 | </h5> | |
3055 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
3056 | <span class="hljs-string">"string"</span> | |
3057 | ] | |
3058 | </code></pre> | |
3059 | <!-- </div> --> | |
3060 | </section> | |
3061 | </div> | |
3062 | </div> | |
3063 | </div> | |
ab0ee6a1 | 3064 | <div id="operation--videos-languages-get" class="operation panel" data-traverse-target="operation--videos-languages-get"> |
5e1c08eb C |
3065 | <!-- <section class="operation-tags row"> --> |
3066 | <!-- <div class="doc-copy"> --> | |
3067 | <div class="operation-tags"> | |
3068 | <a class="label" href="#tag-Video">Video</a> | |
3069 | <!----> | |
3070 | </div> | |
3071 | <!-- </div> --> | |
3072 | <!-- </section> --> | |
3073 | <h2 class="operation-title"> | |
3074 | <span class="operation-name"> | |
3075 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 3076 | <span class="operation-path">/videos/languages</span> |
5e1c08eb C |
3077 | </span> |
3078 | </h2> | |
3079 | <div class="doc-row"> | |
3080 | <div class="doc-copy"> </div> | |
3081 | <div class="doc-examples"></div> | |
3082 | </div> | |
3083 | <div class="doc-row"> | |
3084 | <div class="doc-copy"> | |
3085 | <section class="swagger-responses"> | |
3086 | <div class="prop-row prop-group"> | |
3087 | <div class="prop-name"> | |
3088 | <div class="prop-title">200 OK</div> | |
3089 | <div class="prop-ref"></div> | |
3090 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3091 | </div> | |
3092 | <div class="prop-value"> | |
3093 | <p>successful operation</p> | |
3094 | </div> | |
3095 | </div> | |
228e84aa C |
3096 | <div class="prop-row prop-inner"> |
3097 | <div class="prop-name">type</div> | |
3098 | <div class="prop-value"> | |
3099 | <span class="json-property-type">string[]</span> | |
3100 | <span class="json-property-range" title="Value limits"></span> | |
3101 | </div> | |
3102 | </div> | |
5e1c08eb C |
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 | <span class="hljs-string">"string"</span> | |
3115 | ] | |
3116 | </code></pre> | |
3117 | <!-- </div> --> | |
3118 | </section> | |
3119 | </div> | |
3120 | </div> | |
3121 | </div> | |
ab0ee6a1 | 3122 | <div id="operation--videos-privacies-get" class="operation panel" data-traverse-target="operation--videos-privacies-get"> |
5e1c08eb C |
3123 | <!-- <section class="operation-tags row"> --> |
3124 | <!-- <div class="doc-copy"> --> | |
3125 | <div class="operation-tags"> | |
3126 | <a class="label" href="#tag-Video">Video</a> | |
3127 | <!----> | |
3128 | </div> | |
3129 | <!-- </div> --> | |
3130 | <!-- </section> --> | |
3131 | <h2 class="operation-title"> | |
3132 | <span class="operation-name"> | |
3133 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 3134 | <span class="operation-path">/videos/privacies</span> |
5e1c08eb C |
3135 | </span> |
3136 | </h2> | |
3137 | <div class="doc-row"> | |
3138 | <div class="doc-copy"> </div> | |
3139 | <div class="doc-examples"></div> | |
3140 | </div> | |
3141 | <div class="doc-row"> | |
3142 | <div class="doc-copy"> | |
3143 | <section class="swagger-responses"> | |
3144 | <div class="prop-row prop-group"> | |
3145 | <div class="prop-name"> | |
3146 | <div class="prop-title">200 OK</div> | |
3147 | <div class="prop-ref"></div> | |
3148 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3149 | </div> | |
3150 | <div class="prop-value"> | |
3151 | <p>successful operation</p> | |
3152 | </div> | |
3153 | </div> | |
228e84aa C |
3154 | <div class="prop-row prop-inner"> |
3155 | <div class="prop-name">type</div> | |
3156 | <div class="prop-value"> | |
3157 | <span class="json-property-type">string[]</span> | |
3158 | <span class="json-property-range" title="Value limits"></span> | |
3159 | </div> | |
3160 | </div> | |
5e1c08eb C |
3161 | </section> |
3162 | </div> | |
3163 | <div class="doc-examples"> | |
3164 | <h5>Response Content-Types: | |
3165 | <span>application/json</span> | |
3166 | </h5> | |
3167 | <section> | |
3168 | <h5>Response Example | |
3169 | <span>(200 OK)</span> | |
3170 | </h5> | |
3171 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
3172 | <span class="hljs-string">"string"</span> | |
3173 | ] | |
3174 | </code></pre> | |
3175 | <!-- </div> --> | |
3176 | </section> | |
3177 | </div> | |
3178 | </div> | |
3179 | </div> | |
ab0ee6a1 | 3180 | <div id="operation--videos-search-get" class="operation panel" data-traverse-target="operation--videos-search-get"> |
5e1c08eb C |
3181 | <!-- <section class="operation-tags row"> --> |
3182 | <!-- <div class="doc-copy"> --> | |
3183 | <div class="operation-tags"> | |
3184 | <a class="label" href="#tag-Video">Video</a> | |
3185 | <!----> | |
3186 | </div> | |
3187 | <!-- </div> --> | |
3188 | <!-- </section> --> | |
3189 | <h2 class="operation-title"> | |
3190 | <span class="operation-name"> | |
3191 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 3192 | <span class="operation-path">/videos/search</span> |
5e1c08eb C |
3193 | </span> |
3194 | </h2> | |
3195 | <div class="doc-row"> | |
ab0ee6a1 C |
3196 | <div class="doc-copy"> |
3197 | <section class="swagger-request-params"> | |
3198 | <div class="prop-row prop-group"> | |
3199 | <div class="prop-name"> | |
3200 | <div class="prop-title">start</div> | |
228e84aa C |
3201 | <div class="prop-subtitle"> in query </div> |
3202 | <div class="prop-subtitle"> | |
3203 | <span class="json-property-type">number</span> | |
3204 | <span class="json-property-range" title="Value limits"></span> | |
3205 | </div> | |
ab0ee6a1 C |
3206 | </div> |
3207 | <div class="prop-value"> | |
3208 | <p>starting page</p> | |
3209 | </div> | |
3210 | </div> | |
ab0ee6a1 C |
3211 | <div class="prop-row prop-group"> |
3212 | <div class="prop-name"> | |
3213 | <div class="prop-title">stop</div> | |
228e84aa C |
3214 | <div class="prop-subtitle"> in query </div> |
3215 | <div class="prop-subtitle"> | |
3216 | <span class="json-property-type">number</span> | |
3217 | <span class="json-property-range" title="Value limits"></span> | |
3218 | </div> | |
ab0ee6a1 C |
3219 | </div> |
3220 | <div class="prop-value"> | |
f209b32a | 3221 | <p>stopping page</p> |
ab0ee6a1 C |
3222 | </div> |
3223 | </div> | |
ab0ee6a1 C |
3224 | <div class="prop-row prop-group"> |
3225 | <div class="prop-name"> | |
3226 | <div class="prop-title">sort</div> | |
228e84aa C |
3227 | <div class="prop-subtitle"> in query </div> |
3228 | <div class="prop-subtitle"> | |
3229 | <span class="json-property-type">number</span> | |
3230 | <span class="json-property-range" title="Value limits"></span> | |
3231 | </div> | |
ab0ee6a1 C |
3232 | </div> |
3233 | <div class="prop-value"> | |
3234 | <p>sorting</p> | |
3235 | </div> | |
3236 | </div> | |
ab0ee6a1 C |
3237 | </section> |
3238 | </div> | |
5e1c08eb C |
3239 | <div class="doc-examples"></div> |
3240 | </div> | |
3241 | <div class="doc-row"> | |
3242 | <div class="doc-copy"> | |
3243 | <section class="swagger-responses"> | |
3244 | <div class="prop-row prop-group"> | |
3245 | <div class="prop-name"> | |
3246 | <div class="prop-title">200 OK</div> | |
3247 | <div class="prop-ref"> | |
3248 | <span class="json-schema-ref-array"> | |
3249 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
3250 | </span> | |
3251 | </div> | |
3252 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3253 | </div> | |
3254 | <div class="prop-value"> | |
3255 | <p>successful operation</p> | |
3256 | </div> | |
3257 | </div> | |
228e84aa C |
3258 | <div class="prop-row prop-inner"> |
3259 | <div class="prop-name">type</div> | |
3260 | <div class="prop-value"> | |
3261 | <span class="json-property-type"> | |
3262 | <span class="json-schema-ref-array"> | |
3263 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
3264 | </span> | |
3265 | </span> | |
3266 | <span class="json-property-range" title="Value limits"></span> | |
3267 | </div> | |
3268 | </div> | |
5e1c08eb C |
3269 | </section> |
3270 | </div> | |
3271 | <div class="doc-examples"> | |
3272 | <h5>Response Content-Types: | |
3273 | <span>application/json</span> | |
3274 | </h5> | |
3275 | <section> | |
3276 | <h5>Response Example | |
3277 | <span>(200 OK)</span> | |
3278 | </h5> | |
3279 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
3280 | { | |
3281 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3282 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb | 3283 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
61b66b36 | 3284 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, |
5e1c08eb | 3285 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, |
5d00a3d7 C |
3286 | <span class="hljs-attr">"category"</span>: { |
3287 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3288 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
3289 | }, | |
3290 | <span class="hljs-attr">"licence"</span>: { | |
3291 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3292 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
3293 | }, | |
3294 | <span class="hljs-attr">"language"</span>: { | |
48dce1c9 | 3295 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
5d00a3d7 C |
3296 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
3297 | }, | |
61b66b36 | 3298 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
5e1c08eb C |
3299 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
3300 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
3301 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
3302 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
3303 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
3304 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
3305 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
3306 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
3307 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
3308 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
61b66b36 C |
3309 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, |
3310 | <span class="hljs-attr">"account"</span>: { | |
3311 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3312 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
3313 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
3314 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
3315 | <span class="hljs-attr">"avatar"</span>: { | |
3316 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
3317 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3318 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
3319 | } | |
3320 | } | |
5e1c08eb C |
3321 | } |
3322 | ] | |
3323 | </code></pre> | |
3324 | <!-- </div> --> | |
3325 | </section> | |
3326 | </div> | |
3327 | </div> | |
3328 | </div> | |
ab0ee6a1 | 3329 | <div id="operation--videos--id--put" class="operation panel" data-traverse-target="operation--videos--id--put"> |
5e1c08eb C |
3330 | <!-- <section class="operation-tags row"> --> |
3331 | <!-- <div class="doc-copy"> --> | |
3332 | <div class="operation-tags"> | |
3333 | <a class="label" href="#tag-Video">Video</a> | |
3334 | <!----> | |
3335 | </div> | |
3336 | <!-- </div> --> | |
3337 | <!-- </section> --> | |
3338 | <h2 class="operation-title"> | |
3339 | <span class="operation-name"> | |
3340 | <span class="operation-name">PUT</span> | |
ab0ee6a1 | 3341 | <span class="operation-path">/videos/{id}</span> |
5e1c08eb C |
3342 | </span> |
3343 | </h2> | |
3344 | <div class="doc-row"> | |
3345 | <div class="doc-copy"> | |
3346 | <section class="swagger-request-params"> | |
3347 | <div class="prop-row prop-group"> | |
3348 | <div class="prop-name"> | |
3349 | <div class="prop-title">id</div> | |
3350 | <span class="json-property-required"></span> | |
228e84aa C |
3351 | <div class="prop-subtitle"> in path </div> |
3352 | <div class="prop-subtitle"> | |
3353 | <span class="json-property-type">string</span> | |
3354 | <span class="json-property-range" title="Value limits"></span> | |
3355 | </div> | |
5e1c08eb C |
3356 | </div> |
3357 | <div class="prop-value"> | |
61b66b36 | 3358 | <p>The video id</p> |
5e1c08eb C |
3359 | </div> |
3360 | </div> | |
5e1c08eb C |
3361 | <div class="prop-row prop-group"> |
3362 | <div class="prop-name"> | |
61b66b36 | 3363 | <div class="prop-title">thumbnailfile</div> |
228e84aa C |
3364 | <div class="prop-subtitle"> in formData </div> |
3365 | <div class="prop-subtitle"> | |
3366 | <span class="json-property-type">file</span> | |
3367 | <span class="json-property-range" title="Value limits"></span> | |
3368 | </div> | |
5e1c08eb C |
3369 | </div> |
3370 | <div class="prop-value"> | |
61b66b36 | 3371 | <p>Video thumbnail file</p> |
5e1c08eb C |
3372 | </div> |
3373 | </div> | |
5e1c08eb C |
3374 | <div class="prop-row prop-group"> |
3375 | <div class="prop-name"> | |
61b66b36 | 3376 | <div class="prop-title">previewfile</div> |
228e84aa C |
3377 | <div class="prop-subtitle"> in formData </div> |
3378 | <div class="prop-subtitle"> | |
3379 | <span class="json-property-type">file</span> | |
3380 | <span class="json-property-range" title="Value limits"></span> | |
3381 | </div> | |
5e1c08eb C |
3382 | </div> |
3383 | <div class="prop-value"> | |
61b66b36 | 3384 | <p>Video preview file</p> |
5e1c08eb C |
3385 | </div> |
3386 | </div> | |
5e1c08eb C |
3387 | <div class="prop-row prop-group"> |
3388 | <div class="prop-name"> | |
61b66b36 | 3389 | <div class="prop-title">category</div> |
228e84aa C |
3390 | <div class="prop-subtitle"> in formData </div> |
3391 | <div class="prop-subtitle"> | |
3392 | <span class="json-property-type">number</span> | |
3393 | <span class="json-property-range" title="Value limits"></span> | |
3394 | </div> | |
5e1c08eb C |
3395 | </div> |
3396 | <div class="prop-value"> | |
61b66b36 | 3397 | <p>Video category</p> |
5e1c08eb C |
3398 | </div> |
3399 | </div> | |
5e1c08eb C |
3400 | <div class="prop-row prop-group"> |
3401 | <div class="prop-name"> | |
61b66b36 | 3402 | <div class="prop-title">licence</div> |
228e84aa C |
3403 | <div class="prop-subtitle"> in formData </div> |
3404 | <div class="prop-subtitle"> | |
3405 | <span class="json-property-type">number</span> | |
3406 | <span class="json-property-range" title="Value limits"></span> | |
3407 | </div> | |
5e1c08eb C |
3408 | </div> |
3409 | <div class="prop-value"> | |
61b66b36 | 3410 | <p>Video licence</p> |
5e1c08eb C |
3411 | </div> |
3412 | </div> | |
61b66b36 C |
3413 | <div class="prop-row prop-group"> |
3414 | <div class="prop-name"> | |
3415 | <div class="prop-title">language</div> | |
228e84aa C |
3416 | <div class="prop-subtitle"> in formData </div> |
3417 | <div class="prop-subtitle"> | |
48dce1c9 | 3418 | <span class="json-property-type">string</span> |
228e84aa C |
3419 | <span class="json-property-range" title="Value limits"></span> |
3420 | </div> | |
61b66b36 C |
3421 | </div> |
3422 | <div class="prop-value"> | |
3423 | <p>Video language</p> | |
3424 | </div> | |
3425 | </div> | |
61b66b36 C |
3426 | <div class="prop-row prop-group"> |
3427 | <div class="prop-name"> | |
3428 | <div class="prop-title">description</div> | |
228e84aa C |
3429 | <div class="prop-subtitle"> in formData </div> |
3430 | <div class="prop-subtitle"> | |
3431 | <span class="json-property-type">string</span> | |
3432 | <span class="json-property-range" title="Value limits"></span> | |
3433 | </div> | |
61b66b36 C |
3434 | </div> |
3435 | <div class="prop-value"> | |
3436 | <p>Video description</p> | |
3437 | </div> | |
3438 | </div> | |
2186386c C |
3439 | <div class="prop-row prop-group"> |
3440 | <div class="prop-name"> | |
3441 | <div class="prop-title">waitTranscoding</div> | |
3442 | <div class="prop-subtitle"> in formData </div> | |
3443 | <div class="prop-subtitle"> | |
3444 | <span class="json-property-type">boolean</span> | |
3445 | <span class="json-property-range" title="Value limits"></span> | |
3446 | </div> | |
3447 | </div> | |
3448 | <div class="prop-value"> | |
3449 | <p>Whether or not we wait transcoding before publish the video</p> | |
3450 | </div> | |
3451 | </div> | |
61b66b36 C |
3452 | <div class="prop-row prop-group"> |
3453 | <div class="prop-name"> | |
3454 | <div class="prop-title">support</div> | |
228e84aa C |
3455 | <div class="prop-subtitle"> in formData </div> |
3456 | <div class="prop-subtitle"> | |
3457 | <span class="json-property-type">string</span> | |
3458 | <span class="json-property-range" title="Value limits"></span> | |
3459 | </div> | |
61b66b36 C |
3460 | </div> |
3461 | <div class="prop-value"> | |
3462 | <p>Text describing how to support the video uploader</p> | |
3463 | </div> | |
3464 | </div> | |
61b66b36 C |
3465 | <div class="prop-row prop-group"> |
3466 | <div class="prop-name"> | |
3467 | <div class="prop-title">nsfw</div> | |
228e84aa C |
3468 | <div class="prop-subtitle"> in formData </div> |
3469 | <div class="prop-subtitle"> | |
3470 | <span class="json-property-type">boolean</span> | |
3471 | <span class="json-property-range" title="Value limits"></span> | |
3472 | </div> | |
61b66b36 C |
3473 | </div> |
3474 | <div class="prop-value"> | |
3475 | <p>Whether or not this video contains sensitive content</p> | |
3476 | </div> | |
3477 | </div> | |
61b66b36 C |
3478 | <div class="prop-row prop-group"> |
3479 | <div class="prop-name"> | |
3480 | <div class="prop-title">name</div> | |
228e84aa C |
3481 | <div class="prop-subtitle"> in formData </div> |
3482 | <div class="prop-subtitle"> | |
3483 | <span class="json-property-type">string</span> | |
3484 | <span class="json-property-range" title="Value limits"></span> | |
3485 | </div> | |
61b66b36 C |
3486 | </div> |
3487 | <div class="prop-value"> | |
3488 | <p>Video name</p> | |
3489 | </div> | |
3490 | </div> | |
61b66b36 C |
3491 | <div class="prop-row prop-group"> |
3492 | <div class="prop-name"> | |
3493 | <div class="prop-title">tags</div> | |
228e84aa C |
3494 | <div class="prop-subtitle"> in formData </div> |
3495 | <div class="prop-subtitle"> | |
3496 | <span class="json-property-type">string[]</span> | |
3497 | <span class="json-property-range" title="Value limits"></span> | |
3498 | </div> | |
61b66b36 C |
3499 | </div> |
3500 | <div class="prop-value"> | |
3501 | <p>Video tags</p> | |
3502 | </div> | |
3503 | </div> | |
61b66b36 C |
3504 | <div class="prop-row prop-group"> |
3505 | <div class="prop-name"> | |
3506 | <div class="prop-title">commentsEnabled</div> | |
228e84aa C |
3507 | <div class="prop-subtitle"> in formData </div> |
3508 | <div class="prop-subtitle"> | |
3509 | <span class="json-property-type">boolean</span> | |
3510 | <span class="json-property-range" title="Value limits"></span> | |
3511 | </div> | |
61b66b36 C |
3512 | </div> |
3513 | <div class="prop-value"> | |
3514 | <p>Enable or disable comments for this video</p> | |
3515 | </div> | |
3516 | </div> | |
61b66b36 C |
3517 | <div class="prop-row prop-group"> |
3518 | <div class="prop-name"> | |
3519 | <div class="prop-title">privacy</div> | |
228e84aa C |
3520 | <div class="prop-subtitle"> in formData </div> |
3521 | <div class="prop-subtitle"> | |
3522 | <span class="json-property-type">string</span> | |
3523 | <span class="json-property-enum" title="Possible values"> | |
3524 | <span class="json-property-enum-item">Public</span>, | |
3525 | <span class="json-property-enum-item">Unlisted</span> | |
3526 | </span> | |
3527 | <span class="json-property-range" title="Value limits"></span> | |
3528 | </div> | |
61b66b36 C |
3529 | </div> |
3530 | <div class="prop-value"> | |
3531 | <p>Video privacy</p> | |
3532 | </div> | |
3533 | </div> | |
bbe0f064 C |
3534 | <div class="prop-row prop-group"> |
3535 | <div class="prop-name"> | |
3536 | <div class="prop-title">scheduleUpdate</div> | |
3537 | <div class="prop-subtitle"> in formData </div> | |
3538 | <div class="prop-subtitle"> | |
3539 | <span class="json-property-type">[object Object]</span> | |
3540 | <span class="json-property-range" title="Value limits"></span> | |
3541 | </div> | |
3542 | </div> | |
3543 | <div class="prop-value"> | |
3544 | <p class="no-description">(no description)</p> | |
3545 | </div> | |
3546 | </div> | |
61b66b36 C |
3547 | </section> |
3548 | </div> | |
3549 | <div class="doc-examples"></div> | |
3550 | </div> | |
3551 | <div class="doc-row"> | |
3552 | <div class="doc-copy"> | |
3553 | <section class="swagger-responses"> | |
3554 | <div class="prop-row prop-group"> | |
3555 | <div class="prop-name"> | |
3556 | <div class="prop-title">200 OK</div> | |
3557 | <div class="prop-ref"> | |
3558 | <span class=""> | |
3559 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
3560 | </span> | |
3561 | </div> | |
3562 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3563 | </div> | |
3564 | <div class="prop-value"> | |
3565 | <p>successful operation</p> | |
3566 | </div> | |
3567 | </div> | |
3568 | </section> | |
3569 | </div> | |
3570 | <div class="doc-examples"> | |
3571 | <h5>Response Content-Types: | |
3572 | <span>application/json</span> | |
3573 | </h5> | |
3574 | <section> | |
3575 | <h5>Response Example | |
3576 | <span>(200 OK)</span> | |
3577 | </h5> | |
3578 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
3579 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3580 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
3581 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3582 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
3583 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3584 | <span class="hljs-attr">"category"</span>: { | |
3585 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3586 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
3587 | }, | |
3588 | <span class="hljs-attr">"licence"</span>: { | |
3589 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3590 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
3591 | }, | |
3592 | <span class="hljs-attr">"language"</span>: { | |
48dce1c9 | 3593 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
61b66b36 C |
3594 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
3595 | }, | |
3596 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
3597 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
3598 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
3599 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
3600 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3601 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
3602 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
3603 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
3604 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
3605 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
3606 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
3607 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
3608 | <span class="hljs-attr">"account"</span>: { | |
3609 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3610 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
3611 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
3612 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
3613 | <span class="hljs-attr">"avatar"</span>: { | |
3614 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
3615 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3616 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
3617 | } | |
3618 | } | |
3619 | } | |
3620 | </code></pre> | |
3621 | <!-- </div> --> | |
3622 | </section> | |
3623 | </div> | |
3624 | </div> | |
94ff4c23 C |
3625 | <div class="doc-row"> |
3626 | <div class="doc-copy"> | |
3627 | <section class="swagger-request-security"> | |
3628 | <table class="table"> | |
3629 | <thead> | |
3630 | <tr> | |
3631 | <th class="swagger-request-security-schema"></th> | |
3632 | <th class="swagger-request-security-scopes"></th> | |
3633 | </tr> | |
3634 | </thead> | |
3635 | <tbody> | |
3636 | <tr> | |
3637 | <td> | |
3638 | <a href="#security-definition-OAuth2">OAuth2</a> | |
3639 | </td> | |
3640 | <td> </td> | |
3641 | </tr> | |
3642 | </tbody> | |
3643 | </table> | |
3644 | </section> | |
3645 | </div> | |
3646 | </div> | |
61b66b36 C |
3647 | </div> |
3648 | <div id="operation--videos--id--get" class="operation panel" data-traverse-target="operation--videos--id--get"> | |
3649 | <!-- <section class="operation-tags row"> --> | |
3650 | <!-- <div class="doc-copy"> --> | |
3651 | <div class="operation-tags"> | |
3652 | <a class="label" href="#tag-Video">Video</a> | |
3653 | <!----> | |
3654 | </div> | |
3655 | <!-- </div> --> | |
3656 | <!-- </section> --> | |
3657 | <h2 class="operation-title"> | |
3658 | <span class="operation-name"> | |
3659 | <span class="operation-name">GET</span> | |
3660 | <span class="operation-path">/videos/{id}</span> | |
3661 | </span> | |
3662 | </h2> | |
3663 | <div class="doc-row"> | |
3664 | <div class="doc-copy"> | |
3665 | <section class="swagger-request-params"> | |
3666 | <div class="prop-row prop-group"> | |
3667 | <div class="prop-name"> | |
3668 | <div class="prop-title">id</div> | |
3669 | <span class="json-property-required"></span> | |
228e84aa C |
3670 | <div class="prop-subtitle"> in path </div> |
3671 | <div class="prop-subtitle"> | |
3672 | <span class="json-property-type">string</span> | |
3673 | <span class="json-property-range" title="Value limits"></span> | |
3674 | </div> | |
61b66b36 C |
3675 | </div> |
3676 | <div class="prop-value"> | |
3677 | <p>The video id </p> | |
3678 | </div> | |
3679 | </div> | |
61b66b36 C |
3680 | </section> |
3681 | </div> | |
3682 | <div class="doc-examples"></div> | |
3683 | </div> | |
3684 | <div class="doc-row"> | |
3685 | <div class="doc-copy"> | |
3686 | <section class="swagger-responses"> | |
3687 | <div class="prop-row prop-group"> | |
3688 | <div class="prop-name"> | |
3689 | <div class="prop-title">200 OK</div> | |
3690 | <div class="prop-ref"> | |
3691 | <span class=""> | |
3692 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
3693 | </span> | |
3694 | </div> | |
3695 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3696 | </div> | |
3697 | <div class="prop-value"> | |
3698 | <p>successful operation</p> | |
3699 | </div> | |
3700 | </div> | |
3701 | </section> | |
3702 | </div> | |
3703 | <div class="doc-examples"> | |
3704 | <h5>Response Content-Types: | |
3705 | <span>application/json</span> | |
3706 | </h5> | |
3707 | <section> | |
3708 | <h5>Response Example | |
3709 | <span>(200 OK)</span> | |
3710 | </h5> | |
3711 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
3712 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3713 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
3714 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3715 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
3716 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
3717 | <span class="hljs-attr">"category"</span>: { | |
3718 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3719 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
3720 | }, | |
3721 | <span class="hljs-attr">"licence"</span>: { | |
3722 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
3723 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
3724 | }, | |
3725 | <span class="hljs-attr">"language"</span>: { | |
48dce1c9 | 3726 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
61b66b36 C |
3727 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
3728 | }, | |
3729 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
3730 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
3731 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
3732 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
3733 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3734 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
3735 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
3736 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
3737 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
3738 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
3739 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
3740 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
3741 | <span class="hljs-attr">"account"</span>: { | |
3742 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
3743 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
3744 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
3745 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
3746 | <span class="hljs-attr">"avatar"</span>: { | |
3747 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
3748 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
3749 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
3750 | } | |
3751 | } | |
3752 | } | |
3753 | </code></pre> | |
3754 | <!-- </div> --> | |
3755 | </section> | |
3756 | </div> | |
3757 | </div> | |
3758 | </div> | |
3759 | <div id="operation--videos--id--delete" class="operation panel" data-traverse-target="operation--videos--id--delete"> | |
3760 | <!-- <section class="operation-tags row"> --> | |
3761 | <!-- <div class="doc-copy"> --> | |
3762 | <div class="operation-tags"> | |
3763 | <a class="label" href="#tag-Video">Video</a> | |
3764 | <!----> | |
3765 | </div> | |
3766 | <!-- </div> --> | |
3767 | <!-- </section> --> | |
3768 | <h2 class="operation-title"> | |
3769 | <span class="operation-name"> | |
3770 | <span class="operation-name">DELETE</span> | |
3771 | <span class="operation-path">/videos/{id}</span> | |
3772 | </span> | |
3773 | </h2> | |
3774 | <div class="doc-row"> | |
3775 | <div class="doc-copy"> | |
3776 | <section class="swagger-request-params"> | |
3777 | <div class="prop-row prop-group"> | |
3778 | <div class="prop-name"> | |
3779 | <div class="prop-title">id</div> | |
3780 | <span class="json-property-required"></span> | |
228e84aa C |
3781 | <div class="prop-subtitle"> in path </div> |
3782 | <div class="prop-subtitle"> | |
3783 | <span class="json-property-type">string</span> | |
3784 | <span class="json-property-range" title="Value limits"></span> | |
3785 | </div> | |
61b66b36 C |
3786 | </div> |
3787 | <div class="prop-value"> | |
3788 | <p>The video id </p> | |
3789 | </div> | |
3790 | </div> | |
61b66b36 C |
3791 | </section> |
3792 | </div> | |
3793 | <div class="doc-examples"></div> | |
3794 | </div> | |
3795 | <div class="doc-row"> | |
3796 | <div class="doc-copy"> | |
3797 | <section class="swagger-responses"> | |
3798 | <div class="prop-row prop-group"> | |
3799 | <div class="prop-name"> | |
3800 | <div class="prop-title">204 No Content</div> | |
3801 | </div> | |
3802 | <div class="prop-value"> | |
3803 | <p>successful operation</p> | |
3804 | </div> | |
3805 | </div> | |
3806 | </section> | |
3807 | </div> | |
3808 | <div class="doc-examples"> | |
3809 | <h5>Response Content-Types: | |
3810 | <span>application/json</span> | |
3811 | </h5> | |
3812 | </div> | |
3813 | </div> | |
94ff4c23 C |
3814 | <div class="doc-row"> |
3815 | <div class="doc-copy"> | |
3816 | <section class="swagger-request-security"> | |
3817 | <table class="table"> | |
3818 | <thead> | |
3819 | <tr> | |
3820 | <th class="swagger-request-security-schema"></th> | |
3821 | <th class="swagger-request-security-scopes"></th> | |
3822 | </tr> | |
3823 | </thead> | |
3824 | <tbody> | |
3825 | <tr> | |
3826 | <td> | |
3827 | <a href="#security-definition-OAuth2">OAuth2</a> | |
3828 | </td> | |
3829 | <td> </td> | |
3830 | </tr> | |
3831 | </tbody> | |
3832 | </table> | |
3833 | </section> | |
3834 | </div> | |
3835 | </div> | |
61b66b36 C |
3836 | </div> |
3837 | <div id="operation--videos--id--description-get" class="operation panel" data-traverse-target="operation--videos--id--description-get"> | |
3838 | <!-- <section class="operation-tags row"> --> | |
3839 | <!-- <div class="doc-copy"> --> | |
3840 | <div class="operation-tags"> | |
3841 | <a class="label" href="#tag-Video">Video</a> | |
3842 | <!----> | |
3843 | </div> | |
3844 | <!-- </div> --> | |
3845 | <!-- </section> --> | |
3846 | <h2 class="operation-title"> | |
3847 | <span class="operation-name"> | |
3848 | <span class="operation-name">GET</span> | |
3849 | <span class="operation-path">/videos/{id}/description</span> | |
3850 | </span> | |
3851 | </h2> | |
3852 | <div class="doc-row"> | |
3853 | <div class="doc-copy"> | |
3854 | <section class="swagger-request-params"> | |
3855 | <div class="prop-row prop-group"> | |
3856 | <div class="prop-name"> | |
3857 | <div class="prop-title">id</div> | |
3858 | <span class="json-property-required"></span> | |
228e84aa C |
3859 | <div class="prop-subtitle"> in path </div> |
3860 | <div class="prop-subtitle"> | |
3861 | <span class="json-property-type">string</span> | |
3862 | <span class="json-property-range" title="Value limits"></span> | |
3863 | </div> | |
61b66b36 C |
3864 | </div> |
3865 | <div class="prop-value"> | |
3866 | <p>The video id </p> | |
3867 | </div> | |
3868 | </div> | |
61b66b36 C |
3869 | </section> |
3870 | </div> | |
3871 | <div class="doc-examples"></div> | |
3872 | </div> | |
3873 | <div class="doc-row"> | |
3874 | <div class="doc-copy"> | |
3875 | <section class="swagger-responses"> | |
3876 | <div class="prop-row prop-group"> | |
3877 | <div class="prop-name"> | |
3878 | <div class="prop-title">200 OK</div> | |
3879 | <div class="prop-ref"></div> | |
3880 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
3881 | </div> | |
3882 | <div class="prop-value"> | |
3883 | <p>successful operation</p> | |
3884 | </div> | |
3885 | </div> | |
228e84aa C |
3886 | <div class="prop-row prop-inner"> |
3887 | <div class="prop-name">type</div> | |
3888 | <div class="prop-value"> | |
3889 | <span class="json-property-type">string</span> | |
3890 | <span class="json-property-range" title="Value limits"></span> | |
3891 | </div> | |
3892 | </div> | |
61b66b36 C |
3893 | </section> |
3894 | </div> | |
3895 | <div class="doc-examples"> | |
3896 | <h5>Response Content-Types: | |
3897 | <span>application/json</span> | |
3898 | </h5> | |
3899 | <section> | |
3900 | <h5>Response Example | |
3901 | <span>(200 OK)</span> | |
3902 | </h5> | |
3903 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"string"</span> | |
3904 | </code></pre> | |
3905 | <!-- </div> --> | |
3906 | </section> | |
3907 | </div> | |
3908 | </div> | |
3909 | </div> | |
3910 | <div id="operation--videos--id--views-post" class="operation panel" data-traverse-target="operation--videos--id--views-post"> | |
3911 | <!-- <section class="operation-tags row"> --> | |
3912 | <!-- <div class="doc-copy"> --> | |
3913 | <div class="operation-tags"> | |
3914 | <a class="label" href="#tag-Video">Video</a> | |
3915 | <!----> | |
3916 | </div> | |
3917 | <!-- </div> --> | |
3918 | <!-- </section> --> | |
3919 | <h2 class="operation-title"> | |
3920 | <span class="operation-name"> | |
3921 | <span class="operation-name">POST</span> | |
3922 | <span class="operation-path">/videos/{id}/views</span> | |
3923 | </span> | |
3924 | </h2> | |
3925 | <div class="doc-row"> | |
3926 | <div class="doc-copy"> | |
3927 | <section class="swagger-request-params"> | |
3928 | <div class="prop-row prop-group"> | |
3929 | <div class="prop-name"> | |
3930 | <div class="prop-title">id</div> | |
3931 | <span class="json-property-required"></span> | |
228e84aa C |
3932 | <div class="prop-subtitle"> in path </div> |
3933 | <div class="prop-subtitle"> | |
3934 | <span class="json-property-type">string</span> | |
3935 | <span class="json-property-range" title="Value limits"></span> | |
3936 | </div> | |
61b66b36 C |
3937 | </div> |
3938 | <div class="prop-value"> | |
3939 | <p>The video id </p> | |
3940 | </div> | |
3941 | </div> | |
5e1c08eb C |
3942 | </section> |
3943 | </div> | |
3944 | <div class="doc-examples"></div> | |
3945 | </div> | |
3946 | <div class="doc-row"> | |
3947 | <div class="doc-copy"> | |
3948 | <section class="swagger-responses"> | |
3949 | <div class="prop-row prop-group"> | |
3950 | <div class="prop-name"> | |
3951 | <div class="prop-title">204 No Content</div> | |
3952 | </div> | |
3953 | <div class="prop-value"> | |
3954 | <p>successful operation</p> | |
3955 | </div> | |
3956 | </div> | |
3957 | </section> | |
3958 | </div> | |
3959 | <div class="doc-examples"> | |
3960 | <h5>Response Content-Types: | |
3961 | <span>application/json</span> | |
3962 | </h5> | |
3963 | </div> | |
3964 | </div> | |
3965 | </div> | |
61b66b36 | 3966 | <div id="operation--videos-upload-post" class="operation panel" data-traverse-target="operation--videos-upload-post"> |
5e1c08eb C |
3967 | <!-- <section class="operation-tags row"> --> |
3968 | <!-- <div class="doc-copy"> --> | |
3969 | <div class="operation-tags"> | |
3970 | <a class="label" href="#tag-Video">Video</a> | |
3971 | <!----> | |
3972 | </div> | |
3973 | <!-- </div> --> | |
3974 | <!-- </section> --> | |
3975 | <h2 class="operation-title"> | |
3976 | <span class="operation-name"> | |
61b66b36 C |
3977 | <span class="operation-name">POST</span> |
3978 | <span class="operation-path">/videos/upload</span> | |
5e1c08eb C |
3979 | </span> |
3980 | </h2> | |
3981 | <div class="doc-row"> | |
3982 | <div class="doc-copy"> | |
3983 | <section class="swagger-request-params"> | |
3984 | <div class="prop-row prop-group"> | |
3985 | <div class="prop-name"> | |
61b66b36 C |
3986 | <div class="prop-title">videofile</div> |
3987 | <span class="json-property-required"></span> | |
228e84aa C |
3988 | <div class="prop-subtitle"> in formData </div> |
3989 | <div class="prop-subtitle"> | |
3990 | <span class="json-property-type">file</span> | |
3991 | <span class="json-property-range" title="Value limits"></span> | |
3992 | </div> | |
61b66b36 C |
3993 | </div> |
3994 | <div class="prop-value"> | |
3995 | <p>Video file</p> | |
3996 | </div> | |
3997 | </div> | |
61b66b36 C |
3998 | <div class="prop-row prop-group"> |
3999 | <div class="prop-name"> | |
4000 | <div class="prop-title">thumbnailfile</div> | |
4001 | <span class="json-property-required"></span> | |
228e84aa C |
4002 | <div class="prop-subtitle"> in formData </div> |
4003 | <div class="prop-subtitle"> | |
4004 | <span class="json-property-type">file</span> | |
4005 | <span class="json-property-range" title="Value limits"></span> | |
4006 | </div> | |
61b66b36 C |
4007 | </div> |
4008 | <div class="prop-value"> | |
4009 | <p>Video thumbnail file</p> | |
4010 | </div> | |
4011 | </div> | |
61b66b36 C |
4012 | <div class="prop-row prop-group"> |
4013 | <div class="prop-name"> | |
4014 | <div class="prop-title">previewfile</div> | |
4015 | <span class="json-property-required"></span> | |
228e84aa C |
4016 | <div class="prop-subtitle"> in formData </div> |
4017 | <div class="prop-subtitle"> | |
4018 | <span class="json-property-type">file</span> | |
4019 | <span class="json-property-range" title="Value limits"></span> | |
4020 | </div> | |
61b66b36 C |
4021 | </div> |
4022 | <div class="prop-value"> | |
4023 | <p>Video preview file</p> | |
4024 | </div> | |
4025 | </div> | |
61b66b36 C |
4026 | <div class="prop-row prop-group"> |
4027 | <div class="prop-name"> | |
4028 | <div class="prop-title">category</div> | |
228e84aa C |
4029 | <div class="prop-subtitle"> in formData </div> |
4030 | <div class="prop-subtitle"> | |
4031 | <span class="json-property-type">number</span> | |
4032 | <span class="json-property-range" title="Value limits"></span> | |
4033 | </div> | |
61b66b36 C |
4034 | </div> |
4035 | <div class="prop-value"> | |
4036 | <p>Video category</p> | |
4037 | </div> | |
4038 | </div> | |
2186386c C |
4039 | <div class="prop-row prop-group"> |
4040 | <div class="prop-name"> | |
4041 | <div class="prop-title">waitTranscoding</div> | |
4042 | <div class="prop-subtitle"> in formData </div> | |
4043 | <div class="prop-subtitle"> | |
4044 | <span class="json-property-type">boolean</span> | |
4045 | <span class="json-property-range" title="Value limits"></span> | |
4046 | </div> | |
4047 | </div> | |
4048 | <div class="prop-value"> | |
4049 | <p>Whether or not we wait transcoding before publish the video</p> | |
4050 | </div> | |
4051 | </div> | |
61b66b36 C |
4052 | <div class="prop-row prop-group"> |
4053 | <div class="prop-name"> | |
4054 | <div class="prop-title">licence</div> | |
228e84aa C |
4055 | <div class="prop-subtitle"> in formData </div> |
4056 | <div class="prop-subtitle"> | |
4057 | <span class="json-property-type">number</span> | |
4058 | <span class="json-property-range" title="Value limits"></span> | |
4059 | </div> | |
61b66b36 C |
4060 | </div> |
4061 | <div class="prop-value"> | |
4062 | <p>Video licence</p> | |
4063 | </div> | |
4064 | </div> | |
61b66b36 C |
4065 | <div class="prop-row prop-group"> |
4066 | <div class="prop-name"> | |
4067 | <div class="prop-title">language</div> | |
228e84aa C |
4068 | <div class="prop-subtitle"> in formData </div> |
4069 | <div class="prop-subtitle"> | |
48dce1c9 | 4070 | <span class="json-property-type">string</span> |
228e84aa C |
4071 | <span class="json-property-range" title="Value limits"></span> |
4072 | </div> | |
61b66b36 C |
4073 | </div> |
4074 | <div class="prop-value"> | |
4075 | <p>Video language</p> | |
4076 | </div> | |
4077 | </div> | |
61b66b36 C |
4078 | <div class="prop-row prop-group"> |
4079 | <div class="prop-name"> | |
4080 | <div class="prop-title">description</div> | |
228e84aa C |
4081 | <div class="prop-subtitle"> in formData </div> |
4082 | <div class="prop-subtitle"> | |
4083 | <span class="json-property-type">string</span> | |
4084 | <span class="json-property-range" title="Value limits"></span> | |
4085 | </div> | |
61b66b36 C |
4086 | </div> |
4087 | <div class="prop-value"> | |
4088 | <p>Video description</p> | |
4089 | </div> | |
4090 | </div> | |
61b66b36 C |
4091 | <div class="prop-row prop-group"> |
4092 | <div class="prop-name"> | |
4093 | <div class="prop-title">support</div> | |
228e84aa C |
4094 | <div class="prop-subtitle"> in formData </div> |
4095 | <div class="prop-subtitle"> | |
4096 | <span class="json-property-type">string</span> | |
4097 | <span class="json-property-range" title="Value limits"></span> | |
4098 | </div> | |
61b66b36 C |
4099 | </div> |
4100 | <div class="prop-value"> | |
4101 | <p>Text describing how to support the video uploader</p> | |
4102 | </div> | |
4103 | </div> | |
61b66b36 C |
4104 | <div class="prop-row prop-group"> |
4105 | <div class="prop-name"> | |
4106 | <div class="prop-title">channelId</div> | |
5e1c08eb | 4107 | <span class="json-property-required"></span> |
228e84aa C |
4108 | <div class="prop-subtitle"> in formData </div> |
4109 | <div class="prop-subtitle"> | |
4110 | <span class="json-property-type">number</span> | |
4111 | <span class="json-property-range" title="Value limits"></span> | |
4112 | </div> | |
5e1c08eb C |
4113 | </div> |
4114 | <div class="prop-value"> | |
61b66b36 | 4115 | <p>Channel id that will contain this video</p> |
5e1c08eb C |
4116 | </div> |
4117 | </div> | |
5e1c08eb C |
4118 | <div class="prop-row prop-group"> |
4119 | <div class="prop-name"> | |
61b66b36 C |
4120 | <div class="prop-title">nsfw</div> |
4121 | <span class="json-property-required"></span> | |
228e84aa C |
4122 | <div class="prop-subtitle"> in formData </div> |
4123 | <div class="prop-subtitle"> | |
4124 | <span class="json-property-type">boolean</span> | |
4125 | <span class="json-property-range" title="Value limits"></span> | |
4126 | </div> | |
5e1c08eb C |
4127 | </div> |
4128 | <div class="prop-value"> | |
61b66b36 | 4129 | <p>Whether or not this video contains sensitive content</p> |
5e1c08eb C |
4130 | </div> |
4131 | </div> | |
5e1c08eb C |
4132 | <div class="prop-row prop-group"> |
4133 | <div class="prop-name"> | |
61b66b36 | 4134 | <div class="prop-title">name</div> |
5e1c08eb | 4135 | <span class="json-property-required"></span> |
228e84aa C |
4136 | <div class="prop-subtitle"> in formData </div> |
4137 | <div class="prop-subtitle"> | |
4138 | <span class="json-property-type">string</span> | |
4139 | <span class="json-property-range" title="Value limits"></span> | |
4140 | </div> | |
5e1c08eb C |
4141 | </div> |
4142 | <div class="prop-value"> | |
61b66b36 | 4143 | <p>Video name</p> |
5e1c08eb C |
4144 | </div> |
4145 | </div> | |
5e1c08eb C |
4146 | <div class="prop-row prop-group"> |
4147 | <div class="prop-name"> | |
61b66b36 | 4148 | <div class="prop-title">tags</div> |
228e84aa C |
4149 | <div class="prop-subtitle"> in formData </div> |
4150 | <div class="prop-subtitle"> | |
4151 | <span class="json-property-type">string[]</span> | |
4152 | <span class="json-property-range" title="Value limits"></span> | |
4153 | </div> | |
5e1c08eb C |
4154 | </div> |
4155 | <div class="prop-value"> | |
61b66b36 | 4156 | <p>Video tags</p> |
5e1c08eb C |
4157 | </div> |
4158 | </div> | |
5e1c08eb C |
4159 | <div class="prop-row prop-group"> |
4160 | <div class="prop-name"> | |
61b66b36 | 4161 | <div class="prop-title">commentsEnabled</div> |
228e84aa C |
4162 | <div class="prop-subtitle"> in formData </div> |
4163 | <div class="prop-subtitle"> | |
4164 | <span class="json-property-type">boolean</span> | |
4165 | <span class="json-property-range" title="Value limits"></span> | |
4166 | </div> | |
5e1c08eb C |
4167 | </div> |
4168 | <div class="prop-value"> | |
61b66b36 | 4169 | <p>Enable or disable comments for this video</p> |
5e1c08eb C |
4170 | </div> |
4171 | </div> | |
61b66b36 C |
4172 | <div class="prop-row prop-group"> |
4173 | <div class="prop-name"> | |
4174 | <div class="prop-title">privacy</div> | |
4175 | <span class="json-property-required"></span> | |
228e84aa C |
4176 | <div class="prop-subtitle"> in formData </div> |
4177 | <div class="prop-subtitle"> | |
bbe0f064 | 4178 | <span class="json-property-type">[object Object]</span> |
228e84aa C |
4179 | <span class="json-property-range" title="Value limits"></span> |
4180 | </div> | |
61b66b36 C |
4181 | </div> |
4182 | <div class="prop-value"> | |
4183 | <p>Video privacy</p> | |
4184 | </div> | |
4185 | </div> | |
bbe0f064 C |
4186 | <div class="prop-row prop-group"> |
4187 | <div class="prop-name"> | |
4188 | <div class="prop-title">scheduleUpdate</div> | |
4189 | <div class="prop-subtitle"> in formData </div> | |
4190 | <div class="prop-subtitle"> | |
4191 | <span class="json-property-type">[object Object]</span> | |
4192 | <span class="json-property-range" title="Value limits"></span> | |
4193 | </div> | |
4194 | </div> | |
4195 | <div class="prop-value"> | |
4196 | <p class="no-description">(no description)</p> | |
4197 | </div> | |
4198 | </div> | |
5e1c08eb C |
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">200 OK</div> | |
4209 | <div class="prop-ref"> | |
4210 | <span class=""> | |
4211 | <a class="json-schema-ref" href="#/definitions/VideoUploadResponse">VideoUploadResponse</a> | |
4212 | </span> | |
4213 | </div> | |
4214 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
4215 | </div> | |
4216 | <div class="prop-value"> | |
4217 | <p>successful operation</p> | |
4218 | </div> | |
4219 | </div> | |
4220 | </section> | |
4221 | </div> | |
4222 | <div class="doc-examples"> | |
4223 | <h5>Response Content-Types: | |
4224 | <span>application/json</span> | |
4225 | </h5> | |
4226 | <section> | |
4227 | <h5>Response Example | |
4228 | <span>(200 OK)</span> | |
4229 | </h5> | |
4230 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
61b66b36 C |
4231 | <span class="hljs-attr">"video"</span>: { |
4232 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4233 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
4234 | } | |
5e1c08eb C |
4235 | } |
4236 | </code></pre> | |
4237 | <!-- </div> --> | |
4238 | </section> | |
4239 | </div> | |
4240 | </div> | |
94ff4c23 C |
4241 | <div class="doc-row"> |
4242 | <div class="doc-copy"> | |
4243 | <section class="swagger-request-security"> | |
4244 | <table class="table"> | |
4245 | <thead> | |
4246 | <tr> | |
4247 | <th class="swagger-request-security-schema"></th> | |
4248 | <th class="swagger-request-security-scopes"></th> | |
4249 | </tr> | |
4250 | </thead> | |
4251 | <tbody> | |
4252 | <tr> | |
4253 | <td> | |
4254 | <a href="#security-definition-OAuth2">OAuth2</a> | |
4255 | </td> | |
4256 | <td> </td> | |
4257 | </tr> | |
4258 | </tbody> | |
4259 | </table> | |
4260 | </section> | |
4261 | </div> | |
4262 | </div> | |
5e1c08eb C |
4263 | </div> |
4264 | <h1 id="tag-VideoAbuse" class="swagger-summary-tag" data-traverse-target="tag-VideoAbuse">VideoAbuse</h1> | |
ab0ee6a1 | 4265 | <div id="operation--videos-abuse-get" class="operation panel" data-traverse-target="operation--videos-abuse-get"> |
5e1c08eb C |
4266 | <!-- <section class="operation-tags row"> --> |
4267 | <!-- <div class="doc-copy"> --> | |
4268 | <div class="operation-tags"> | |
4269 | <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> | |
4270 | <!----> | |
4271 | </div> | |
4272 | <!-- </div> --> | |
4273 | <!-- </section> --> | |
4274 | <h2 class="operation-title"> | |
4275 | <span class="operation-name"> | |
4276 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 4277 | <span class="operation-path">/videos/abuse</span> |
5e1c08eb C |
4278 | </span> |
4279 | </h2> | |
4280 | <div class="doc-row"> | |
ab0ee6a1 C |
4281 | <div class="doc-copy"> |
4282 | <section class="swagger-request-params"> | |
4283 | <div class="prop-row prop-group"> | |
4284 | <div class="prop-name"> | |
4285 | <div class="prop-title">start</div> | |
228e84aa C |
4286 | <div class="prop-subtitle"> in query </div> |
4287 | <div class="prop-subtitle"> | |
4288 | <span class="json-property-type">number</span> | |
4289 | <span class="json-property-range" title="Value limits"></span> | |
4290 | </div> | |
ab0ee6a1 C |
4291 | </div> |
4292 | <div class="prop-value"> | |
4293 | <p>starting page</p> | |
4294 | </div> | |
4295 | </div> | |
ab0ee6a1 C |
4296 | <div class="prop-row prop-group"> |
4297 | <div class="prop-name"> | |
4298 | <div class="prop-title">stop</div> | |
228e84aa C |
4299 | <div class="prop-subtitle"> in query </div> |
4300 | <div class="prop-subtitle"> | |
4301 | <span class="json-property-type">number</span> | |
4302 | <span class="json-property-range" title="Value limits"></span> | |
4303 | </div> | |
ab0ee6a1 C |
4304 | </div> |
4305 | <div class="prop-value"> | |
f209b32a | 4306 | <p>stopping page</p> |
ab0ee6a1 C |
4307 | </div> |
4308 | </div> | |
ab0ee6a1 C |
4309 | <div class="prop-row prop-group"> |
4310 | <div class="prop-name"> | |
4311 | <div class="prop-title">sort</div> | |
228e84aa C |
4312 | <div class="prop-subtitle"> in query </div> |
4313 | <div class="prop-subtitle"> | |
4314 | <span class="json-property-type">number</span> | |
4315 | <span class="json-property-range" title="Value limits"></span> | |
4316 | </div> | |
ab0ee6a1 C |
4317 | </div> |
4318 | <div class="prop-value"> | |
4319 | <p>sorting</p> | |
4320 | </div> | |
4321 | </div> | |
ab0ee6a1 C |
4322 | </section> |
4323 | </div> | |
5e1c08eb C |
4324 | <div class="doc-examples"></div> |
4325 | </div> | |
4326 | <div class="doc-row"> | |
4327 | <div class="doc-copy"> | |
4328 | <section class="swagger-responses"> | |
4329 | <div class="prop-row prop-group"> | |
4330 | <div class="prop-name"> | |
4331 | <div class="prop-title">200 OK</div> | |
4332 | <div class="prop-ref"> | |
4333 | <span class="json-schema-ref-array"> | |
4334 | <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a> | |
4335 | </span> | |
4336 | </div> | |
4337 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
4338 | </div> | |
4339 | <div class="prop-value"> | |
4340 | <p>successful operation</p> | |
4341 | </div> | |
4342 | </div> | |
228e84aa C |
4343 | <div class="prop-row prop-inner"> |
4344 | <div class="prop-name">type</div> | |
4345 | <div class="prop-value"> | |
4346 | <span class="json-property-type"> | |
4347 | <span class="json-schema-ref-array"> | |
4348 | <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a> | |
4349 | </span> | |
4350 | </span> | |
4351 | <span class="json-property-range" title="Value limits"></span> | |
4352 | </div> | |
4353 | </div> | |
5e1c08eb C |
4354 | </section> |
4355 | </div> | |
4356 | <div class="doc-examples"> | |
4357 | <h5>Response Content-Types: | |
4358 | <span>application/json</span> | |
4359 | </h5> | |
4360 | <section> | |
4361 | <h5>Response Example | |
4362 | <span>(200 OK)</span> | |
4363 | </h5> | |
4364 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
4365 | { | |
4366 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4367 | <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
4368 | <span class="hljs-attr">"reporterAccount"</span>: { |
4369 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4370 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4371 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4372 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
4373 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4374 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
4375 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
4376 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
4377 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4378 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4379 | <span class="hljs-attr">"avatar"</span>: { | |
4380 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
4381 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4382 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
4383 | } | |
4384 | }, | |
61b66b36 C |
4385 | <span class="hljs-attr">"video"</span>: { |
4386 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4387 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4388 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4389 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span> | |
4390 | }, | |
5e1c08eb C |
4391 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span> |
4392 | } | |
4393 | ] | |
4394 | </code></pre> | |
4395 | <!-- </div> --> | |
4396 | </section> | |
4397 | </div> | |
4398 | </div> | |
94ff4c23 C |
4399 | <div class="doc-row"> |
4400 | <div class="doc-copy"> | |
4401 | <section class="swagger-request-security"> | |
4402 | <table class="table"> | |
4403 | <thead> | |
4404 | <tr> | |
4405 | <th class="swagger-request-security-schema"></th> | |
4406 | <th class="swagger-request-security-scopes"></th> | |
4407 | </tr> | |
4408 | </thead> | |
4409 | <tbody> | |
4410 | <tr> | |
4411 | <td> | |
4412 | <a href="#security-definition-OAuth2">OAuth2</a> | |
4413 | </td> | |
4414 | <td> </td> | |
4415 | </tr> | |
4416 | </tbody> | |
4417 | </table> | |
4418 | </section> | |
4419 | </div> | |
4420 | </div> | |
5e1c08eb | 4421 | </div> |
ab0ee6a1 | 4422 | <div id="operation--videos--id--abuse-post" class="operation panel" data-traverse-target="operation--videos--id--abuse-post"> |
5e1c08eb C |
4423 | <!-- <section class="operation-tags row"> --> |
4424 | <!-- <div class="doc-copy"> --> | |
4425 | <div class="operation-tags"> | |
4426 | <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> | |
4427 | <!----> | |
4428 | </div> | |
4429 | <!-- </div> --> | |
4430 | <!-- </section> --> | |
4431 | <h2 class="operation-title"> | |
4432 | <span class="operation-name"> | |
4433 | <span class="operation-name">POST</span> | |
ab0ee6a1 | 4434 | <span class="operation-path">/videos/{id}/abuse</span> |
5e1c08eb C |
4435 | </span> |
4436 | </h2> | |
4437 | <div class="doc-row"> | |
4438 | <div class="doc-copy"> | |
4439 | <section class="swagger-request-params"> | |
4440 | <div class="prop-row prop-group"> | |
4441 | <div class="prop-name"> | |
4442 | <div class="prop-title">id</div> | |
4443 | <span class="json-property-required"></span> | |
228e84aa C |
4444 | <div class="prop-subtitle"> in path </div> |
4445 | <div class="prop-subtitle"> | |
4446 | <span class="json-property-type">string</span> | |
4447 | <span class="json-property-range" title="Value limits"></span> | |
4448 | </div> | |
5e1c08eb C |
4449 | </div> |
4450 | <div class="prop-value"> | |
4451 | <p>The video id </p> | |
4452 | </div> | |
4453 | </div> | |
5e1c08eb C |
4454 | </section> |
4455 | </div> | |
4456 | <div class="doc-examples"></div> | |
4457 | </div> | |
4458 | <div class="doc-row"> | |
4459 | <div class="doc-copy"> | |
4460 | <section class="swagger-responses"> | |
4461 | <div class="prop-row prop-group"> | |
4462 | <div class="prop-name"> | |
4463 | <div class="prop-title">204 No Content</div> | |
4464 | </div> | |
4465 | <div class="prop-value"> | |
4466 | <p>successful operation</p> | |
4467 | </div> | |
4468 | </div> | |
4469 | </section> | |
4470 | </div> | |
4471 | <div class="doc-examples"> | |
4472 | <h5>Response Content-Types: | |
4473 | <span>application/json</span> | |
4474 | </h5> | |
4475 | </div> | |
4476 | </div> | |
94ff4c23 C |
4477 | <div class="doc-row"> |
4478 | <div class="doc-copy"> | |
4479 | <section class="swagger-request-security"> | |
4480 | <table class="table"> | |
4481 | <thead> | |
4482 | <tr> | |
4483 | <th class="swagger-request-security-schema"></th> | |
4484 | <th class="swagger-request-security-scopes"></th> | |
4485 | </tr> | |
4486 | </thead> | |
4487 | <tbody> | |
4488 | <tr> | |
4489 | <td> | |
4490 | <a href="#security-definition-OAuth2">OAuth2</a> | |
4491 | </td> | |
4492 | <td> </td> | |
4493 | </tr> | |
4494 | </tbody> | |
4495 | </table> | |
4496 | </section> | |
4497 | </div> | |
4498 | </div> | |
5e1c08eb C |
4499 | </div> |
4500 | <h1 id="tag-VideoBlacklist" class="swagger-summary-tag" data-traverse-target="tag-VideoBlacklist">VideoBlacklist</h1> | |
ab0ee6a1 | 4501 | <div id="operation--videos--videoId--blacklist-post" class="operation panel" data-traverse-target="operation--videos--videoId--blacklist-post"> |
5e1c08eb C |
4502 | <!-- <section class="operation-tags row"> --> |
4503 | <!-- <div class="doc-copy"> --> | |
4504 | <div class="operation-tags"> | |
4505 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | |
4506 | <!----> | |
4507 | </div> | |
4508 | <!-- </div> --> | |
4509 | <!-- </section> --> | |
4510 | <h2 class="operation-title"> | |
4511 | <span class="operation-name"> | |
4512 | <span class="operation-name">POST</span> | |
ab0ee6a1 | 4513 | <span class="operation-path">/videos/{videoId}/blacklist</span> |
5e1c08eb C |
4514 | </span> |
4515 | </h2> | |
4516 | <div class="doc-row"> | |
4517 | <div class="doc-copy"> | |
4518 | <section class="swagger-request-params"> | |
4519 | <div class="prop-row prop-group"> | |
4520 | <div class="prop-name"> | |
4521 | <div class="prop-title">videoId</div> | |
4522 | <span class="json-property-required"></span> | |
228e84aa C |
4523 | <div class="prop-subtitle"> in path </div> |
4524 | <div class="prop-subtitle"> | |
4525 | <span class="json-property-type">string</span> | |
4526 | <span class="json-property-range" title="Value limits"></span> | |
4527 | </div> | |
5e1c08eb C |
4528 | </div> |
4529 | <div class="prop-value"> | |
4530 | <p>The video id </p> | |
4531 | </div> | |
4532 | </div> | |
5e1c08eb C |
4533 | </section> |
4534 | </div> | |
4535 | <div class="doc-examples"></div> | |
4536 | </div> | |
4537 | <div class="doc-row"> | |
4538 | <div class="doc-copy"> | |
4539 | <section class="swagger-responses"> | |
4540 | <div class="prop-row prop-group"> | |
4541 | <div class="prop-name"> | |
4542 | <div class="prop-title">204 No Content</div> | |
4543 | </div> | |
4544 | <div class="prop-value"> | |
4545 | <p>successful operation</p> | |
4546 | </div> | |
4547 | </div> | |
4548 | </section> | |
4549 | </div> | |
4550 | <div class="doc-examples"> | |
4551 | <h5>Response Content-Types: | |
4552 | <span>application/json</span> | |
4553 | </h5> | |
4554 | </div> | |
4555 | </div> | |
94ff4c23 C |
4556 | <div class="doc-row"> |
4557 | <div class="doc-copy"> | |
4558 | <section class="swagger-request-security"> | |
4559 | <table class="table"> | |
4560 | <thead> | |
4561 | <tr> | |
4562 | <th class="swagger-request-security-schema"></th> | |
4563 | <th class="swagger-request-security-scopes"></th> | |
4564 | </tr> | |
4565 | </thead> | |
4566 | <tbody> | |
4567 | <tr> | |
4568 | <td> | |
4569 | <a href="#security-definition-OAuth2">OAuth2</a> | |
4570 | </td> | |
4571 | <td> </td> | |
4572 | </tr> | |
4573 | </tbody> | |
4574 | </table> | |
4575 | </section> | |
4576 | </div> | |
4577 | </div> | |
5e1c08eb | 4578 | </div> |
ab0ee6a1 | 4579 | <div id="operation--videos--videoId--blacklist-delete" class="operation panel" data-traverse-target="operation--videos--videoId--blacklist-delete"> |
5e1c08eb C |
4580 | <!-- <section class="operation-tags row"> --> |
4581 | <!-- <div class="doc-copy"> --> | |
4582 | <div class="operation-tags"> | |
4583 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | |
4584 | <!----> | |
4585 | </div> | |
4586 | <!-- </div> --> | |
4587 | <!-- </section> --> | |
4588 | <h2 class="operation-title"> | |
4589 | <span class="operation-name"> | |
4590 | <span class="operation-name">DELETE</span> | |
ab0ee6a1 | 4591 | <span class="operation-path">/videos/{videoId}/blacklist</span> |
5e1c08eb C |
4592 | </span> |
4593 | </h2> | |
4594 | <div class="doc-row"> | |
4595 | <div class="doc-copy"> | |
4596 | <section class="swagger-request-params"> | |
4597 | <div class="prop-row prop-group"> | |
4598 | <div class="prop-name"> | |
4599 | <div class="prop-title">videoId</div> | |
4600 | <span class="json-property-required"></span> | |
228e84aa C |
4601 | <div class="prop-subtitle"> in path </div> |
4602 | <div class="prop-subtitle"> | |
4603 | <span class="json-property-type">string</span> | |
4604 | <span class="json-property-range" title="Value limits"></span> | |
4605 | </div> | |
5e1c08eb C |
4606 | </div> |
4607 | <div class="prop-value"> | |
4608 | <p>The video id </p> | |
4609 | </div> | |
4610 | </div> | |
5e1c08eb C |
4611 | </section> |
4612 | </div> | |
4613 | <div class="doc-examples"></div> | |
4614 | </div> | |
4615 | <div class="doc-row"> | |
4616 | <div class="doc-copy"> | |
4617 | <section class="swagger-responses"> | |
4618 | <div class="prop-row prop-group"> | |
4619 | <div class="prop-name"> | |
4620 | <div class="prop-title">204 No Content</div> | |
4621 | </div> | |
4622 | <div class="prop-value"> | |
4623 | <p>successful operation</p> | |
4624 | </div> | |
4625 | </div> | |
4626 | </section> | |
4627 | </div> | |
4628 | <div class="doc-examples"> | |
4629 | <h5>Response Content-Types: | |
4630 | <span>application/json</span> | |
4631 | </h5> | |
4632 | </div> | |
4633 | </div> | |
94ff4c23 C |
4634 | <div class="doc-row"> |
4635 | <div class="doc-copy"> | |
4636 | <section class="swagger-request-security"> | |
4637 | <table class="table"> | |
4638 | <thead> | |
4639 | <tr> | |
4640 | <th class="swagger-request-security-schema"></th> | |
4641 | <th class="swagger-request-security-scopes"></th> | |
4642 | </tr> | |
4643 | </thead> | |
4644 | <tbody> | |
4645 | <tr> | |
4646 | <td> | |
4647 | <a href="#security-definition-OAuth2">OAuth2</a> | |
4648 | </td> | |
4649 | <td> </td> | |
4650 | </tr> | |
4651 | </tbody> | |
4652 | </table> | |
4653 | </section> | |
4654 | </div> | |
4655 | </div> | |
5e1c08eb | 4656 | </div> |
ab0ee6a1 | 4657 | <div id="operation--videos-blacklist-get" class="operation panel" data-traverse-target="operation--videos-blacklist-get"> |
5e1c08eb C |
4658 | <!-- <section class="operation-tags row"> --> |
4659 | <!-- <div class="doc-copy"> --> | |
4660 | <div class="operation-tags"> | |
4661 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | |
4662 | <!----> | |
4663 | </div> | |
4664 | <!-- </div> --> | |
4665 | <!-- </section> --> | |
4666 | <h2 class="operation-title"> | |
4667 | <span class="operation-name"> | |
4668 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 4669 | <span class="operation-path">/videos/blacklist</span> |
5e1c08eb C |
4670 | </span> |
4671 | </h2> | |
4672 | <div class="doc-row"> | |
ab0ee6a1 C |
4673 | <div class="doc-copy"> |
4674 | <section class="swagger-request-params"> | |
4675 | <div class="prop-row prop-group"> | |
4676 | <div class="prop-name"> | |
4677 | <div class="prop-title">start</div> | |
228e84aa C |
4678 | <div class="prop-subtitle"> in query </div> |
4679 | <div class="prop-subtitle"> | |
4680 | <span class="json-property-type">number</span> | |
4681 | <span class="json-property-range" title="Value limits"></span> | |
4682 | </div> | |
ab0ee6a1 C |
4683 | </div> |
4684 | <div class="prop-value"> | |
4685 | <p>starting page</p> | |
4686 | </div> | |
4687 | </div> | |
ab0ee6a1 C |
4688 | <div class="prop-row prop-group"> |
4689 | <div class="prop-name"> | |
4690 | <div class="prop-title">stop</div> | |
228e84aa C |
4691 | <div class="prop-subtitle"> in query </div> |
4692 | <div class="prop-subtitle"> | |
4693 | <span class="json-property-type">number</span> | |
4694 | <span class="json-property-range" title="Value limits"></span> | |
4695 | </div> | |
ab0ee6a1 C |
4696 | </div> |
4697 | <div class="prop-value"> | |
f209b32a | 4698 | <p>stopping page</p> |
ab0ee6a1 C |
4699 | </div> |
4700 | </div> | |
ab0ee6a1 C |
4701 | <div class="prop-row prop-group"> |
4702 | <div class="prop-name"> | |
4703 | <div class="prop-title">sort</div> | |
228e84aa C |
4704 | <div class="prop-subtitle"> in query </div> |
4705 | <div class="prop-subtitle"> | |
4706 | <span class="json-property-type">number</span> | |
4707 | <span class="json-property-range" title="Value limits"></span> | |
4708 | </div> | |
ab0ee6a1 C |
4709 | </div> |
4710 | <div class="prop-value"> | |
4711 | <p>sorting</p> | |
4712 | </div> | |
4713 | </div> | |
ab0ee6a1 C |
4714 | </section> |
4715 | </div> | |
5e1c08eb C |
4716 | <div class="doc-examples"></div> |
4717 | </div> | |
4718 | <div class="doc-row"> | |
4719 | <div class="doc-copy"> | |
4720 | <section class="swagger-responses"> | |
4721 | <div class="prop-row prop-group"> | |
4722 | <div class="prop-name"> | |
4723 | <div class="prop-title">200 OK</div> | |
4724 | <div class="prop-ref"> | |
4725 | <span class="json-schema-ref-array"> | |
4726 | <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a> | |
4727 | </span> | |
4728 | </div> | |
4729 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
4730 | </div> | |
4731 | <div class="prop-value"> | |
4732 | <p>successful operation</p> | |
4733 | </div> | |
4734 | </div> | |
228e84aa C |
4735 | <div class="prop-row prop-inner"> |
4736 | <div class="prop-name">type</div> | |
4737 | <div class="prop-value"> | |
4738 | <span class="json-property-type"> | |
4739 | <span class="json-schema-ref-array"> | |
4740 | <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a> | |
4741 | </span> | |
4742 | </span> | |
4743 | <span class="json-property-range" title="Value limits"></span> | |
4744 | </div> | |
4745 | </div> | |
5e1c08eb C |
4746 | </section> |
4747 | </div> | |
4748 | <div class="doc-examples"> | |
4749 | <h5>Response Content-Types: | |
4750 | <span>application/json</span> | |
4751 | </h5> | |
4752 | <section> | |
4753 | <h5>Response Example | |
4754 | <span>(200 OK)</span> | |
4755 | </h5> | |
4756 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
4757 | { | |
4758 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
4759 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
4760 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
4761 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
4762 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4763 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
4764 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
4765 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
4766 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
4767 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
4768 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
4769 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
4770 | } | |
4771 | ] | |
4772 | </code></pre> | |
4773 | <!-- </div> --> | |
4774 | </section> | |
4775 | </div> | |
4776 | </div> | |
94ff4c23 C |
4777 | <div class="doc-row"> |
4778 | <div class="doc-copy"> | |
4779 | <section class="swagger-request-security"> | |
4780 | <table class="table"> | |
4781 | <thead> | |
4782 | <tr> | |
4783 | <th class="swagger-request-security-schema"></th> | |
4784 | <th class="swagger-request-security-scopes"></th> | |
4785 | </tr> | |
4786 | </thead> | |
4787 | <tbody> | |
4788 | <tr> | |
4789 | <td> | |
4790 | <a href="#security-definition-OAuth2">OAuth2</a> | |
4791 | </td> | |
4792 | <td> </td> | |
4793 | </tr> | |
4794 | </tbody> | |
4795 | </table> | |
4796 | </section> | |
4797 | </div> | |
4798 | </div> | |
5e1c08eb C |
4799 | </div> |
4800 | <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1> | |
48dce1c9 | 4801 | <div id="operation--video-channels-get" class="operation panel" data-traverse-target="operation--video-channels-get"> |
5e1c08eb C |
4802 | <!-- <section class="operation-tags row"> --> |
4803 | <!-- <div class="doc-copy"> --> | |
4804 | <div class="operation-tags"> | |
4805 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
4806 | <!----> | |
4807 | </div> | |
4808 | <!-- </div> --> | |
4809 | <!-- </section> --> | |
4810 | <h2 class="operation-title"> | |
4811 | <span class="operation-name"> | |
4812 | <span class="operation-name">GET</span> | |
48dce1c9 | 4813 | <span class="operation-path">/video-channels</span> |
5e1c08eb C |
4814 | </span> |
4815 | </h2> | |
4816 | <div class="doc-row"> | |
ab0ee6a1 C |
4817 | <div class="doc-copy"> |
4818 | <section class="swagger-request-params"> | |
4819 | <div class="prop-row prop-group"> | |
4820 | <div class="prop-name"> | |
4821 | <div class="prop-title">start</div> | |
228e84aa C |
4822 | <div class="prop-subtitle"> in query </div> |
4823 | <div class="prop-subtitle"> | |
4824 | <span class="json-property-type">number</span> | |
4825 | <span class="json-property-range" title="Value limits"></span> | |
4826 | </div> | |
ab0ee6a1 C |
4827 | </div> |
4828 | <div class="prop-value"> | |
4829 | <p>starting page</p> | |
4830 | </div> | |
4831 | </div> | |
ab0ee6a1 C |
4832 | <div class="prop-row prop-group"> |
4833 | <div class="prop-name"> | |
4834 | <div class="prop-title">stop</div> | |
228e84aa C |
4835 | <div class="prop-subtitle"> in query </div> |
4836 | <div class="prop-subtitle"> | |
4837 | <span class="json-property-type">number</span> | |
4838 | <span class="json-property-range" title="Value limits"></span> | |
4839 | </div> | |
ab0ee6a1 C |
4840 | </div> |
4841 | <div class="prop-value"> | |
f209b32a | 4842 | <p>stopping page</p> |
ab0ee6a1 C |
4843 | </div> |
4844 | </div> | |
ab0ee6a1 C |
4845 | <div class="prop-row prop-group"> |
4846 | <div class="prop-name"> | |
4847 | <div class="prop-title">sort</div> | |
228e84aa C |
4848 | <div class="prop-subtitle"> in query </div> |
4849 | <div class="prop-subtitle"> | |
4850 | <span class="json-property-type">number</span> | |
4851 | <span class="json-property-range" title="Value limits"></span> | |
4852 | </div> | |
ab0ee6a1 C |
4853 | </div> |
4854 | <div class="prop-value"> | |
4855 | <p>sorting</p> | |
4856 | </div> | |
4857 | </div> | |
ab0ee6a1 C |
4858 | </section> |
4859 | </div> | |
5e1c08eb C |
4860 | <div class="doc-examples"></div> |
4861 | </div> | |
4862 | <div class="doc-row"> | |
4863 | <div class="doc-copy"> | |
4864 | <section class="swagger-responses"> | |
4865 | <div class="prop-row prop-group"> | |
4866 | <div class="prop-name"> | |
4867 | <div class="prop-title">200 OK</div> | |
4868 | <div class="prop-ref"> | |
4869 | <span class="json-schema-ref-array"> | |
4870 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
4871 | </span> | |
4872 | </div> | |
4873 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
4874 | </div> | |
4875 | <div class="prop-value"> | |
4876 | <p>successful operation</p> | |
4877 | </div> | |
4878 | </div> | |
228e84aa C |
4879 | <div class="prop-row prop-inner"> |
4880 | <div class="prop-name">type</div> | |
4881 | <div class="prop-value"> | |
4882 | <span class="json-property-type"> | |
4883 | <span class="json-schema-ref-array"> | |
4884 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
4885 | </span> | |
4886 | </span> | |
4887 | <span class="json-property-range" title="Value limits"></span> | |
4888 | </div> | |
4889 | </div> | |
5e1c08eb C |
4890 | </section> |
4891 | </div> | |
4892 | <div class="doc-examples"> | |
4893 | <h5>Response Content-Types: | |
4894 | <span>application/json</span> | |
4895 | </h5> | |
4896 | <section> | |
4897 | <h5>Response Example | |
4898 | <span>(200 OK)</span> | |
4899 | </h5> | |
4900 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
4901 | { | |
4902 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
4903 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
4904 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
cc918ac3 C |
4905 | <span class="hljs-attr">"ownerAccount"</span>: { |
4906 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5e1c08eb | 4907 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
cc918ac3 | 4908 | } |
48dce1c9 C |
4909 | } |
4910 | ] | |
4911 | </code></pre> | |
4912 | <!-- </div> --> | |
4913 | </section> | |
4914 | </div> | |
4915 | </div> | |
4916 | </div> | |
cc918ac3 | 4917 | <div id="operation--video-channels-post" class="operation panel" data-traverse-target="operation--video-channels-post"> |
48dce1c9 C |
4918 | <!-- <section class="operation-tags row"> --> |
4919 | <!-- <div class="doc-copy"> --> | |
4920 | <div class="operation-tags"> | |
4921 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
4922 | <!----> | |
4923 | </div> | |
4924 | <!-- </div> --> | |
4925 | <!-- </section> --> | |
4926 | <h2 class="operation-title"> | |
4927 | <span class="operation-name"> | |
cc918ac3 C |
4928 | <span class="operation-name">POST</span> |
4929 | <span class="operation-path">/video-channels</span> | |
48dce1c9 C |
4930 | </span> |
4931 | </h2> | |
4932 | <div class="doc-row"> | |
4933 | <div class="doc-copy"> | |
cc918ac3 C |
4934 | <section class="swagger-request-body"> |
4935 | <div class="prop-row"> | |
48dce1c9 | 4936 | <div class="prop-name"> |
cc918ac3 C |
4937 | <div class="swagger-request-model"> |
4938 | <span class=""> | |
4939 | <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a> | |
4940 | </span> | |
48dce1c9 C |
4941 | </div> |
4942 | </div> | |
cc918ac3 C |
4943 | <div class="prop-value columns small-6"> |
4944 | <!-- <div class="swagger-request-description"> --> | |
4945 | <p>undefined</p> | |
4946 | <!-- </div> --> | |
48dce1c9 C |
4947 | </div> |
4948 | </div> | |
4949 | </section> | |
4950 | </div> | |
cc918ac3 C |
4951 | <div class="doc-examples"> |
4952 | <section> | |
4953 | <h5>Request Content-Types: | |
4954 | <span>application/json</span> | |
4955 | </h5> | |
4956 | <h5>Request Example</h5> | |
4957 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
4958 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
4959 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
4960 | } | |
4961 | </code></pre> | |
4962 | <!-- </div> --> | |
4963 | </section> | |
4964 | </div> | |
48dce1c9 C |
4965 | </div> |
4966 | <div class="doc-row"> | |
4967 | <div class="doc-copy"> | |
4968 | <section class="swagger-responses"> | |
4969 | <div class="prop-row prop-group"> | |
4970 | <div class="prop-name"> | |
cc918ac3 | 4971 | <div class="prop-title">204 No Content</div> |
5e1c08eb C |
4972 | </div> |
4973 | <div class="prop-value"> | |
4974 | <p>successful operation</p> | |
4975 | </div> | |
4976 | </div> | |
4977 | </section> | |
4978 | </div> | |
4979 | <div class="doc-examples"> | |
4980 | <h5>Response Content-Types: | |
4981 | <span>application/json</span> | |
4982 | </h5> | |
4983 | </div> | |
4984 | </div> | |
94ff4c23 C |
4985 | <div class="doc-row"> |
4986 | <div class="doc-copy"> | |
4987 | <section class="swagger-request-security"> | |
4988 | <table class="table"> | |
4989 | <thead> | |
4990 | <tr> | |
4991 | <th class="swagger-request-security-schema"></th> | |
4992 | <th class="swagger-request-security-scopes"></th> | |
4993 | </tr> | |
4994 | </thead> | |
4995 | <tbody> | |
4996 | <tr> | |
4997 | <td> | |
4998 | <a href="#security-definition-OAuth2">OAuth2</a> | |
4999 | </td> | |
5000 | <td> </td> | |
5001 | </tr> | |
5002 | </tbody> | |
5003 | </table> | |
5004 | </section> | |
5005 | </div> | |
5006 | </div> | |
5e1c08eb | 5007 | </div> |
cc918ac3 | 5008 | <div id="operation--video-channels--id--get" class="operation panel" data-traverse-target="operation--video-channels--id--get"> |
5e1c08eb C |
5009 | <!-- <section class="operation-tags row"> --> |
5010 | <!-- <div class="doc-copy"> --> | |
5011 | <div class="operation-tags"> | |
5012 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
5013 | <!----> | |
5014 | </div> | |
5015 | <!-- </div> --> | |
5016 | <!-- </section> --> | |
5017 | <h2 class="operation-title"> | |
5018 | <span class="operation-name"> | |
5019 | <span class="operation-name">GET</span> | |
cc918ac3 | 5020 | <span class="operation-path">/video-channels/{id}</span> |
5e1c08eb C |
5021 | </span> |
5022 | </h2> | |
5023 | <div class="doc-row"> | |
5024 | <div class="doc-copy"> | |
5025 | <section class="swagger-request-params"> | |
5026 | <div class="prop-row prop-group"> | |
5027 | <div class="prop-name"> | |
5028 | <div class="prop-title">id</div> | |
5029 | <span class="json-property-required"></span> | |
228e84aa C |
5030 | <div class="prop-subtitle"> in path </div> |
5031 | <div class="prop-subtitle"> | |
5032 | <span class="json-property-type">string</span> | |
5033 | <span class="json-property-range" title="Value limits"></span> | |
5034 | </div> | |
5e1c08eb C |
5035 | </div> |
5036 | <div class="prop-value"> | |
48dce1c9 | 5037 | <p>The video channel id </p> |
5e1c08eb C |
5038 | </div> |
5039 | </div> | |
5e1c08eb C |
5040 | </section> |
5041 | </div> | |
5042 | <div class="doc-examples"></div> | |
5043 | </div> | |
5044 | <div class="doc-row"> | |
5045 | <div class="doc-copy"> | |
5046 | <section class="swagger-responses"> | |
5047 | <div class="prop-row prop-group"> | |
5048 | <div class="prop-name"> | |
5049 | <div class="prop-title">200 OK</div> | |
5050 | <div class="prop-ref"> | |
5051 | <span class=""> | |
5052 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
5053 | </span> | |
5054 | </div> | |
5055 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
5056 | </div> | |
5057 | <div class="prop-value"> | |
5058 | <p>successful operation</p> | |
5059 | </div> | |
5060 | </div> | |
5061 | </section> | |
5062 | </div> | |
5063 | <div class="doc-examples"> | |
5064 | <h5>Response Content-Types: | |
5065 | <span>application/json</span> | |
5066 | </h5> | |
5067 | <section> | |
5068 | <h5>Response Example | |
5069 | <span>(200 OK)</span> | |
5070 | </h5> | |
5071 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5072 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5073 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
5074 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
cc918ac3 C |
5075 | <span class="hljs-attr">"ownerAccount"</span>: { |
5076 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5e1c08eb | 5077 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
cc918ac3 | 5078 | } |
5e1c08eb C |
5079 | } |
5080 | </code></pre> | |
5081 | <!-- </div> --> | |
5082 | </section> | |
5083 | </div> | |
5084 | </div> | |
5085 | </div> | |
cc918ac3 | 5086 | <div id="operation--video-channels--id--put" class="operation panel" data-traverse-target="operation--video-channels--id--put"> |
5e1c08eb C |
5087 | <!-- <section class="operation-tags row"> --> |
5088 | <!-- <div class="doc-copy"> --> | |
5089 | <div class="operation-tags"> | |
5090 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
5091 | <!----> | |
5092 | </div> | |
5093 | <!-- </div> --> | |
5094 | <!-- </section> --> | |
5095 | <h2 class="operation-title"> | |
5096 | <span class="operation-name"> | |
5097 | <span class="operation-name">PUT</span> | |
cc918ac3 | 5098 | <span class="operation-path">/video-channels/{id}</span> |
5e1c08eb C |
5099 | </span> |
5100 | </h2> | |
5101 | <div class="doc-row"> | |
5102 | <div class="doc-copy"> | |
5103 | <section class="swagger-request-body"> | |
5104 | <div class="prop-row"> | |
5105 | <div class="prop-name"> | |
5106 | <div class="swagger-request-model"> | |
5107 | <span class=""> | |
5108 | <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a> | |
5109 | </span> | |
5110 | </div> | |
5111 | </div> | |
5112 | <div class="prop-value columns small-6"> | |
228e84aa C |
5113 | <!-- <div class="swagger-request-description"> --> |
5114 | <p>undefined</p> | |
5e1c08eb C |
5115 | <!-- </div> --> |
5116 | </div> | |
5117 | </div> | |
5118 | </section> | |
5119 | <section class="swagger-request-params"> | |
5120 | <div class="prop-row prop-group"> | |
5121 | <div class="prop-name"> | |
5122 | <div class="prop-title">id</div> | |
5123 | <span class="json-property-required"></span> | |
228e84aa C |
5124 | <div class="prop-subtitle"> in path </div> |
5125 | <div class="prop-subtitle"> | |
5126 | <span class="json-property-type">string</span> | |
5127 | <span class="json-property-range" title="Value limits"></span> | |
5128 | </div> | |
5e1c08eb C |
5129 | </div> |
5130 | <div class="prop-value"> | |
48dce1c9 | 5131 | <p>The video channel id </p> |
5e1c08eb C |
5132 | </div> |
5133 | </div> | |
5e1c08eb C |
5134 | </section> |
5135 | </div> | |
5136 | <div class="doc-examples"> | |
5137 | <section> | |
5138 | <h5>Request Content-Types: | |
5139 | <span>application/json</span> | |
5140 | </h5> | |
5141 | <h5>Request Example</h5> | |
5142 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5143 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5144 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
5145 | } | |
5146 | </code></pre> | |
5147 | <!-- </div> --> | |
5148 | </section> | |
5149 | </div> | |
5150 | </div> | |
5151 | <div class="doc-row"> | |
5152 | <div class="doc-copy"> | |
5153 | <section class="swagger-responses"> | |
5154 | <div class="prop-row prop-group"> | |
5155 | <div class="prop-name"> | |
5156 | <div class="prop-title">204 No Content</div> | |
5157 | </div> | |
5158 | <div class="prop-value"> | |
5159 | <p>successful operation</p> | |
5160 | </div> | |
5161 | </div> | |
5162 | </section> | |
5163 | </div> | |
5164 | <div class="doc-examples"> | |
5165 | <h5>Response Content-Types: | |
5166 | <span>application/json</span> | |
5167 | </h5> | |
5168 | </div> | |
5169 | </div> | |
94ff4c23 C |
5170 | <div class="doc-row"> |
5171 | <div class="doc-copy"> | |
5172 | <section class="swagger-request-security"> | |
5173 | <table class="table"> | |
5174 | <thead> | |
5175 | <tr> | |
5176 | <th class="swagger-request-security-schema"></th> | |
5177 | <th class="swagger-request-security-scopes"></th> | |
5178 | </tr> | |
5179 | </thead> | |
5180 | <tbody> | |
5181 | <tr> | |
5182 | <td> | |
5183 | <a href="#security-definition-OAuth2">OAuth2</a> | |
5184 | </td> | |
5185 | <td> </td> | |
5186 | </tr> | |
5187 | </tbody> | |
5188 | </table> | |
5189 | </section> | |
5190 | </div> | |
5191 | </div> | |
5e1c08eb | 5192 | </div> |
cc918ac3 | 5193 | <div id="operation--video-channels--id--delete" class="operation panel" data-traverse-target="operation--video-channels--id--delete"> |
5e1c08eb C |
5194 | <!-- <section class="operation-tags row"> --> |
5195 | <!-- <div class="doc-copy"> --> | |
5196 | <div class="operation-tags"> | |
5197 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
5198 | <!----> | |
5199 | </div> | |
5200 | <!-- </div> --> | |
5201 | <!-- </section> --> | |
5202 | <h2 class="operation-title"> | |
5203 | <span class="operation-name"> | |
5204 | <span class="operation-name">DELETE</span> | |
cc918ac3 | 5205 | <span class="operation-path">/video-channels/{id}</span> |
5e1c08eb C |
5206 | </span> |
5207 | </h2> | |
5208 | <div class="doc-row"> | |
5209 | <div class="doc-copy"> | |
5210 | <section class="swagger-request-params"> | |
5211 | <div class="prop-row prop-group"> | |
5212 | <div class="prop-name"> | |
5213 | <div class="prop-title">id</div> | |
5214 | <span class="json-property-required"></span> | |
228e84aa C |
5215 | <div class="prop-subtitle"> in path </div> |
5216 | <div class="prop-subtitle"> | |
5217 | <span class="json-property-type">string</span> | |
5218 | <span class="json-property-range" title="Value limits"></span> | |
5219 | </div> | |
5e1c08eb C |
5220 | </div> |
5221 | <div class="prop-value"> | |
48dce1c9 | 5222 | <p>The video channel id </p> |
5e1c08eb C |
5223 | </div> |
5224 | </div> | |
5e1c08eb C |
5225 | </section> |
5226 | </div> | |
5227 | <div class="doc-examples"></div> | |
5228 | </div> | |
5229 | <div class="doc-row"> | |
5230 | <div class="doc-copy"> | |
5231 | <section class="swagger-responses"> | |
5232 | <div class="prop-row prop-group"> | |
5233 | <div class="prop-name"> | |
5234 | <div class="prop-title">204 No Content</div> | |
5235 | </div> | |
5236 | <div class="prop-value"> | |
5237 | <p>successful operation</p> | |
5238 | </div> | |
5239 | </div> | |
5240 | </section> | |
5241 | </div> | |
5242 | <div class="doc-examples"> | |
5243 | <h5>Response Content-Types: | |
5244 | <span>application/json</span> | |
5245 | </h5> | |
5246 | </div> | |
5247 | </div> | |
94ff4c23 C |
5248 | <div class="doc-row"> |
5249 | <div class="doc-copy"> | |
5250 | <section class="swagger-request-security"> | |
5251 | <table class="table"> | |
5252 | <thead> | |
5253 | <tr> | |
5254 | <th class="swagger-request-security-schema"></th> | |
5255 | <th class="swagger-request-security-scopes"></th> | |
5256 | </tr> | |
5257 | </thead> | |
5258 | <tbody> | |
5259 | <tr> | |
5260 | <td> | |
5261 | <a href="#security-definition-OAuth2">OAuth2</a> | |
5262 | </td> | |
5263 | <td> </td> | |
5264 | </tr> | |
5265 | </tbody> | |
5266 | </table> | |
5267 | </section> | |
5268 | </div> | |
5269 | </div> | |
5e1c08eb | 5270 | </div> |
cc918ac3 C |
5271 | <div id="operation--video-channels--id--videos-get" class="operation panel" data-traverse-target="operation--video-channels--id--videos-get"> |
5272 | <!-- <section class="operation-tags row"> --> | |
5273 | <!-- <div class="doc-copy"> --> | |
5274 | <div class="operation-tags"> | |
5275 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
5276 | <!----> | |
5277 | </div> | |
5278 | <!-- </div> --> | |
5279 | <!-- </section> --> | |
5280 | <h2 class="operation-title"> | |
5281 | <span class="operation-name"> | |
5282 | <span class="operation-name">GET</span> | |
5283 | <span class="operation-path">/video-channels/{id}/videos</span> | |
5284 | </span> | |
5285 | </h2> | |
5286 | <div class="doc-row"> | |
5287 | <div class="doc-copy"> | |
5288 | <section class="swagger-request-params"> | |
5289 | <div class="prop-row prop-group"> | |
5290 | <div class="prop-name"> | |
5291 | <div class="prop-title">id</div> | |
5292 | <span class="json-property-required"></span> | |
5293 | <div class="prop-subtitle"> in path </div> | |
5294 | <div class="prop-subtitle"> | |
5295 | <span class="json-property-type">string</span> | |
5296 | <span class="json-property-range" title="Value limits"></span> | |
5297 | </div> | |
5298 | </div> | |
5299 | <div class="prop-value"> | |
5300 | <p>The video channel id </p> | |
5301 | </div> | |
5302 | </div> | |
5303 | </section> | |
5304 | </div> | |
5305 | <div class="doc-examples"></div> | |
5306 | </div> | |
5307 | <div class="doc-row"> | |
5308 | <div class="doc-copy"> | |
5309 | <section class="swagger-responses"> | |
5310 | <div class="prop-row prop-group"> | |
5311 | <div class="prop-name"> | |
5312 | <div class="prop-title">200 OK</div> | |
5313 | <div class="prop-ref"> | |
5314 | <span class=""> | |
5315 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
5316 | </span> | |
5317 | </div> | |
5318 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
5319 | </div> | |
5320 | <div class="prop-value"> | |
5321 | <p>successful operation</p> | |
5322 | </div> | |
5323 | </div> | |
5324 | </section> | |
5325 | </div> | |
5326 | <div class="doc-examples"> | |
5327 | <h5>Response Content-Types: | |
5328 | <span>application/json</span> | |
5329 | </h5> | |
5330 | <section> | |
5331 | <h5>Response Example | |
5332 | <span>(200 OK)</span> | |
5333 | </h5> | |
5334 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5335 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5336 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5337 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5338 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
5339 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5340 | <span class="hljs-attr">"category"</span>: { | |
5341 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5342 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
5343 | }, | |
5344 | <span class="hljs-attr">"licence"</span>: { | |
5345 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5346 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
5347 | }, | |
5348 | <span class="hljs-attr">"language"</span>: { | |
5349 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
5350 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
5351 | }, | |
5352 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
5353 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
5354 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
5355 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
5356 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5357 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
5358 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
5359 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
5360 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
5361 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
5362 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
5363 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
5364 | <span class="hljs-attr">"account"</span>: { | |
5365 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5366 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5367 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5368 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5369 | <span class="hljs-attr">"avatar"</span>: { | |
5370 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5371 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5372 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5373 | } | |
5374 | } | |
5375 | } | |
5376 | </code></pre> | |
5377 | <!-- </div> --> | |
5378 | </section> | |
5379 | </div> | |
5380 | </div> | |
5381 | </div> | |
ad9e39fb | 5382 | <div id="operation--accounts--name--video-channels-get" class="operation panel" data-traverse-target="operation--accounts--name--video-channels-get"> |
cc918ac3 C |
5383 | <!-- <section class="operation-tags row"> --> |
5384 | <!-- <div class="doc-copy"> --> | |
5385 | <div class="operation-tags"> | |
5386 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
5387 | <!----> | |
5388 | </div> | |
5389 | <!-- </div> --> | |
5390 | <!-- </section> --> | |
5391 | <h2 class="operation-title"> | |
5392 | <span class="operation-name"> | |
5393 | <span class="operation-name">GET</span> | |
ad9e39fb | 5394 | <span class="operation-path">/accounts/{name}/video-channels</span> |
cc918ac3 C |
5395 | </span> |
5396 | </h2> | |
5397 | <div class="doc-row"> | |
5398 | <div class="doc-copy"> | |
5399 | <section class="swagger-request-params"> | |
5400 | <div class="prop-row prop-group"> | |
5401 | <div class="prop-name"> | |
ad9e39fb | 5402 | <div class="prop-title">name</div> |
cc918ac3 C |
5403 | <span class="json-property-required"></span> |
5404 | <div class="prop-subtitle"> in path </div> | |
5405 | <div class="prop-subtitle"> | |
5406 | <span class="json-property-type">string</span> | |
5407 | <span class="json-property-range" title="Value limits"></span> | |
5408 | </div> | |
5409 | </div> | |
5410 | <div class="prop-value"> | |
ad9e39fb C |
5411 | <p>The name of the account (chocobozzz or |
5412 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | |
cc918ac3 C |
5413 | </div> |
5414 | </div> | |
5415 | </section> | |
5416 | </div> | |
5417 | <div class="doc-examples"></div> | |
5418 | </div> | |
5419 | <div class="doc-row"> | |
5420 | <div class="doc-copy"> | |
5421 | <section class="swagger-responses"> | |
5422 | <div class="prop-row prop-group"> | |
5423 | <div class="prop-name"> | |
5424 | <div class="prop-title">200 OK</div> | |
5425 | <div class="prop-ref"> | |
5426 | <span class="json-schema-ref-array"> | |
5427 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
5428 | </span> | |
5429 | </div> | |
5430 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
5431 | </div> | |
5432 | <div class="prop-value"> | |
5433 | <p>successful operation</p> | |
5434 | </div> | |
5435 | </div> | |
5436 | <div class="prop-row prop-inner"> | |
5437 | <div class="prop-name">type</div> | |
5438 | <div class="prop-value"> | |
5439 | <span class="json-property-type"> | |
5440 | <span class="json-schema-ref-array"> | |
5441 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
5442 | </span> | |
5443 | </span> | |
5444 | <span class="json-property-range" title="Value limits"></span> | |
5445 | </div> | |
5446 | </div> | |
5447 | </section> | |
5448 | </div> | |
5449 | <div class="doc-examples"> | |
5450 | <h5>Response Content-Types: | |
5451 | <span>application/json</span> | |
5452 | </h5> | |
5453 | <section> | |
5454 | <h5>Response Example | |
5455 | <span>(200 OK)</span> | |
5456 | </h5> | |
5457 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
5458 | { | |
5459 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5460 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
5461 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
5462 | <span class="hljs-attr">"ownerAccount"</span>: { | |
5463 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5464 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
5465 | } | |
5466 | } | |
5467 | ] | |
5468 | </code></pre> | |
5469 | <!-- </div> --> | |
5470 | </section> | |
5471 | </div> | |
5472 | </div> | |
5473 | </div> | |
5e1c08eb | 5474 | <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1> |
ab0ee6a1 | 5475 | <div id="operation--videos--videoId--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-get"> |
5e1c08eb C |
5476 | <!-- <section class="operation-tags row"> --> |
5477 | <!-- <div class="doc-copy"> --> | |
5478 | <div class="operation-tags"> | |
5479 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
5480 | <!----> | |
5481 | </div> | |
5482 | <!-- </div> --> | |
5483 | <!-- </section> --> | |
5484 | <h2 class="operation-title"> | |
5485 | <span class="operation-name"> | |
5486 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 5487 | <span class="operation-path">/videos/{videoId}/comment-threads</span> |
5e1c08eb C |
5488 | </span> |
5489 | </h2> | |
5490 | <div class="doc-row"> | |
5491 | <div class="doc-copy"> | |
5492 | <section class="swagger-request-params"> | |
5493 | <div class="prop-row prop-group"> | |
5494 | <div class="prop-name"> | |
ab0ee6a1 C |
5495 | <div class="prop-title">videoId</div> |
5496 | <span class="json-property-required"></span> | |
228e84aa C |
5497 | <div class="prop-subtitle"> in path </div> |
5498 | <div class="prop-subtitle"> | |
5499 | <span class="json-property-type">string</span> | |
5500 | <span class="json-property-range" title="Value limits"></span> | |
5501 | </div> | |
ab0ee6a1 C |
5502 | </div> |
5503 | <div class="prop-value"> | |
5504 | <p>The video id </p> | |
5505 | </div> | |
5506 | </div> | |
ab0ee6a1 C |
5507 | <div class="prop-row prop-group"> |
5508 | <div class="prop-name"> | |
5509 | <div class="prop-title">start</div> | |
228e84aa C |
5510 | <div class="prop-subtitle"> in query </div> |
5511 | <div class="prop-subtitle"> | |
5512 | <span class="json-property-type">number</span> | |
5513 | <span class="json-property-range" title="Value limits"></span> | |
5514 | </div> | |
ab0ee6a1 C |
5515 | </div> |
5516 | <div class="prop-value"> | |
5517 | <p>starting page</p> | |
5518 | </div> | |
5519 | </div> | |
ab0ee6a1 C |
5520 | <div class="prop-row prop-group"> |
5521 | <div class="prop-name"> | |
5522 | <div class="prop-title">stop</div> | |
228e84aa C |
5523 | <div class="prop-subtitle"> in query </div> |
5524 | <div class="prop-subtitle"> | |
5525 | <span class="json-property-type">number</span> | |
5526 | <span class="json-property-range" title="Value limits"></span> | |
5527 | </div> | |
5e1c08eb C |
5528 | </div> |
5529 | <div class="prop-value"> | |
f209b32a | 5530 | <p>stopping page</p> |
5e1c08eb C |
5531 | </div> |
5532 | </div> | |
ab0ee6a1 C |
5533 | <div class="prop-row prop-group"> |
5534 | <div class="prop-name"> | |
5535 | <div class="prop-title">sort</div> | |
228e84aa C |
5536 | <div class="prop-subtitle"> in query </div> |
5537 | <div class="prop-subtitle"> | |
5538 | <span class="json-property-type">number</span> | |
5539 | <span class="json-property-range" title="Value limits"></span> | |
5540 | </div> | |
ab0ee6a1 C |
5541 | </div> |
5542 | <div class="prop-value"> | |
5543 | <p>sorting</p> | |
5544 | </div> | |
5545 | </div> | |
5e1c08eb C |
5546 | </section> |
5547 | </div> | |
5548 | <div class="doc-examples"></div> | |
5549 | </div> | |
5550 | <div class="doc-row"> | |
5551 | <div class="doc-copy"> | |
5552 | <section class="swagger-responses"> | |
5553 | <div class="prop-row prop-group"> | |
5554 | <div class="prop-name"> | |
5555 | <div class="prop-title">200 OK</div> | |
5556 | <div class="prop-ref"> | |
5557 | <span class=""> | |
ab0ee6a1 | 5558 | <a class="json-schema-ref" href="#/definitions/CommentThreadResponse">CommentThreadResponse</a> |
5e1c08eb C |
5559 | </span> |
5560 | </div> | |
5561 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
5562 | </div> | |
5563 | <div class="prop-value"> | |
5564 | <p>successful operation</p> | |
5565 | </div> | |
5566 | </div> | |
5567 | </section> | |
5568 | </div> | |
5569 | <div class="doc-examples"> | |
5570 | <h5>Response Content-Types: | |
5571 | <span>application/json</span> | |
5572 | </h5> | |
5573 | <section> | |
5574 | <h5>Response Example | |
5575 | <span>(200 OK)</span> | |
5576 | </h5> | |
ab0ee6a1 C |
5577 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ |
5578 | <span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>, | |
5579 | <span class="hljs-attr">"data"</span>: [ | |
5580 | { | |
5581 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5582 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5583 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
5584 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
5585 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
5586 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
5587 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5588 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5589 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
5590 | <span class="hljs-attr">"account"</span>: { | |
5591 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5592 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5593 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5594 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5595 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5596 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5597 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5598 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5599 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5600 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5601 | <span class="hljs-attr">"avatar"</span>: { | |
5602 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5603 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5604 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5605 | } | |
5606 | } | |
5607 | } | |
5608 | ] | |
5609 | } | |
5610 | </code></pre> | |
5e1c08eb C |
5611 | <!-- </div> --> |
5612 | </section> | |
5613 | </div> | |
5614 | </div> | |
5615 | </div> | |
ab0ee6a1 | 5616 | <div id="operation--videos--videoId--comment-threads-post" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-post"> |
5e1c08eb C |
5617 | <!-- <section class="operation-tags row"> --> |
5618 | <!-- <div class="doc-copy"> --> | |
5619 | <div class="operation-tags"> | |
5620 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
5621 | <!----> | |
5622 | </div> | |
5623 | <!-- </div> --> | |
5624 | <!-- </section> --> | |
5625 | <h2 class="operation-title"> | |
5626 | <span class="operation-name"> | |
5627 | <span class="operation-name">POST</span> | |
ab0ee6a1 | 5628 | <span class="operation-path">/videos/{videoId}/comment-threads</span> |
5e1c08eb C |
5629 | </span> |
5630 | </h2> | |
5631 | <div class="doc-row"> | |
5632 | <div class="doc-copy"> | |
5633 | <section class="swagger-request-params"> | |
5634 | <div class="prop-row prop-group"> | |
5635 | <div class="prop-name"> | |
5636 | <div class="prop-title">videoId</div> | |
5637 | <span class="json-property-required"></span> | |
228e84aa C |
5638 | <div class="prop-subtitle"> in path </div> |
5639 | <div class="prop-subtitle"> | |
5640 | <span class="json-property-type">string</span> | |
5641 | <span class="json-property-range" title="Value limits"></span> | |
5642 | </div> | |
5e1c08eb C |
5643 | </div> |
5644 | <div class="prop-value"> | |
5645 | <p>The video id </p> | |
5646 | </div> | |
5647 | </div> | |
5e1c08eb C |
5648 | </section> |
5649 | </div> | |
5650 | <div class="doc-examples"></div> | |
5651 | </div> | |
5652 | <div class="doc-row"> | |
5653 | <div class="doc-copy"> | |
5654 | <section class="swagger-responses"> | |
5655 | <div class="prop-row prop-group"> | |
5656 | <div class="prop-name"> | |
5657 | <div class="prop-title">200 OK</div> | |
ab0ee6a1 C |
5658 | <div class="prop-ref"> |
5659 | <span class=""> | |
5660 | <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a> | |
5661 | </span> | |
5662 | </div> | |
5663 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
5e1c08eb C |
5664 | </div> |
5665 | <div class="prop-value"> | |
5666 | <p>successful operation</p> | |
5667 | </div> | |
5668 | </div> | |
5669 | </section> | |
5670 | </div> | |
5671 | <div class="doc-examples"> | |
5672 | <h5>Response Content-Types: | |
5673 | <span>application/json</span> | |
5674 | </h5> | |
ab0ee6a1 C |
5675 | <section> |
5676 | <h5>Response Example | |
5677 | <span>(200 OK)</span> | |
5678 | </h5> | |
5679 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5680 | <span class="hljs-attr">"comment"</span>: { | |
5681 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5682 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5683 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
5684 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
5685 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
5686 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
5687 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5688 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5689 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
5690 | <span class="hljs-attr">"account"</span>: { | |
5691 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5692 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5693 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5694 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5695 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5696 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5697 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5698 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5699 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5700 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5701 | <span class="hljs-attr">"avatar"</span>: { | |
5702 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5703 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5704 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5705 | } | |
5706 | } | |
5707 | } | |
5708 | } | |
5709 | </code></pre> | |
5710 | <!-- </div> --> | |
5711 | </section> | |
5e1c08eb C |
5712 | </div> |
5713 | </div> | |
94ff4c23 C |
5714 | <div class="doc-row"> |
5715 | <div class="doc-copy"> | |
5716 | <section class="swagger-request-security"> | |
5717 | <table class="table"> | |
5718 | <thead> | |
5719 | <tr> | |
5720 | <th class="swagger-request-security-schema"></th> | |
5721 | <th class="swagger-request-security-scopes"></th> | |
5722 | </tr> | |
5723 | </thead> | |
5724 | <tbody> | |
5725 | <tr> | |
5726 | <td> | |
5727 | <a href="#security-definition-OAuth2">OAuth2</a> | |
5728 | </td> | |
5729 | <td> </td> | |
5730 | </tr> | |
5731 | </tbody> | |
5732 | </table> | |
5733 | </section> | |
5734 | </div> | |
5735 | </div> | |
5e1c08eb | 5736 | </div> |
ab0ee6a1 | 5737 | <div id="operation--videos--videoId--comment-threads--threadId--get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads--threadId--get"> |
5e1c08eb C |
5738 | <!-- <section class="operation-tags row"> --> |
5739 | <!-- <div class="doc-copy"> --> | |
5740 | <div class="operation-tags"> | |
5741 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
5742 | <!----> | |
5743 | </div> | |
5744 | <!-- </div> --> | |
5745 | <!-- </section> --> | |
5746 | <h2 class="operation-title"> | |
5747 | <span class="operation-name"> | |
5748 | <span class="operation-name">GET</span> | |
ab0ee6a1 | 5749 | <span class="operation-path">/videos/{videoId}/comment-threads/{threadId}</span> |
5e1c08eb C |
5750 | </span> |
5751 | </h2> | |
5752 | <div class="doc-row"> | |
5753 | <div class="doc-copy"> | |
5754 | <section class="swagger-request-params"> | |
5755 | <div class="prop-row prop-group"> | |
5756 | <div class="prop-name"> | |
5757 | <div class="prop-title">videoId</div> | |
5758 | <span class="json-property-required"></span> | |
228e84aa C |
5759 | <div class="prop-subtitle"> in path </div> |
5760 | <div class="prop-subtitle"> | |
5761 | <span class="json-property-type">string</span> | |
5762 | <span class="json-property-range" title="Value limits"></span> | |
5763 | </div> | |
5e1c08eb C |
5764 | </div> |
5765 | <div class="prop-value"> | |
5766 | <p>The video id </p> | |
5767 | </div> | |
5768 | </div> | |
5e1c08eb C |
5769 | <div class="prop-row prop-group"> |
5770 | <div class="prop-name"> | |
5771 | <div class="prop-title">threadId</div> | |
5772 | <span class="json-property-required"></span> | |
228e84aa C |
5773 | <div class="prop-subtitle"> in path </div> |
5774 | <div class="prop-subtitle"> | |
5775 | <span class="json-property-type">string</span> | |
5776 | <span class="json-property-range" title="Value limits"></span> | |
5777 | </div> | |
5e1c08eb C |
5778 | </div> |
5779 | <div class="prop-value"> | |
5780 | <p>The thread id </p> | |
5781 | </div> | |
5782 | </div> | |
5e1c08eb C |
5783 | </section> |
5784 | </div> | |
5785 | <div class="doc-examples"></div> | |
5786 | </div> | |
5787 | <div class="doc-row"> | |
5788 | <div class="doc-copy"> | |
5789 | <section class="swagger-responses"> | |
5790 | <div class="prop-row prop-group"> | |
5791 | <div class="prop-name"> | |
5792 | <div class="prop-title">200 OK</div> | |
5793 | <div class="prop-ref"> | |
5794 | <span class=""> | |
5795 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
5796 | </span> | |
5797 | </div> | |
5798 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
5799 | </div> | |
5800 | <div class="prop-value"> | |
5801 | <p>successful operation</p> | |
5802 | </div> | |
5803 | </div> | |
5804 | </section> | |
5805 | </div> | |
5806 | <div class="doc-examples"> | |
5807 | <h5>Response Content-Types: | |
5808 | <span>application/json</span> | |
5809 | </h5> | |
5810 | <section> | |
5811 | <h5>Response Example | |
5812 | <span>(200 OK)</span> | |
5813 | </h5> | |
5814 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5815 | <span class="hljs-attr">"comment"</span>: { | |
5816 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5817 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5818 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
5819 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
5820 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
5821 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
5822 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5823 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5824 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
5825 | <span class="hljs-attr">"account"</span>: { | |
5826 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5827 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5828 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5829 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5830 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5831 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5832 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5833 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5834 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5835 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5836 | <span class="hljs-attr">"avatar"</span>: { | |
5837 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5838 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5839 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5840 | } | |
5841 | } | |
5842 | }, | |
5843 | <span class="hljs-attr">"children"</span>: [ | |
5844 | { | |
5845 | <span class="hljs-attr">"comment"</span>: { | |
5846 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5847 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5848 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
5849 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
5850 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
5851 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
5852 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5853 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5854 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
5855 | <span class="hljs-attr">"account"</span>: { | |
5856 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
5857 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5858 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5859 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5860 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5861 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5862 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5863 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5864 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5865 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5866 | <span class="hljs-attr">"avatar"</span>: { | |
5867 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5868 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5869 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5870 | } | |
5871 | } | |
5872 | }, | |
5873 | <span class="hljs-attr">"children"</span>: [ | |
5874 | { | |
5875 | <span class="hljs-attr">"comment"</span>: { | |
5876 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5877 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5878 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
5879 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
5880 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
5881 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
5882 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5883 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5884 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
5885 | <span class="hljs-attr">"account"</span>: { | |
5886 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5887 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5888 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5889 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5890 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
5891 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
5892 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
5893 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5894 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
5895 | <span class="hljs-attr">"avatar"</span>: { | |
5896 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
5897 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5898 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
5899 | } | |
5900 | } | |
5901 | } | |
5902 | } | |
5903 | ] | |
5904 | } | |
5905 | ] | |
5906 | } | |
5907 | </code></pre> | |
5908 | <!-- </div> --> | |
5909 | </section> | |
5910 | </div> | |
5911 | </div> | |
5912 | </div> | |
ab0ee6a1 | 5913 | <div id="operation--videos--videoId--comments--commentId--post" class="operation panel" data-traverse-target="operation--videos--videoId--comments--commentId--post"> |
5e1c08eb C |
5914 | <!-- <section class="operation-tags row"> --> |
5915 | <!-- <div class="doc-copy"> --> | |
5916 | <div class="operation-tags"> | |
5917 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
5918 | <!----> | |
5919 | </div> | |
5920 | <!-- </div> --> | |
5921 | <!-- </section> --> | |
5922 | <h2 class="operation-title"> | |
5923 | <span class="operation-name"> | |
5924 | <span class="operation-name">POST</span> | |
ab0ee6a1 | 5925 | <span class="operation-path">/videos/{videoId}/comments/{commentId}</span> |
5e1c08eb C |
5926 | </span> |
5927 | </h2> | |
5928 | <div class="doc-row"> | |
5929 | <div class="doc-copy"> | |
5930 | <section class="swagger-request-params"> | |
5931 | <div class="prop-row prop-group"> | |
5932 | <div class="prop-name"> | |
5933 | <div class="prop-title">videoId</div> | |
5934 | <span class="json-property-required"></span> | |
228e84aa C |
5935 | <div class="prop-subtitle"> in path </div> |
5936 | <div class="prop-subtitle"> | |
5937 | <span class="json-property-type">string</span> | |
5938 | <span class="json-property-range" title="Value limits"></span> | |
5939 | </div> | |
5e1c08eb C |
5940 | </div> |
5941 | <div class="prop-value"> | |
5942 | <p>The video id </p> | |
5943 | </div> | |
5944 | </div> | |
5e1c08eb C |
5945 | <div class="prop-row prop-group"> |
5946 | <div class="prop-name"> | |
5947 | <div class="prop-title">commentId</div> | |
5948 | <span class="json-property-required"></span> | |
228e84aa C |
5949 | <div class="prop-subtitle"> in path </div> |
5950 | <div class="prop-subtitle"> | |
5951 | <span class="json-property-type">string</span> | |
5952 | <span class="json-property-range" title="Value limits"></span> | |
5953 | </div> | |
5e1c08eb C |
5954 | </div> |
5955 | <div class="prop-value"> | |
5956 | <p>The comment id </p> | |
5957 | </div> | |
5958 | </div> | |
5e1c08eb C |
5959 | </section> |
5960 | </div> | |
5961 | <div class="doc-examples"></div> | |
5962 | </div> | |
5963 | <div class="doc-row"> | |
5964 | <div class="doc-copy"> | |
5965 | <section class="swagger-responses"> | |
5966 | <div class="prop-row prop-group"> | |
5967 | <div class="prop-name"> | |
5968 | <div class="prop-title">200 OK</div> | |
ab0ee6a1 C |
5969 | <div class="prop-ref"> |
5970 | <span class=""> | |
5971 | <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a> | |
5972 | </span> | |
5973 | </div> | |
5974 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
5e1c08eb C |
5975 | </div> |
5976 | <div class="prop-value"> | |
5977 | <p>successful operation</p> | |
5978 | </div> | |
5979 | </div> | |
5980 | </section> | |
5981 | </div> | |
5982 | <div class="doc-examples"> | |
5983 | <h5>Response Content-Types: | |
5984 | <span>application/json</span> | |
5985 | </h5> | |
ab0ee6a1 C |
5986 | <section> |
5987 | <h5>Response Example | |
5988 | <span>(200 OK)</span> | |
5989 | </h5> | |
5990 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
5991 | <span class="hljs-attr">"comment"</span>: { | |
5992 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5993 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
5994 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
5995 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
5996 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
5997 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
5998 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
5999 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6000 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
6001 | <span class="hljs-attr">"account"</span>: { | |
6002 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
6003 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6004 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
6005 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6006 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6007 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
6008 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
6009 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
6010 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6011 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6012 | <span class="hljs-attr">"avatar"</span>: { | |
6013 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
6014 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6015 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
6016 | } | |
6017 | } | |
6018 | } | |
6019 | } | |
6020 | </code></pre> | |
6021 | <!-- </div> --> | |
6022 | </section> | |
5e1c08eb C |
6023 | </div> |
6024 | </div> | |
94ff4c23 C |
6025 | <div class="doc-row"> |
6026 | <div class="doc-copy"> | |
6027 | <section class="swagger-request-security"> | |
6028 | <table class="table"> | |
6029 | <thead> | |
6030 | <tr> | |
6031 | <th class="swagger-request-security-schema"></th> | |
6032 | <th class="swagger-request-security-scopes"></th> | |
6033 | </tr> | |
6034 | </thead> | |
6035 | <tbody> | |
6036 | <tr> | |
6037 | <td> | |
6038 | <a href="#security-definition-OAuth2">OAuth2</a> | |
6039 | </td> | |
6040 | <td> </td> | |
6041 | </tr> | |
6042 | </tbody> | |
6043 | </table> | |
6044 | </section> | |
6045 | </div> | |
6046 | </div> | |
5e1c08eb | 6047 | </div> |
ab0ee6a1 | 6048 | <div id="operation--videos--videoId--comments--commentId--delete" class="operation panel" data-traverse-target="operation--videos--videoId--comments--commentId--delete"> |
5e1c08eb C |
6049 | <!-- <section class="operation-tags row"> --> |
6050 | <!-- <div class="doc-copy"> --> | |
6051 | <div class="operation-tags"> | |
6052 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
6053 | <!----> | |
6054 | </div> | |
6055 | <!-- </div> --> | |
6056 | <!-- </section> --> | |
6057 | <h2 class="operation-title"> | |
6058 | <span class="operation-name"> | |
6059 | <span class="operation-name">DELETE</span> | |
ab0ee6a1 | 6060 | <span class="operation-path">/videos/{videoId}/comments/{commentId}</span> |
5e1c08eb C |
6061 | </span> |
6062 | </h2> | |
6063 | <div class="doc-row"> | |
6064 | <div class="doc-copy"> | |
6065 | <section class="swagger-request-params"> | |
6066 | <div class="prop-row prop-group"> | |
6067 | <div class="prop-name"> | |
6068 | <div class="prop-title">videoId</div> | |
6069 | <span class="json-property-required"></span> | |
228e84aa C |
6070 | <div class="prop-subtitle"> in path </div> |
6071 | <div class="prop-subtitle"> | |
6072 | <span class="json-property-type">string</span> | |
6073 | <span class="json-property-range" title="Value limits"></span> | |
6074 | </div> | |
5e1c08eb C |
6075 | </div> |
6076 | <div class="prop-value"> | |
6077 | <p>The video id </p> | |
6078 | </div> | |
6079 | </div> | |
5e1c08eb C |
6080 | <div class="prop-row prop-group"> |
6081 | <div class="prop-name"> | |
6082 | <div class="prop-title">commentId</div> | |
6083 | <span class="json-property-required"></span> | |
228e84aa C |
6084 | <div class="prop-subtitle"> in path </div> |
6085 | <div class="prop-subtitle"> | |
6086 | <span class="json-property-type">string</span> | |
6087 | <span class="json-property-range" title="Value limits"></span> | |
6088 | </div> | |
5e1c08eb C |
6089 | </div> |
6090 | <div class="prop-value"> | |
6091 | <p>The comment id </p> | |
6092 | </div> | |
6093 | </div> | |
5e1c08eb C |
6094 | </section> |
6095 | </div> | |
6096 | <div class="doc-examples"></div> | |
6097 | </div> | |
6098 | <div class="doc-row"> | |
6099 | <div class="doc-copy"> | |
6100 | <section class="swagger-responses"> | |
6101 | <div class="prop-row prop-group"> | |
6102 | <div class="prop-name"> | |
6103 | <div class="prop-title">204 No Content</div> | |
6104 | </div> | |
6105 | <div class="prop-value"> | |
6106 | <p>successful operation</p> | |
6107 | </div> | |
6108 | </div> | |
6109 | </section> | |
6110 | </div> | |
6111 | <div class="doc-examples"> | |
6112 | <h5>Response Content-Types: | |
6113 | <span>application/json</span> | |
6114 | </h5> | |
6115 | </div> | |
6116 | </div> | |
94ff4c23 C |
6117 | <div class="doc-row"> |
6118 | <div class="doc-copy"> | |
6119 | <section class="swagger-request-security"> | |
6120 | <table class="table"> | |
6121 | <thead> | |
6122 | <tr> | |
6123 | <th class="swagger-request-security-schema"></th> | |
6124 | <th class="swagger-request-security-scopes"></th> | |
6125 | </tr> | |
6126 | </thead> | |
6127 | <tbody> | |
6128 | <tr> | |
6129 | <td> | |
6130 | <a href="#security-definition-OAuth2">OAuth2</a> | |
6131 | </td> | |
6132 | <td> </td> | |
6133 | </tr> | |
6134 | </tbody> | |
6135 | </table> | |
6136 | </section> | |
6137 | </div> | |
6138 | </div> | |
5e1c08eb C |
6139 | </div> |
6140 | <h1 id="tag-VideoRate" class="swagger-summary-tag" data-traverse-target="tag-VideoRate">VideoRate</h1> | |
ab0ee6a1 | 6141 | <div id="operation--videos--id--rate-put" class="operation panel" data-traverse-target="operation--videos--id--rate-put"> |
5e1c08eb C |
6142 | <!-- <section class="operation-tags row"> --> |
6143 | <!-- <div class="doc-copy"> --> | |
6144 | <div class="operation-tags"> | |
6145 | <a class="label" href="#tag-VideoRate">VideoRate</a> | |
6146 | <!----> | |
6147 | </div> | |
6148 | <!-- </div> --> | |
6149 | <!-- </section> --> | |
6150 | <h2 class="operation-title"> | |
6151 | <span class="operation-name"> | |
6152 | <span class="operation-name">PUT</span> | |
ab0ee6a1 | 6153 | <span class="operation-path">/videos/{id}/rate</span> |
5e1c08eb C |
6154 | </span> |
6155 | </h2> | |
6156 | <div class="doc-row"> | |
6157 | <div class="doc-copy"> | |
6158 | <section class="swagger-request-params"> | |
6159 | <div class="prop-row prop-group"> | |
6160 | <div class="prop-name"> | |
6161 | <div class="prop-title">id</div> | |
6162 | <span class="json-property-required"></span> | |
228e84aa C |
6163 | <div class="prop-subtitle"> in path </div> |
6164 | <div class="prop-subtitle"> | |
6165 | <span class="json-property-type">string</span> | |
6166 | <span class="json-property-range" title="Value limits"></span> | |
6167 | </div> | |
5e1c08eb C |
6168 | </div> |
6169 | <div class="prop-value"> | |
6170 | <p>The video id </p> | |
6171 | </div> | |
6172 | </div> | |
5e1c08eb C |
6173 | </section> |
6174 | </div> | |
6175 | <div class="doc-examples"></div> | |
6176 | </div> | |
6177 | <div class="doc-row"> | |
6178 | <div class="doc-copy"> | |
6179 | <section class="swagger-responses"> | |
6180 | <div class="prop-row prop-group"> | |
6181 | <div class="prop-name"> | |
6182 | <div class="prop-title">204 No Content</div> | |
6183 | </div> | |
6184 | <div class="prop-value"> | |
6185 | <p>successful operation</p> | |
6186 | </div> | |
6187 | </div> | |
6188 | </section> | |
6189 | </div> | |
6190 | <div class="doc-examples"> | |
6191 | <h5>Response Content-Types: | |
6192 | <span>application/json</span> | |
6193 | </h5> | |
6194 | </div> | |
6195 | </div> | |
94ff4c23 C |
6196 | <div class="doc-row"> |
6197 | <div class="doc-copy"> | |
6198 | <section class="swagger-request-security"> | |
6199 | <table class="table"> | |
6200 | <thead> | |
6201 | <tr> | |
6202 | <th class="swagger-request-security-schema"></th> | |
6203 | <th class="swagger-request-security-scopes"></th> | |
6204 | </tr> | |
6205 | </thead> | |
6206 | <tbody> | |
6207 | <tr> | |
6208 | <td> | |
6209 | <a href="#security-definition-OAuth2">OAuth2</a> | |
6210 | </td> | |
6211 | <td> </td> | |
6212 | </tr> | |
6213 | </tbody> | |
6214 | </table> | |
6215 | </section> | |
6216 | </div> | |
6217 | </div> | |
5e1c08eb C |
6218 | </div> |
6219 | <h1>Schema Definitions</h1> | |
48dce1c9 | 6220 | <div id="definition-VideoConstantNumber" class="definition panel" data-traverse-target="definition-VideoConstantNumber"> |
5d00a3d7 | 6221 | <h2 class="panel-title"> |
48dce1c9 | 6222 | <a name="/definitions/VideoConstantNumber"></a>VideoConstantNumber: |
5d00a3d7 C |
6223 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
6224 | <span class="json-property-range" title="Value limits"></span> | |
6225 | ||
6226 | ||
6227 | </span> --> | |
6228 | </h2> | |
6229 | <div class="doc-row"> | |
6230 | <div class="doc-copy"> | |
6231 | <section class="json-schema-properties"> | |
6232 | <dl> | |
6233 | <dt data-property-name="id"> | |
6234 | <span class="json-property-name">id:</span> | |
6235 | <span class="json-property-type">number</span> | |
6236 | <span class="json-property-range" title="Value limits"></span> | |
6237 | </dt> | |
6238 | <dt data-property-name="label"> | |
6239 | <span class="json-property-name">label:</span> | |
6240 | <span class="json-property-type">string</span> | |
6241 | <span class="json-property-range" title="Value limits"></span> | |
6242 | </dt> | |
6243 | </dl> | |
6244 | </section> | |
6245 | </div> | |
6246 | <div class="doc-examples"> | |
6247 | <section> | |
6248 | <h5>Example</h5> | |
6249 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6250 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6251 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
6252 | } | |
48dce1c9 C |
6253 | </code></pre> |
6254 | <!-- </div> --> | |
6255 | </section> | |
6256 | </div> | |
6257 | </div> | |
6258 | </div> | |
6259 | <div id="definition-VideoConstantString" class="definition panel" data-traverse-target="definition-VideoConstantString"> | |
6260 | <h2 class="panel-title"> | |
6261 | <a name="/definitions/VideoConstantString"></a>VideoConstantString: | |
6262 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6263 | <span class="json-property-range" title="Value limits"></span> | |
6264 | ||
6265 | ||
6266 | </span> --> | |
6267 | </h2> | |
6268 | <div class="doc-row"> | |
6269 | <div class="doc-copy"> | |
6270 | <section class="json-schema-properties"> | |
6271 | <dl> | |
6272 | <dt data-property-name="id"> | |
6273 | <span class="json-property-name">id:</span> | |
6274 | <span class="json-property-type">string</span> | |
6275 | <span class="json-property-range" title="Value limits"></span> | |
6276 | </dt> | |
6277 | <dt data-property-name="label"> | |
6278 | <span class="json-property-name">label:</span> | |
6279 | <span class="json-property-type">string</span> | |
6280 | <span class="json-property-range" title="Value limits"></span> | |
6281 | </dt> | |
6282 | </dl> | |
6283 | </section> | |
6284 | </div> | |
6285 | <div class="doc-examples"> | |
6286 | <section> | |
6287 | <h5>Example</h5> | |
6288 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6289 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
6290 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
6291 | } | |
5d00a3d7 C |
6292 | </code></pre> |
6293 | <!-- </div> --> | |
6294 | </section> | |
6295 | </div> | |
6296 | </div> | |
6297 | </div> | |
61b66b36 C |
6298 | <div id="definition-VideoPrivacy" class="definition panel" data-traverse-target="definition-VideoPrivacy"> |
6299 | <h2 class="panel-title"> | |
6300 | <a name="/definitions/VideoPrivacy"></a>VideoPrivacy: string | |
6301 | <!-- <span class="json-property-type"><span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values"> | |
6302 | <span class="json-property-enum-item">Public</span>, | |
6303 | <span class="json-property-enum-item">Unlisted</span>, | |
6304 | <span class="json-property-enum-item">Private</span> | |
6305 | </span> | |
6306 | <span class="json-property-range" title="Value limits"></span> | |
6307 | ||
6308 | ||
6309 | </span> --> | |
6310 | </h2> | |
6311 | <div class="doc-row"> | |
6312 | <div class="doc-copy"> | |
6313 | <span class="json-property-type">string</span> | |
6314 | <span class="json-property-enum" title="Possible values"> | |
6315 | <span class="json-property-enum-item">Public</span>, | |
6316 | <span class="json-property-enum-item">Unlisted</span>, | |
6317 | <span class="json-property-enum-item">Private</span> | |
6318 | </span> | |
6319 | <span class="json-property-range" title="Value limits"></span> | |
6320 | </div> | |
6321 | </div> | |
6322 | </div> | |
5e1c08eb C |
6323 | <div id="definition-Video" class="definition panel" data-traverse-target="definition-Video"> |
6324 | <h2 class="panel-title"> | |
6325 | <a name="/definitions/Video"></a>Video: | |
6326 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6327 | <span class="json-property-range" title="Value limits"></span> | |
6328 | ||
6329 | ||
6330 | </span> --> | |
6331 | </h2> | |
6332 | <div class="doc-row"> | |
6333 | <div class="doc-copy"> | |
6334 | <section class="json-schema-properties"> | |
6335 | <dl> | |
6336 | <dt data-property-name="id"> | |
6337 | <span class="json-property-name">id:</span> | |
6338 | <span class="json-property-type">number</span> | |
6339 | <span class="json-property-range" title="Value limits"></span> | |
6340 | </dt> | |
6341 | <dt data-property-name="uuid"> | |
6342 | <span class="json-property-name">uuid:</span> | |
6343 | <span class="json-property-type">string</span> | |
6344 | <span class="json-property-range" title="Value limits"></span> | |
6345 | </dt> | |
5e1c08eb C |
6346 | <dt data-property-name="createdAt"> |
6347 | <span class="json-property-name">createdAt:</span> | |
6348 | <span class="json-property-type">string</span> | |
6349 | <span class="json-property-range" title="Value limits"></span> | |
6350 | </dt> | |
61b66b36 C |
6351 | <dt data-property-name="publishedAt"> |
6352 | <span class="json-property-name">publishedAt:</span> | |
6353 | <span class="json-property-type">string</span> | |
6354 | <span class="json-property-range" title="Value limits"></span> | |
6355 | </dt> | |
5e1c08eb C |
6356 | <dt data-property-name="updatedAt"> |
6357 | <span class="json-property-name">updatedAt:</span> | |
6358 | <span class="json-property-type">string</span> | |
6359 | <span class="json-property-range" title="Value limits"></span> | |
6360 | </dt> | |
5e1c08eb C |
6361 | <dt data-property-name="category"> |
6362 | <span class="json-property-name">category:</span> | |
5d00a3d7 C |
6363 | <span class="json-property-type"> |
6364 | <span class=""> | |
48dce1c9 | 6365 | <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a> |
5d00a3d7 C |
6366 | </span> |
6367 | </span> | |
5e1c08eb C |
6368 | <span class="json-property-range" title="Value limits"></span> |
6369 | </dt> | |
6370 | <dt data-property-name="licence"> | |
6371 | <span class="json-property-name">licence:</span> | |
5d00a3d7 C |
6372 | <span class="json-property-type"> |
6373 | <span class=""> | |
48dce1c9 | 6374 | <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a> |
5d00a3d7 C |
6375 | </span> |
6376 | </span> | |
5e1c08eb C |
6377 | <span class="json-property-range" title="Value limits"></span> |
6378 | </dt> | |
6379 | <dt data-property-name="language"> | |
6380 | <span class="json-property-name">language:</span> | |
5d00a3d7 C |
6381 | <span class="json-property-type"> |
6382 | <span class=""> | |
48dce1c9 | 6383 | <a class="json-schema-ref" href="#/definitions/VideoConstantString">VideoConstantString</a> |
5d00a3d7 C |
6384 | </span> |
6385 | </span> | |
5e1c08eb C |
6386 | <span class="json-property-range" title="Value limits"></span> |
6387 | </dt> | |
61b66b36 C |
6388 | <dt data-property-name="privacy"> |
6389 | <span class="json-property-name">privacy:</span> | |
6390 | <span class="json-property-type"> | |
6391 | <span class=""> | |
6392 | <a class="json-schema-ref" href="#/definitions/VideoPrivacy">VideoPrivacy</a> | |
6393 | </span> | |
6394 | </span> | |
6395 | <span class="json-property-range" title="Value limits"></span> | |
6396 | </dt> | |
5e1c08eb C |
6397 | <dt data-property-name="description"> |
6398 | <span class="json-property-name">description:</span> | |
6399 | <span class="json-property-type">string</span> | |
6400 | <span class="json-property-range" title="Value limits"></span> | |
6401 | </dt> | |
6402 | <dt data-property-name="duration"> | |
6403 | <span class="json-property-name">duration:</span> | |
6404 | <span class="json-property-type">number</span> | |
6405 | <span class="json-property-range" title="Value limits"></span> | |
6406 | </dt> | |
6407 | <dt data-property-name="isLocal"> | |
6408 | <span class="json-property-name">isLocal:</span> | |
6409 | <span class="json-property-type">boolean</span> | |
6410 | <span class="json-property-range" title="Value limits"></span> | |
6411 | </dt> | |
6412 | <dt data-property-name="name"> | |
6413 | <span class="json-property-name">name:</span> | |
6414 | <span class="json-property-type">string</span> | |
6415 | <span class="json-property-range" title="Value limits"></span> | |
6416 | </dt> | |
5e1c08eb C |
6417 | <dt data-property-name="thumbnailPath"> |
6418 | <span class="json-property-name">thumbnailPath:</span> | |
6419 | <span class="json-property-type">string</span> | |
6420 | <span class="json-property-range" title="Value limits"></span> | |
6421 | </dt> | |
6422 | <dt data-property-name="previewPath"> | |
6423 | <span class="json-property-name">previewPath:</span> | |
6424 | <span class="json-property-type">string</span> | |
6425 | <span class="json-property-range" title="Value limits"></span> | |
6426 | </dt> | |
6427 | <dt data-property-name="embedPath"> | |
6428 | <span class="json-property-name">embedPath:</span> | |
6429 | <span class="json-property-type">string</span> | |
6430 | <span class="json-property-range" title="Value limits"></span> | |
6431 | </dt> | |
6432 | <dt data-property-name="views"> | |
6433 | <span class="json-property-name">views:</span> | |
6434 | <span class="json-property-type">number</span> | |
6435 | <span class="json-property-range" title="Value limits"></span> | |
6436 | </dt> | |
6437 | <dt data-property-name="likes"> | |
6438 | <span class="json-property-name">likes:</span> | |
6439 | <span class="json-property-type">number</span> | |
6440 | <span class="json-property-range" title="Value limits"></span> | |
6441 | </dt> | |
6442 | <dt data-property-name="dislikes"> | |
6443 | <span class="json-property-name">dislikes:</span> | |
6444 | <span class="json-property-type">number</span> | |
6445 | <span class="json-property-range" title="Value limits"></span> | |
6446 | </dt> | |
6447 | <dt data-property-name="nsfw"> | |
6448 | <span class="json-property-name">nsfw:</span> | |
6449 | <span class="json-property-type">boolean</span> | |
6450 | <span class="json-property-range" title="Value limits"></span> | |
6451 | </dt> | |
5d00a3d7 C |
6452 | <dt data-property-name="account"> |
6453 | <span class="json-property-name">account:</span> | |
6454 | <span class="json-property-type">object</span> | |
6455 | <span class="json-property-range" title="Value limits"></span> | |
6456 | </dt> | |
ad9e39fb C |
6457 | <dt class="json-inner-schema"> |
6458 | <section class="json-schema-properties"> | |
6459 | <dl> | |
6460 | <dt data-property-name="name"> | |
6461 | <span class="json-property-name">name:</span> | |
6462 | <span class="json-property-type">string</span> | |
6463 | <span class="json-property-range" title="Value limits"></span> | |
6464 | </dt> | |
6465 | <dt data-property-name="displayName"> | |
6466 | <span class="json-property-name">displayName:</span> | |
6467 | <span class="json-property-type">string</span> | |
6468 | <span class="json-property-range" title="Value limits"></span> | |
6469 | </dt> | |
6470 | <dt data-property-name="url"> | |
6471 | <span class="json-property-name">url:</span> | |
6472 | <span class="json-property-type">string</span> | |
6473 | <span class="json-property-range" title="Value limits"></span> | |
6474 | </dt> | |
6475 | <dt data-property-name="host"> | |
6476 | <span class="json-property-name">host:</span> | |
6477 | <span class="json-property-type">string</span> | |
6478 | <span class="json-property-range" title="Value limits"></span> | |
6479 | </dt> | |
6480 | <dt data-property-name="avatar"> | |
6481 | <span class="json-property-name">avatar:</span> | |
6482 | <span class="json-property-type"> | |
6483 | <span class=""> | |
6484 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | |
6485 | </span> | |
6486 | </span> | |
6487 | <span class="json-property-range" title="Value limits"></span> | |
6488 | </dt> | |
6489 | </dl> | |
6490 | </section> | |
6491 | </dt> | |
5e1c08eb C |
6492 | </dl> |
6493 | </section> | |
6494 | </div> | |
6495 | <div class="doc-examples"> | |
6496 | <section> | |
6497 | <h5>Example</h5> | |
6498 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6499 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6500 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb | 6501 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
61b66b36 | 6502 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, |
5e1c08eb | 6503 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, |
5d00a3d7 C |
6504 | <span class="hljs-attr">"category"</span>: { |
6505 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6506 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
6507 | }, | |
6508 | <span class="hljs-attr">"licence"</span>: { | |
6509 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6510 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
6511 | }, | |
6512 | <span class="hljs-attr">"language"</span>: { | |
48dce1c9 | 6513 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
5d00a3d7 C |
6514 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
6515 | }, | |
61b66b36 | 6516 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
5e1c08eb C |
6517 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
6518 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
6519 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
6520 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
5e1c08eb C |
6521 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
6522 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
6523 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
6524 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
6525 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
6526 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
61b66b36 C |
6527 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, |
6528 | <span class="hljs-attr">"account"</span>: { | |
6529 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6530 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
6531 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6532 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
6533 | <span class="hljs-attr">"avatar"</span>: { | |
6534 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
6535 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6536 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
6537 | } | |
6538 | } | |
5e1c08eb C |
6539 | } |
6540 | </code></pre> | |
6541 | <!-- </div> --> | |
6542 | </section> | |
6543 | </div> | |
6544 | </div> | |
6545 | </div> | |
6546 | <div id="definition-VideoAbuse" class="definition panel" data-traverse-target="definition-VideoAbuse"> | |
6547 | <h2 class="panel-title"> | |
6548 | <a name="/definitions/VideoAbuse"></a>VideoAbuse: | |
6549 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6550 | <span class="json-property-range" title="Value limits"></span> | |
6551 | ||
6552 | ||
6553 | </span> --> | |
6554 | </h2> | |
6555 | <div class="doc-row"> | |
6556 | <div class="doc-copy"> | |
6557 | <section class="json-schema-properties"> | |
6558 | <dl> | |
6559 | <dt data-property-name="id"> | |
6560 | <span class="json-property-name">id:</span> | |
6561 | <span class="json-property-type">number</span> | |
6562 | <span class="json-property-range" title="Value limits"></span> | |
6563 | </dt> | |
6564 | <dt data-property-name="reason"> | |
6565 | <span class="json-property-name">reason:</span> | |
6566 | <span class="json-property-type">string</span> | |
6567 | <span class="json-property-range" title="Value limits"></span> | |
6568 | </dt> | |
5d00a3d7 C |
6569 | <dt data-property-name="reporterAccount"> |
6570 | <span class="json-property-name">reporterAccount:</span> | |
6571 | <span class="json-property-type"> | |
6572 | <span class=""> | |
6573 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
6574 | </span> | |
6575 | </span> | |
5e1c08eb C |
6576 | <span class="json-property-range" title="Value limits"></span> |
6577 | </dt> | |
5d00a3d7 C |
6578 | <dt data-property-name="video"> |
6579 | <span class="json-property-name">video:</span> | |
6580 | <span class="json-property-type">object</span> | |
5e1c08eb C |
6581 | <span class="json-property-range" title="Value limits"></span> |
6582 | </dt> | |
ad9e39fb C |
6583 | <dt class="json-inner-schema"> |
6584 | <section class="json-schema-properties"> | |
6585 | <dl> | |
6586 | <dt data-property-name="id"> | |
6587 | <span class="json-property-name">id:</span> | |
6588 | <span class="json-property-type">number</span> | |
6589 | <span class="json-property-range" title="Value limits"></span> | |
6590 | </dt> | |
6591 | <dt data-property-name="name"> | |
6592 | <span class="json-property-name">name:</span> | |
6593 | <span class="json-property-type">string</span> | |
6594 | <span class="json-property-range" title="Value limits"></span> | |
6595 | </dt> | |
6596 | <dt data-property-name="uuid"> | |
6597 | <span class="json-property-name">uuid:</span> | |
6598 | <span class="json-property-type">string</span> | |
6599 | <span class="json-property-range" title="Value limits"></span> | |
6600 | </dt> | |
6601 | <dt data-property-name="url"> | |
6602 | <span class="json-property-name">url:</span> | |
6603 | <span class="json-property-type">string</span> | |
6604 | <span class="json-property-range" title="Value limits"></span> | |
6605 | </dt> | |
6606 | </dl> | |
6607 | </section> | |
6608 | </dt> | |
5e1c08eb C |
6609 | <dt data-property-name="createdAt"> |
6610 | <span class="json-property-name">createdAt:</span> | |
6611 | <span class="json-property-type">string</span> | |
6612 | <span class="json-property-range" title="Value limits"></span> | |
6613 | </dt> | |
6614 | </dl> | |
6615 | </section> | |
6616 | </div> | |
6617 | <div class="doc-examples"> | |
6618 | <section> | |
6619 | <h5>Example</h5> | |
6620 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6621 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6622 | <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>, | |
5d00a3d7 C |
6623 | <span class="hljs-attr">"reporterAccount"</span>: { |
6624 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
6625 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6626 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
6627 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6628 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6629 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
6630 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
6631 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
6632 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6633 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6634 | <span class="hljs-attr">"avatar"</span>: { | |
6635 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
6636 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6637 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
6638 | } | |
6639 | }, | |
61b66b36 C |
6640 | <span class="hljs-attr">"video"</span>: { |
6641 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6642 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6643 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
6644 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span> | |
6645 | }, | |
5e1c08eb C |
6646 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span> |
6647 | } | |
6648 | </code></pre> | |
6649 | <!-- </div> --> | |
6650 | </section> | |
6651 | </div> | |
6652 | </div> | |
6653 | </div> | |
6654 | <div id="definition-VideoBlacklist" class="definition panel" data-traverse-target="definition-VideoBlacklist"> | |
6655 | <h2 class="panel-title"> | |
6656 | <a name="/definitions/VideoBlacklist"></a>VideoBlacklist: | |
6657 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6658 | <span class="json-property-range" title="Value limits"></span> | |
6659 | ||
6660 | ||
6661 | </span> --> | |
6662 | </h2> | |
6663 | <div class="doc-row"> | |
6664 | <div class="doc-copy"> | |
6665 | <section class="json-schema-properties"> | |
6666 | <dl> | |
6667 | <dt data-property-name="id"> | |
6668 | <span class="json-property-name">id:</span> | |
6669 | <span class="json-property-type">number</span> | |
6670 | <span class="json-property-range" title="Value limits"></span> | |
6671 | </dt> | |
6672 | <dt data-property-name="videoId"> | |
6673 | <span class="json-property-name">videoId:</span> | |
6674 | <span class="json-property-type">number</span> | |
6675 | <span class="json-property-range" title="Value limits"></span> | |
6676 | </dt> | |
6677 | <dt data-property-name="createdAt"> | |
6678 | <span class="json-property-name">createdAt:</span> | |
6679 | <span class="json-property-type">string</span> | |
6680 | <span class="json-property-range" title="Value limits"></span> | |
6681 | </dt> | |
6682 | <dt data-property-name="updatedAt"> | |
6683 | <span class="json-property-name">updatedAt:</span> | |
6684 | <span class="json-property-type">string</span> | |
6685 | <span class="json-property-range" title="Value limits"></span> | |
6686 | </dt> | |
6687 | <dt data-property-name="name"> | |
6688 | <span class="json-property-name">name:</span> | |
6689 | <span class="json-property-type">string</span> | |
6690 | <span class="json-property-range" title="Value limits"></span> | |
6691 | </dt> | |
6692 | <dt data-property-name="uuid"> | |
6693 | <span class="json-property-name">uuid:</span> | |
6694 | <span class="json-property-type">string</span> | |
6695 | <span class="json-property-range" title="Value limits"></span> | |
6696 | </dt> | |
6697 | <dt data-property-name="description"> | |
6698 | <span class="json-property-name">description:</span> | |
6699 | <span class="json-property-type">string</span> | |
6700 | <span class="json-property-range" title="Value limits"></span> | |
6701 | </dt> | |
6702 | <dt data-property-name="duration"> | |
6703 | <span class="json-property-name">duration:</span> | |
6704 | <span class="json-property-type">number</span> | |
6705 | <span class="json-property-range" title="Value limits"></span> | |
6706 | </dt> | |
6707 | <dt data-property-name="views"> | |
6708 | <span class="json-property-name">views:</span> | |
6709 | <span class="json-property-type">number</span> | |
6710 | <span class="json-property-range" title="Value limits"></span> | |
6711 | </dt> | |
6712 | <dt data-property-name="likes"> | |
6713 | <span class="json-property-name">likes:</span> | |
6714 | <span class="json-property-type">number</span> | |
6715 | <span class="json-property-range" title="Value limits"></span> | |
6716 | </dt> | |
6717 | <dt data-property-name="dislikes"> | |
6718 | <span class="json-property-name">dislikes:</span> | |
6719 | <span class="json-property-type">number</span> | |
6720 | <span class="json-property-range" title="Value limits"></span> | |
6721 | </dt> | |
6722 | <dt data-property-name="nsfw"> | |
6723 | <span class="json-property-name">nsfw:</span> | |
6724 | <span class="json-property-type">boolean</span> | |
6725 | <span class="json-property-range" title="Value limits"></span> | |
6726 | </dt> | |
6727 | </dl> | |
6728 | </section> | |
6729 | </div> | |
6730 | <div class="doc-examples"> | |
6731 | <section> | |
6732 | <h5>Example</h5> | |
6733 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6734 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6735 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
6736 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6737 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6738 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6739 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
6740 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
6741 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
6742 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
6743 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
6744 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
6745 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
6746 | } | |
6747 | </code></pre> | |
6748 | <!-- </div> --> | |
6749 | </section> | |
6750 | </div> | |
6751 | </div> | |
6752 | </div> | |
6753 | <div id="definition-VideoChannel" class="definition panel" data-traverse-target="definition-VideoChannel"> | |
6754 | <h2 class="panel-title"> | |
6755 | <a name="/definitions/VideoChannel"></a>VideoChannel: | |
6756 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6757 | <span class="json-property-range" title="Value limits"></span> | |
6758 | ||
6759 | ||
6760 | </span> --> | |
6761 | </h2> | |
6762 | <div class="doc-row"> | |
6763 | <div class="doc-copy"> | |
6764 | <section class="json-schema-properties"> | |
6765 | <dl> | |
6766 | <dt data-property-name="displayName"> | |
6767 | <span class="json-property-name">displayName:</span> | |
6768 | <span class="json-property-type">string</span> | |
6769 | <span class="json-property-range" title="Value limits"></span> | |
6770 | </dt> | |
6771 | <dt data-property-name="description"> | |
6772 | <span class="json-property-name">description:</span> | |
6773 | <span class="json-property-type">string</span> | |
6774 | <span class="json-property-range" title="Value limits"></span> | |
6775 | </dt> | |
6776 | <dt data-property-name="isLocal"> | |
6777 | <span class="json-property-name">isLocal:</span> | |
6778 | <span class="json-property-type">boolean</span> | |
6779 | <span class="json-property-range" title="Value limits"></span> | |
6780 | </dt> | |
cc918ac3 C |
6781 | <dt data-property-name="ownerAccount"> |
6782 | <span class="json-property-name">ownerAccount:</span> | |
5e1c08eb C |
6783 | <span class="json-property-type">object</span> |
6784 | <span class="json-property-range" title="Value limits"></span> | |
6785 | </dt> | |
ad9e39fb C |
6786 | <dt class="json-inner-schema"> |
6787 | <section class="json-schema-properties"> | |
6788 | <dl> | |
6789 | <dt data-property-name="id"> | |
6790 | <span class="json-property-name">id:</span> | |
6791 | <span class="json-property-type">number</span> | |
6792 | <span class="json-property-range" title="Value limits"></span> | |
6793 | </dt> | |
6794 | <dt data-property-name="uuid"> | |
6795 | <span class="json-property-name">uuid:</span> | |
6796 | <span class="json-property-type">string</span> | |
6797 | <span class="json-property-range" title="Value limits"></span> | |
6798 | </dt> | |
6799 | </dl> | |
6800 | </section> | |
6801 | </dt> | |
5e1c08eb C |
6802 | </dl> |
6803 | </section> | |
6804 | </div> | |
6805 | <div class="doc-examples"> | |
6806 | <section> | |
6807 | <h5>Example</h5> | |
6808 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6809 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
6810 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
6811 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
cc918ac3 C |
6812 | <span class="hljs-attr">"ownerAccount"</span>: { |
6813 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5e1c08eb | 6814 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
cc918ac3 | 6815 | } |
5e1c08eb C |
6816 | } |
6817 | </code></pre> | |
6818 | <!-- </div> --> | |
6819 | </section> | |
6820 | </div> | |
6821 | </div> | |
6822 | </div> | |
6823 | <div id="definition-VideoComment" class="definition panel" data-traverse-target="definition-VideoComment"> | |
6824 | <h2 class="panel-title"> | |
6825 | <a name="/definitions/VideoComment"></a>VideoComment: | |
6826 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6827 | <span class="json-property-range" title="Value limits"></span> | |
6828 | ||
6829 | ||
6830 | </span> --> | |
6831 | </h2> | |
6832 | <div class="doc-row"> | |
6833 | <div class="doc-copy"> | |
6834 | <section class="json-schema-properties"> | |
6835 | <dl> | |
6836 | <dt data-property-name="id"> | |
6837 | <span class="json-property-name">id:</span> | |
6838 | <span class="json-property-type">number</span> | |
6839 | <span class="json-property-range" title="Value limits"></span> | |
6840 | </dt> | |
6841 | <dt data-property-name="url"> | |
6842 | <span class="json-property-name">url:</span> | |
6843 | <span class="json-property-type">string</span> | |
6844 | <span class="json-property-range" title="Value limits"></span> | |
6845 | </dt> | |
6846 | <dt data-property-name="text"> | |
6847 | <span class="json-property-name">text:</span> | |
6848 | <span class="json-property-type">string</span> | |
6849 | <span class="json-property-range" title="Value limits"></span> | |
6850 | </dt> | |
6851 | <dt data-property-name="threadId"> | |
6852 | <span class="json-property-name">threadId:</span> | |
6853 | <span class="json-property-type">number</span> | |
6854 | <span class="json-property-range" title="Value limits"></span> | |
6855 | </dt> | |
6856 | <dt data-property-name="inReplyToCommentId"> | |
6857 | <span class="json-property-name">inReplyToCommentId:</span> | |
6858 | <span class="json-property-type">number</span> | |
6859 | <span class="json-property-range" title="Value limits"></span> | |
6860 | </dt> | |
6861 | <dt data-property-name="videoId"> | |
6862 | <span class="json-property-name">videoId:</span> | |
6863 | <span class="json-property-type">number</span> | |
6864 | <span class="json-property-range" title="Value limits"></span> | |
6865 | </dt> | |
6866 | <dt data-property-name="createdAt"> | |
6867 | <span class="json-property-name">createdAt:</span> | |
6868 | <span class="json-property-type">string</span> | |
6869 | <span class="json-property-range" title="Value limits"></span> | |
6870 | </dt> | |
6871 | <dt data-property-name="updatedAt"> | |
6872 | <span class="json-property-name">updatedAt:</span> | |
6873 | <span class="json-property-type">string</span> | |
6874 | <span class="json-property-range" title="Value limits"></span> | |
6875 | </dt> | |
6876 | <dt data-property-name="totalReplies"> | |
6877 | <span class="json-property-name">totalReplies:</span> | |
6878 | <span class="json-property-type">number</span> | |
6879 | <span class="json-property-range" title="Value limits"></span> | |
6880 | </dt> | |
6881 | <dt data-property-name="account"> | |
6882 | <span class="json-property-name">account:</span> | |
6883 | <span class="json-property-type"> | |
6884 | <span class=""> | |
6885 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
6886 | </span> | |
6887 | </span> | |
6888 | <span class="json-property-range" title="Value limits"></span> | |
6889 | </dt> | |
6890 | </dl> | |
6891 | </section> | |
6892 | </div> | |
6893 | <div class="doc-examples"> | |
6894 | <section> | |
6895 | <h5>Example</h5> | |
6896 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6897 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6898 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6899 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
6900 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
6901 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
6902 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
6903 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6904 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6905 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
6906 | <span class="hljs-attr">"account"</span>: { | |
6907 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
6908 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6909 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
6910 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6911 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6912 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
6913 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
6914 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
6915 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6916 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6917 | <span class="hljs-attr">"avatar"</span>: { | |
6918 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
6919 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6920 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
6921 | } | |
6922 | } | |
6923 | } | |
6924 | </code></pre> | |
6925 | <!-- </div> --> | |
6926 | </section> | |
6927 | </div> | |
6928 | </div> | |
6929 | </div> | |
6930 | <div id="definition-VideoCommentThreadTree" class="definition panel" data-traverse-target="definition-VideoCommentThreadTree"> | |
6931 | <h2 class="panel-title"> | |
6932 | <a name="/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree: | |
6933 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
6934 | <span class="json-property-range" title="Value limits"></span> | |
6935 | ||
6936 | ||
6937 | </span> --> | |
6938 | </h2> | |
6939 | <div class="doc-row"> | |
6940 | <div class="doc-copy"> | |
6941 | <section class="json-schema-properties"> | |
6942 | <dl> | |
6943 | <dt data-property-name="comment"> | |
6944 | <span class="json-property-name">comment:</span> | |
6945 | <span class="json-property-type"> | |
6946 | <span class=""> | |
6947 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
6948 | </span> | |
6949 | </span> | |
6950 | <span class="json-property-range" title="Value limits"></span> | |
6951 | </dt> | |
6952 | <dt data-property-name="children"> | |
6953 | <span class="json-property-name">children:</span> | |
6954 | <span class="json-property-type"> | |
6955 | <span class="json-schema-ref-array"> | |
6956 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
6957 | </span> | |
6958 | </span> | |
6959 | <span class="json-property-range" title="Value limits"></span> | |
6960 | </dt> | |
ad9e39fb C |
6961 | <dt class="json-inner-schema"> |
6962 | <section class="json-schema-array-items"> | |
6963 | <span class="json-property-type"> | |
6964 | <span class=""> | |
6965 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
6966 | </span> | |
6967 | </span> | |
6968 | <span class="json-property-range" title="Value limits"></span> | |
6969 | <div class="json-inner-schema"> </div> | |
6970 | </section> | |
6971 | </dt> | |
5e1c08eb C |
6972 | </dl> |
6973 | </section> | |
6974 | </div> | |
6975 | <div class="doc-examples"> | |
6976 | <section> | |
6977 | <h5>Example</h5> | |
6978 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
6979 | <span class="hljs-attr">"comment"</span>: { | |
6980 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6981 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6982 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
6983 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
6984 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
6985 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
6986 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6987 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
6988 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
6989 | <span class="hljs-attr">"account"</span>: { | |
6990 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
6991 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
6992 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
6993 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
6994 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
6995 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
6996 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
6997 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
6998 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
6999 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7000 | <span class="hljs-attr">"avatar"</span>: { | |
7001 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
7002 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7003 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
7004 | } | |
7005 | } | |
7006 | }, | |
7007 | <span class="hljs-attr">"children"</span>: [ | |
7008 | { | |
7009 | <span class="hljs-attr">"comment"</span>: { | |
7010 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7011 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7012 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
7013 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
7014 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
7015 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
7016 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7017 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7018 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
7019 | <span class="hljs-attr">"account"</span>: { | |
7020 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
7021 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7022 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
7023 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7024 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
7025 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
7026 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
7027 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
7028 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7029 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7030 | <span class="hljs-attr">"avatar"</span>: { | |
7031 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
7032 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7033 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
7034 | } | |
7035 | } | |
7036 | }, | |
7037 | <span class="hljs-attr">"children"</span>: [ | |
7038 | { | |
7039 | <span class="hljs-attr">"comment"</span>: { | |
7040 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7041 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7042 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
7043 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
7044 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
7045 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
7046 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7047 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7048 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
7049 | <span class="hljs-attr">"account"</span>: { | |
7050 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
7051 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7052 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
7053 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7054 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
7055 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
7056 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
7057 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
7058 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7059 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7060 | <span class="hljs-attr">"avatar"</span>: { | |
7061 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
7062 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7063 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
7064 | } | |
7065 | } | |
7066 | } | |
7067 | } | |
7068 | ] | |
7069 | } | |
7070 | ] | |
7071 | } | |
7072 | </code></pre> | |
7073 | <!-- </div> --> | |
7074 | </section> | |
7075 | </div> | |
7076 | </div> | |
7077 | </div> | |
7078 | <div id="definition-Avatar" class="definition panel" data-traverse-target="definition-Avatar"> | |
7079 | <h2 class="panel-title"> | |
7080 | <a name="/definitions/Avatar"></a>Avatar: | |
7081 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
7082 | <span class="json-property-range" title="Value limits"></span> | |
7083 | ||
7084 | ||
7085 | </span> --> | |
7086 | </h2> | |
7087 | <div class="doc-row"> | |
7088 | <div class="doc-copy"> | |
7089 | <section class="json-schema-properties"> | |
7090 | <dl> | |
7091 | <dt data-property-name="path"> | |
7092 | <span class="json-property-name">path:</span> | |
7093 | <span class="json-property-type">string</span> | |
7094 | <span class="json-property-range" title="Value limits"></span> | |
7095 | </dt> | |
7096 | <dt data-property-name="createdAt"> | |
7097 | <span class="json-property-name">createdAt:</span> | |
7098 | <span class="json-property-type">string</span> | |
7099 | <span class="json-property-range" title="Value limits"></span> | |
7100 | </dt> | |
7101 | <dt data-property-name="updatedAt"> | |
7102 | <span class="json-property-name">updatedAt:</span> | |
7103 | <span class="json-property-type">string</span> | |
7104 | <span class="json-property-range" title="Value limits"></span> | |
7105 | </dt> | |
7106 | </dl> | |
7107 | </section> | |
7108 | </div> | |
7109 | <div class="doc-examples"> | |
7110 | <section> | |
7111 | <h5>Example</h5> | |
7112 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
7113 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
7114 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7115 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
7116 | } | |
7117 | </code></pre> | |
7118 | <!-- </div> --> | |
7119 | </section> | |
7120 | </div> | |
7121 | </div> | |
7122 | </div> | |
7123 | <div id="definition-Actor" class="definition panel" data-traverse-target="definition-Actor"> | |
7124 | <h2 class="panel-title"> | |
7125 | <a name="/definitions/Actor"></a>Actor: | |
7126 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
7127 | <span class="json-property-range" title="Value limits"></span> | |
7128 | ||
7129 | ||
7130 | </span> --> | |
7131 | </h2> | |
7132 | <div class="doc-row"> | |
7133 | <div class="doc-copy"> | |
7134 | <section class="json-schema-properties"> | |
7135 | <dl> | |
7136 | <dt data-property-name="id"> | |
7137 | <span class="json-property-name">id:</span> | |
7138 | <span class="json-property-type">number</span> | |
7139 | <span class="json-property-range" title="Value limits"></span> | |
7140 | </dt> | |
7141 | <dt data-property-name="uuid"> | |
7142 | <span class="json-property-name">uuid:</span> | |
7143 | <span class="json-property-type">string</span> | |
7144 | <span class="json-property-range" title="Value limits"></span> | |
7145 | </dt> | |
7146 | <dt data-property-name="url"> | |
7147 | <span class="json-property-name">url:</span> | |
7148 | <span class="json-property-type">string</span> | |
7149 | <span class="json-property-range" title="Value limits"></span> | |
7150 | </dt> | |
7151 | <dt data-property-name="name"> | |
7152 | <span class="json-property-name">name:</span> | |
7153 | <span class="json-property-type">string</span> | |
7154 | <span class="json-property-range" title="Value limits"></span> | |
7155 | </dt> | |
7156 | <dt data-property-name="host"> | |
7157 | <span class="json-property-name">host:</span> | |
7158 | <span class="json-property-type">string</span> | |
7159 | <span class="json-property-range" title="Value limits"></span> | |
7160 | </dt> | |
7161 | <dt data-property-name="followingCount"> | |
7162 | <span class="json-property-name">followingCount:</span> | |
7163 | <span class="json-property-type">number</span> | |
7164 | <span class="json-property-range" title="Value limits"></span> | |
7165 | </dt> | |
7166 | <dt data-property-name="followersCount"> | |
7167 | <span class="json-property-name">followersCount:</span> | |
7168 | <span class="json-property-type">number</span> | |
7169 | <span class="json-property-range" title="Value limits"></span> | |
7170 | </dt> | |
7171 | <dt data-property-name="createdAt"> | |
7172 | <span class="json-property-name">createdAt:</span> | |
7173 | <span class="json-property-type">string</span> | |
7174 | <span class="json-property-range" title="Value limits"></span> | |
7175 | </dt> | |
7176 | <dt data-property-name="updatedAt"> | |
7177 | <span class="json-property-name">updatedAt:</span> | |
7178 | <span class="json-property-type">string</span> | |
7179 | <span class="json-property-range" title="Value limits"></span> | |
7180 | </dt> | |
7181 | <dt data-property-name="avatar"> | |
7182 | <span class="json-property-name">avatar:</span> | |
7183 | <span class="json-property-type"> | |
7184 | <span class=""> | |
7185 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | |
7186 | </span> | |
7187 | </span> | |
7188 | <span class="json-property-range" title="Value limits"></span> | |
7189 | </dt> | |
7190 | </dl> | |
7191 | </section> | |
7192 | </div> | |
7193 | <div class="doc-examples"> | |
7194 | <section> | |
7195 | <h5>Example</h5> | |
7196 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
7197 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7198 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
7199 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7200 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
7201 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
7202 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
7203 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
7204 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7205 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7206 | <span class="hljs-attr">"avatar"</span>: { | |
7207 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
7208 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7209 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
7210 | } | |
7211 | } | |
7212 | </code></pre> | |
7213 | <!-- </div> --> | |
7214 | </section> | |
7215 | </div> | |
7216 | </div> | |
7217 | </div> | |
7218 | <div id="definition-Account" class="definition panel" data-traverse-target="definition-Account"> | |
7219 | <h2 class="panel-title"> | |
7220 | <a name="/definitions/Account"></a>Account: | |
7221 | <!-- <span class="json-property-type"><span class="json-property-type"></span> | |
7222 | <span class="json-property-range" title="Value limits"></span> | |
7223 | ||
7224 | ||
7225 | </span> --> | |
7226 | </h2> | |
7227 | <div class="doc-row"> | |
7228 | <div class="doc-copy"> | |
7229 | <section class="json-schema-allOf"> | |
7230 | <section class="json-schema-allOf-inherited"> | |
7231 | <ul> | |
7232 | <span class=""> | |
7233 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
7234 | </span> | |
7235 | </ul> | |
7236 | </section> | |
7237 | <section class="json-schema-allOf-additional"> | |
7238 | <section class="json-schema-properties"> | |
7239 | <dl> | |
7240 | <dt data-property-name="displayName"> | |
7241 | <span class="json-property-name">displayName:</span> | |
7242 | <span class="json-property-type">string</span> | |
7243 | <span class="json-property-range" title="Value limits"></span> | |
7244 | </dt> | |
7245 | </dl> | |
7246 | </section> | |
7247 | </section> | |
7248 | </section> | |
7249 | </div> | |
7250 | <div class="doc-examples"> | |
7251 | <section> | |
7252 | <h5>Example</h5> | |
7253 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
7254 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
7255 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7256 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
7257 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7258 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
7259 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
7260 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
7261 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
7262 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7263 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7264 | <span class="hljs-attr">"avatar"</span>: { | |
7265 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
7266 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7267 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
7268 | } | |
7269 | } | |
7270 | </code></pre> | |
7271 | <!-- </div> --> | |
7272 | </section> | |
7273 | </div> | |
7274 | </div> | |
7275 | </div> | |
7276 | <div id="definition-User" class="definition panel" data-traverse-target="definition-User"> | |
7277 | <h2 class="panel-title"> | |
7278 | <a name="/definitions/User"></a>User: | |
7279 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
7280 | <span class="json-property-range" title="Value limits"></span> | |
7281 | ||
7282 | ||
7283 | </span> --> | |
7284 | </h2> | |
7285 | <div class="doc-row"> | |
7286 | <div class="doc-copy"> | |
7287 | <section class="json-schema-properties"> | |
7288 | <dl> | |
7289 | <dt data-property-name="id"> | |
7290 | <span class="json-property-name">id:</span> | |
7291 | <span class="json-property-type">number</span> | |
7292 | <span class="json-property-range" title="Value limits"></span> | |
7293 | </dt> | |
7294 | <dt data-property-name="username"> | |
7295 | <span class="json-property-name">username:</span> | |
7296 | <span class="json-property-type">string</span> | |
7297 | <span class="json-property-range" title="Value limits"></span> | |
7298 | </dt> | |
7299 | <dt data-property-name="email"> | |
7300 | <span class="json-property-name">email:</span> | |
7301 | <span class="json-property-type">string</span> | |
7302 | <span class="json-property-range" title="Value limits"></span> | |
7303 | </dt> | |
7304 | <dt data-property-name="displayNSFW"> | |
7305 | <span class="json-property-name">displayNSFW:</span> | |
7306 | <span class="json-property-type">boolean</span> | |
7307 | <span class="json-property-range" title="Value limits"></span> | |
7308 | </dt> | |
7309 | <dt data-property-name="autoPlayVideo"> | |
7310 | <span class="json-property-name">autoPlayVideo:</span> | |
7311 | <span class="json-property-type">boolean</span> | |
7312 | <span class="json-property-range" title="Value limits"></span> | |
7313 | </dt> | |
7314 | <dt data-property-name="role"> | |
7315 | <span class="json-property-name">role:</span> | |
7316 | <span class="json-property-type">string</span> | |
7317 | <span class="json-property-enum" title="Possible values"> | |
7318 | <span class="json-property-enum-item">User</span>, | |
7319 | <span class="json-property-enum-item">Moderator</span>, | |
7320 | <span class="json-property-enum-item">Administrator</span> | |
7321 | </span> | |
7322 | <span class="json-property-range" title="Value limits"></span> | |
7323 | </dt> | |
7324 | <dt data-property-name="videoQuota"> | |
7325 | <span class="json-property-name">videoQuota:</span> | |
7326 | <span class="json-property-type">number</span> | |
7327 | <span class="json-property-range" title="Value limits"></span> | |
7328 | </dt> | |
7329 | <dt data-property-name="createdAt"> | |
7330 | <span class="json-property-name">createdAt:</span> | |
7331 | <span class="json-property-type">string</span> | |
7332 | <span class="json-property-range" title="Value limits"></span> | |
7333 | </dt> | |
7334 | <dt data-property-name="account"> | |
7335 | <span class="json-property-name">account:</span> | |
7336 | <span class="json-property-type"> | |
7337 | <span class=""> | |
7338 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
7339 | </span> | |
7340 | </span> | |
7341 | <span class="json-property-range" title="Value limits"></span> | |
7342 | </dt> | |
7343 | <dt data-property-name="videoChannels"> | |
7344 | <span class="json-property-name">videoChannels:</span> | |
7345 | <span class="json-property-type"> | |
7346 | <span class="json-schema-ref-array"> | |
7347 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
7348 | </span> | |
7349 | </span> | |
7350 | <span class="json-property-range" title="Value limits"></span> | |
7351 | </dt> | |
ad9e39fb C |
7352 | <dt class="json-inner-schema"> |
7353 | <section class="json-schema-array-items"> | |
7354 | <span class="json-property-type"> | |
7355 | <span class=""> | |
7356 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
7357 | </span> | |
7358 | </span> | |
7359 | <span class="json-property-range" title="Value limits"></span> | |
7360 | <div class="json-inner-schema"> </div> | |
7361 | </section> | |
7362 | </dt> | |
5e1c08eb C |
7363 | </dl> |
7364 | </section> | |
7365 | </div> | |
7366 | <div class="doc-examples"> | |
7367 | <section> | |
7368 | <h5>Example</h5> | |
7369 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
7370 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7371 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
7372 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
7373 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
7374 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
7375 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
7376 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
7377 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7378 | <span class="hljs-attr">"account"</span>: { | |
7379 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
7380 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7381 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
7382 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7383 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
7384 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
7385 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
7386 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
7387 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7388 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7389 | <span class="hljs-attr">"avatar"</span>: { | |
7390 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
7391 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7392 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
7393 | } | |
7394 | }, | |
7395 | <span class="hljs-attr">"videoChannels"</span>: [ | |
7396 | { | |
7397 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
7398 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
7399 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
cc918ac3 C |
7400 | <span class="hljs-attr">"ownerAccount"</span>: { |
7401 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
5e1c08eb | 7402 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
cc918ac3 | 7403 | } |
5e1c08eb C |
7404 | } |
7405 | ] | |
7406 | } | |
7407 | </code></pre> | |
7408 | <!-- </div> --> | |
7409 | </section> | |
7410 | </div> | |
7411 | </div> | |
7412 | </div> | |
7413 | <div id="definition-ServerConfig" class="definition panel" data-traverse-target="definition-ServerConfig"> | |
7414 | <h2 class="panel-title"> | |
7415 | <a name="/definitions/ServerConfig"></a>ServerConfig: | |
7416 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
7417 | <span class="json-property-range" title="Value limits"></span> | |
7418 | ||
7419 | ||
7420 | </span> --> | |
7421 | </h2> | |
7422 | <div class="doc-row"> | |
7423 | <div class="doc-copy"> | |
7424 | <section class="json-schema-properties"> | |
7425 | <dl> | |
7426 | <dt data-property-name="signup"> | |
7427 | <span class="json-property-name">signup:</span> | |
7428 | <span class="json-property-type">object</span> | |
7429 | <span class="json-property-range" title="Value limits"></span> | |
7430 | </dt> | |
ad9e39fb C |
7431 | <dt class="json-inner-schema"> |
7432 | <section class="json-schema-properties"> | |
7433 | <dl> | |
7434 | <dt data-property-name="allowed"> | |
7435 | <span class="json-property-name">allowed:</span> | |
7436 | <span class="json-property-type">boolean</span> | |
7437 | <span class="json-property-range" title="Value limits"></span> | |
7438 | </dt> | |
7439 | </dl> | |
7440 | </section> | |
7441 | </dt> | |
5e1c08eb C |
7442 | <dt data-property-name="transcoding"> |
7443 | <span class="json-property-name">transcoding:</span> | |
7444 | <span class="json-property-type">object</span> | |
7445 | <span class="json-property-range" title="Value limits"></span> | |
7446 | </dt> | |
ad9e39fb C |
7447 | <dt class="json-inner-schema"> |
7448 | <section class="json-schema-properties"> | |
7449 | <dl> | |
7450 | <dt data-property-name="enabledResolutions"> | |
7451 | <span class="json-property-name">enabledResolutions:</span> | |
7452 | <span class="json-property-type">number[]</span> | |
7453 | <span class="json-property-range" title="Value limits"></span> | |
7454 | </dt> | |
7455 | <dt class="json-inner-schema"> | |
7456 | <section class="json-schema-array-items"> | |
7457 | <span class="json-property-type">number</span> | |
7458 | <span class="json-property-range" title="Value limits"></span> | |
7459 | <div class="json-inner-schema"> </div> | |
7460 | </section> | |
7461 | </dt> | |
7462 | </dl> | |
7463 | </section> | |
7464 | </dt> | |
5e1c08eb C |
7465 | <dt data-property-name="avatar"> |
7466 | <span class="json-property-name">avatar:</span> | |
7467 | <span class="json-property-type">object</span> | |
7468 | <span class="json-property-range" title="Value limits"></span> | |
7469 | </dt> | |
ad9e39fb C |
7470 | <dt class="json-inner-schema"> |
7471 | <section class="json-schema-properties"> | |
7472 | <dl> | |
7473 | <dt data-property-name="file"> | |
7474 | <span class="json-property-name">file:</span> | |
7475 | <span class="json-property-type">object</span> | |
7476 | <span class="json-property-range" title="Value limits"></span> | |
7477 | </dt> | |
7478 | <dt class="json-inner-schema"> | |
7479 | <section class="json-schema-properties"> | |
7480 | <dl> | |
7481 | <dt data-property-name="size"> | |
7482 | <span class="json-property-name">size:</span> | |
7483 | <span class="json-property-type">object</span> | |
7484 | <span class="json-property-range" title="Value limits"></span> | |
7485 | </dt> | |
7486 | <dt class="json-inner-schema"> | |
7487 | <section class="json-schema-properties"> | |
7488 | <dl> | |
7489 | <dt data-property-name="max"> | |
7490 | <span class="json-property-name">max:</span> | |
7491 | <span class="json-property-type">number</span> | |
7492 | <span class="json-property-range" title="Value limits"></span> | |
7493 | </dt> | |
7494 | </dl> | |
7495 | </section> | |
7496 | </dt> | |
7497 | </dl> | |
7498 | </section> | |
7499 | </dt> | |
7500 | <dt data-property-name="extensions"> | |
7501 | <span class="json-property-name">extensions:</span> | |
7502 | <span class="json-property-type">string[]</span> | |
7503 | <span class="json-property-range" title="Value limits"></span> | |
7504 | </dt> | |
7505 | <dt class="json-inner-schema"> | |
7506 | <section class="json-schema-array-items"> | |
7507 | <span class="json-property-type">string</span> | |
7508 | <span class="json-property-range" title="Value limits"></span> | |
7509 | <div class="json-inner-schema"> </div> | |
7510 | </section> | |
7511 | </dt> | |
7512 | </dl> | |
7513 | </section> | |
7514 | </dt> | |
5e1c08eb C |
7515 | <dt data-property-name="video"> |
7516 | <span class="json-property-name">video:</span> | |
7517 | <span class="json-property-type">object</span> | |
7518 | <span class="json-property-range" title="Value limits"></span> | |
7519 | </dt> | |
ad9e39fb C |
7520 | <dt class="json-inner-schema"> |
7521 | <section class="json-schema-properties"> | |
7522 | <dl> | |
7523 | <dt data-property-name="file"> | |
7524 | <span class="json-property-name">file:</span> | |
7525 | <span class="json-property-type">object</span> | |
7526 | <span class="json-property-range" title="Value limits"></span> | |
7527 | </dt> | |
7528 | <dt class="json-inner-schema"> | |
7529 | <section class="json-schema-properties"> | |
7530 | <dl> | |
7531 | <dt data-property-name="extensions"> | |
7532 | <span class="json-property-name">extensions:</span> | |
7533 | <span class="json-property-type">string[]</span> | |
7534 | <span class="json-property-range" title="Value limits"></span> | |
7535 | </dt> | |
7536 | <dt class="json-inner-schema"> | |
7537 | <section class="json-schema-array-items"> | |
7538 | <span class="json-property-type">string</span> | |
7539 | <span class="json-property-range" title="Value limits"></span> | |
7540 | <div class="json-inner-schema"> </div> | |
7541 | </section> | |
7542 | </dt> | |
7543 | </dl> | |
7544 | </section> | |
7545 | </dt> | |
7546 | </dl> | |
7547 | </section> | |
7548 | </dt> | |
5e1c08eb C |
7549 | </dl> |
7550 | </section> | |
7551 | </div> | |
7552 | <div class="doc-examples"> | |
7553 | <section> | |
7554 | <h5>Example</h5> | |
7555 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
7556 | <span class="hljs-attr">"signup"</span>: { | |
7557 | <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span> | |
7558 | }, | |
7559 | <span class="hljs-attr">"transcoding"</span>: { | |
7560 | <span class="hljs-attr">"enabledResolutions"</span>: [ | |
7561 | <span class="hljs-string">"number"</span> | |
7562 | ] | |
7563 | }, | |
7564 | <span class="hljs-attr">"avatar"</span>: { | |
7565 | <span class="hljs-attr">"file"</span>: { | |
7566 | <span class="hljs-attr">"size"</span>: { | |
7567 | <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span> | |
7568 | } | |
7569 | }, | |
7570 | <span class="hljs-attr">"extensions"</span>: [ | |
7571 | <span class="hljs-string">"string"</span> | |
7572 | ] | |
7573 | }, | |
7574 | <span class="hljs-attr">"video"</span>: { | |
7575 | <span class="hljs-attr">"file"</span>: { | |
7576 | <span class="hljs-attr">"extensions"</span>: [ | |
7577 | <span class="hljs-string">"string"</span> | |
7578 | ] | |
7579 | } | |
7580 | } | |
7581 | } | |
7582 | </code></pre> | |
7583 | <!-- </div> --> | |
7584 | </section> | |
7585 | </div> | |
7586 | </div> | |
7587 | </div> | |
7588 | <div id="definition-Follow" class="definition panel" data-traverse-target="definition-Follow"> | |
7589 | <h2 class="panel-title"> | |
7590 | <a name="/definitions/Follow"></a>Follow: | |
7591 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
7592 | <span class="json-property-range" title="Value limits"></span> | |
7593 | ||
7594 | ||
7595 | </span> --> | |
7596 | </h2> | |
7597 | <div class="doc-row"> | |
7598 | <div class="doc-copy"> | |
7599 | <section class="json-schema-properties"> | |
7600 | <dl> | |
7601 | <dt data-property-name="id"> | |
7602 | <span class="json-property-name">id:</span> | |
7603 | <span class="json-property-type">number</span> | |
7604 | <span class="json-property-range" title="Value limits"></span> | |
7605 | </dt> | |
7606 | <dt data-property-name="follower"> | |
7607 | <span class="json-property-name">follower:</span> | |
7608 | <span class="json-property-type"> | |
7609 | <span class=""> | |
7610 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
7611 | </span> | |
7612 | </span> | |
7613 | <span class="json-property-range" title="Value limits"></span> | |
7614 | </dt> | |
7615 | <dt data-property-name="following"> | |
7616 | <span class="json-property-name">following:</span> | |
7617 | <span class="json-property-type"> | |
7618 | <span class=""> | |
7619 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
7620 | </span> | |
7621 | </span> | |
7622 | <span class="json-property-range" title="Value limits"></span> | |
7623 | </dt> | |
7624 | <dt data-property-name="score"> | |
7625 | <span class="json-property-name">score:</span> | |
7626 | <span class="json-property-type">number</span> | |
7627 | <span class="json-property-range" title="Value limits"></span> | |
7628 | </dt> | |
7629 | <dt data-property-name="state"> | |
7630 | <span class="json-property-name">state:</span> | |
7631 | <span class="json-property-type">string</span> | |
7632 | <span class="json-property-enum" title="Possible values"> | |
7633 | <span class="json-property-enum-item">pending</span>, | |
7634 | <span class="json-property-enum-item">accepted</span> | |
7635 | </span> | |
7636 | <span class="json-property-range" title="Value limits"></span> | |
7637 | </dt> | |
7638 | <dt data-property-name="createdAt"> | |
7639 | <span class="json-property-name">createdAt:</span> | |
7640 | <span class="json-property-type">string</span> | |
7641 | <span class="json-property-range" title="Value limits"></span> | |
7642 | </dt> | |
7643 | <dt data-property-name="updatedAt"> | |
7644 | <span class="json-property-name">updatedAt:</span> | |
7645 | <span class="json-property-type">string</span> | |
7646 | <span class="json-property-range" title="Value limits"></span> | |
7647 | </dt> | |
7648 | </dl> | |
7649 | </section> | |
7650 | </div> | |
7651 | <div class="doc-examples"> | |
7652 | <section> | |
7653 | <h5>Example</h5> | |
7654 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
7655 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7656 | <span class="hljs-attr">"follower"</span>: { | |
7657 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7658 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
7659 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7660 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
7661 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
7662 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
7663 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
7664 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7665 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7666 | <span class="hljs-attr">"avatar"</span>: { | |
7667 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
7668 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7669 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
7670 | } | |
7671 | }, | |
7672 | <span class="hljs-attr">"following"</span>: { | |
7673 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7674 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
7675 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7676 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
7677 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
7678 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
7679 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
7680 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7681 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7682 | <span class="hljs-attr">"avatar"</span>: { | |
7683 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
7684 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7685 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
7686 | } | |
7687 | }, | |
7688 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
7689 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
7690 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7691 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
7692 | } | |
7693 | </code></pre> | |
7694 | <!-- </div> --> | |
7695 | </section> | |
7696 | </div> | |
7697 | </div> | |
7698 | </div> | |
7699 | <div id="definition-Job" class="definition panel" data-traverse-target="definition-Job"> | |
7700 | <h2 class="panel-title"> | |
7701 | <a name="/definitions/Job"></a>Job: | |
7702 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
7703 | <span class="json-property-range" title="Value limits"></span> | |
7704 | ||
7705 | ||
7706 | </span> --> | |
7707 | </h2> | |
7708 | <div class="doc-row"> | |
7709 | <div class="doc-copy"> | |
7710 | <section class="json-schema-properties"> | |
7711 | <dl> | |
7712 | <dt data-property-name="id"> | |
7713 | <span class="json-property-name">id:</span> | |
7714 | <span class="json-property-type">number</span> | |
7715 | <span class="json-property-range" title="Value limits"></span> | |
7716 | </dt> | |
7717 | <dt data-property-name="state"> | |
7718 | <span class="json-property-name">state:</span> | |
7719 | <span class="json-property-type">string</span> | |
7720 | <span class="json-property-enum" title="Possible values"> | |
7721 | <span class="json-property-enum-item">pending</span>, | |
7722 | <span class="json-property-enum-item">processing</span>, | |
7723 | <span class="json-property-enum-item">error</span>, | |
7724 | <span class="json-property-enum-item">success</span> | |
7725 | </span> | |
7726 | <span class="json-property-range" title="Value limits"></span> | |
7727 | </dt> | |
7728 | <dt data-property-name="category"> | |
7729 | <span class="json-property-name">category:</span> | |
7730 | <span class="json-property-type">string</span> | |
7731 | <span class="json-property-enum" title="Possible values"> | |
7732 | <span class="json-property-enum-item">transcoding</span>, | |
7733 | <span class="json-property-enum-item">activitypub-http</span> | |
7734 | </span> | |
7735 | <span class="json-property-range" title="Value limits"></span> | |
7736 | </dt> | |
7737 | <dt data-property-name="handlerName"> | |
7738 | <span class="json-property-name">handlerName:</span> | |
7739 | <span class="json-property-type">string</span> | |
7740 | <span class="json-property-range" title="Value limits"></span> | |
7741 | </dt> | |
7742 | <dt data-property-name="handlerInputData"> | |
7743 | <span class="json-property-name">handlerInputData:</span> | |
7744 | <span class="json-property-type">string</span> | |
7745 | <span class="json-property-range" title="Value limits"></span> | |
7746 | </dt> | |
7747 | <dt data-property-name="createdAt"> | |
7748 | <span class="json-property-name">createdAt:</span> | |
7749 | <span class="json-property-type">string</span> | |
7750 | <span class="json-property-range" title="Value limits"></span> | |
7751 | </dt> | |
7752 | <dt data-property-name="updatedAt"> | |
7753 | <span class="json-property-name">updatedAt:</span> | |
7754 | <span class="json-property-type">string</span> | |
7755 | <span class="json-property-range" title="Value limits"></span> | |
7756 | </dt> | |
7757 | </dl> | |
7758 | </section> | |
7759 | </div> | |
7760 | <div class="doc-examples"> | |
7761 | <section> | |
7762 | <h5>Example</h5> | |
7763 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
7764 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7765 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
7766 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>, | |
7767 | <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>, | |
7768 | <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>, | |
7769 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7770 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
7771 | } | |
7772 | </code></pre> | |
7773 | <!-- </div> --> | |
7774 | </section> | |
7775 | </div> | |
7776 | </div> | |
7777 | </div> | |
7778 | <div id="definition-AddUserResponse" class="definition panel" data-traverse-target="definition-AddUserResponse"> | |
7779 | <h2 class="panel-title"> | |
7780 | <a name="/definitions/AddUserResponse"></a>AddUserResponse: | |
7781 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
7782 | <span class="json-property-range" title="Value limits"></span> | |
7783 | ||
7784 | ||
7785 | </span> --> | |
7786 | </h2> | |
7787 | <div class="doc-row"> | |
7788 | <div class="doc-copy"> | |
7789 | <section class="json-schema-properties"> | |
7790 | <dl> | |
7791 | <dt data-property-name="id"> | |
7792 | <span class="json-property-name">id:</span> | |
7793 | <span class="json-property-type">number</span> | |
7794 | <span class="json-property-range" title="Value limits"></span> | |
7795 | </dt> | |
7796 | <dt data-property-name="uuid"> | |
7797 | <span class="json-property-name">uuid:</span> | |
7798 | <span class="json-property-type">string</span> | |
7799 | <span class="json-property-range" title="Value limits"></span> | |
7800 | </dt> | |
7801 | </dl> | |
7802 | </section> | |
7803 | </div> | |
7804 | <div class="doc-examples"> | |
7805 | <section> | |
7806 | <h5>Example</h5> | |
7807 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
7808 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7809 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
7810 | } | |
7811 | </code></pre> | |
7812 | <!-- </div> --> | |
7813 | </section> | |
7814 | </div> | |
7815 | </div> | |
7816 | </div> | |
7817 | <div id="definition-VideoUploadResponse" class="definition panel" data-traverse-target="definition-VideoUploadResponse"> | |
7818 | <h2 class="panel-title"> | |
7819 | <a name="/definitions/VideoUploadResponse"></a>VideoUploadResponse: | |
7820 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
7821 | <span class="json-property-range" title="Value limits"></span> | |
7822 | ||
7823 | ||
7824 | </span> --> | |
7825 | </h2> | |
7826 | <div class="doc-row"> | |
7827 | <div class="doc-copy"> | |
7828 | <section class="json-schema-properties"> | |
7829 | <dl> | |
61b66b36 C |
7830 | <dt data-property-name="video"> |
7831 | <span class="json-property-name">video:</span> | |
7832 | <span class="json-property-type">object</span> | |
5e1c08eb C |
7833 | <span class="json-property-range" title="Value limits"></span> |
7834 | </dt> | |
ad9e39fb C |
7835 | <dt class="json-inner-schema"> |
7836 | <section class="json-schema-properties"> | |
7837 | <dl> | |
7838 | <dt data-property-name="id"> | |
7839 | <span class="json-property-name">id:</span> | |
7840 | <span class="json-property-type">number</span> | |
7841 | <span class="json-property-range" title="Value limits"></span> | |
7842 | </dt> | |
7843 | <dt data-property-name="uuid"> | |
7844 | <span class="json-property-name">uuid:</span> | |
7845 | <span class="json-property-type">string</span> | |
7846 | <span class="json-property-range" title="Value limits"></span> | |
7847 | </dt> | |
7848 | </dl> | |
7849 | </section> | |
7850 | </dt> | |
5e1c08eb C |
7851 | </dl> |
7852 | </section> | |
7853 | </div> | |
7854 | <div class="doc-examples"> | |
7855 | <section> | |
7856 | <h5>Example</h5> | |
7857 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
61b66b36 C |
7858 | <span class="hljs-attr">"video"</span>: { |
7859 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7860 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
7861 | } | |
5e1c08eb | 7862 | } |
ab0ee6a1 C |
7863 | </code></pre> |
7864 | <!-- </div> --> | |
7865 | </section> | |
7866 | </div> | |
7867 | </div> | |
7868 | </div> | |
7869 | <div id="definition-CommentThreadResponse" class="definition panel" data-traverse-target="definition-CommentThreadResponse"> | |
7870 | <h2 class="panel-title"> | |
7871 | <a name="/definitions/CommentThreadResponse"></a>CommentThreadResponse: | |
7872 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
7873 | <span class="json-property-range" title="Value limits"></span> | |
7874 | ||
7875 | ||
7876 | </span> --> | |
7877 | </h2> | |
7878 | <div class="doc-row"> | |
7879 | <div class="doc-copy"> | |
7880 | <section class="json-schema-properties"> | |
7881 | <dl> | |
7882 | <dt data-property-name="total"> | |
7883 | <span class="json-property-name">total:</span> | |
7884 | <span class="json-property-type">number</span> | |
7885 | <span class="json-property-range" title="Value limits"></span> | |
7886 | </dt> | |
7887 | <dt data-property-name="data"> | |
7888 | <span class="json-property-name">data:</span> | |
7889 | <span class="json-property-type"> | |
7890 | <span class="json-schema-ref-array"> | |
7891 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
7892 | </span> | |
7893 | </span> | |
7894 | <span class="json-property-range" title="Value limits"></span> | |
7895 | </dt> | |
ad9e39fb C |
7896 | <dt class="json-inner-schema"> |
7897 | <section class="json-schema-array-items"> | |
7898 | <span class="json-property-type"> | |
7899 | <span class=""> | |
7900 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
7901 | </span> | |
7902 | </span> | |
7903 | <span class="json-property-range" title="Value limits"></span> | |
7904 | <div class="json-inner-schema"> </div> | |
7905 | </section> | |
7906 | </dt> | |
ab0ee6a1 C |
7907 | </dl> |
7908 | </section> | |
7909 | </div> | |
7910 | <div class="doc-examples"> | |
7911 | <section> | |
7912 | <h5>Example</h5> | |
7913 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
7914 | <span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>, | |
7915 | <span class="hljs-attr">"data"</span>: [ | |
7916 | { | |
7917 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7918 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7919 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
7920 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
7921 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
7922 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
7923 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7924 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7925 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
7926 | <span class="hljs-attr">"account"</span>: { | |
7927 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
7928 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7929 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
7930 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7931 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
7932 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
7933 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
7934 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
7935 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7936 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7937 | <span class="hljs-attr">"avatar"</span>: { | |
7938 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
7939 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7940 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
7941 | } | |
7942 | } | |
7943 | } | |
7944 | ] | |
7945 | } | |
7946 | </code></pre> | |
7947 | <!-- </div> --> | |
7948 | </section> | |
7949 | </div> | |
7950 | </div> | |
7951 | </div> | |
7952 | <div id="definition-CommentThreadPostResponse" class="definition panel" data-traverse-target="definition-CommentThreadPostResponse"> | |
7953 | <h2 class="panel-title"> | |
7954 | <a name="/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse: | |
7955 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
7956 | <span class="json-property-range" title="Value limits"></span> | |
7957 | ||
7958 | ||
7959 | </span> --> | |
7960 | </h2> | |
7961 | <div class="doc-row"> | |
7962 | <div class="doc-copy"> | |
7963 | <section class="json-schema-properties"> | |
7964 | <dl> | |
7965 | <dt data-property-name="comment"> | |
7966 | <span class="json-property-name">comment:</span> | |
7967 | <span class="json-property-type"> | |
7968 | <span class=""> | |
7969 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
7970 | </span> | |
7971 | </span> | |
7972 | <span class="json-property-range" title="Value limits"></span> | |
7973 | </dt> | |
7974 | </dl> | |
7975 | </section> | |
7976 | </div> | |
7977 | <div class="doc-examples"> | |
7978 | <section> | |
7979 | <h5>Example</h5> | |
7980 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
7981 | <span class="hljs-attr">"comment"</span>: { | |
7982 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7983 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7984 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
7985 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
7986 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
7987 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
7988 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
7989 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
7990 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
7991 | <span class="hljs-attr">"account"</span>: { | |
7992 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
7993 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
7994 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
7995 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
7996 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
7997 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
7998 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
7999 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
8000 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
8001 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
8002 | <span class="hljs-attr">"avatar"</span>: { | |
8003 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
8004 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
8005 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
8006 | } | |
8007 | } | |
8008 | } | |
8009 | } | |
5e1c08eb C |
8010 | </code></pre> |
8011 | <!-- </div> --> | |
8012 | </section> | |
8013 | </div> | |
8014 | </div> | |
8015 | </div> | |
8016 | <div id="definition-AddUser" class="definition panel" data-traverse-target="definition-AddUser"> | |
8017 | <h2 class="panel-title"> | |
8018 | <a name="/definitions/AddUser"></a>AddUser: | |
8019 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
8020 | <span class="json-property-range" title="Value limits"></span> | |
8021 | ||
8022 | ||
8023 | </span> --> | |
8024 | </h2> | |
8025 | <div class="doc-row"> | |
8026 | <div class="doc-copy"> | |
8027 | <section class="json-schema-properties"> | |
8028 | <dl> | |
8029 | <dt data-property-name="username" class="has-description"> | |
8030 | <span class="json-property-name">username:</span> | |
8031 | <span class="json-property-type">string</span> | |
8032 | <span class="json-property-range" title="Value limits"></span> | |
8033 | <span class="json-property-required"></span> | |
8034 | </dt> | |
8035 | <dd> | |
8036 | <p>The user username </p> | |
8037 | </dd> | |
8038 | <dt data-property-name="password" class="has-description"> | |
8039 | <span class="json-property-name">password:</span> | |
8040 | <span class="json-property-type">string</span> | |
8041 | <span class="json-property-range" title="Value limits"></span> | |
8042 | <span class="json-property-required"></span> | |
8043 | </dt> | |
8044 | <dd> | |
8045 | <p>The user password </p> | |
8046 | </dd> | |
8047 | <dt data-property-name="email" class="has-description"> | |
8048 | <span class="json-property-name">email:</span> | |
8049 | <span class="json-property-type">string</span> | |
8050 | <span class="json-property-range" title="Value limits"></span> | |
8051 | <span class="json-property-required"></span> | |
8052 | </dt> | |
8053 | <dd> | |
8054 | <p>The user email </p> | |
8055 | </dd> | |
8056 | <dt data-property-name="videoQuota" class="has-description"> | |
8057 | <span class="json-property-name">videoQuota:</span> | |
8058 | <span class="json-property-type">string</span> | |
8059 | <span class="json-property-range" title="Value limits"></span> | |
8060 | <span class="json-property-required"></span> | |
8061 | </dt> | |
8062 | <dd> | |
8063 | <p>The user videoQuota </p> | |
8064 | </dd> | |
8065 | <dt data-property-name="role" class="has-description"> | |
8066 | <span class="json-property-name">role:</span> | |
8067 | <span class="json-property-type">string</span> | |
8068 | <span class="json-property-range" title="Value limits"></span> | |
8069 | <span class="json-property-required"></span> | |
8070 | </dt> | |
8071 | <dd> | |
8072 | <p>The user role </p> | |
8073 | </dd> | |
8074 | </dl> | |
8075 | </section> | |
8076 | </div> | |
8077 | <div class="doc-examples"> | |
8078 | <section> | |
8079 | <h5>Example</h5> | |
8080 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
8081 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
8082 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
8083 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
8084 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
8085 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
8086 | } | |
8087 | </code></pre> | |
8088 | <!-- </div> --> | |
8089 | </section> | |
8090 | </div> | |
8091 | </div> | |
8092 | </div> | |
8093 | <div id="definition-UpdateUser" class="definition panel" data-traverse-target="definition-UpdateUser"> | |
8094 | <h2 class="panel-title"> | |
8095 | <a name="/definitions/UpdateUser"></a>UpdateUser: | |
8096 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
8097 | <span class="json-property-range" title="Value limits"></span> | |
8098 | ||
8099 | ||
8100 | </span> --> | |
8101 | </h2> | |
8102 | <div class="doc-row"> | |
8103 | <div class="doc-copy"> | |
8104 | <section class="json-schema-properties"> | |
8105 | <dl> | |
8106 | <dt data-property-name="id" class="has-description"> | |
8107 | <span class="json-property-name">id:</span> | |
8108 | <span class="json-property-type">string</span> | |
8109 | <span class="json-property-range" title="Value limits"></span> | |
8110 | <span class="json-property-required"></span> | |
8111 | </dt> | |
8112 | <dd> | |
8113 | <p>The user id </p> | |
8114 | </dd> | |
8115 | <dt data-property-name="email" class="has-description"> | |
8116 | <span class="json-property-name">email:</span> | |
8117 | <span class="json-property-type">string</span> | |
8118 | <span class="json-property-range" title="Value limits"></span> | |
8119 | <span class="json-property-required"></span> | |
8120 | </dt> | |
8121 | <dd> | |
8122 | <p>The updated email of the user </p> | |
8123 | </dd> | |
8124 | <dt data-property-name="videoQuota" class="has-description"> | |
8125 | <span class="json-property-name">videoQuota:</span> | |
8126 | <span class="json-property-type">string</span> | |
8127 | <span class="json-property-range" title="Value limits"></span> | |
8128 | <span class="json-property-required"></span> | |
8129 | </dt> | |
8130 | <dd> | |
8131 | <p>The updated videoQuota of the user </p> | |
8132 | </dd> | |
8133 | <dt data-property-name="role" class="has-description"> | |
8134 | <span class="json-property-name">role:</span> | |
8135 | <span class="json-property-type">string</span> | |
8136 | <span class="json-property-range" title="Value limits"></span> | |
8137 | <span class="json-property-required"></span> | |
8138 | </dt> | |
8139 | <dd> | |
8140 | <p>The updated role of the user </p> | |
8141 | </dd> | |
8142 | </dl> | |
8143 | </section> | |
8144 | </div> | |
8145 | <div class="doc-examples"> | |
8146 | <section> | |
8147 | <h5>Example</h5> | |
8148 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
8149 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
8150 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
8151 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
8152 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
8153 | } | |
8154 | </code></pre> | |
8155 | <!-- </div> --> | |
8156 | </section> | |
8157 | </div> | |
8158 | </div> | |
8159 | </div> | |
8160 | <div id="definition-UpdateMe" class="definition panel" data-traverse-target="definition-UpdateMe"> | |
8161 | <h2 class="panel-title"> | |
8162 | <a name="/definitions/UpdateMe"></a>UpdateMe: | |
8163 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
8164 | <span class="json-property-range" title="Value limits"></span> | |
8165 | ||
8166 | ||
8167 | </span> --> | |
8168 | </h2> | |
8169 | <div class="doc-row"> | |
8170 | <div class="doc-copy"> | |
8171 | <section class="json-schema-properties"> | |
8172 | <dl> | |
8173 | <dt data-property-name="password" class="has-description"> | |
8174 | <span class="json-property-name">password:</span> | |
8175 | <span class="json-property-type">string</span> | |
8176 | <span class="json-property-range" title="Value limits"></span> | |
8177 | <span class="json-property-required"></span> | |
8178 | </dt> | |
8179 | <dd> | |
8180 | <p>Your new password </p> | |
8181 | </dd> | |
8182 | <dt data-property-name="email" class="has-description"> | |
8183 | <span class="json-property-name">email:</span> | |
8184 | <span class="json-property-type">string</span> | |
8185 | <span class="json-property-range" title="Value limits"></span> | |
8186 | <span class="json-property-required"></span> | |
8187 | </dt> | |
8188 | <dd> | |
8189 | <p>Your new email </p> | |
8190 | </dd> | |
8191 | <dt data-property-name="displayNSFW" class="has-description"> | |
8192 | <span class="json-property-name">displayNSFW:</span> | |
8193 | <span class="json-property-type">string</span> | |
8194 | <span class="json-property-range" title="Value limits"></span> | |
8195 | <span class="json-property-required"></span> | |
8196 | </dt> | |
8197 | <dd> | |
8198 | <p>Your new displayNSFW </p> | |
8199 | </dd> | |
8200 | <dt data-property-name="autoPlayVideo" class="has-description"> | |
8201 | <span class="json-property-name">autoPlayVideo:</span> | |
8202 | <span class="json-property-type">string</span> | |
8203 | <span class="json-property-range" title="Value limits"></span> | |
8204 | <span class="json-property-required"></span> | |
8205 | </dt> | |
8206 | <dd> | |
8207 | <p>Your new autoPlayVideo </p> | |
8208 | </dd> | |
8209 | </dl> | |
8210 | </section> | |
8211 | </div> | |
8212 | <div class="doc-examples"> | |
8213 | <section> | |
8214 | <h5>Example</h5> | |
8215 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
8216 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
8217 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
8218 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>, | |
8219 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span> | |
8220 | } | |
8221 | </code></pre> | |
8222 | <!-- </div> --> | |
8223 | </section> | |
8224 | </div> | |
8225 | </div> | |
8226 | </div> | |
8227 | <div id="definition-GetMeVideoRating" class="definition panel" data-traverse-target="definition-GetMeVideoRating"> | |
8228 | <h2 class="panel-title"> | |
8229 | <a name="/definitions/GetMeVideoRating"></a>GetMeVideoRating: | |
8230 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
8231 | <span class="json-property-range" title="Value limits"></span> | |
8232 | ||
8233 | ||
8234 | </span> --> | |
8235 | </h2> | |
8236 | <div class="doc-row"> | |
8237 | <div class="doc-copy"> | |
8238 | <section class="json-schema-properties"> | |
8239 | <dl> | |
8240 | <dt data-property-name="id" class="has-description"> | |
8241 | <span class="json-property-name">id:</span> | |
8242 | <span class="json-property-type">string</span> | |
8243 | <span class="json-property-range" title="Value limits"></span> | |
8244 | <span class="json-property-required"></span> | |
8245 | </dt> | |
8246 | <dd> | |
8247 | <p>Id of the video </p> | |
8248 | </dd> | |
8249 | <dt data-property-name="rating" class="has-description"> | |
8250 | <span class="json-property-name">rating:</span> | |
8251 | <span class="json-property-type">number</span> | |
8252 | <span class="json-property-range" title="Value limits"></span> | |
8253 | <span class="json-property-required"></span> | |
8254 | </dt> | |
8255 | <dd> | |
8256 | <p>Rating of the video </p> | |
8257 | </dd> | |
8258 | </dl> | |
8259 | </section> | |
8260 | </div> | |
8261 | <div class="doc-examples"> | |
8262 | <section> | |
8263 | <h5>Example</h5> | |
8264 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
8265 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
8266 | <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span> | |
8267 | } | |
8268 | </code></pre> | |
8269 | <!-- </div> --> | |
8270 | </section> | |
8271 | </div> | |
8272 | </div> | |
8273 | </div> | |
8274 | <div id="definition-RegisterUser" class="definition panel" data-traverse-target="definition-RegisterUser"> | |
8275 | <h2 class="panel-title"> | |
8276 | <a name="/definitions/RegisterUser"></a>RegisterUser: | |
8277 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
8278 | <span class="json-property-range" title="Value limits"></span> | |
8279 | ||
8280 | ||
8281 | </span> --> | |
8282 | </h2> | |
8283 | <div class="doc-row"> | |
8284 | <div class="doc-copy"> | |
8285 | <section class="json-schema-properties"> | |
8286 | <dl> | |
8287 | <dt data-property-name="username" class="has-description"> | |
8288 | <span class="json-property-name">username:</span> | |
8289 | <span class="json-property-type">string</span> | |
8290 | <span class="json-property-range" title="Value limits"></span> | |
8291 | <span class="json-property-required"></span> | |
8292 | </dt> | |
8293 | <dd> | |
8294 | <p>The username of the user </p> | |
8295 | </dd> | |
8296 | <dt data-property-name="password" class="has-description"> | |
8297 | <span class="json-property-name">password:</span> | |
8298 | <span class="json-property-type">string</span> | |
8299 | <span class="json-property-range" title="Value limits"></span> | |
8300 | <span class="json-property-required"></span> | |
8301 | </dt> | |
8302 | <dd> | |
8303 | <p>The password of the user </p> | |
8304 | </dd> | |
8305 | <dt data-property-name="email" class="has-description"> | |
8306 | <span class="json-property-name">email:</span> | |
8307 | <span class="json-property-type">string</span> | |
8308 | <span class="json-property-range" title="Value limits"></span> | |
8309 | <span class="json-property-required"></span> | |
8310 | </dt> | |
8311 | <dd> | |
8312 | <p>The email of the user </p> | |
8313 | </dd> | |
8314 | </dl> | |
8315 | </section> | |
8316 | </div> | |
8317 | <div class="doc-examples"> | |
8318 | <section> | |
8319 | <h5>Example</h5> | |
8320 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
8321 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
8322 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
8323 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span> | |
8324 | } | |
8325 | </code></pre> | |
8326 | <!-- </div> --> | |
8327 | </section> | |
8328 | </div> | |
8329 | </div> | |
8330 | </div> | |
8331 | <div id="definition-VideoChannelInput" class="definition panel" data-traverse-target="definition-VideoChannelInput"> | |
8332 | <h2 class="panel-title"> | |
8333 | <a name="/definitions/VideoChannelInput"></a>VideoChannelInput: | |
8334 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
8335 | <span class="json-property-range" title="Value limits"></span> | |
8336 | ||
8337 | ||
8338 | </span> --> | |
8339 | </h2> | |
8340 | <div class="doc-row"> | |
8341 | <div class="doc-copy"> | |
8342 | <section class="json-schema-properties"> | |
8343 | <dl> | |
8344 | <dt data-property-name="name"> | |
8345 | <span class="json-property-name">name:</span> | |
8346 | <span class="json-property-type">string</span> | |
8347 | <span class="json-property-range" title="Value limits"></span> | |
8348 | </dt> | |
8349 | <dt data-property-name="description"> | |
8350 | <span class="json-property-name">description:</span> | |
8351 | <span class="json-property-type">string</span> | |
8352 | <span class="json-property-range" title="Value limits"></span> | |
8353 | </dt> | |
8354 | </dl> | |
8355 | </section> | |
8356 | </div> | |
8357 | <div class="doc-examples"> | |
8358 | <section> | |
8359 | <h5>Example</h5> | |
8360 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
8361 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
8362 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
8363 | } | |
bbe0f064 C |
8364 | </code></pre> |
8365 | <!-- </div> --> | |
8366 | </section> | |
8367 | </div> | |
8368 | </div> | |
8369 | </div> | |
8370 | <div id="definition-ScheduleVideoUpdate" class="definition panel" data-traverse-target="definition-ScheduleVideoUpdate"> | |
8371 | <h2 class="panel-title"> | |
8372 | <a name="/definitions/ScheduleVideoUpdate"></a>ScheduleVideoUpdate: | |
8373 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
8374 | <span class="json-property-range" title="Value limits"></span> | |
8375 | ||
8376 | ||
8377 | </span> --> | |
8378 | </h2> | |
8379 | <div class="doc-row"> | |
8380 | <div class="doc-copy"> | |
8381 | <section class="json-schema-properties"> | |
8382 | <dl> | |
8383 | <dt data-property-name="updateAt" class="has-description"> | |
8384 | <span class="json-property-name">updateAt:</span> | |
8385 | <span class="json-property-type">dateTime</span> | |
8386 | <span class="json-property-range" title="Value limits"></span> | |
8387 | </dt> | |
8388 | <dd> | |
8389 | <p>When to update the video</p> | |
8390 | </dd> | |
8391 | <dt data-property-name="privacy"> | |
8392 | <span class="json-property-name">privacy:</span> | |
8393 | <span class="json-property-type"> | |
8394 | <span class=""> | |
8395 | <a class="json-schema-ref" href="#/definitions/VideoPrivacy">VideoPrivacy</a> | |
8396 | </span> | |
8397 | </span> | |
8398 | <span class="json-property-range" title="Value limits"></span> | |
8399 | </dt> | |
8400 | </dl> | |
8401 | </section> | |
8402 | </div> | |
8403 | <div class="doc-examples"> | |
8404 | <section> | |
8405 | <h5>Example</h5> | |
8406 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
8407 | <span class="hljs-attr">"updateAt"</span>: <span class="hljs-string">"dateTime"</span>, | |
8408 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span> | |
8409 | } | |
5e1c08eb C |
8410 | </code></pre> |
8411 | <!-- </div> --> | |
8412 | </section> | |
8413 | </div> | |
8414 | </div> | |
8415 | </div> | |
8416 | <div class="doc-row no-margin"> | |
8417 | <div class="doc-copy doc-separator"> | |
8418 | <a class="powered-by" href="https://sourcey.com/spectacle">Documentation by | |
8419 | <span>Spectacle</span> | |
8420 | </a> | |
8421 | </div> | |
8422 | </div> | |
8423 | </article> | |
8424 | </div> | |
8425 | </div> | |
8426 | </body> | |
8427 | </html> |